My favorites | Sign in
Project Home Wiki Issues Source
READ-ONLY: This project has been archived. For more information see this post.
Search
for
DesignDoc  
Updated Apr 10, 2010 by codeshar...@gmail.com

Design Rules:

  • The 4 parts to the spec are:
    1. Container spec
    2. Content spec
    3. Meta-data spec
    4. Views spec
  • All documents are stored inside a file archive container. The zip format has been selected as the container format. The zip format is a stable well known format with a wealth of tools and development libraries. The zip format is also capable of supporting compression and encryption.
  • This spec will describe the internal structure of the files within the .zip container.
  • Raw content is stored in an XML syntax which structures content as objects. The XML content docs are only responsible for storing structured content.
  • Schema documents are used to define the valid structure of the content file(s).
  • XSLT documents are used to convert the raw XML content documents into a specific views.
  • XML micro-schemas will be used to represent data using existing XML schemas. A micro-schema is a sub-set of an existing XML schema (or standard) that has been condensed to into a simpler format that is necessary to convey only the data necessary to convey a textual, spoken, and visual representation of the content that the parent format was design to represent. Ex. MathML is used to describe mathematical formulas.
  • Content authors are free to determine if they want to ship only preprocessed views or if the want to include the raw content as well. Including the raw content files will allow greater flexibility for features.
  • Additional "Converters" or XSLT files can be included to allow the consumer to use software to generate alternate views.
  • Publications are required provide a minimum of two views:
    1. Re-flow view - this is essentially an HTML view. The content reflows based on the size of the container. If you resize a browser window while you are viewing a web page you'll see the content reflow.
    2. Page Perfect view - this is a fixed size document. Similar in purpose to a PDF.

Package / Container Format Diagram

Design Rules - Incubator

  • Content can be saved in multiple files and in a single file. It is up to the author to dictate the flow of the content. NOTE: This brings up a conflict in separating the data from the display. If a content author wants to control the flow differently than was originally intended or designed then there shouldn't be a required change in structure. The downside to enabling greater flexibility with content flow is added complexity.
  • Content is saved as an object graph. @todo Develop a method for indexing or querying for data from objects in the graph. Perhaps XPATH or XSLT in conjunction with XPATH (or XPointer).
Powered by Google Project Hosting