Help:Editing

From Gnash Project Wiki

Jump to: navigation, search

This page offers an introduction to the basics of wiki editing.

The Gnash Dev Wiki uses the same MediaWiki software that is used by Wikipedia and thousands of other websites, so if you have ever edited a page on Wikipedia, you probably are already familiar with the Media Wiki markup language. The information below should cover the basic syntax, but if you need more in-depth documentation on wiki markup, please refer to the MediaWiki editing help.

Contents

Styles

Bold Text is shown by surrounding your statement with six apostrophies, as: '''This is a bold statement.''' This will appear as: This is a bold statement. Quotation marks ( " ) will not achieve the same effect and you will end up with your bold text looking like "this" upon submission of your page edit.


Italic Text is shown by surrounding your statement with four apostrophies instead of six: This is an italic statement.


Larger and smaller text is achieved by surrounding your statement with = signs. One = sign on either side (=Text=) will produce Heading 1. Two = signs will produce Heading 2, and so forth:

Heading 3

Heading 4

Headings 1 and 2 will automatically place a horizontal line beneath them, and all headings will automatically catagorize themselves as headings in the Contents listing at the top of the page.


Text will appear in Monospace font by adding a space before the sentence:

Monospace Text.


To indent text, place a : before the sentence.


Lists

There are several types of lists one may do in a Wiki. Bullet lists are the most common and are achieved by asterisks (*). Adding more asterisks will indent the item listed:

* This makes a single bullet for me to blab in.
** I am trying to make a point here:
*** I am very smart.
will appear as:
  • This makes a single bullet for me to blab in.
    • I am trying to make a point here:
      • I am very smart.


Numbered lists are also useful. Placing a number sign (#) before the item will indicate a numbered list. As with bullet lists, the more number signs there are, the more indented the item will be:

  1. I am smart. How smart? I'll put it this way:
    1. Ever heard of Einstein, Socrates, Plato?
      1. Morons.
  2. Yes, I am an intelligent human being.
  3. Did I say that I was smart?


Images and Links

Images are simple to insert into your Wiki pages. Simply put in the URL of the image and it will appear: http://www.gnu.org/software/gnash/images/GnashGnu.jpg will appear as: http://www.gnu.org/software/gnash/images/GnashGnu.jpg


If you do not want the image to appear directly on the page, but rather make a link to it, first place a single bracket, then the URL of your image. Put a space after the URL and then type your title. For exmaple: [http://www.gnu.org/software/gnash/images/GnashGnu.jpg Gnash Gnu] will appear as: Gnash Gnu

Which brings us to Links. There are two kinds of links: Internal and External. Internal links means that the page you are linking to already exists withing the Wiki database; such as, Overview. Link to an internal source like so: [[Overview]]

To make a link to an external source, place the URL of the page you are linking to between two brackets. As with images, if you want to add a tittle, put a space after the URL and add your desired statement. Like so: [http://www.gnu.org/software/gnash/ Gnash!] It shall appear thus: Gnash!



Tables

Tables are not used all that often in Wikis; however, they are very useful. They are also a little confusing. To make a table, you start out with a curvy bracket facing East: {. Now put a | right in front of that bracket. You should now have {| . Exciting, isn't it?

Now define your values. After your {| , add some specifics such as the following: border=1 cellpadding=5 cellspacing=0. Tables need this sort of information to tell them who they are (otherwise they start having identity issues). Add a paragraph and a | for each new row, and a two || 's for each new cell:

    {| border=1 cellpadding=5 cellspacing=0
    |hello || phwee || kawaii!
    |- 
    |twoo || three || four 
    |- 
    |five || six || seven 
    |}
will produce:
hello phwee kawaii!
twoo three four
five six seven

Linking to Bugs, Tasks, and Patches

Linking to Bugs, Tasks, and Patches is simple when you use templates. For example:

To create a link to Task #1234, type:

{{Task|1234}}

To create a link to Bug #1234, type:

{{Bug|1234}}

To create a link to Patch #1234, type:

{{Patch|1234}}

Nowiki

If you need text to appear without wiki formatting, use the <nowiki> (text) </nowiki> tags. This is what we use to make these examples appear unformatted.