Jump to content

User:Hans/Contribute

From KDE UserBase Wiki
Revision as of 22:00, 6 July 2010 by Hans (talk | contribs)

Template:I18n/Language Navigation Bar

This page describes how to contribute content to UserBase. For an introduction to translating pages, see Translate.

Overview

UserBase is a free wiki for KDE Software, which means that anyone can add and improve the content here. [...]

There are many ways to contribute to UserBase. [...]

  • Editing content
  • Adding new content
  • Managing content
  • Translating content
  • Writing manuals

Getting started

Tip

If you already have an OpenID account, it should work well with UserBase. Login with OpenID

  • Go to a page that you want to improve. For starters you can experiment freely in the Sandbox to familiarize yourself with the wiki
  • Click on Edit to edit the page
  • Make your changes in the text box, see [[]] below for more information
  • Use Show preview to preview your changes
  • If everything looks good, enter a short summary of the changes in the Summary box and click on Save page

Guidelines

What belongs in 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.

Editing

Start editing

Only registered users are allowed to edit the content in the KDE UserBase wiki. You can log in or create your account on Special:UserLogin. If you have an OpenID account you can try to log in with it on Special:OpenIDLogin.

When you are logged in, you will see an Edit tab at the top of all pages. Clicking on it takes you to the Editing page, where you can edit the content of your current page.

Make changes

The Edit text box contains the editable source text of a page, which lets you add new text and modify the content as needed. A quick reference to the basic wiki markup can be found on Cheatsheet. For a more comprehensive help on formatting, see Toolbox.

To maintain high quality content, try to be concise, objective and keep the language professional. Please follow the style used in other wiki articles on UserBase for consistency. You can find guidelines for the layout in PageLayout. Additionally, following the Typographical Guidelines will make it easier to export the content for translation.

Preview changes

When you have finished, click Show preview to see how your changes will look before you save them permanently. Repeat the edit/preview process until you are satisfied.

Save changes

Before you save the page, write a short summary of the changes in the Summary box below the Edit box.

Example: Fixed a typo

If the changes are superficial, such as typo or formatting corrections, mark the edit as minor by checking This is a minor edit.

Finally, press Save page to save the modified page. Your changes will immediately be reflected on the page.

Talk pages

Creating new pages

Before creating a new page, you should have a user account on UserBase and be familiar with writing and editing articles. Please also consider the following:

  • Is the page relevant to the purpose of UserBase? Irrelevant pages will be deleted
  • Will the content be useful for other people? If it's only of interest to you, it belongs to your user page
  • Does a similar page already exist? Do a quick search first to make sure a similar topic does not already exist.

The procedure

There are two ways to create a new page. The first is recommended for new contributors and/or if you want to work on it before making it "live". The second option is faster and mainly for more experienced contributors.

Creating a page in your user space

Creating a new page directly

Naming conventions and where to put new pages

Writing manuals

See also