Help:Editing: Difference between revisions

From KDE TechBase
m (Trying the edit again, hopefully without jacking up the page.)
(let's not copy wikipedia content. referring to it works good enough.)
Line 18: Line 18:


==Most frequent wiki markup explained==
==Most frequent wiki markup explained==
Here are the 6 most frequently used types of wiki markup.
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].


{| border="1" cellpadding="2" style="background:#FFFF99"
!width="500" style="background:#FFFF99"|What it looks like
!width="500" style="background:#FFFF99"|What you type
|-
|
You can ''italicize text'' by putting 2
apostrophes on each side.
3 apostrophes will embolden '''the text'''.
5 apostrophes will embolden and italicize
'''''the text'''''.
(4 apostrophes doesn't do anything special -- there's just ''''one left over''''.)
|<pre>
You can ''italicize text'' by putting 2
apostrophes on each side.
3 apostrophes will embolden '''the text'''.
5 apostrophes will embolden and italicize
'''''the text'''''.
(4 apostrophes doesn't do anything
special -- there's just ''''one left
over''''.)
</pre>
|-
|
You should "sign" your comments on talk pages: <br>
- Three tildes give your user name: [[User:Karl Wick|Karl Wick]] <br>
- Four tildes give your user name plus date/time: [[User:Karl Wick|Karl Wick]] 07:46, 27 November 2005 (UTC) <br>
- Five tildes give the date/time alone: 07:46, 27 November 2005 (UTC) <br>
|<pre>
You should "sign" your comments
on talk pages: <br>
- Three tildes give your user
name: ~~~ <br>
- Four tildes give your user
name plus date/time: ~~~~ <br>
- Five tildes give the
date/time alone: ~~~~~ <br>
</pre>
|-
|
<div style="font-size:150%;border-bottom:1px solid #000000;">Section headings</div>
''Headings'' organize your writing into sections.
The Wiki software can automatically generate
a table of contents from them.
<div style="font-size:132%;font-weight:bold;">Subsection</div>
Using more equals signs creates a subsection.
<div style="font-size:116%;font-weight:bold;">A smaller subsection</div>
Don't skip levels, like from two to four equals signs.
Start with 2 equals signs not 1 because 1 creates H1 tags which should be reserved for page title.
|<pre>
== Section headings ==
''Headings'' organize your writing into sections.
The Wiki software can automatically generate
a table of contents from them.
=== Subsection ===
Using more equals signs creates a subsection.
==== A smaller subsection ====
Don't skip levels,
like from two to four equals signs.
Start with 2 equals signs not 1
because 1 creates H1 tags
which should be reserved for page title.
</pre>
|- id="lists"
|
* ''Unordered lists'' are easy to do:
** Start every line with a star.
*** More stars indicate a deeper level.
*: Previous item continues.
** A newline
* in a list 
marks the end of the list.
*Of course you can start again.
|<pre>
* ''Unordered lists'' are easy to do:
** Start every line with a star.
*** More stars indicate a deeper level.
*: Previous item continues.
** A new line
* in a list 
marks the end of the list.
* Of course you can start again.
</pre>
|-
|
# ''Numbered lists'' are:
## Very organized
## Easy to follow
A new line marks the end of the list.
# New numbering starts with 1.
|<pre>
# ''Numbered lists'' are:
## Very organized
## Easy to follow
A new line marks the end of the list.
# New numbering starts with 1.
</pre>
|-
|
Here's a link to the [[Main Page]].
|<pre>
Here's a link to the [[Main Page]].
</pre>
|-
|
[[The weather in London]] is a page that doesn't exist
yet. You could create it by clicking on the link.
|<pre>
[[The weather in London]] is
a page that doesn't exist
yet. You could create it by
clicking on the link.
</pre>
|-
|
You can link to a page section by its title:
* [[List of cities by country#Morocco]].
If multiple sections have the same title, add
a number. [[#Example section 3]] goes to the
third section named "Example section".
|<pre>
You can link to a page section by its title:
* [[List of cities by country#Morocco]].
If multiple sections have the same title, add
a number. [[#Example section 3]] goes to the
third section named "Example section".
</pre>
|}
==Further reading==
<!--Relevant links are welcome-->
<!--Relevant links are welcome-->
Much of the information in the Wikipedia [http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page Page editing help] is relevant here as well.

Revision as of 18:31, 26 February 2007

On a wiki, it is customary to allow readers to edit content and structure. This is a brief overview of the editing and contributing process. The editing table of contents to the right contains more information on editing functions.

Editing basics

Review policy and conventions

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 Discussion or talk pages to ask questions or check to see if your idea will be accepted. Please make note of the license your contributions will be covered with.

Start editing

To start editing a KDE Developer Wiki 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, not here.

Type your changes

You can just type your text. However, also using basic wiki markup (described in the next section) to make links and do simple formatting adds to 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.

Summarize your changes

Write a short edit summary in the small field below the edit-box.

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.

Most frequent wiki markup explained

The wikipedia provides a quick introduction about the most important mediawiki syntax. Please read the Page editing help.


Retrieved from "https://techbase.kde.org/index.php?title=Help:Editing&oldid=8412"