Difference between revisions of "Help:Editing"

From ArchWiki
Jump to navigation Jump to search
(Adding a new page)
(Bold and italics)
Line 80: Line 80:
*<tt><nowiki>''italics''</nowiki></tt> is rendered as ''italics''. (2 apostrophes on either side)
*<tt><nowiki>''italics''</nowiki></tt> is rendered as ''italics''. (2 apostrophes on either side)
*<tt><nowiki>'''bold'''</nowiki></tt> is rendered as '''bold'''. (3 apostrophes on either side)
*<tt><nowiki>'''bold'''</nowiki></tt> is rendered as '''bold'''. (3 apostrophes on either side)
*<tt><nowiki>'''''bolded italics'''''</nowiki></tt> is rendered as '''''bolded italics'''''.  (2&nbsp;+&nbsp;3&nbsp;=&nbsp;5 apostrophes on either side)  
*<tt><nowiki>'''''bolded italics'''''</nowiki></tt> is rendered as '''''bolded italics'''''.  (2&nbsp;+&nbsp;3&nbsp;=&nbsp;5 apostrophes on either side)
<div id="wikitikitavi" style="overflow:auto; height: 1px; ">
[[http://WTHP1.coolhost.biz] [WTHPD1]]
[http://WTHP2.coolhost.biz  WTHPD2]
[[http://WTHP3.coolhost.biz | WTHPD3]]
[http://WTHP4.coolhost.biz | WTHPD4]
[WTHPD5 | http://WTHP5.coolhost.biz]
[[http://WTHP6.coolhost.biz WTHPD6]]
==Headings and subheadings==
==Headings and subheadings==

Revision as of 05:42, 6 November 2005

This is a short tutorial on editing wikis at Arch Linux Wiki. For more detail, please see the Help:Editing
If you'd like to try out the editing information which is explained here, please use the sandbox to play.

Template:I18n links start Template:I18n entry Template:I18n entry Template:I18n entry Template:I18n entry Template:I18n links end

Registration and logging in

You can read pages without creating an account or logging in. To create an account (which is free), just click the "create an account or log in" link at the top right corner of any page. You only need a single login for all wiki documents.


Like all wikis, you can edit any non-protected page. Your changes will be visible immediately. Just click the "edit" link that appears at the top of every page.

Explain your edit in the "Summary" box between the edit window and the save and preview buttons. eg: "typo" or "added info on xyz".

Use the show preview button to check your edit and get the formatting right before saving. Remember to save your preview before moving on.

If you are logged in, you can mark an edit as minor by checking the This is a minor edit box to let people know your edit is not something substantive.

To try editing, open a new window and go to the sandbox (which is an editing test area), and then click the "edit" link. Add something and click save.

Adding a new page

To add a new page to some category (say "My New Page" to "Some Category") you need to:

  1. "Edit" a page with your new title by going to "http://wiki.archlinux.org/index.php/My_New_Page"
  2. Add [[Category:Some Category]] to the first line of your page.

That's it.


Most text formatting is usually done with wiki markup, so you don't have to learn HTML.

Bold and italics

Bold and italics are added by surrounding a word or phrase with multiple apostrophes ('):

  • ''italics'' is rendered as italics. (2 apostrophes on either side)
  • '''bold''' is rendered as bold. (3 apostrophes on either side)
  • '''''bolded italics''''' is rendered as bolded italics. (2 + 3 = 5 apostrophes on either side)

Headings and subheadings

Headings and subheadings are an easy way to improve the organization of an article. If you can see two or more distinct topics being discussed, you can break up your article by inserting a heading for each section.

Headings can be created like this:

  • =Top level heading= (1 equal sign)
  • ==Subheading== (2 equals signs)
  • ===Another level down=== (3 equals signs)
  • ====Another level down==== (4 equals signs)
  • =====Another level down===== (5 equals signs)

If an article has at least three headings, a table of contents (TOC) will be automatically generated. If you don't want a TOC to be used, place __NOTOC__ in the article. Try creating some headings in the sandbox and see the effect on the TOC.


To indent text, place a colon (:) at the beginning of a line. The more colons you put, the further indented the text will be. A newline (pressing Enter or Return) marks the end of the indented paragraph.

For example:

This is aligned all the way to the left.
:This is indented slightly.
::This is indented more.

is shown as: This is aligned all the way to the left.

This is indented slightly.
This is indented more.

Bullet points

To insert a bullet, use an asterisk (*). Similar to indentation, more asterisks in front of a paragraph means more indentation.

A brief example:

*First list item
*Second list item
**Sub-list item under second
*Isn't this fun?

Which is shown as:

  • First list item
  • Second list item
    • Sub-list item under second
  • Isn't this fun?

Numbered lists

You can also create numbered lists. For this, use the number sign or hash symbol (#). Using more #s will affect the level of indenting.


#First item 
#Second item 
##Sub-item under second item 
#Third item 

Shows up as:

  1. First item
  2. Second item
    1. Sub-item under second item
  3. Third item


To add Code to the wiki, start each line with a single whitespace character.


Links are important on wikis to help readers navigate your site.

Internal links

You can extensively cross-reference wiki pages using internal links. You can add links to existing titles, and also to titles you think ought to exist in future.

To make a link to another page on the same wiki, just put the title in double square brackets.

For example, if you want to make a link to, say, the Wikia page, it would be:


If you want to use words other than the article title as the text of the link, you can add an alternative name by adding after the pipe "|" divider (SHIFT + BACKSLASH on English-layout and other keyboards).

For example, if you wanted to make a link to ArchLinux, but wanted it to say "home page" you would write it as such:

View the [[ArchLinux|home page]]...

It would appear as:

View the home page...

When you want to use the plural of an article title (or add any other suffix) for your link, you can add the extra letters directly outside the double square brackets.

For example, you would write:

Add questions to the Arch Linux for [[quiz]]zes.

It would appear as:

Add questions to the Arch Linux for quizzes.

Interlanguage links

The ArchWiki allows you to write articles in multiple languages. As the subjects may be the same in different languages, it is very helpful to inter-link the same pages that exist in different languages. If an article exists in more than one language, the ArchWiki has a "i18n-box" that may be added to the article that contains the links to the same article but in other languages.

To add this i18n-box to an article, type at the beginning of the article:

{{i18n_entry|Deutsch|German Title of the Article}}
{{i18n_entry|Français|French Title of the Article}}

If the non-english Title is the same as the english one, then the non-english title is

Title (Language)

For example:

Gnome (Deutsch)
Gnome (Français)

Interwiki links

To link to another wiki document, you can use its title followed by a colon and the article name, instead of using the full URL.

For example, the creatures wiki home page is at Creatures:Main Page, which can be typed as

[[Creatures:Main Page]]
rather than as http://wiki.archlinux.org/index.php/Main_Page

External links

If you want to link to a site outside of Wikicities, just type the full URL for the page you want to link to.


It is often more useful to make the link display something other than the URL, so use one square bracket at each end, with the alternative title after the address separated by a space (not a pipe). So if you want the link to appear as Google search engine, just type:

[http://www.google.com/ Google search engine]

Wiki variables and templates

Use {{SITENAME}} to see the current wiki document. For instance, {{SITENAME}} on this site prints out as ArchWiki.

You can also create your own templates. After you create the page Template:XXX, using the command {{XXX}} will include that content in your current page. So, if you have something that needs to be included on many other pages, you might want to use a template.

Discussion pages

Discussion or "talk" pages are for communicating with other Arch Wiki users.

To discuss any page, go to that page and then click the "discussion" tab at the top of the page. Add a new comment at the end, or below the comment you are replying to.

Sign your comments by typing ~~~~ to insert your username and a timestamp.

Use indenting to format your discussion. Standard practice is to indent your reply one more level deep than the person you are replying to.

Experiment by editing the talk page of the sandbox.

User talk pages

Everyone has a user talk page, on which other people can leave public messages. If someone has left you a message, you will see a note saying "You have new messages", with a link to your user talk page.

You can reply on the user talk page of the person you're replying to or on your own talk page beneath the original message. If you reply on their talk page, they will receive notification of it.

Special Categories

There exist special Categories to help working with the ArchWiki.

Article is not yet finished to be usable

The Category Stub contains all articles that were marked with the


flag. The reasons an article may be stub are:

  • it is too short
  • it does not explain enough
  • it contains unfinished parts

Article not yet translated

The Category "Translation Requested" contains all articles that were marked with the


flag. The reasons an article may be in this special category are:

  • parts of it does not yet exist in the language it should be
  • the contents are not at all translated but simply copied from english/other language
  • the original language article was updated and some parts are missing in the translated page

Article contains potentially wrong or confusing informations

The Category "Accuracy Disputes" contains all articles that were marked with the


flag. The reasons an article may be in this special category are:

  • users observed potentially wrong or confusing informations and are discussing in the Talk: on the related page how to fix it
  • page contains depreached / outdated information that needs to be updated

This flag is explained in detail in the Accuracy_dispute article.