(added headings and includes) |
(adding a small disclaimer) |
||
Line 5: | Line 5: | ||
==Introduction== | ==Introduction== | ||
This page not intended to be a [[DocsProject/StyleGuide|style guide]], but rather a guide indicating what technical elements are required for a wiki page to be considered complete from a wiki gardening perspective. | This page not intended to be a [[DocsProject/StyleGuide|style guide]], but rather a guide indicating what technical elements are required for a wiki page to be considered complete from a wiki gardening perspective. | ||
This page is not for teaching [http://meta.wikimedia.org/wiki/Help:Editing|how to do wiki formatting], nor the [[Help:Editing|special guidelines for the Fedora wiki]]. | |||
==Page naming== | ==Page naming== |
Revision as of 20:26, 20 August 2008
Introduction
This page not intended to be a style guide, but rather a guide indicating what technical elements are required for a wiki page to be considered complete from a wiki gardening perspective.
This page is not for teaching to do wiki formatting, nor the special guidelines for the Fedora wiki.
Page naming
The current naming convention is to largely abandon
Links
Links to the Fedora Project wiki should always be internal links, and not external links.
Size
Generally you should consider splitting a document into multiple pages if the document size exceeds 32KB. This is by no means a hard limit but rather one element to take into consideration.
Header
If a header exists for a given project that a page belongs to it should be included in the documents.
Headings
You should subdivide your content with headings. Mediawiki automatically will create table of contents. Using headers also permits you to link directly to sections of a page.
Includes
Do not repeat content from another page manually. That creates additional work to edit and change. Using includes permits changes to occur in one place and be updated everywhere it is used.
Categories
Each page should have at least one category, and it will be a rare page that has only one catgory. In our current implementation Categories are the guide spaces for the wiki. You can find a list of all categories here.