ZedAI Profiles Overview

From zedwiki

Jump to: navigation, search

This document gives an abstract overview of the authoring profiles provided in the ZedAI framework.

This document is a scratch working area and does not describe the final feature sets of the profiles.

Contents

OUT OF DATE

Simple Book Profile

Target

This profile is geared towards markup of material with a simple structure, such as novels, children's books, non-complicated text books, some types of manuals, etc.

It should be as simple as possible, the easiest of all profiles to learn and ease, and thus also serve as a starting point for people getting started with the ZedAI framework.

Elements

The profile offers grammar for markup of things like

  • sections and section headings
  • the standard set of block elements (paragraphs, blockquotes, various types of lists)
  • the standard set of inline elements
  • page breaks
  • tables
  • various types of notes (footnotes)
  • book cover, front-, body and backmatter

Text (Advanced) Book Profile

Target

This profile is intended to be used to markup text books with complicated structures and/or special content types.

Elements

This profile extends the Simple Book profile.

Further, it adds:

  • Boxes (sidebars and other types of out-of-spine content)
  • More advanced frontmatter TOC content model
  • Support for Section TOCs (TOCs in the beginning of chapters)
  • Support for annotation markup (see http://code.google.com/p/zednext/issues/detail?id=16)
  • Support for exercise markup
  • Support for science markup (computer science, mathematics)
  • Support for SVG?

Features available to all profiles

  • A required set of metadata elements
  • Support for XInclude (to split big books in several files)
  • Support for conditional content (DISELECT or something similar)
Personal tools