Revision as of 18:29, 18 August 2008

This is a wiki. This means, depending on your priviledges, you can edit articles. You can use a special syntax to format text, include links and so on.

Format text

Headings

To make headings:

This markup	produces
= Header =	Header
== Sub-Header ==	Sub-Header
=== Sub-sub-Header ===	Sub-sub-Header

Font Face

To make bold or italic font:

This markup	produces
This is ''italic'' and this is '''bold'''.	This is italic and this is bold.

Code

To make clear text is meant as code or computer in/output just prepend a space at the beginning of the line:

<- here is a space at the beginning of the line.

Links

To link to another article in this wiki:

This markup	produces
Have a look at our [[application]] section.	Have a look at our applications section.

To link to another namespace, e.g. a category:

This markup	produces
Have a look at our [[:Category:Guides]] section.	Have a look at our Category:Guides section.

Bullets and Numbering

For bullets you use asterisks:

This markup	produces
* this is an item ** this is a sub-item * this is again a top-level item	this is an item this is a sub-item this is again a top-level item

For numbers you use hashes:

This markup	produces
# this is an item ## this is a sub-item ## this is the second sub-item # this is again a top-level item	this is an item this is a sub-item this is the second sub-item this is again a top-level item

Line feeds

You can enter a line feed into your article by adding two line feeds to your markup text.

Tables

Make a sortable table. This input:

{| class="wikitable sortable" border=1
! col1 !! col2 !! col3
|-
| field1 || field2 || field3
|-
| ZZZ    || AAA    || MMM
|-
|}

Produces:

col1	col2	col3
field1	field2	field3
ZZZ	AAA	MMM

@@ Line 1: / Line 1: @@
-You are welcome to contribute to the KDE UserBase wiki. To maintain high quality content and articles there are a few guidelines you should follow. This is a brief introduction to editing and contributing.
+This is a wiki. This means, depending on your priviledges, you can edit articles. You can use a special syntax to format text, include links and so on.
-== What Content belongs in KDE UserBase ==
+= Format text =
-The KDE UserBase wiki is meant to contain information relevant for KDE users. More details can be found in the article [[Help:Wiki Structure]].
+== Headings ==
+To make headings:
+{| border=1
+! This markup !! produces
+|-
+| <nowiki>= Header =</nowiki> ||
+= Header =
+|-
+| <nowiki>== Sub-Header ==</nowiki> ||
+== Sub-Header ==
+|-
+| <nowiki>=== Sub-sub-Header ===</nowiki> ||
+== Sub-sub-Header ==
+|-
+|}
-[http://docs.kde.org End-user documentation] or [http://api.kde.org API documentation] should ''not'' be added here. For technical issues, use [http://techbase.kde.org KDE TechBase].
+== Font Face ==
+To make bold or italic font:
+{| border=1
+! This markup !! produces
+|-
+| <nowiki>This is ''italic'' and this is '''bold'''.</nowiki> || This is ''italic'' and this is '''bold'''.
+|-
+|}
-=== Where to put new Articles ===
+== Code ==
+To make clear text is meant as code or computer in/output just prepend a space at the beginning of the line:
+ <- here is a space at the beginning of the line.
-The KDE UserBase wiki uses subpages. Take a quick look at the article about the [[Help:Wiki Structure]]. In short: Do not randomly add toplevel pages.
+= Links =
-<!--
+To link to another article in this wiki:
-It is possible to translate KDE UserBase articles into other languages. Read the article about [[Help:Wiki Translation]] for further details. -->
+{| border=1
+! This markup !! produces
+|-
+| <nowiki>Have a look at our [[application]] section.</nowiki> || Have a look at our [[applications]] section.
+|-
+|}
+To link to another namespace, e.g. a category:
+{| border=1
+! This markup !! produces
+|-
+| <nowiki>Have a look at our [[:Category:Guides]] section.</nowiki> || Have a look at our [[:Category:Guides]] section.
+|-
+|}
-=== The Procedure ===
+= Bullets and Numbering =
+For bullets you use asterisks:
+{| border=1
+! This markup !! produces
+|-
+| * this is an item <br /> ** this is a sub-item <br /> * this is again a top-level item ||
+* this is an item
+** this is a sub-item
+* this is again a top-level item
+|-
+|}
+For numbers you use hashes:
+{| border=1
+! This markup !! produces
+|-
+| # this is an item <br /> ## this is a sub-item <br /> ## this is the second sub-item <br /> # this is again a top-level item ||
+# this is an item
+## this is a sub-item
+## this is the second sub-item
+# this is again a top-level item
+|-
+|}
-You want to add new content. To keep high quality, please create the article in your userpage first (e.g. User:foo/My Acticle). Once it is ready, discuss the article with other developers and proofread it. Finally, if a location is found, move the page.
+= Line feeds =
-After moving the page please '''add yourself to the watch list''' by clicking the ''Watch'' register. You will get a notice by mail whenever the page changes.
+You can enter a line feed into your article by adding two line feeds to your markup text.
-== Editing Basics ==
+= Tables =
+Make a sortable table. This input:
-In the KDE UserBase wiki all readers are allowed to edit content and structure.
+<pre>
+{| class="wikitable sortable" border=1
-=== Review Policy and Conventions ===
+! col1 !! col2 !! col3
+|-
-Make sure that you submit information which is relevant to the specific purpose of the wiki, or your content might be deleted. You can always use the [[Help:Talk page|''Discussion'' or ''talk'' pages]] to ask questions or to check if your idea will be accepted. Please make sure your contributions are not violating any licenses.
+| field1 || field2 || field3
+|-
-=== Start Editing ===
+| ZZZ    || AAA    || MMM
+|-
-To start editing a [[Main Page|KDE UserBase]] page, click the '''Edit''' link at the tab on the top. This brings you to the edit page: a page with a text box containing the ''wikitext'' - the editable code from which the server produces the finished page. ''If you just want to experiment, please do so in the [[Sandbox|sandbox]], not here''.
+|}
+</pre>
-=== Type your Changes ===
+Produces:
+{| class="wikitable sortable" border=1
-You can just type your text. However, also using basic wiki markup to make links and do simple formatting increases the value of your contribution. Please follow the style used in other wiki articles. If you follow this, your contributions will be more valuable as they won't need to be cleaned up later.
+! col1 !! col2 !! col3
+|-
-=== Summarize your Changes ===
+| field1 || field2 || field3
+|-
-Write a short edit summary in the small field below the edit-box.
+| ZZZ    || AAA    || MMM
+|-
-Example: "Fixed a typo"
+|}
-=== Preview before Saving ===
-When you have finished, click '''Show preview''' to see how your changes will look '''before''' you make them permanent.  Repeat the edit/preview process until you are satisfied, then click '''Save page''' and your changes will be immediately applied to the article.
-== Wiki Markup Reference ==
-The wikipedia provides a quick introduction about the most important mediawiki syntax. Please read the [http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page Page editing help].