Difference between revisions of "Tasks and Tools"

Jump to: navigation, search
m (fix typo)
 
(42 intermediate revisions by 6 users not shown)
Line 1: Line 1:
==Before you Start==
+
<languages />
 +
<translate>
  
===First Things First===
+
==Before you Start== <!--T:1-->
  
* You must be a registered user to contribute.  The [[Quick_Start|Quick Start]] page tells you how to register and log in.
+
===First Things First=== <!--T:2-->
* 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===
+
<!--T:3-->
 +
* To contribute to UserBase you must register an account.  See what advantages this brings you on the [[Special:myLanguage/Quick_Start|Quick Start]] page.  There you will also find help to register and log in.
  
 +
<!--T:26-->
 +
* Be aware that your contribution will be governed by the [[KDE_UserBase_Wiki:Copyrights|twin licenses]] for which icon-links are provided in the side-bar of each page.  Click on the images in the Navigation Panel to read the details.  You are agreeing to your contribution being publicly available and that others can use that information on their own sites. 
 +
[[File:Userbase twin licenses.png|center|the twin licenses]]
 +
 +
<!--T:27-->
 +
* Use the Talk page to communicate with other contributors or get help.  Normally someone will get back to you within a day.
 +
 +
===Relevance=== <!--T:4-->
 +
 +
<!--T:5-->
 
It should relate to KDE software, directly or indirectly. We define it like this:
 
