Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "COSMOS Document Naming"
(→Document naming) |
|||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[COSMOS|COSMOS Wiki]] > [[COSMOS_Documentation_Plan|COSMOS Document Plan]] | [[COSMOS|COSMOS Wiki]] > [[COSMOS_Documentation_Plan|COSMOS Document Plan]] | ||
| − | This section covers the naming of a COSMOS | + | |
| + | This section covers the file naming of a COSMOS documents and adding a Category documentation reference. | ||
== Document naming == | == Document naming == | ||
| Line 9: | Line 10: | ||
* or '''wiki.eclipse.org/COSMOS_Development_Guide_{topic}''' | * or '''wiki.eclipse.org/COSMOS_Development_Guide_{topic}''' | ||
| − | Where '''''{topic}''''' is the name of the COSMOS component or subject. For example, the following | + | Where '''''{topic}''''' is the name of the COSMOS component or subject. For example, the following table lists a few topics of the COSMOS User's Guide and the associated filename. |
| − | + | {| | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | {| | + | |
|- border="1" | |- border="1" | ||
| Line 53: | Line 48: | ||
| − | + | [[Category:COSMOS_Documentation]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | [[Category: | + | |
Latest revision as of 09:40, 12 February 2008
COSMOS Wiki > COSMOS Document Plan
This section covers the file naming of a COSMOS documents and adding a Category documentation reference.
Document naming
When creating a Wiki document page, use the following naming structure:
- wiki.eclipse.org/COSMOS_Users's_Guide_{topic}
- or wiki.eclipse.org/COSMOS_Development_Guide_{topic}
Where {topic} is the name of the COSMOS component or subject. For example, the following table lists a few topics of the COSMOS User's Guide and the associated filename.
| Topic | Filename |
|---|---|
| Overview | COSMOS_User's_Guide_Overview |
| Management Enablement | COSMOS_User's_Guide_Management_Enablement |
| WSDM_tooling | COSMOS_User's_Guide_WSDM_tooling |
Adding a Category documentation reference
To help organize and locate documents, please insert the following category tag at the bottom of your document Wiki page:
'''[[Category:COSMOS Consumer Documentation]]'''
Hierarchy of documentation categories example
[[Category:COSMOS]] .... [[Category:COSMOS Consumer Documentation]] ............ [[Category:COSMOS User's Guide]] ............ [[Category:COSMOS Development Guide]]To make
[[Category:COSMOS User's Guide]]a child of
[[Category:COSMOS Consumer Documentation]], just edit wiki.eclipse.org/Category:COSMOS_User's_Guide and put
[[Category:COSMOS Consumer Documentation]]at the bottom of the page, and submit the change.