WikiGuide

Revision 14 as of 2005-10-24 08:17:33

Clear message

This page contains some guidelines and help for how to post and work on the documentation in the Ubuntu wiki (UserDocumentation). Our aim is to make consistent, integrated and reliable documentation that users can access simply and quickly.

Style and Guidelines

Our aim is to make documentation which a new computer user can understand and which teaches the user what they are doing. With that in mind, please take into account the following guidelines:

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.

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 [https://wiki.ubuntu.com/DraftWikiGuide?action=raw here].

The basic rules are:

  • 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:

  • Inserting Icons (see IconsPage)

  • Inserting a table of contents (use [[TableOfContents]])

  • If you have a longer Table of Contents, you can use this piece of code to make it into a seperate table on the right-hand side of the page (see UserDocumentation to see this in action):

||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">'''Contents'''[[BR]][[TableOfContents]]||
  • Isn't this possible with some plug-in love and css? -- Johannes2
  • to add


CategoryDocumentation