Diff for "DocumentationTemplate"


Differences between revisions 9 and 49 (spanning 40 versions)
Revision 9 as of 2008-07-21 13:43:32
Size: 544
Editor: cpe
Comment:
Revision 49 as of 2016-01-04 23:26:35
Size: 1134
Editor: knome
Comment: Revert spam
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">'''Contents'''<<BR>><<TableOfContents(2)>>||
Line 3: Line 2:
This page is a default template for documentation on the wiki. To create a new guide on the wiki, read the page WikiGuide.
Line 5: Line 3:
= Introduction = Some sections may just contain a list of links. It is sometimes useful to include a short explanation of what the links are for. For example: 'Ubuntu includes the following Internet applications by default.'
Line 7: Line 5:
Describes what the page does, why it is useful.  * <Link> - Lists of links should have bullets. Link text should not be in bold. Each link should be followed by a short explanation of the link.
 * <Link> - Explanations of links should be written as full sentences.
Line 9: Line 8:
= First Section = = See Also =
Line 11: Line 10:
For example, installation instructions. A see also section can be used to point users towards other trusted Ubuntu resources. For example, if a page exists in the official documentation on http://help.ubuntu.com, you can link to such a page. This section is optional.
Line 13: Line 12:
= Second Section =  * <Link> - Explanation of link.
 * <Link> - Explanation of link.
 * <Link> - Explanation of link.
Line 15: Line 16:
For example, configuration instructions. = External Links =
Line 17: Line 18:
----
CategoryDocumentation
CategoryTemplate
An external links section can be used to point users towards general information about the subject matter of the page, such as a [[http://en.wikipedia.org|wikipedia]] entry or project homepage. This section is optional.

 * <Link> - Explanation of link.
 * <Link> - Explanation of link.
 * <Link> - Explanation of link.

Some sections may just contain a list of links. It is sometimes useful to include a short explanation of what the links are for. For example: 'Ubuntu includes the following Internet applications by default.'

  • <Link> - Lists of links should have bullets. Link text should not be in bold. Each link should be followed by a short explanation of the link.

  • <Link> - Explanations of links should be written as full sentences.

See Also

A see also section can be used to point users towards other trusted Ubuntu resources. For example, if a page exists in the official documentation on http://help.ubuntu.com, you can link to such a page. This section is optional.

  • <Link> - Explanation of link.

  • <Link> - Explanation of link.

  • <Link> - Explanation of link.

External Links

An external links section can be used to point users towards general information about the subject matter of the page, such as a wikipedia entry or project homepage. This section is optional.

  • <Link> - Explanation of link.

  • <Link> - Explanation of link.

  • <Link> - Explanation of link.

DocumentationTemplate (last edited 2016-01-04 23:26:35 by knome)