Style Guide

From Documentation

Revision as of 05:50, 29 September 2006

This is the style guide for formatting text for the Functional Software online Documentation.

Product Links

• The first occurrence of a product name (backup3G, duty3G, etc) in a paragraph should be linked to the main documentation entry for that product.
• Product names in lists, or dot points need not be linked, unless they are the first mention in the relevant section of the page.
• If the context of the product mention indicates a specific part of the manual, the link should encircle the whole mention, and link to the relevant part of the document.

How To

1. To create a link to a main document level, simply use "[[product3G]]"
2. To link to a sub-section of a document, use "[[product3G/subPage | product3G Subpage]]"
3. To link to a specific part of a document, use "[[product3G/subPage#sectionName | Section Name]]"

Examples

1. [[COSmanager]] = COSmanager
2. [[COSmanager/User_Guide/Appendices | COSmanager User Guide Appendices]] = COSmanager User Guide Appendices
3. [[COSmanager/User_Guide/Appendices#Appendix_A_.E2.80.94_the_COSmanager_User_Interface| Appendix A—the COSmanager User Interface]] = Appendix A—the COSmanager User Interface

Documentation Styles

Cautions, Notes, Tips

Currently, cautions, notes and tips look like:

Note

This is a note, of some description

This look is achieved using the following code:

----
;Note: This is a note, of some description
----

Obviously, change the text to suit your needs.