Export translations

Settings

Group

Language

Format

Export for off-line translation

Export in native format

<languages />
{{Info|1=This page offers examples of formatting code for common tasks}}

==Add an Introductory Screenshot and Description==

Whenever possible we begin an application's top-level page with this.  The code to achieve it is

{{Input|1=<nowiki>{|class="tablecenter vertical-centered"
|[[Image:YourScreenshot.png|250px|thumb]]
|Your descriptive text
|}</nowiki>}}

==Format Your Text==

===Use Headings===

Each heading goes on its own line starting and ending with two or more '=' characters. Once there are more than a handful of headings on a page they automatically create a Table of Contents, so use them. The number of '=' characters determines their level in the Table of Contents, thus your headings should be '==Main section name==', '===Subsection name===', '====Sub-subheading name here====', and so on. Avoid using single '=', as that denotes a page heading and every wiki page already has one made from its name; for example, this page's title "{{PAGENAME}}" appears as its page heading.

===Use '''bold''' and ''italic''===

Blips are used to specify bold and italic words.

Use <nowiki>'''bold text'''</nowiki> to specify '''bold text''' and
<nowiki>''italic text''</nowiki> to specify ''italic text''.

In order to ensure we get easy and accurate translations, please adhere to the ''[[Special:myLanguage/Typographical_Guidelines|typographical guidelines]].''

===Add a Code Snippet===

We have templates to assist in correctly displaying code snippets.  Examples of use in various situations are available on [[Special:myLanguage/Typographical_Guidelines|the typographical guideline page]]

If you have problems displaying pipe characters in your code snippet, please see the explanation and markup detailed on [[Special:myLanguage/Typographical_Guidelines|Typographical Guidelines]]

===Add Indents===

:"''':'''" is used for an indent, and was used in multiples in some old pages.  This is deprecated, and causes some problems, so the multiples will be removed as they are found.  A single "''':'''" indents by four characters.

=== Format Dates ===

Dates in a purely numerical format cause confusion, due to differences in expectations of geographical zones. Please format dates as {{Input|1=<nowiki>18 Mar 2011</nowiki>}} with the month either spelled out completely or in abbreviated form, and the year in 4-digit format. The day may be single or double-digit.
=== Bulleted Lists ===

<nowiki>*</nowiki> is the symbol to use for bulletted lists. ** gives a second level:

{{Input|1=<nowiki>
* Almonds

* Nuts
** Cashews

* Raisins
</nowiki>}}
produces

* Almonds

* Nuts
** Cashews

* Raisins

=== Enumerations ===

Enumerations are produced in the same way, using '#'.

{{Input|1=<nowiki>
# Sift
# Mix
## Stir thoroughly
# Bake
</nowiki>}}

produces

# Sift
# Mix
## Stir thoroughly
# Bake

