FS
Documentation

Style Guide

From Documentation

(Difference between revisions)
Jump to: navigation, search
Revision as of 05:49, 29 September 2006
Daniels (Talk | contribs)
(Cautions, Notes, Tips)
← Previous diff
Revision as of 05:49, 29 September 2006
Daniels (Talk | contribs)
(Cautions, Notes, Tips)
Next diff →
Line 31: Line 31:
This look is achieved using the following code: This look is achieved using the following code:
-<nowiki>----</nowiki>+<nowiki>----</nowiki><br />
-<nowiki>;Note:</nowiki> This is a note, of some description+<nowiki>;Note:</nowiki> This is a note, of some description<br />
-<nowiki>----</nowiki>+<nowiki>----</nowiki><br />

Revision as of 05:49, 29 September 2006

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

Contents

Product Links


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
----