Error: Macro BackLinksMenu(None) failed

compressed data is corrupt

User Documentation Style Guide

This page is a sample style guide for creating user documentation. This is part of UNPLANNED_USER_DOC_STRUCTURE_R0..

Organization

• Each numbered item in the user documentation structure (UNPLANNED_USER_DOC_STRUCTURE/Outline) will get its own page in the wiki.

• Each release will have its own documentation directory in the wiki: e.g. for iteration 3, the user documentation is at ITERATION_03/Release/UserDocumentation.

• Names for pages in the wiki will be in the form xx_SectionTitle; xx is the number of the section in the outline. Subsections are subdirectories. Thus we have, for example, ITERATION_03/Release/UserDocumentation/02_WorkingWithSophie/02_HalosAndHUDs, which is section 2.2, "Halos and HUDs". Numbers follow the outline at UNPLANNED_USER_DOC_STRUCTURE/Outline. Names are in camelcase and should be the complete title of the section to avoid confusion.

• When Sophie Author/Sophie Reader/Sophie Server are separated into distinct sections, there will be distinct subdirectories for Author, Reader, and Server. So Release/UserDocumentation/02_WorkingWithSophie/02_HalosAndHUDs will move to Release/UserDocumentation/Author/02_WorkingWithSophie/02_HalosAndHUDs.

• Each page begins with a [[BackLinksMenu]] command and ends with a [[TitleIndex(xxx)]] where xxx is the page's path in the wiki. The title of the section is given as the header for the page, including the numbers of the outline, e.g. 2.2. Halos and HUDs.

• Each page should have an outline of the subsections in it. For example, section 2 should include a bulleted list with 2.1, 2.2, 2.3, 2.4. For interim releases where functionality is not present (e.g. embedded books in the Iteration 3 release), a page should be added saying that that functionality is not part of this release; however, these pages should not be listed in the outlines.

Images

• Images go in subversion at trunk/sophie2-platform/doc/user_doc_images/ . Images are structured by release; UNPLANNED_USER_DOC_SAMPLE contains images for the documentation sample, RELEASE_3 contains images added for RELEASE_3. Each new release will get a new subdirectory.

• Images should not be more than 800 pixels wide.

• For now, explanatory text in images is in Avenir 95 Bold in either 12 or 24 point.

Conventions

• Use "Sophie 2" rather than "Sophie2": we want to emphasize continuity from Sophie 1 to Sophie 2. "Sophie 2.0" is also acceptable.

• It is not necessary to always say "Sophie 2" or "Sophie 2.0"; simply "Sophie" is fine.

Extensibility

• More rules will be added to this list as they are needed and created.