It should relate to KDE software, directly or indirectly. We define it like this:
:[[Image:dialog-ok32.png|11px]] For New Users - helping to get started
+
:[[Image:dialog-ok32.png|13px]] For New Users - helping to get started
:[[Image:dialog-ok32.png|11px]] For Regular Users - learning about changes
+
:[[Image:dialog-ok32.png|13px]] For Regular Users - learning about new features and tips
:[[Image:dialog-ok32.png|11px]] For Advanced Users - but use sub-pages for this.
+
:[[Image:dialog-ok32.png|13px]] For Advanced Users - but use sub-pages for this.
:[[Image:edit-delete.png|11px]] For Developers - [http://techbase.kde.org Techbase] is the place for that
+
  
==Ways to Contribute==
+
<!--T:6-->
* [[ImageUpdate|Update an image]], replacing an outdated image with a newer one.
+
:[[Image:edit-delete.png|13px]] Not for Developers - [http://techbase.kde.org Techbase] is the place for that
* [[Taking Screenshots|Create a screenshot]]
+
* [[ModifyPage|Modify existing content]], fix a spelling, clarify a description, add more details.
+
* [[CreatePage|Create a new page]], showcase an application, introduce a new concept.
+
* [[WriteManuals|Write a manual]].  You need to know an application quite well, and probably to be in contact with the author.  We can help you.
+
* [[EditMarkup|Preparing a page for translation]] needs more patience than skill.  If you can spare short periods of time, frequently, this is a very helpful task.
+
* [[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.
+
  
==Hints and Tips==
+
== Ways to Contribute == <!--T:7-->
 +
 
 +
=== Update Existing Content === <!--T:8-->
 +
 
 +
<!--T:9-->
 +
* [[Special:myLanguage/Update an Image|Update an image]], replacing an outdated image with a newer one.
 +
* [[Special:myLanguage/Taking Screenshots|Create a screenshot]]
 +
* [[Special:myLanguage/Modify a Page|Modify existing content]], fix a spelling, clarify a description, add more details.
 +
 
 +
=== Add New Pages === <!--T:10-->
 +
 
 +
<!--T:11-->
 +
* [[Special:myLanguage/Create a Page|Create a new page]], showcase an application, introduce a new concept.
 +
* [[Special:myLanguage/Writing an Application Manual|Write a manual]].  You need to know an application quite well, and probably to be in contact with the author.  We can help you.
 +
 
 +
</translate><span id="Working with Languages"></span><translate>
 +
 
 +
=== Working with Languages === <!--T:12-->
 +
 
 +
<!--T:13-->
 +
* [[Special:myLanguage/Edit Markup|Preparing a page for translation]] needs more patience than skill.  If you can spare short periods of time, frequently, this is a very helpful task.
 +
* [[Special:myLanguage/Translate a Page|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.  That page also points you to instructions for translating sidebar links.
 +
* [[Special:myLanguage/Off-line_Translation|Translate with Off-Line Tools]].  Get the essentials for Gettext and Import.
 +
* [[Special:myLanguage/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.
 +
* [http://kde-apps.org/content/show.php/KDE+WikiSentinel?content=158697 WikiSentinel] is a specialized feed reader that collects the translated pages that need to be updated. It allows you to see a preview of the changes in the selected page and open it directly in the web browser: ready to translate.
 +
 
 +
<!--T:14-->
 +
{{Remember|1=It's important to be consistent, particularly in Manuals, so here are some general rules:<!--}}-->
 +
 
 +
<!--T:20-->
 +
* Take care with heading levels - we start at second level (Mediawiki uses top level for page-name), using <nowiki>==</nowiki>
 +
 
 +
<!--T:21-->
 +
* Make sure you refer frequently to this page and to [[Special:myLanguage/Typographical_Guidelines|Typographical Guidelines]]
 +
 
 +
<!--T:22-->
 +
* Check if all table cells have space after the pipe character. This rule conforms with [http://en.wikipedia.org/wiki/Help:Table traditional wiki formatting].
 +
 
 +
<!--T:23-->
 +
* Make application name formatting consistent (avoid using '''Amarok''''s, do use '''Amarok's''').
 +
 
 +
<!--T:24-->
 +
* Ensure that ''all'' images are in PNG format (you can use JPEG as well, but in this case you should convert your images to PNG later).  Save work by converting them before you start [[Image:Smiley.png|16px]].
 +
 
 +
<!--T:25-->
 +
<!--{{-->* Remove all non-printable characters from image names.}}
 +
 
 +
==Hints and Tips== <!--T:16-->
 +
 
 +
<!--T:28-->
 +
{{Attention|1=If a page is completely superceeded and should be deleted, please list it on [[Pages_for_Deletion|Pages for Deletion]] where an Admin will deal with it.}}
 +
 
 +
<!--T:17-->
 
Some Preferences that will help -
 
Some Preferences that will help -
* If you don't have [edit] links against the sections, open your '''User Preferences''' ([[Special: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
+
<!--T:18-->
 +
* If you don't have [edit] links against the sections, open your <menuchoice> My Preferences</menuchoice> (in the <menuchoice>Personal Tools </menuchoice>section of the sidebar) then look for <menuchoice>Editing</menuchoice> and in the <menuchoice>Advanced Options</menuchoice> set <menuchoice>Enable section editing via [edit] links</menuchoice>
 +
* While you are in those settings, enable <menuchoice>Show preview on first edit</menuchoice> - 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
 
* 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
  
 +
 +
 +
<!--T:19-->
 
[[Category:Contributing]]
 
[[Category:Contributing]]
 +
</translate>

Latest revision as of 19:20, 18 May 2013

Other languages:
català • ‎dansk • ‎Deutsch • ‎Ελληνικά • ‎English • ‎français • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎Lëtzebuergesch • ‎Nederlands • ‎português do Brasil • ‎русский • ‎slovenčina • ‎Türkçe • ‎українська • ‎中文(中国大陆)‎ • ‎中文(台灣)‎

Before you Start

First Things First

  • To contribute to UserBase you must register an account. See what advantages this brings you on the Quick Start page. There you will also find help to register and log in.
  • Be aware that your contribution will be governed by the twin licenses for which icon-links are provided in the side-bar of each page. Click on the images in the Navigation Panel to read the details. You are agreeing to your contribution being publicly available and that others can use that information on their own sites.
the twin licenses
  • Use the Talk page to communicate with other contributors or get help. Normally someone will get back to you within a day.

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 new features and tips
Dialog-ok32.png For Advanced Users - but use sub-pages for this.
Edit-delete.png Not for Developers - Techbase is the place for that

Ways to Contribute

Update Existing Content

Add New Pages

  • Create a new page, showcase an application, introduce a new concept.
  • Write a manual. You need to know an application quite well, and probably to be in contact with the author. We can help you.

Working with Languages

  • Preparing a page for translation needs more patience than skill. If you can spare short periods of time, frequently, this is a very helpful task.
  • 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. That page also points you to instructions for translating sidebar links.
  • Translate with Off-Line Tools. Get the essentials for Gettext and Import.
  • How To Convert UserBase Manual to Docbook gives you an insight into the process that takes place on your finished manual.
  • WikiSentinel is a specialized feed reader that collects the translated pages that need to be updated. It allows you to see a preview of the changes in the selected page and open it directly in the web browser: ready to translate.
Flag-red.png
 
Remember
It's important to be consistent, particularly in Manuals, 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 application name formatting consistent (avoid using Amarok's, do use Amarok's).
  • Ensure that all images are in PNG format (you can use JPEG 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

Warning.png
 
Attention
If a page is completely superceeded and should be deleted, please list it on Pages for Deletion where an Admin will deal with it.


Some Preferences that will help -

  • If you don't have [edit] links against the sections, open your My Preferences (in the Personal Tools section of the sidebar) then look for Editing and in the Advanced Options 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

This page was last modified on 18 May 2013, at 19:20. Content is available under Creative Commons License SA 4.0 unless otherwise noted.