Difference between revisions of "AMule Project FAQ:Help"

Revision as of 22:32, 28 March 2005

This page describes how to use the AMule Wiki. For the main aMule page with howtos and FAQs, go here.

Wiki is a revolutionary concept in web maintenance. It consists in letting people edit all (or almost all) the pages in the web so that everybody contributes with it.

Instead of using traditional HTML tags, it uses some alternative much easier to use and more intuitive tags and ideas. This help document pretends to take you to know them.

Please read carefully and contribute in anything you might think you should.
Thank you.

First notes

Feel free to edit whatever suits the article's title (read this wiki's policy).

Creating a new article

To create a new article, just get the URL of any existing article, remove the article's name from the URL and put in the title you want to use in your new article. Then just go to that url with your webbrowser and click on Edit this article.

New lines

First of all, to create a new line, either user <br> at the end of the line (so next line will be shown right under the current one), or leave a blank line between the two lines (new paragraf will begin). More than one blank line between two lines will have no different effect than only one blank line. If you want to have more than one blank line displayed, use <br> also.
No examples are displayed since it would take too much space in this page, but feel free to test when editting any Wiki page.

Blank spaces

Blank spaces are also characters that are ignored when more than one on a sequence are found (only one will be displayed).
If you really wish to display more than one blank spaces, write &nbsp; instead of the blank space.
Examples follow:

Code: I am typing arround      some blank spaces
Preview: I am typing arround some blank spaces

Code: I am typing arround &nbsp;&nbsp;&nbsp;&nbsp; some blank spaces
Preview: I am typing arround      some blank spaces

Tab character

Typing : at the beginning of the line will just act as a tab character. The more : characters you type, the deeper tabulation level will be displayed.
Example follows:

Code:
:This is tabbed only once
::This has been tabbed twice
::::This has been tabed four times
:This is tabbed only once, again

Preview:

This is tabbed only once

This has been tabbed twice

This has been tabed four times

This is tabbed only once, again

Bold characters

If you want to emphasize some words, you can turn them bold by wrapping them with three single quotemarks (''') like this:

Code: '''This will be shown in bold'''
Preview: This will be shown in bold

Italic characters

If you wish to emphasize some words in some other way, you can turn them italic by wrapping them with two single quotemarks ('') like this:

Code: ''This will be shown in italic''
Preview: This will be shown in italic

Bold & Italic characters

If you wish to show some words in both bold and italic, just wrap them with five single quotemarks (''''') like this:

Code: '''''This is in both bold and italic'''''
Preview: This is in both bold and italic

Linking

You must see the difference between two very different links:

• Wiki links
• External links

Linking Wiki links

Wiki links are links which refer to pages in this same Wiki.
For example, the page FAQ_aMule exists in this Wiki and contains the aMule FAQ, so it is a Wiki link.
These links are done by wrapping the page name with '' and ''. Note that page names are case sensitive.
Some examples follow:

Code: [[FAQ_aMule]]
Preview: FAQ_aMule

Also, note that underscores (_) in page names can be replaced with blank spaces.

Code: [[FAQ aMule]]
Preview: FAQ aMule

Often, you'll want some text other than the Wiki name to show up in those links.
This is done by introducing a pipe-character after the page's Wiki name followed by any text you like.
Examples:

Code: [[FAQ_aMule|FAQ about aMule]]
Preview: FAQ about aMule

Code: Read [[FAQ_aMule|this]], please
Preview: Read this, please

Any suffix after a Wiki link will be shown as part of the link. However, prefixes will not be active links.
Examples:

Code: [[FAQ aMule]]rs
Preview: FAQ aMulers

Code: Prefixes aren't linked, pre[[FAQ aMule]]post
Preview: Prefixes aren't linked, preFAQ aMulepost

Linking external links

External links are those which do not refer to any page on this same Wiki.
If you simply wish to show the link, just write the url, like this:

Code: http://www.amule.org
Preview: http://www.amule.org

Now, if you want to give the link some name, you must wrap the linking word with [ and ] and insert first the url to link to separated with a blank space. Like this:

Code: This links to [http://www.amule.org aMule's WebPage]
Preview: This links to aMule's WebPage

If you wrap the link with [ and ] and don't give it a description text, the links might be replaced with a sequencial number, like this:

Code: [http://www.amule.org]
Preview: [1]

Titles

Titles are wrapped between == characters, as follows:

== Title ==

subtitles should add one more = character, as follows:

== Title ==
=== SubTitle ===
==== SubSubTitle ====

This == characters must be at the begginning and ending of the line. Otherwise they will be ignored and displayed.

Lists

There are two kinds of list:

• Simple lists
  
• Numbered lists

Simple lists

This are just lists which will show no more than an idention spot.
You can use them by typing an asterisk (*) at the beginning of the line. The amount of asterisks written indicate the depth of the level in the list.
Note that no <br> tags should be used.
Example follows:

Code:
*This is a list
*With it's second element
**And some child elements
**And some more
***Even subchilds
*And back to the first level of the list

Preview:

• This is a list
• With it's second element
  • And some child elements
  • And some more
    • Even subchilds
• And back to the first level of the list

Numbered lists

This are lists which will have each element of it automatically numbered.
You can use them by typing number sign (#) characters at the beginning of the line. The amount of number sign (#) characters written indicates the depth of the level in the numbered list.
Note that no <br> tags should be used and that the lines must be one after the other in order to have them correctly numbered.
Example follows:

Code:
#This is a numbered list
#With it's second element
##And some child elements
##And some more
###Even subchilds
#And back to the first level of the list

Preview:

1. This is a numbered list
2. With it's second element
   1. And some child elements
   2. And some more
      1. Even subchilds
3. And back to the first level of the list

Displaying the less-than (<) and ampersand (&) characters

The less-than character (<) is hard to be displayed on HTML pages because it marks the beginning of a tag.
Whenever you want to type it, and you're not using it in an HTML tag, write &lt; instead of < like this:

Code: 5 &lt; 7 == true
Preview: 5 < 7 == true

The ampersand character (&) might also be problematic to show when it is followed by a number or a sequence of characters ending in a semi-colon (;) character (no blank spaces in between).
If such is yuor case, instead of the ampersand character (&), use &amp; like this:

Code: The ampersand character is this: &amp;
Preview: The ampersand character is this: &

Excluding Wiki tags

If in a given moment you want to use some text which is considered a wiki tag, wrap that text with <nowiki> and </nowiki> like this:

Code: <nowiki>This will not be shown in '''bold''' or ''italic''</nowiki>
Preview: This will not be shown in '''bold''' or ''italic''

Inserting images

To insert images, just write it's url. Example:

Code: http://www.amule.org/images/logo.gif
Preview: http://www.amule.org/images/logo.gif

Going forward

Of course, since it is all HTML in the end, you can use any HTML tag you wish to expand your design abilities.

Page names

The names of the pages must follow this rules:

• Several words never go together. Use _ characters to separate them. For example: These_are_several_words
• When more than one word is used, use a lower letter for first letter unless it's a property name. For example: Till_there_was_John
• If any of the words in the title has an another upper case letter, use it. For example: This_is_aMule
• If you are translating a wiki page, just use the original page's title followed by a dash (-) and the language code of your translation. For example: Translated_to_french-fr

Translating the Wiki

Please read this document.

Testing pages

If you want to test what you've learned, do not use an existing page/article to test. Instead, create a new page which's title begins with test:.

Never leave in a test page any usefull information as a backup or some kind of repository to use later. Test pages can be removed at any moment.

More information

Other references:

• http://meta.wikimedia.org/wiki/MediaWiki_User%27s_Guide#For_editors
• http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page