Difference between revisions of "Help:Contribute"

Jump to: navigation, search
(initial version)
 
(Merge with Help:Editing)
Line 1: Line 1:
You are welcome to contribute to the KDE TechBase wiki. In order to keep a high quality of the articles there are some guidelines you should follow.
+
You are welcome to contribute to the KDE TechBase wiki. In order to keep a high quality of the articles there are some guidelines you should follow. This is a brief overview of the editing and contributing process.  
  
 
== What Content belongs into KDE TechBase ==
 
== What Content belongs into KDE TechBase ==
Line 11: Line 11:
 
More details can be found in the article [[Help:Wiki Structure]]. [http://docs.kde.org End-user documentation] or [http://api.kde.org API documentation] should ''not'' be added here. For non-technical use cases use the [http://wiki.kde.org KDE wiki].
 
More details can be found in the article [[Help:Wiki Structure]]. [http://docs.kde.org End-user documentation] or [http://api.kde.org API documentation] should ''not'' be added here. For non-technical use cases use the [http://wiki.kde.org KDE wiki].
  
== Where to put new Articles ==
+
=== Where to put new Articles ===
  
 
The KDE TechBase wiki uses subpages. Take a quick look at the article about the [[Help:Wiki Structure]]. In short: Do not randomly add toplevel pages.
 
The KDE TechBase wiki uses subpages. Take a quick look at the article about the [[Help:Wiki Structure]]. In short: Do not randomly add toplevel pages.
Line 17: Line 17:
 
It is possible to translate KDE TechBase articles into other languages. Read the article about [[Help:Wiki Translation]] for further details.
 
It is possible to translate KDE TechBase articles into other languages. Read the article about [[Help:Wiki Translation]] for further details.
  
== The Procedure ==
+
=== The Procedure ===
  
 
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 proof-read it. Finally, if a location is found, move the page.
 
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 proof-read it. Finally, if a location is found, move the page.
  
 
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.
 
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.
 +
 +
== Editing Basics ==
 +
 +
In the KDE TechBase wiki all readers are allowed to edit content and structure.
 +
 +
=== 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 [[Help:Talk page|''Discussion'' or ''talk'' pages]] to ask questions or check to see if your idea will be accepted. Please make sure your contributions are not violating licenses.
 +
 +
=== Start Editing ===
 +
 +
To start editing a [[Main Page|KDE TechBase]] 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''.
 +
 +
=== Type your Changes ===
 +
 +
You can just type your text. However, also using basic wiki markup 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.
 +
 +
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].

Revision as of 10:34, 13 August 2007

You are welcome to contribute to the KDE TechBase wiki. In order to keep a high quality of the articles there are some guidelines you should follow. This is a brief overview of the editing and contributing process.

Contents

What Content belongs into KDE TechBase

The KDE TechBase wiki is meant to contain technical information all around KDE, for instance

More details can be found in the article Help:Wiki Structure. End-user documentation or API documentation should not be added here. For non-technical use cases use the KDE wiki.

Where to put new Articles

The KDE TechBase wiki uses subpages. Take a quick look at the article about the Help:Wiki Structure. In short: Do not randomly add toplevel pages.

It is possible to translate KDE TechBase articles into other languages. Read the article about Help:Wiki Translation for further details.

The Procedure

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 proof-read it. Finally, if a location is found, move the page.

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.

Editing Basics

In the KDE TechBase wiki all readers are allowed to edit content and structure.

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 sure your contributions are not violating licenses.

Start Editing

To start editing a KDE TechBase 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 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.

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 Page editing help.


KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal