Difference between revisions of "Contributing"
From ADF Docs
(→Text Formatting) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 4: | Line 4: | ||
===Text Formatting=== | ===Text Formatting=== | ||
| − | *Bulleted lists items end with a period. | + | * Bulleted lists items end with a period. |
| + | * Numbers below ten are written out. (For example, one is written "one" not "1." | ||
[[Category: About the Wiki]] | [[Category: About the Wiki]] | ||
| + | |||
| + | ===Categories=== | ||
| + | *Each category has an auto-generated description page with a link to all pages with that category. The first line of each category page should be a description. | ||
| + | *All pages within a project are tagged with project name, then page type. For example, a how-to guide within the Photo Gallery project would be tagged as: | ||
| + | <pre> | ||
| + | [[Category: Photo Gallery]][[Category:How-to Guide]] | ||
| + | </pre> | ||
| + | *When applying categories to a page, categorize pages in order of broad to specific. For example, a how-to guide within the Photo Gallery project would be tagged as | ||
| + | <pre> | ||
| + | [[Category: Photo Gallery]][[Category:How-to Guide]] | ||
| + | </pre> | ||
| + | NOT | ||
| + | <pre> | ||
| + | [[Category:How-to Guide]][[Category: Photo Gallery]] | ||
| + | </pre> | ||
| + | *All category names are written in sentence case (first letter capitalized). Spaces are allowed - hyphens and dashes shouldn't be used in place of spaces. | ||
| + | *The home page of a project receives an additional category tag: | ||
| + | <pre> | ||
| + | [[Category: Project]] | ||
| + | </pre> | ||
| + | Additional pages within the project do not receive the Project category. | ||
Latest revision as of 23:25, 20 December 2009
Wiki Standards
In order to maintain consistency throughout the wiki documentation, the following standards are encouraged.
Text Formatting
- Bulleted lists items end with a period.
- Numbers below ten are written out. (For example, one is written "one" not "1."
Categories
- Each category has an auto-generated description page with a link to all pages with that category. The first line of each category page should be a description.
- All pages within a project are tagged with project name, then page type. For example, a how-to guide within the Photo Gallery project would be tagged as:
[[Category: Photo Gallery]][[Category:How-to Guide]]
- When applying categories to a page, categorize pages in order of broad to specific. For example, a how-to guide within the Photo Gallery project would be tagged as
[[Category: Photo Gallery]][[Category:How-to Guide]]
NOT
[[Category:How-to Guide]][[Category: Photo Gallery]]
- All category names are written in sentence case (first letter capitalized). Spaces are allowed - hyphens and dashes shouldn't be used in place of spaces.
- The home page of a project receives an additional category tag:
[[Category: Project]]
Additional pages within the project do not receive the Project category.
