|
|
(46 intermediate revisions by 11 users not shown) |
Line 1: |
Line 1: |
− | <center>'''English''' | [[AMule_Project_FAQ:Help-de|Deutsch]]</center>
| + | see : http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page |
− | | + | |
− | 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 think you should.<br>
| + | |
− | Thank you.
| + | |
− | | + | |
− | == First notes ==
| + | |
− | | + | |
− | Feel free to edit whatever suits the article's title (read this wiki's [[aMule_Project_FAQ:Policy|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.<br>
| + | |
− | 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).<br>
| + | |
− | If you really wish to display more than one blank spaces, write ''&nbsp;'' instead of the blank space.<br>
| + | |
− | Examples follow:
| + | |
− | | + | |
− | '''''Code:''''' I am typing around some blank spaces<br>
| + | |
− | '''''Preview:''''' I am typing around some blank spaces
| + | |
− | | + | |
− | '''''Code:''''' I am typing around &nbsp;&nbsp;&nbsp;&nbsp; some blank spaces<br>
| + | |
− | '''''Preview:''''' I am typing around 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.<br>
| + | |
− | Example follows:
| + | |
− | | + | |
− | '''''Code:'''''<br>
| + | |
− | <nowiki>:This is tabbed only once</nowiki><br>
| + | |
− | <nowiki>::This has been tabbed twice</nowiki><br>
| + | |
− | <nowiki>::::This has been tabbed four times</nowiki><br>
| + | |
− | <nowiki>:This is tabbed only once, again</nowiki><br>
| + | |
− | | + | |
− | '''''Preview:'''''<br>
| + | |
− | :This is tabbed only once
| + | |
− | ::This has been tabbed twice
| + | |
− | ::::This has been tabbed 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 (''<nowiki>'''</nowiki>'') like this:
| + | |
− | | + | |
− | '''''Code:''''' <nowiki>'''This will be shown in bold'''</nowiki><br>
| + | |
− | '''''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 (''<nowiki>''</nowiki>'') like this:
| + | |
− | | + | |
− | '''''Code:''''' <nowiki>''This will be shown in italic''</nowiki><br>
| + | |
− | '''''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 (''<nowiki>'''''</nowiki>'') like this:
| + | |
− | | + | |
− | '''''Code:''''' <nowiki>'''''This is in both bold and italic'''''</nowiki><br>
| + | |
− | '''''Preview:''''' '''''This is in both bold and italic'''''
| + | |
− | | + | |
− | == Linking ==
| + | |
− | | + | |
− | You must 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 links which refer to pages in this same [http://wiki.org/wiki.cgi?WhatIsWiki Wiki].<br>
| + | |
− | 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.<br>
| + | |
− | These links are done by wrapping the page name with ''<nowiki>[[</nowiki>'' and ''<nowiki>]]</nowiki>''. Note that page names are [http://www.webopedia.com/TERM/C/case_sensitive.html case sensitive]. <br>
| + | |
− | Some examples follow:
| + | |
− | | + | |
− | '''''Code:''''' <nowiki>[[FAQ_aMule]]</nowiki><br>
| + | |
− | '''''Preview:''''' [[FAQ_aMule]]
| + | |
− | | + | |
− | Also, note that underscores (''_'') in page names can be replaced with blank spaces.<br>
| + | |
− | | + | |
− | '''''Code:''''' <nowiki>[[FAQ aMule]]</nowiki><br>
| + | |
− | '''''Preview:''''' [[FAQ aMule]]
| + | |
− | | + | |
− | Often, you'll want some text other than the Wiki name to show up in those links.<br>
| + | |
− | This is done by introducing a pipe-character after the page's Wiki name followed by any text you like.<br>
| + | |
− | Examples:
| + | |
− | | + | |
− | '''''Code:''''' <nowiki>[[FAQ_aMule|FAQ about aMule]]</nowiki><br>
| + | |
− | '''''Preview:''''' [[FAQ_aMule|FAQ about aMule]]
| + | |
− | | + | |
− | '''''Code:''''' <nowiki>Read [[FAQ_aMule|this]], please</nowiki><br>
| + | |
− | '''''Preview:''''' Read [[FAQ_aMule|this]], please
| + | |
− | | + | |
− | Any suffix after a Wiki link will be shown as part of the link. However, prefixes will not be active links.<br>
| + | |
− | Examples:
| + | |
− | | + | |
− | '''''Code:''''' <nowiki>[[FAQ aMule]]rs</nowiki><br>
| + | |
− | '''''Preview:''''' [[FAQ aMule]]rs
| + | |
− | | + | |
− | '''''Code:''''' <nowiki>Prefixes aren't linked, pre[[FAQ aMule]]post</nowiki><br>
| + | |
− | '''''Preview:''''' Prefixes aren't linked, pre[[FAQ aMule]]post
| + | |
− | | + | |
− | === Linking external links ===
| + | |
− | | + | |
− | External links are those which do not refer to any page on this same [http://wiki.org/wiki.cgi?WhatIsWiki Wiki].<br>
| + | |
− | If you simply wish to show the link, just write the url, like this:
| + | |
− | | + | |
− | '''''Code:''''' <nowiki>http://www.amule.org</nowiki><br>
| + | |
− | '''''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><br>
| + | |
− | '''''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><br>
| + | |
− | '''''Preview:''''' [http://www.amule.org]
| + | |
− | | + | |
− | == Titles ==
| + | |
− | | + | |
− | Titles are wrapped between ''=='' characters, as follows:<br>
| + | |
− | | + | |
− | <nowiki>== Title ==</nowiki>
| + | |
− | | + | |
− | subtitles should add one more ''='' character, as follows:<br>
| + | |
− | | + | |
− | <nowiki>== Title ==</nowiki><br>
| + | |
− | <nowiki>=== SubTitle ===</nowiki><br>
| + | |
− | <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:<br>
| + | |
− | *Simple lists<br>
| + | |
− | *Numbered lists
| + | |
− | | + | |
− | === Simple lists ===
| + | |
− | | + | |
− | This are just lists which will show no more than an idention spot.<br>
| + | |
− | 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.<br>
| + | |
− | Note that no ''<br>'' tags should be used.<br>
| + | |
− | Example follows:
| + | |
− | | + | |
− | '''''Code:'''''<br>
| + | |
− | <nowiki>*This is a list</nowiki><br>
| + | |
− | <nowiki>*With it's second element</nowiki><br>
| + | |
− | <nowiki>**And some child elements</nowiki><br>
| + | |
− | <nowiki>**And some more</nowiki><br>
| + | |
− | <nowiki>***Even subchilds</nowiki><br>
| + | |
− | <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.<br>
| + | |
− | 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.<br>
| + | |
− | 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.<br>
| + | |
− | Example follows:
| + | |
− | | + | |
− | '''''Code:'''''<br>
| + | |
− | <nowiki>#This is a numbered list</nowiki><br>
| + | |
− | <nowiki>#With it's second element</nowiki><br>
| + | |
− | <nowiki>##And some child elements</nowiki><br>
| + | |
− | <nowiki>##And some more</nowiki><br>
| + | |
− | <nowiki>###Even subchilds</nowiki><br>
| + | |
− | <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.<br>
| + | |
− | 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<br>
| + | |
− | '''''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).<br>
| + | |
− | If such is yuor case, instead of the ampersand character (&), use ''&amp;'' like this:
| + | |
− | | + | |
− | '''''Code:''''' The ampersand character is this: &amp;<br>
| + | |
− | '''''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><br>
| + | |
− | '''''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><br>
| + | |
− | '''''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: ''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 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]].
| + | |
− | | + | |
− | == 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:<br>
| + | |
− | *http://meta.wikimedia.org/wiki/MediaWiki_User%27s_Guide#For_editors
| + | |
− | *http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page
| + | |