Difference between revisions of "Tasks and Tools"

Jump to: navigation, search
(Marked this version for translation)
Line 2: Line 2:
 
<translate>
 
<translate>
  
==Before you Start==
+
==Before you Start== <!--T:1-->
  
===First Things First===
+
===First Things First=== <!--T:2-->
  
 +
<!--T:3-->
 
* Anyone can contribute to UserBase, but it is recommended that you create an account. The [[Special:myLanguage/Quick_Start|Quick Start]] page tells you how to register and log in.
 
* Anyone can contribute to UserBase, but it is recommended that you create an account. The [[Special:myLanguage/Quick_Start|Quick Start]] page tells you how to register and log in.
 
* Be aware that your contribution will be governed by the licenses [[KDE_UserBase:Copyrights|Gnu Free Document Licence and Creative Commons]].  Click on the images in the Navigation Panel to read the details.
 
* Be aware that your contribution will be governed by the licenses [[KDE_UserBase:Copyrights|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.
 
* Use the Talk page to communicate with other contributors or get help.
  
===Relevance===
+
===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|13px]] For New Users - helping to get started
 
:[[Image:dialog-ok32.png|13px]] For New Users - helping to get started
Line 17: Line 19:
 
:[[Image:dialog-ok32.png|13px]] For Advanced Users - but use sub-pages for this.
 
:[[Image:dialog-ok32.png|13px]] For Advanced Users - but use sub-pages for this.
  
 +
<!--T:6-->
 
:[[Image:edit-delete.png|13px]] Not for Developers - [http://techbase.kde.org Techbase] is the place for that
 
:[[Image:edit-delete.png|13px]] Not for Developers - [http://techbase.kde.org Techbase] is the place for that
  
== Ways to Contribute ==
+
== Ways to Contribute == <!--T:7-->
  
=== Update Existing Content ===
+
=== 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/Update an Image|Update an image]], replacing an outdated image with a newer one.
 
* [[Special:myLanguage/Taking Screenshots|Create a screenshot]]
 
* [[Special:myLanguage/Taking Screenshots|Create a screenshot]]
 
* [[Special:myLanguage/Modify a Page|Modify existing content]], fix a spelling, clarify a description, add more details.
 
* [[Special:myLanguage/Modify a Page|Modify existing content]], fix a spelling, clarify a description, add more details.
  
=== Add New Pages ===
+
=== 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/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.
 
* [[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.
  
=== Working with Languages ===
+
=== 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/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.
 
* [[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.
Line 39: Line 45:
 
* [[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.
 
* [[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.
  
 +
<!--T:14-->
 
{{Remember|1=It's important to be consistent, so here are some general rules:
 
{{Remember|1=It's important to be consistent, so here are some general rules:
  
 +
<!--T:15-->
 
* Take care with heading levels - we start at second level (Mediawiki uses top level for page-name), using <nowiki>"=="</nowiki>
 
* Take care with heading levels - we start at second level (Mediawiki uses top level for page-name), using <nowiki>"=="</nowiki>
 
* Make sure you refer frequently to this page and to [[Typographical_Guidelines|typographical guidelines]]
 
* Make sure you refer frequently to this page and to [[Typographical_Guidelines|typographical guidelines]]
Line 48: Line 56:
 
* Remove all non-printable characters from image names.}}
 
* Remove all non-printable characters from image names.}}
  
==Hints and Tips==
+
==Hints and Tips== <!--T:16-->
  
 +
<!--T:17-->
 
Some Preferences that will help -
 
Some Preferences that will help -
  
 +
<!--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>
 
* 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
 
* 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>
 
</translate>

Revision as of 09:00, 4 June 2011

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

  • Anyone can contribute to UserBase, but it is recommended that you create an account. 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 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

Flag-red.png
 
Remember
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).
  • For screenshots and other images, .png format is preferred. The Upload page lists the file types that are acceptable. 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 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

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