AMule Project FAQ:Help

2004-11-28T16:40:20Z

217.234.37.35:

This page describes how to use the AMule Wiki. For the main AMule page with howtos and FAQs, [[Main_Page|go here]].

[http://wiki.org/wiki.cgi?WhatIsWiki 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 [http://www.w3.org/MarkUp 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 thikn you should. 
Thank you.

== New lines ==

First of all, to create a new line, either user 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 also. 
No examples are displayed since it would take too much space in this page, but feel free to test when editting any [http://wiki.org/wiki.cgi?WhatIsWiki 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:''''' 
''<nowiki>:This is tabbed only once</nowiki> 
<nowiki>::This has been tabbed twice</nowiki> 
<nowiki>:::This has been tabed four times</nowiki> 
<nowiki>:This is tabbed only once, again</nowiki> 

'''''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 in '''bold''' wrapping them with ''<nowiki>'''</nowiki>'' like this:

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

== Italic characters ==

If you wish to emphasize some words in some other way, you can turn them in ''italic'' wrapping them with ''<nowiki>''</nowiki>'' like this:

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

== Bold & Italic characters ==

If you wish to show some words on both '''bold''' and ''italic'', just wrap them with ''<nowiki>'''''</nowiki>'' like this:

'''''Code:''''' ''<nowiki>'''''This is in both bold and italic'''''</nowiki>'' 
'''''Preview:''''' '''''This is in both bold and italic'''''

== Linking ==

You mist see the difference between two very different links:
*[http://wiki.org/wiki.cgi?WhatIsWiki Wiki] links
*External links

=== Linking [http://wiki.org/wiki.cgi?WhatIsWiki Wiki] links ===

[http://wiki.org/wiki.cgi?WhatIsWiki Wiki] links are those which refer to pages in this same [http://wiki.org/wiki.cgi?WhatIsWiki Wiki]. 
For example, the page ''FAQ_aMule'' exists in this [http://wiki.org/wiki.cgi?WhatIsWiki Wiki] and contains the [[FAQ_aMule|aMule FAQ]], so it is a [http://wiki.org/wiki.cgi?WhatIsWiki Wiki] link. 
This links are doen by wrapping them with ''[['' and '']]''. Note that page names are [http://www.webopedia.com/TERM/C/case_sensitive.html case sensitive]. Also, note that pages which's name contain lower-dashes (''_'') can be replaced with blank spaces. 
Some examples follow:

'''''Code:''''' <nowiki>[[FAQ_aMule]]</nowiki> 
'''''Preview:''''' [[FAQ_aMule]]

'''''Code:''''' <nowiki>[[FAQ aMule]]</nowiki> 
'''''Preview:''''' [[FAQ aMule]]

But obviously, you can enter any text to those links, other than the page which they're linking to's name. 
This is done by introducing a pip-character (''|'') before the link's name and after the page's name. 
More examples follow:

'''''Code:''''' <nowiki>[[FAQ_aMule|FAQ about aMule]]</nowiki> 
'''''Preview:''''' [[FAQ_aMule|FAQ about aMule]]

'''''Code:''''' <nowiki>[[FAQ aMule|FAQ about aMule]]</nowiki> 
'''''Preview:''''' [[FAQ aMule|FAQ about aMule]]

You can even link part of a word and have the whole of it linked (only works for post-fixes. No profixes will be linked):

'''''Code:''''' <nowiki>[[FAQ aMule]]rs</nowiki> 
'''''Preview:''''' [[FAQ aMule]]rs

=== Linking external links ===

External links are those which do not refer to any page on this same [http://wiki.org/wiki.cgi?WhatIsWiki Wiki]. 
If you simply wish to show the link, just write the url, like this:

'''''Code:''''' <nowiki>http://www.amule.org</nowiki> 
'''''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 <nowiki>[http://www.amule.org aMule's WebPage]</nowiki>'' 
'''''Preview:''''' ''This links to [http://www.amule.org 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:''''' <nowiki>[http://www.amule.org]</nowiki> 
'''''Preview:''''' [http://www.amule.org]

== Titles ==

Titles are wrapped between ''=='' characters, as follows: 

''<nowiki>== Title ==</nowiki>''

subtitles should add one more ''='' character, as follows: 

''<nowiki>== Title ==</nowiki>'' 
''<nowiki>=== SubTitle ===</nowiki>'' 
''<nowiki>==== SubSubTitle ====</nowiki>''

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 '' '' tags should be used. 
Example follows:

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

'''''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 slash (''#'') characters at the beginning of the line. The amount of slash (''#'') characters written indicate the depth of the level in the numbered list. 
Note that no '' '' tags should be used and that the lines must be one after the other in order to have them correctly numbered. 
Example follows:

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

'''''Preview:'''''
#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

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

The less-than character (<) is hard to be displayed on [http://www.w3.org/MarkUp HTML] pages because it marks the beginning of a tag. 
Whenever you want to type it, and you're not using it in an [http://www.w3.org/MarkUp 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 [http://wiki.org/wiki.cgi?WhatIsWiki 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><nowiki>This will not be shown in '''bold''' or ''italic''</nowiki></nowiki> 
'''''Preview:''''' <nowiki>This will not be shown in '''bold''' or ''italic''</nowiki>

== Inserting images ==

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

'''''Code:''''' <nowiki>http://www.amule.org/images/logo.gif</nowiki> 
'''''Preview:''''' http://www.amule.org/images/logo.gif

== Going forward ==

Of course, since it is all [http://www.w3.org/MarkUp HTML] in the end, you can use any [http://www.w3.org/MarkUp 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: ''This_are_several_words''
*When more than one word is used, use lower letter on first letter unless it's a property name. For example: ''Till_there_was_John''
*If any of the words in the title has an excepting upper letter, put it. For example: ''This_is_aMule''
*If you are [[translating Wiki|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 [[Main Page|Wiki]] ==

Please read [[translating Wiki|this document]].

== More information ==

Other references: 
*See [http://wiki.doomicile.de/Using_Wiki http://wiki.doomicile.de/Using_Wiki]
*As a complete guide, also see http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page

AMule Project FAQ - User contributions [en]

AMule Project FAQ:Help