Difference between revisions of "Tasks and Tools"

Jump to: navigation, search
(Added important tips - may add highlight later)
Line 24: Line 24:
 
* [[TranslatePage|Translate a page]].  You need to be fluent in a language, but not a professional translator to translate a wiki page.  Translating manuals is the skill of a special team.
 
* [[TranslatePage|Translate a page]].  You need to be fluent in a language, but not a professional translator to translate a wiki page.  Translating manuals is the skill of a special team.
 
* [[Off-line_Translation|Translate with Off-Line Tools]].  Get the essentials for Gettext and Import.
 
* [[Off-line_Translation|Translate with Off-Line Tools]].  Get the essentials for Gettext and Import.
 +
* [[How_To_Convert_a_UserBase_Manual_to_Docbook||How To Convert UserBase Manual to Docbook]] gives you an insight into the process that takes place on your finished manual.
  
 
{{Info|1=It's important to be consistent, so here are some general rules:
 
{{Info|1=It's important to be consistent, so here are some general rules:

Revision as of 16:18, 5 March 2011

Before you Start

First Things First

  • You must be a registered user to contribute. The Quick Start page tells you how to register and log in.
  • Be aware that your contribution will be governed by the licenses Gnu Free Document Licence and Creative Commons. Click on the images in the Navigation Panel to read the details.
  • Use the Talk page to communicate with other contributors or get help.

Relevance

It should relate to KDE software, directly or indirectly. We define it like this:

Dialog-ok32.png For New Users - helping to get started
Dialog-ok32.png For Regular Users - learning about changes
Dialog-ok32.png For Advanced Users - but use sub-pages for this.
Edit-delete.png For Developers - Techbase is the place for that

Ways to Contribute

Dialog-information.png
 
Information
It's important to be consistent, so here are some general rules:
  • Take care with heading levels - we start at second level (Mediawiki uses top level for page-name), using ==
  • Make sure you refer frequently to this page and to typographical guidelines
  • * Check if all table cells have space after the pipe character. This rule conforms with traditional wiki formatting.
  • Make application name formatting consistent (avoid using Amaroks, do use Amarok's).
  • Ensure that all images are in PNG format (you can use JPEG (.jpeg, not .jpg) as well, but in this case you should convert your images to PNG later. Save work by converting them before you start 16px.
  • Remove all non-printable characters from image names.


Hints and Tips

Some Preferences that will help -

  • If you don't have [edit] links against the sections, open your User Preferences (Personal Tools in the sidebar) then look for Editing and set Enable section editing via [edit] links
  • While you are in those settings, enable Show preview on first edit - while you are editing you can glance at the original display for reference
  • The default display is to show the preview first, with the edit box below. If you prefer the edit box at the top you can change that setting in the same place

Content is available under Creative Commons License SA 4.0 unless otherwise noted.