Differences between revisions 29 and 30
Revision 29 as of 2006-04-27 06:57:30
Size: 5529
Editor: sou-ts1-2600-201
Comment: Eat your own dogfood. Show the table of contents
Revision 30 as of 2006-04-27 07:05:36
Size: 5635
Editor: S0106000d88b9f3db
Comment: add ToC comment, replace simple ToC markup
Deletions are marked like this. Additions are marked like this.
Line 69: Line 69:
 * To insert a simple table of contents, without the box around it, just use: {{{[[TableOfContents]]}}})

Below are some guidelines and help for how to post and work on the documentation in the Ubuntu Wiki (UserDocumentation). Our aim is to produce consistent, integrated and reliable documentation that users can access simply and quickly.

Style and Guidelines

Our aim is to make documentation which a new user can easily understand and follow. With this in mind, please take into account the following suggested guidelines:

  • Search for existing guides before creating new pages. If an existing document is of poor standard, out of date, or missing something, improve it!!
  • Attempt to abide by the [ Documentation Team Styleguide] before posting, in particular:

    • When referring to Ubuntu releases, use "Ubuntu X.XX (Nickname)" or just "Ubuntu X.XX" - eg. "Ubuntu 5.10 (Breezy Badger)" or "Ubuntu 5.10", rather than just "Breezy" or "Ubuntu Breezy".
    • Capitalize the names of the Universe & Multiverse repositories when you use them. Also, Linux, Ubuntu, Windows, etc should be capitalized.

  • Leave a comment when saving your edits so others can see what you are doing when reviewing RecentChanges.

  • If you create a new page, use a descriptive name - the default search in this wiki is by page title, not full text.
    • If you create a page with "Howto" in the title, please put it at the end of the title, for example PocketPCHowto rather than HowtoPocketPC. Placing "Howto" at the end of the title is the existing style used and it aids in sorting documents on Category pages.
  • Put pages into CategoryCleanup when they have not been reviewed and be encouraged to discuss your contributions on the [ docteam mailing list]. If you let us know about it, it can be reviewed more quickly and taken out of CategoryCleanup.

  • Don't link pages on the pages directly linked-off UserDocumentation (eg. [:Multimedia]) until they have been reviewed and are out of CategoryCleanup

Deleting and Renaming

Deleting and/or renaming pages causes major problems: it breaks links within the wiki itself and also on the internet and people's bookmarks. So the number one rule is don't delete or rename pages unless you really know what you're doing. Having said that, here are a couple of guides to help:

  • A good alternative to renaming is to insert a redirect from the target page to the original page. See HelpOnProcessingInstructions

  • You can search for all of the pages which contain a link to a specific page by clicking on the title of the specific page. If you rename or delete a page, you MUST fix all these links.

  • If you are thinking about renaming a well-known or useful page, please raise it on the DocumentationTeam [ mailing list].

Help on Editing

The wiki can often seem like a scary thing to start editing, but this is in fact NOT the case! It is easy to start editing and contribute. The best way to start is to look at the formatting which is employed on various pages, (for example, you can see the code of this page [ here].)

The basic rules are:

  • To create a page, type the address for the new page into the address bar of your browser and then select "Create new page". Alternatively, make a link for your page in an existing page, save it, click on the new link, and select "Create new page".
  • Paragraphs should be separated by a blank line.
  • To make a list you use a white space at the beginning of a line, followed by either an asterisk (for bullet points), a number, letter etc.
  • To make a heading you use = Title = for a level one heading, == Title == for a level 2 heading, and so on.

  • Placing '' around words or phrases will make them italics, and ''' will make them bold.

  • To quote a block of code, wrap paragraphs in  {{{  }}}.

An Example Page:

= Title of Page =
== Subtitle ==
This page is going to explain how to write a guide on the wiki. The following things are important:
 * Read the docteam Styleguide
 * Make sure you are not reproducing material already on the wiki
 * ask the Documentation Team to check the guide afterwards and place it in CategoryCleanup

The following paragraph is a lettered list:
 a. this is the ''first'' item
 a. this is the ''second'' item
 a. this is the ''third'' item
this is a block of code
} }} (the space should not be in your version)

It is that easy!

For more help about this wiki, see the page HelpContents

Clever Things

As you edit the wiki you will learn how to use the power of the wiki software to do even more clever things! Here are some examples:

  • To see almost all the wiki's formatting in action, have a look at the SyntaxReference page.

  • Inserting Icons - see IconsPage

  • Inserting a table of contents such as what you see at the top of this page:
    • ||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">'''Contents'''[[BR]][[TableOfContents]]||
  • To insert a simple table of contents, without the box around it, just use: [[TableOfContents]])

Please feel free to discuss the contents of this page on the DocumentationTeam [ mailing list].


WikiGuide (last edited 2008-08-06 16:40:22 by localhost)