For more details see [http://meta.wikimedia.org/wiki/Help:List wikimedia] on lists.

=== Combining Bulleted Lists and Enumerations ===

You can have an enumerated sublist in a bulleted list and vice versa, like this:

{{Input|1=<nowiki>
* Nuts
*# Cashew
*# Crazy
* Other things
</nowiki>}}

produces

* Nuts
*# Cashew
*# Crazy
* Other things

while

{{Input|1=<nowiki>
# Nuts
#* Cashew
#* Crazy
# Other things
</nowiki>}}

produces

# Nuts
#* Cashew
#* Crazy
# Other things

{{Note|1=Enumerations should never have blank lines in them: it breaks the sequence and numbering starts at one again. Similarly, there should never be blank lines before a sublist item whether enumerated or bulleted: it creates two levels of item markings (bullets or numbers)}}

{{Note|1=Please remember, that long lists are a problem for translators. With single level bulleted lists, place each bullet in a section of its own, i.e. make a blank line between bullets. With two levels of bullets the subitems must be kept in the same section as their top level bullet; if you have to use subbullets, please keep the sublists short! With enumerations involved, you must keep everything in one unit. Please try to avoid enumerations, and if you find that you must use them try to keep them short.}}

{{Remember|2=Workaround|1=Though it is important to avoid blank lines in enumerations and nested lists it is still possible to split such lists in several translations units. This is highly recommended!}}

To get each bullet and each sub bullet in its own translation unit you can enter something like this:

{{Input|1=<nowiki>* First bullet &lt;/translate &gt;
&lt;translate &gt;
** First sub bullet &lt;/translate &gt;
&lt;translate &gt;
** Another sub bullet This one consists of two paragraphs &lt;/translate &gt;
&lt;translate &gt;
* The next main bullet &lt;/translate &gt;
&lt;translate &gt;
** And so on</nowiki>}}

This displays like this:

* First bullet
** First sub bullet
** Another sub bullet This one consists of two paragraphs
* The next main bullet
** And so on

The same method should apply to the other kinds of lists.

If on the other hand you need to have more sections in the same item, you can do something like this to have each section in a translation unit of its own:

{{Input|1=<nowiki>* First bullet &lt;/translate &gt;
&lt;translate &gt;
* Second bullet, first section. &lt;/translate&gt; &lt;translate &gt; Second section of the
second bullet. This section has a translation unit of its own &lt;/translate &gt;
&lt;translate &gt;
* And so on</nowiki>}}

This displays like this:

* First bullet
* Second bullet, first section. Second section of the second bullet. This section has a translation unit of its own
* And so on

=== Itemizations ===

Itemizations are produced using ''';''' and ''':''' alternatively.  They are best for giving short descriptions for a group of related objects.

{{Input|1=<nowiki>
;Animals
: They move around and devour other creatures.

;Plants
: They have roots and feed upon ground water and sun.
</nowiki>}}
produces

;Animals
: They move around and devour other creatures.

;Plants
: They have roots and feed upon ground water and sun.

{{Note|1=As always, please keep each item in a section of its own; it helps translators a lot.}}

===Add a Link===

There are three kinds of links to learn, internal ones, to another userbase page, internal links to a section of a userbase page, and external URL links.

For an internal link the format <nowiki>[[PageLayout]]</nowiki>, where you want to display the name of the page, does work, but it is not ideal, particularly for translation to docbook and for localisation. It is better to use the form <nowiki>[[Special:myLanguage/PageLayout|Page Layout]]</nowiki>, because that allows translators to link correctly even though the page name is localised. The result is that it directs to the correctly translated page, if one exists. You often need to include the link in a sentence, so in that case you would use

{{Input|1=<nowiki>[[Special:myLanguage/PageLayout|this page]]</nowiki>}} which displays 
[[Special:myLanguage/PageLayout|this page]]

Internal links to subsections of a page use character '#' (hash) and should look like this {{Input|1=<nowiki>[[Special:myLanguage/Tasks_and_Tools#Working_with_Languages|...]]</nowiki>}}With this kind of link it is very important, that the page you link to declares the reference anchor. If the anchor contains space characters, replace them by character '_' (underscore) when calling the reference. If the reference is found, the section will be automatically displayed by your browser (if it manages anchors). If it is not the case, you will have to go down through the page to find the referenced section.

=== Anchor declaration ===

Anchor declaration must be done immediatly BEFORE the referenced section, and followed by a blank line separating the anchor and its headline. In the following example just copy in the ID value, the title of associated section. It should look like this: 
{{Input|1=<nowiki>&lt;/translate&gt; &lt;translate&gt;</nowiki>}}

If the page containing the section that you link to is not yet marked up for translation, you should omit the <nowiki>&lt;/translate &gt; and &lt;translate &gt;</nowiki> tags.

External links are slightly different so

{{Input|1=<nowiki>[http://techbase.kde.org/Schedules our road map]</nowiki>}} displays 
[http://techbase.kde.org/Schedules our road map], which would take you straight to the techbase page.

One last thing to note - when you preview your page, all links are live.  This gives you two benefits. You can check (by hovering) that your links are set up as you expected, and you can use a red link to create a new page.

=== Make an application list ===

If you want to make a list of applications like the ones in the subpages of [[Special:myLanguage/Applications|Applications]], you should use the <code>AppItem</code> template. Simply enter

{{Input|1=<nowiki>{|
{{AppItem|System Settings/Locale|Preferences-desktop-locale.png|
Settings for localized handling of numbers, dates, etc}}A short text.
A few more short lines about the app. This is optional.
|-
{{AppItem|System Settings/Shortcuts and Gestures|Preferences-desktop-keyboard.png|
Shortcuts and Gestures}}Another short text. If you do not type <keycap>Enter</keycap> between the texts
you get one section no matter how long the text is.
|}</nowiki>}}

This gives the following display:

{|
{{AppItem|System Settings/Locale|Preferences-desktop-locale.png|
Settings for localized handling of numbers, dates, etc}}A short text.
A few more short lines about the app. This is optional.
|-
{{AppItem|System Settings/Shortcuts and Gestures|Preferences-desktop-keyboard.png|
Shortcuts and Gestures}}Another short text. If you do not type <keycap>Enter</keycap> between the texts you get one section no matter how long the text is.
|}

Note, that you should not prepend "Special:myLanguage" to the page name - the template takes care of that. Also note, that you must give a title, even if the title is the same as the page name.

=== Footnotes ===

Footnotes are rarely used in our pages, but if you need them you can place a <code><nowiki><ref></nowiki>''text''<nowiki></ref></nowiki></code> in the source where the footnote mark should appear. There has to be one <code><nowiki><references /></nowiki></code> somewhere in the source as well, usually towards the end of the page. This is where the text added by the <nowiki><ref></nowiki> tags will appear. For more info see the [http://en.wikipedia.org/wiki/Help:Footnotes Wikipedia help page].

==Illustrate Your Text==

===Add a single image, centered===

{{Input|1=<nowiki>[[File:KMail-kde4.png|250px|center]]</nowiki>}}

Note that you can change the position of the image, but the default is left.  The size of the image depends on the circumstances, but for screenshots I recommend no less than 250px and no more than 500px.

Also note that <code>Image:</code> and <code>File:</code> are synonyms. 
So that <code><nowiki>[[Image:KMail-kde4.png]]</nowiki></code> is the same as <code><nowiki>[[File:KMail-kde4.png]]</nowiki></code>. However <code>Image:</code> is deprecated, so prefer <code>File:</code> in new content.

see [http://www.mediawiki.org/wiki/Help:Images mediawiki] for more info.

===Make the Image Clickable and Add a Caption===

Where you need to show more detail, create a moderately sized image, clickable, so that the full-size can be seen.  Simply add the parameter '|thumb' within the image parentheses.

A caption can also be added as a parameter, but will only show if '|thumb' is present.

Example:

{{Input|1=<nowiki>[[File:file_name.png|thumb|this will be the caption]]</nowiki>}}

=== Add a caption without a thumbnail ===

Captions also appear on images marked up with the frame syntax.

Example:

{{Input|1=<nowiki>[[File:image.png|frame|left|this will be the caption]]
</nowiki>}}

===Prevent text from flowing around image===

Sometimes you might not want the text to flow down the sides of your image. You can prevent this by adding a <code><nowiki> </nowiki></code> tag between the file tag and the text in question.

Example:
{{Input|1=<nowiki>[[File:image.png]]
 
This text would normally flow down the sides of the image but now it will be found under the image
</nowiki>}}

===Use Tables to Precisely Place Multiple Images===

{{Input|1=<nowiki>{|class="tablecenter" style="border: 1px solid grey;"
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
|-
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]
|}</nowiki>}}

displays

{|class="tablecenter" style="border: 1px solid grey;"
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
|-
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]
|}

Note that all the parameters for one image are contained within <nowiki>[[...]]</nowiki>, and cells are separated by '||'. To start a new line, insert '|-' on an otherwise-empty line, then '|' at the start of the next one.

For more details on Table formating see [http://www.mediawiki.org/wiki/Help:Tables mediawiki]
 
=== Embed a Video ===

As of July 2012 the MediaWiki [http://www.mediawiki.org/wiki/Extension:EmbedVideo EmbedVideo] extension has been installed on userbase.kde. This means you can embed videos from various video hosting sites into the page content and have them display in line.

EmbedVideo parser function expects to be called in any of the following ways:

<nowiki> {{#ev:service|id}} </nowiki> 
<nowiki> {{#ev:service|id|width}}</nowiki> 
<nowiki> {{#ev:service|id|width|align}}</nowiki> 
<nowiki> {{#ev:service|id|width|align|desc}}</nowiki> 
<nowiki> {{#evp:service|id|desc}}</nowiki> 
<nowiki> {{#evp:service|id|desc|align}}</nowiki> 
<nowiki> {{#evp:service|id|desc|align|width}}</nowiki>

Where: 
 service is the name of a video sharing service (See "service name" in the list below)
 id is the id of the video to include
 width (optional) is the width in pixels of the viewing area (height will be determined automatically)
 align (optional) is an alignment (float) attribute. May be "left" or "right".
 desc (optional) is a short description to display beneath the video when it is aligned

For example, to include the famous "evolution of dance" YouTube video, you'd enter:
<pre>{{#ev:youtube|dMH0bHeiRNg}}</pre>

And if you wanted scaled down to thumbnail size, on the right with a short description, you could use:
<pre>{{#ev:youtube|dMH0bHeiRNg|100|right|This is an embedded video!}}</pre>

As of version 1.0, EmbedVideo supports embedding video content from the following services:
{| class="wikitable"
|-
! Site 
! Service Name
|-
! [http://www.dailymotion.com/ Dailymotion] 
| <tt>dailymotion</tt>
|-
! Div Share
| <tt>divshare</tt>
|-
! [http://edutopia.org Edutopia] 
| <tt>edutopia</tt>
|-
! [http://www.funnyordie.com/ FunnyOrDie] 
| <tt>funnyordie</tt>
|-
! [http://video.google.com/ Google Video] 
| <tt>googlevideo</tt>
|-
! [http://interia.pl/ Interia] 
| <tt>interia</tt> or <tt>interiavideo</tt>
|-
! [http://revver.com/ Revver] 
| <tt>revver</tt>
|-
! [http://sevenload.com/ sevenload] 
| <tt>sevenload</tt>
|-
! [http://teachertube.org TeacherTube] 
| <tt>teachertube</tt>
|-
! [http://www.youtube.com/ YouTube] 
| <tt>youtube</tt> and <tt>youtubehd</tt>
|-
! [http://www.vimeo.com Vimeo]
| <tt>vimeo</tt>
|}
 
==Add Notes and Warnings==

{{Warning|2=Important|1=Indented boxes do not display correctly! Never put a colon in front of a box; it will make the box look very odd.}}

Where a note or warning is relevant within your text, use these templates:

<nowiki>{{Info|This is general information}}</nowiki> displays
{{Info|This is general information}}

<nowiki>{{Note|Some important information at this point}}</nowiki> displays
{{Note|Some important information at this point}}

<nowiki>{{Tip|A helpful piece of advice, something to remember}}</nowiki>displays
{{Tip|A helpful piece of advice, something to remember}}

<nowiki>{{Warning|Take care - this is a dangerous thing to do}}</nowiki> displays
{{Warning|Take care - this is a dangerous thing to do}}

Where the strongest possible warning is needed, the Remember box can be used, but please use sparingly.
<nowiki>{{Remember|1=This is for things that definitely must not be forgotten}}</nowiki>
{{Remember|1=This is for things that definitely must not be forgotten}}

You can also change the heading:

{{Remember|2=Don't Forget This!|1=You can use parameter number 2 to set an individual box heading:
{{Input|1=<nowiki>{{Remember|2=Don't Forget This!|1=You can use...}}</nowiki>}}}}

==Page Redirection==
You can make a page to redirect to another page automatically by using:
<pre>#REDIRECT [[Pagename]]</pre>

==KDE3 and KDE SC 4 Versions of Applications==

By default, KDE SC 4 is assumed.  If the KDE SC 4 version is not yet ready for release, or where only a KDE 3 version exists, it may be necessary to document the KDE3 version.  In this case you should add the template {{tl|KDE3}} 
which displays {{KDE3}}
Should you be writing about a KDE3 version and KDE SC 4 version on the same page, use icons for both — {{tl|KDE4}} which displays {{KDE4}}

==Other Useful Templates== 

=== Inserting GUI Icons ===

The best way to refer to icons in the GUI is to display it in the text. This can be done with a template like this: <code><nowiki>{{Icon|list-add}}</nowiki></code>. This will display the {{Icon|list-add}} icon.

For this to work, the icon image must have been uploaded to the wiki. See [[Special:myLanguage/Update_an_Image|Update an Image]] for an explanation on how to upload images. The .png files can usually be found here: <tt>usr/share/icons/oxygen</tt>. If possible use the 16x16 icon. The file name should have an <tt>Icon-</tt> prefix as in <tt>Icon-list-add.png</tt> &mdash; apart from the prefix the filename should exactly match the usual name. Note, that when using the template you should neither write the <tt>Icon-</tt> prefix nor the <tt>.png</tt> file type extension.

The {{Plus}} icon can also be written as <code><nowiki>{{Plus}}</nowiki></code>, and the {{Minus}} icon as <code><nowiki>{{Minus}}</nowiki></code>. You can also use <code><nowiki>{{Configure}}</nowiki></code> to get the {{Configure}} icon, and <code><nowiki>{{Exit}}</nowiki></code> gets you the {{Exit}} icon.

===Community Applications===

The final consideration concerns those applications which are not distributed as core KDE applications. These need to be indicated by an icon, placing <nowiki>{{Community-app}}</nowiki>

at the end of your sentence or line, just as you would to denote a footnote in general writing. You then need to add <nowiki>{{Community-app-footnote}}</nowiki> which will create a footnote, like this:

===Making Major Edits to Existing Pages===

If a page is likely to be open for editing for some time there is a danger of conflicts - someone else may edit at the same time, and saving your edit will cancel out theirs, or vice versa. The way to avoid that is to make a temporary entry, directly under the language bar, using <nowiki>{{Being_Edited}}</nowiki> which will display

''Don't forget to remove it when you have finished!''

===Adding a New Complex Page===

If you need to be able to work on a page for quite some time, over several days, for instance, you may like to use the Construction template - <nowiki>{{Construction}}</nowiki>, which displays

===Links to Pages in the Neighbourhood===

You can add links to a preceding or a following page using the following templates as described here:
{{Input|1=<nowiki>{{Prevnext2|prevpage=Previous Pagename|nextpage=Following Pagename|prevtext=The page before this page|nexttext=This page you should read later|index=Index page|indextext=Back to Menu}}</nowiki>}}
{{Prevnext2|prevpage=Previous Pagename|nextpage=Following Pagename|prevtext=The page before this page|nexttext=This page you should read later|index=Index page|indextext=Back to Menu}}

All six arguments are optional. For first pages with no preceeding page or last pages with no following page use this:
{{Input|1=<nowiki>{{Prevnext2|nextpage=Following Pagename|nexttext=This page you should read later}}</nowiki>}}
{{Prevnext2|nextpage=Following Pagename|nexttext=This page you should read later}}
{{Input|1=<nowiki>{{Prevnext2|prevpage=Previous Pagename|prevtext=The page before this page}}</nowiki>}}
{{Prevnext2|prevpage=Previous Pagename|prevtext=The page before this page}}
If you don't specify an <code>indexname</code> the name of the current page will be displayed.

{{Note|1=You should always specify a text for the pages you link to, and you should always use <code>Special:myLanguage</code> with your links; otherwise you create problems for the translators.}}

=== Links to bugs ===

You can link directly to a bug in Bugzilla by using this template:

Please do not forget to add the <code><nowiki><s> and </s></nowiki></code> to strike through a bug that is closed.

==Adding a List of Sub-Pages==

{{Input|1=<nowiki>== Subpages of {{FULLPAGENAME}} ==
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>}}

is very useful when you want to list subpages with active links, such as

=== Subpages of {{FULLPAGENAME}}===

It does, however, also list all "other-language" pages, so use with discretion.

{{Special:PrefixIndex/{{FULLPAGENAME}}/}}

----

[[Category:Contributing]]