User:Hans/Contribute

From KDE UserBase Wiki
Revision as of 13:40, 5 July 2010 by Hans (talk | contribs) (Copy content from Help:Contents)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Template:I18n/Language Navigation Bar You are welcome to contribute to the KDE Community's 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.

How to contribute

Tip If you already have an OpenID account it may well work with UserBase. You should try that first.
  • Surf to a page that you want to improve, e.g. KTimetracker
  • Click on Edit
  • Do your changes, here is some help with formatting and with page layout
  • Preview your page - links are already live, so you can check them at the same time (by hovering)
  • Click on Save page

What Content belongs in the KDE Community UserBase

KDE UserBase is the home for users and enthusiasts of KDE software. It provides high quality information for end users on how to use KDE applications.

UserBase is the central point of contact for end users looking for help using KDE applications or for any other user-oriented information about KDE-related issues. It provides task-oriented help how to achieve user's goals, application-oriented info to learn more about the applications a user uses or tips and tricks to make user's life easier and more pleasant. Information on userbase should be polished and stable. It should not require deep technical knowledge or being familiar with the community. Contributions by users are very welcome.

For technical documentation use KDE TechBase. For community info use the KDE Community Wiki. See the Wiki Landing Page for an overview.

Where to put new Articles

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

For instance, you read the page http://userbase.kde.org/KWord, and realise that a page about using Shapes would be very useful. You should then create your new page as http://userbase.kde.org/KWord/Using_Shapes.

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 Article). 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 UserBase wiki only registered users are allowed to edit content and structure. You can create your account here. If any problem or question arises, we are able to leave you messages on your User:Talk page and you will receive a notification. You can respond at the same place, or on the Talk page of the user that contacted you. All logged in users are allowed to upload files.

Review Policy and Conventions

Make sure that you submit information which is relevant to the specific purpose of the wiki, or your content might get deleted. You can always use the 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.

Start Editing

To start editing a 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 your own user page, as listed under Personal tools, not here. You can copy and paste code from any page there for experimentation, and it's also a good place to keep your notes or develop any new pages.

Type your Changes

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. You can find guidance in PageLayout. Additionally, we'll appreciate if you abide by the Typographical Guidelines in your articles. If you follow these, your contributions will be more valuable as they won't need to be cleaned up later. You can find lots of examples of code markup in the Toolbox.

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.

You can see a list of all the pages in this 'Getting Started' category by clicking on the link below.

Working with TranslateWiki

If you want to get started in translating documents, you will find information on the Translation Workflow page. You may also find this blog helpful.