Style Guide
From Documentation
(Difference between revisions)
| Revision as of 04:10, 29 September 2006 Daniels (Talk | contribs) ← Previous diff |
Revision as of 04:11, 29 September 2006 Daniels (Talk | contribs) (→Product Links) Next diff → |
||
| Line 6: | Line 6: | ||
| *Product names in lists, or dot points need not be linked, unless they are the first mention in the relevant section of the page. | *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. | *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 {nowiki}[[product3G]]{/nowiki} | ||
Revision as of 04:11, 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 {nowiki}product3G{/nowiki}