Tasks and Tools/en: Difference between revisions

← Older edit

Latest revision as of 05:20, 19 May 2024

Attention

The following applies to all KDE Wikis not just UserBase

Before you Start

First Things First

To contribute to KDE wikis 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 Creative Commons License SA 4.0 for which a link is provided at the bottom of each page. Follow the link to read the details. You are agreeing to your contribution being publicly available and that others can use that information on their own sites.

Use the Talk page to communicate with other contributors or get help. Normally someone will get back to you within a day.

Relevance

All content added to the wikis should relate to KDE software, directly or indirectly. Currently the following wikis are intended for the following content.

UserBase

UserBase is for user content of any kind. E.g.

For New Users - helping to get started
For Regular Users - learning about new features and tips
For Advanced Users - but use sub-pages for this.

Community

Community Wiki is for developers and developer-focused information and tutorials, the exception to this is code documentation which should be part of the relevant repository.

TechBase

Warning

Don't use TechBase

TechBase is currently in the process of being retired with any useful information being moved to Community or other docs (see this issue for further details).

Ways to Contribute

Update Existing Content

Update an image, replacing an outdated image with a newer one.
Create a screenshot
Modify existing content, fix a spelling, clarify a description, add more details.

Add New Pages

Create a new page. Showcase an application, introduce a new concept, tips and tricks, etc.
Write a manual. You need to know an application quite well, and probably to be in contact with the author. We can help you.It's important to be consistent, particularly in Manuals, so here are some general rules:
- Take care with heading levels. Start at second level, using ==. Mediawiki uses top level for page-name.
- 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 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 .
- Remove all non-printable characters from image names.

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.

Hints and Tips

Attention

If a page is completely a duplicate or superseded and should be deleted, please mark it for deletion, see Propose Deletion for the full process.

Some Preferences that will help -

At the top of the page you will find the Preferences menu. In the Editing section you may want to 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

@@ Line 1: / Line 1: @@
 <languages />
+{{Attention|The following applies to all KDE Wikis not just UserBase}}
 ==Before you Start==
@@ Line 5: / Line 8: @@
 ===First Things First===
-* 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.
+* To contribute to KDE wikis 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.
-* 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.
+* Be aware that your contribution will be governed by the [https://creativecommons.org/licenses/by-sa/4.0/ Creative Commons License SA 4.0] for which a link is provided at the bottom of each page.  Follow the link 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]]
 * Use the Talk page to communicate with other contributors or get help.  Normally someone will get back to you within a day.
@@ Line 14: / Line 16: @@
 ===Relevance===
-It should relate to KDE software, directly or indirectly. We define it like this:
+All content added to the wikis should relate to KDE software, directly or indirectly. Currently the following wikis are intended for the following content.
-:[[Image:dialog-ok32.png|13px]] For New Users - helping to get started
-:[[Image:dialog-ok32.png|13px]] For Regular Users - learning about new features and tips
+====UserBase====
-:[[Image:dialog-ok32.png|13px]] For Advanced Users - but use sub-pages for this.
+UserBase is for user content of any kind. E.g.
+* For New Users - helping to get started
+* For Regular Users - learning about new features and tips
+* For Advanced Users - but use sub-pages for this.
-:[[Image:edit-delete.png|13px]] Not for Developers - [http://techbase.kde.org Techbase] is the place for that
+====Community====
+[https://community.kde.org Community Wiki] is for developers and developer-focused information and tutorials, the exception to this is code documentation which should be part of the relevant repository.
+====TechBase====
+{{Warning|Don't use TechBase}}
+TechBase is currently in the process of being retired with any useful information being moved to Community or other docs (see [https://invent.kde.org/teams/web/wiki-sites/-/issues/1 this issue] for further details).
 == Ways to Contribute ==
@@ Line 31: / Line 44: @@
 === Add New Pages ===
-* [[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, tips and tricks, etc.
-* [[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.It's important to be consistent, particularly in Manuals, so here are some general rules:
+** Take care with heading levels. Start at second level, using <nowiki>==</nowiki>. Mediawiki uses top level for page-name.
+** Make sure you refer frequently to this page and to [[Special:myLanguage/Typographical_Guidelines|Typographical Guidelines]]
+** 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].
+** 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 [[Image:Smiley.png|16px]].
+** Remove all non-printable characters from image names.
 <span id="Working with Languages"></span>
 === Working with Languages ===
@@ Line 42: / Line 61: @@
 * [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.
-{{Remember|1=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 <nowiki>==</nowiki>
-* Make sure you refer frequently to this page and to [[Special:myLanguage/Typographical_Guidelines|Typographical Guidelines]]
-* 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].
-* 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 [[Image:Smiley.png|16px]].
-<!--{{-->* Remove all non-printable characters from image names.}}
 ==Hints and Tips==
-{{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.}}
+{{Attention|1=If a page is completely a duplicate or superseded and should be deleted, please mark it for deletion, see [[Propose Deletion]] for the full process.}}
 Some Preferences that will help -
-* 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>
+* At the top of the page you will find the <menuchoice>Preferences</menuchoice> menu. In the <menuchoice>Editing</menuchoice> section you may want to 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