Style Guide
From Documentation
(Difference between revisions)
| Revision as of 04:13, 29 September 2006 Daniels (Talk | contribs) (→How To) ← Previous diff |
Revision as of 04:15, 29 September 2006 Daniels (Talk | contribs) (→How To) Next diff → |
||
| Line 9: | Line 9: | ||
| === How To === | === How To === | ||
| - | *To create a link to a main document level, simply use "<nowiki>[[product3G]]</nowiki>" | + | #To create a link to a main document level, simply use "<nowiki>[[product3G]]</nowiki>" |
| - | *To link to a sub-section of a document, use "<nowiki>[[COSmanager/User_Guide/Installing_COSmanager | Installing COSmanager]]</nowiki>", as an example | + | #To link to a sub-section of a document, use "<nowiki>[[product3G/subPage | product3G Subpage]]</nowiki>" |
| + | #To link to a specific part of a document, use "<nowiki>[[product3G/subPage#sectionName | Section Name]]</nowiki>" | ||
| + | |||
| + | === Examples === | ||
| + | |||
| + | COSmanager/User_Guide/Appendices#Appendix_A_.E2.80.94_the_COSmanager_User_Interface| Appendix A—the COSmanager User Interface | ||
Revision as of 04:15, 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
- To create a link to a main document level, simply use "[[product3G]]"
- To link to a sub-section of a document, use "[[product3G/subPage | product3G Subpage]]"
- To link to a specific part of a document, use "[[product3G/subPage#sectionName | Section Name]]"
Examples
COSmanager/User_Guide/Appendices#Appendix_A_.E2.80.94_the_COSmanager_User_Interface| Appendix A—the COSmanager User Interface