fluidinfo / bookreader Goto Github PK

Importing "Little Brother" means there are two works for the bookreader to work with enabling the users / readers some sort of compare and contrast opportunity for two different types of work (fiction vs non).

The general outline of the project should be made in terms of directories and files.

When I first imported the work it was for the purposes of experimentation. However, ideas and schema have developed so the work needs pulling, tags deleting and re-importing to take into account the changes required.

Add the appropriate elements to the UI and ensure that the resulting fluidinfo session is configured.

Example usage:

  var reader = bookreader({username: "test", password: "secret"});
  var work = bookreader.getWork("The Three Bears");

Suggested behaviour to focus on retrieving, tagging and searching blocks that constitute a work that is organised in a linear fashion (so it might not necessarily be a book). :-)

• Define basic functions of the top level bookreader application - login, logout, set-up and functions that return objects that represent:
  • Works
  • Circle of Friends
  • Specific blocks
  • Library (of user's books)
• Define basic functions and behaviour of a "work" object (representing a thing consisting of blocks organised in a linear fashion). Best thought of as synonymous with a "book".
• Define basic functions and behaviour of a "friends" object (representing who else the current user is interested in following within the bookreader application).
• Define basic functions and behaviour of "block" objects (representing a constituent part of a work that sits at a specific point in the linear organisation of the work). Best thought of as synonymous with paragraphs and/or sentences. Also, blocks can contain blocks.
• Define basic functions and behaviour of "library" objects (linking together works that the user has read/annotated)

In order to make things move quickly and to help provide lots of basic browser based utilities the sammy.js (http://www.sammyjs.org/) framework should be incorporated into the application. (I've been hesitating about if the app should implement some of sammy's functionality itself, but hey... why make work for yourself?)

Example usage:

var reader = bookreader({username: "foo", password: "bar"}); // the bookreader object encapsulates most of the app logic
var work = reader.getWork({title: "The Three Bears"}); // a "work" object contains details about a work
var friends = reader.getFriends(); // friends = your book circle of fluidinfo users (whose tags you're interested in)
var library = reader.getLibrary(); // library = works you're reading / have been reading