Toolbox: Difference between revisions

From KDE Wiki Sandbox
(→‎Making major edits to Existing Pages: Added remove template instruction)
m (Fix minor typo)
 
(162 intermediate revisions by 19 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|Toolbox}}
<languages />
<translate>
<!--T:1-->
{{Info|1=This page offers examples of formatting code for common tasks}}


'''This page offers examples of formatting code for common tasks'''
==Add an Introductory Screenshot and Description== <!--T:2-->


==Deciding where to create your page==
<!--T:3-->
Many people choose to draft a page on their own Talk page, then move the result to the desired site.  Sometimes there is a good reason for preferring to do it in the final location.  If that is the case, consider using before your content <nowiki>{{Construction}}</nowiki> which will display
Whenever possible we begin an application's top-level page with this.  The code to achieve it is


{{Construction}}
<!--T:4-->
{{Input|1=<nowiki>{|class="tablecenter vertical-centered"
|[[Image:YourScreenshot.png|250px|thumb]]
|Your descriptive text
|}</nowiki>}}
 
==Format Your Text== <!--T:5-->
 
===Use Headings=== <!--T:6-->
 
<!--T:7-->
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''=== <!--T:8-->
 
<!--T:9-->
Blips are used to specify bold and italic words.
 
<!--T:10-->
Use <nowiki>'''bold text'''</nowiki> to specify '''bold text''' and
<nowiki>''italic text''</nowiki> to specify ''italic text''.
 
<!--T:11-->
In order to ensure we get easy and accurate translations, please adhere to the ''[[Special:myLanguage/Typographical_Guidelines|typographical guidelines]].''
 
===Add a Code Snippet=== <!--T:12-->
 
<!--T:13-->
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]]
 
<!--T:14-->
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=== <!--T:15-->
 
<!--T:16-->
:"''':'''" 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 === <!--T:17-->
 
<!--T:18-->
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.
</translate><span id="Bulleted Lists"></span><translate>
 
=== Bulleted Lists === <!--T:19-->
 
<!--T:20-->
<nowiki>*</nowiki> is the symbol to use for bulletted lists.  ** gives a second level:<br />
 
<!--T:21-->
<!--}}-->{{Input|1=<nowiki>
* Almonds
 
<!--T:22-->
* Nuts
** Cashews
 
<!--T:23-->
* Raisins
</nowiki>}}<!--{{-->
produces
 
<!--T:24-->
* Almonds
 
<!--T:25-->
* Nuts
** Cashews
 
<!--T:26-->
* Raisins
 
=== Enumerations === <!--T:27-->
 
<!--T:28-->
Enumerations are produced in the same way, using '#'.
 
<!--T:29-->
{{Input|1=<nowiki>
# Sift
# Mix
## Stir thoroughly
# Bake
</nowiki>}}
 
<!--T:30-->
produces
 
<!--T:31-->
# Sift
# Mix
## Stir thoroughly
# Bake
 
<!--T:141-->
For more details see [http://meta.wikimedia.org/wiki/Help:List wikimedia] on lists.
 
=== Combining Bulleted Lists and Enumerations === <!--T:32-->
 
<!--T:33-->
You can have an enumerated sublist in a bulleted list and vice versa, like this:
 
<!--T:34-->
{{Input|1=<nowiki>
* Nuts
*# Cashew
*# Crazy
* Other things
</nowiki>}}
 
<!--T:35-->
produces
 
<!--T:36-->
* Nuts
*# Cashew
*# Crazy
* Other things
 
<!--T:37-->
while
 
<!--T:38-->
{{Input|1=<nowiki>
# Nuts
#* Cashew
#* Crazy
# Other things
</nowiki>}}
 
<!--T:39-->
produces


==Add an i18n language bar==
<!--T:40-->
# Nuts
#* Cashew
#* Crazy
# Other things


{|style="width:75%; border:2px dotted #BCBCBC;" align="center"
<!--T:41-->
|<nowiki>{{Template:I18n/Language Navigation Bar|Toolbox}}</nowiki>
{{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)}}
|}


Simply replace the existing pagename (Toolbar, in this instance) with the name of the page you are creating.
<!--T:42-->
{{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.}}


==Format your text==
<!--T:116-->
===Use Headings===
{{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!}}
:Headings automatically form part of your Table of Contents, so need to be structured.  Their place in the tree is governed by multiple '=' characters at each end of the heading.  Avoid using a single one - that denotes a page heading, and the automatic page heading should be used.  Your major headings will use '==text goes here==', the next level, '===more text===' and so on.


===Use '''bold''' and ''italic''===
<!--T:117-->
:Blips are used to specify bold and italic words.
To get each bullet and each sub bullet in its own translation unit you can enter something like this:


:Use <nowiki>'''bold text'''</nowiki> to specify '''bold text''' and
<!--T:118-->
:<nowiki>''italic text''</nowiki> to specify ''italic text''.
{{Input|1=<nowiki>* First bullet &lt;/translate &gt;
&lt;translate &gt;
** First sub bullet &lt;/translate &gt;
&lt;translate &gt;
** Another sub bullet<br /><br />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>}}


===Add a code snippet===
<!--T:119-->
This displays like this:


:Simply adding a space at the beginning of the line displays your text in a fixed font, so 'this snippet of code' becomes
<!--T:120-->
* First bullet</translate>
<translate>
<!--T:121-->
** First sub bullet</translate>
<translate>
<!--T:122-->
** Another sub bullet<br /><br />This one consists of two paragraphs</translate>
<translate>
<!--T:123-->
* The next main bullet</translate>
<translate>
<!--T:124-->
** And so on


this snippet of code
<!--T:125-->
The same method should apply to the other kinds of lists.


:If it needs to stand out more, you can enclose it in a box:
<!--T:126-->
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:


:{|style="width:50%; border:2px dotted #BCBCBC;" align="center"
<!--T:127-->
| this snippet of code
{{Input|1=<nowiki>* First bullet &lt;/translate &gt;
|}
&lt;translate &gt;
* Second bullet, first section. &lt;/translate&gt;<br /><br /> &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>}}


:However, you lose the clarity that the change of font gives.  This method may be more useful for extended snippets, of several lines, rather than short ones.  The decision should be based on what is aesthetically pleasing in the context of the rest of your page layout.
<!--T:128-->
This displays like this:


===Add indents===
<!--T:129-->
* First bullet</translate>
<translate>
<!--T:130-->
* Second bullet, first section.</translate><br /><br /><translate><!--T:131-->
Second section of the second bullet. This section has a translation unit of its own</translate>
<translate>
<!--T:132-->
* And so on


:':' is used for an indent, and can be used in multiples.  A single ':' indents by two characters.
=== Itemizations === <!--T:43-->


===Lists, numbered and bulleted===
<!--T:44-->
:<nowiki>*</nowiki> is the symbol to use for bulletted lists.  ** gives a second level:
Itemizations are produced using ''';''' and ''':''' alternatively. They are best for giving short descriptions for a group of related objects.
<nowiki>
::* One star
  ::* Next point
::** Sub-point
::* Third point</nowiki>


:produces
<!--T:45-->
<!--}}-->{{Input|1=<nowiki>
;Animals
: They move around and devour other creatures.


::* One star
<!--T:46-->
::* Next point
;Plants
::** Sub-point
: They have roots and feed upon ground water and sun.
::* Third point
</nowiki>}}<!--{{-->
produces


:Numbered lists are produced in the same way, using '#'.
<!--T:47-->
;Animals
: They move around and devour other creatures.


<!--T:48-->
;Plants
: They have roots and feed upon ground water and sun.


<nowiki>
<!--T:49-->
::# A single hash
{{Note|1=As always, please keep each item in a section of its own; it helps translators a lot.}}
::# Second point
::## A sub-point
::# Third point</nowiki>


:produces
===Add a Link=== <!--T:50-->


::# A single hash
<!--T:51-->
::# Second point
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.
::## A sub-point
::# Third point


:This is less useful than the bulletted list.
<!--T:52-->
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


===Add a link===
<!--T:53-->
{{Input|1=<nowiki>[[Special:myLanguage/PageLayout|this page]]</nowiki>}} which displays
[[Special:myLanguage/PageLayout|this page]]


There are two kinds of links to learn, internal ones, to another userbase page, and external URL links.
<!--T:108-->
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.


For an internal link you can sometimes simply use <nowiki>[[PageLayout]]</nowiki>, where you want to display the name of the page. However, you often need to include the link in a sentence, so you would use
<!--T:165-->
External links are given as the URL and a text separated by a space and delimited by single square brackets as in {{Input|1=<nowiki>[https://en.wikipedia.org/wiki/KDE KDE's Wikipedia page]</nowiki>}} which gives [https://en.wikipedia.org/wiki/KDE KDE's Wikipedia page].


:{|style="width:50%; border:2px dotted #BCBCBC;" align="center"
=== Anchor declaration === <!--T:163-->
|<nowiki>[[PageLayout|this page]]</nowiki>
|}


which displays
<!--T:164-->
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;<span id="Working with Languages"></span> &lt;translate&gt;</nowiki>}}


[[PageLayout|this page]]
<!--T:109-->
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.


<!--T:54-->
External links are slightly different so
External links are slightly different so


:{|style="width:80%; border:2px dotted #BCBCBC;" align="center"
<!--T:55-->
|<nowiki>[http://techbase.kde.org/Schedules our road map]</nowiki>
{{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.
 
<!--T:56-->
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 === <!--T:110-->
 
<!--T:111-->
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
 
<!--T:112-->
{{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>}}
 
<!--T:113-->
This gives the following display:
 
<!--T:114-->
{|
{{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.
|}
|}


displays
<!--T:115-->
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 === <!--T:145-->
 
<!--T:146-->
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== <!--T:57-->
 
===Add a single image, centered=== <!--T:58-->
 
<!--T:59-->
{{Input|1=<nowiki>[[File:KMail-kde4.png|250px|center]]</nowiki>}}
 
<!--T:60-->
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.
 
<!--T:158-->
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.
 
<!--T:142-->
see [http://www.mediawiki.org/wiki/Help:Images mediawiki] for more info.
 
===Make the Image Clickable and Add a Caption=== <!--T:61-->
 
<!--T:62-->
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.
 
<!--T:63-->
A caption can also be added as a parameter, but will only show if '|thumb' is present.
 
<!--T:152-->
Example:
 
<!--T:153-->
{{Input|1=<nowiki>[[File:file_name.png|thumb|this will be the caption]]</nowiki>}}


[http://techbase.kde.org/Schedules our road map] which would take you straight to the techbase page.
=== Add a caption without a thumbnail === <!--T:154-->


One last thing to note - when you preview your page, the 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.
<!--T:155-->
Captions also appear on images marked up with the frame syntax.


==Illustrate your text==
<!--T:156-->
===Add a single image, centered===
Example:


:{|style="width:50%; border:2px dotted #BCBCBC;" align="center"
<!--T:160-->
|<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>
{{Input|1=<nowiki>[[File:image.png|frame|left|this will be the caption]]
|}
</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. 
===Prevent text from flowing around image=== <!--T:157-->


===Make the image clickable, and add a caption===
<!--T:161-->
Sometimes you might not want the text to flow down the sides of your image. You can prevent this by adding a <code><nowiki> <br clear=all> </nowiki></code> tag between the file tag and the text in question.


: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.
<!--T:159-->
Example:
{{Input|1=<nowiki>[[File:image.png]]
<br clear=all>
This text would normally flow down the sides of the image but now it will be found under the image
</nowiki>}}


:A caption can also be added as a parameter, but will only show if '|thumb' is present.
===Use Tables to Precisely Place Multiple Images=== <!--T:64-->


===Use tables to precisely place multiple images===
<!--T:65-->
<div style="white-space:pre;">
{{Input|1=<nowiki>{|class="tablecenter" style="border: 1px solid grey;"
:{|style="width:80%; border:2px dotted #BCBCBC;" align="center"
|<nowiki>{|style="width:500px" cellpadding="2"
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
|[[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]]
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]
|}</nowiki>
|}</nowiki>}}
|}
</div>


:displays
<!--T:66-->
displays


:{|style="width:500px" cellpadding="2"
<!--T:67-->
{|class="tablecenter" style="border: 1px solid grey;"
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
|-
|-
Line 139: Line 393:




:Note that all the parameters for one image are contained within <nowiki>[[...]]</nowiki>, and cells are separated by '||'.  To start a new line, insert '|-'
<!--T:68-->
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.
 
<!--T:151-->
For more details on Table formating see [http://www.mediawiki.org/wiki/Help:Tables mediawiki]
 
</translate><span id="Embed a Video"></span> <translate>


==Add Notes and Warnings==
=== Embed a Video === <!--T:133-->


Where a note or warning is relevant within your text, use a table, like these:
<!--T:134-->
{|style="width:80%; border:2px dotted #BCBCBC;" align="center"
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.
|<nowiki>
 
::{|cellpadding="2"
<!--T:135-->
|[[Image:Im-status-message-edit.png]]||'''Note'''||Some important information
EmbedVideo parser function expects to be called in any of the following ways:
|}
 
</nowiki>
<!--T:136-->
<nowiki> {{#ev:service|id}} </nowiki> <br />
<nowiki> {{#ev:service|id|width}}</nowiki><br />
<nowiki> {{#ev:service|id|width|align}}</nowiki><br />
<nowiki> {{#ev:service|id|width|align|desc}}</nowiki><br />
<nowiki> {{#evp:service|id|desc}}</nowiki><br />
<nowiki> {{#evp:service|id|desc|align}}</nowiki><br />
<nowiki> {{#evp:service|id|desc|align|width}}</nowiki><br />
 
<!--T:137-->
Where: <br />
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
 
<!--T:138-->
For example, to include the famous "evolution of dance" YouTube video, you'd enter:
<pre>{{#ev:youtube|dMH0bHeiRNg}}</pre>
 
<!--T:139-->
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>
 
 
<!--T:140-->
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>
|}
|}


::{|cellpadding="2"
</translate><span id="Add Notes and Warnings"></span> <translate>
|[[Image:Im-status-message-edit.png]]||'''Note'''||Some important information
 
|}
==Add Notes and Warnings== <!--T:69-->
 
<!--T:144-->
{{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.}}
 
<!--T:70-->
Where a note or warning is relevant within your text, use these templates:
 
<!--T:71-->
<nowiki>{{Info|This is general information}}</nowiki> displays
{{Info|This is general information}}


{|style="width:80%; border:2px dotted #BCBCBC;" align="center"
<!--T:72-->
|<nowiki>
<nowiki>{{Note|Some important information at this point}}</nowiki> displays
::{|
{{Note|Some important information at this point}}
|[[Image:help-hint.png]]||'''Tip'''||Something useful to remember
|}
</nowiki>
|}


<!--T:73-->
<nowiki>{{Tip|A helpful piece of advice, something to remember}}</nowiki>displays
{{Tip|A helpful piece of advice, something to remember}}


::{|
<!--T:74-->
|[[Image:help-hint.png]]||'''Tip'''||Something useful 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}}


<!--T:75-->
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}}


{|style="width:80%; border:2px dotted #BCBCBC;" align="center"
<!--T:76-->
|<nowiki>::{|
You can also change the heading:
|[[Image:dialog-warning.png|32px]]||'''Warning'''||This is dangerous
|}
</nowiki>
|}


::{|
<!--T:77-->
|[[Image:dialog-warning.png|32px]]||'''Warning'''||This is dangerous
{{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>}}}}


Where a note or warning is important enough to need to stand out strongly there are two useful templates, Info and Warning.  Use
==Page Redirection== <!--T:162-->
You can make a page to redirect to another page automatically by using:
<pre>#REDIRECT [[Pagename]]</pre>


<nowiki>{{info|This is another way to display your information}}</nowiki>
==KDE3 and KDE SC 4 Versions of Applications== <!--T:78-->  


  {{info|This is another way to display your information}}
<!--T:79-->
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}}


or
==Other Useful Templates== <!--T:80-->


<nowiki>{{warning|This is a very dangerous thing to do}}</nowiki>
</translate><span id="Inserting GUI Icons"></span><translate>


{{warning|This is a very dangerous thing to do}}
=== Inserting GUI Icons === <!--T:81-->


Note that the size of the boxes for these two templates are fixed - you cannot alter them.
<!--T:82-->
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.


==KDE3 and KDE SC 4 versions of applications==
<!--T:83-->
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.


By default, KDE SC 4 is assumed.  If the KDE SC 4 version is not yet ready for release it may be necessary to document the KDE3 version.  In this case you should add an icon <nowiki>{{KDE3}}</nowiki>  
<!--T:84-->
which displays {{KDE3}}.  Should you be writing about a KDE3 version and KDE SC 4 version on the same page, use icons for both - <nowiki>{{KDE4}}</nowiki> which displays {{KDE4}}
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==
===Community Applications=== <!--T:85-->


<!--T:86-->
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>
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>


<!--T:87-->
{{Community-app}}
{{Community-app}}


<!--T:88-->
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:
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:


<!--T:89-->
{{Community-app-footnote}}
{{Community-app-footnote}}


==Making major edits to Existing Pages==
===Making Major Edits to Existing Pages=== <!--T:90-->
 
<!--T:91-->
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
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


<!--T:92-->
{{Being_Edited}}
{{Being_Edited}}


'''''Don't forget to remove it when you have finished!'''''
<!--T:93-->
''Don't forget to remove it when you have finished!''
 
===Adding a New Complex Page=== <!--T:94-->
 
<!--T:95-->
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
 
<!--T:96-->
{{Construction}}
 
===Links to Pages in the Neighbourhood=== <!--T:97-->
 
<!--T:98-->
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}}
 
<!--T:99-->
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.
 
<!--T:143-->
{{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 === <!--T:147-->
 
<!--T:148-->
You can link directly to a bug in Bugzilla by using this template:
 
<!--T:149-->
<code><nowiki>{{Bug|123456}}</nowiki></code>
 
<!--T:150-->
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== <!--T:100-->
 
<!--T:101-->
{{Input|1=<nowiki>== Subpages of {{FULLPAGENAME}} ==
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>}}
 
<!--T:102-->
is very useful when you want to list subpages with active links, such as
 
=== Subpages of {{FULLPAGENAME}}=== <!--T:103-->
 
<!--T:104-->
It does, however, also list all "other-language" pages, so use with discretion.
 
<!--T:105-->
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}
 
 
<!--T:106-->
----
 


[[Category:Getting Started]]
<!--T:107-->
[[Category:Contributing]]
</translate>

Latest revision as of 15:28, 30 December 2022

Other languages:
Information
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 

{|class="tablecenter vertical-centered"
|[[Image:YourScreenshot.png|250px|thumb]]
|Your descriptive text
|}

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 "Toolbox" appears as its page heading.

Use bold and italic

Blips are used to specify bold and italic words.

Use '''bold text''' to specify bold text and ''italic text'' to specify italic text.

In order to ensure we get easy and accurate translations, please adhere to the 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 the typographical guideline page

If you have problems displaying pipe characters in your code snippet, please see the explanation and markup detailed on 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 

18 Mar 2011

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

* is the symbol to use for bulletted lists. ** gives a second level:

* Almonds

* Nuts
** Cashews

* Raisins

produces

  • Almonds
  • Nuts
    • Cashews
  • Raisins

Enumerations

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

# Sift
# Mix
## Stir thoroughly
# Bake

produces

  1. Sift
  2. Mix
    1. Stir thoroughly
  3. Bake

For more details see wikimedia on lists.

Combining Bulleted Lists and Enumerations

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

* Nuts
*# Cashew
*# Crazy
* Other things

produces

  • Nuts
    1. Cashew
    2. Crazy
  • Other things

while 

# Nuts
#* Cashew
#* Crazy
# Other things

produces

  1. Nuts
    • Cashew
    • Crazy
  2. Other things
Note
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
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.


Workaround
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: 

* First bullet </translate >
<translate >
** First sub bullet </translate >
<translate >
** Another sub bullet<br /><br />This one consists of two paragraphs </translate >
<translate >
* The next main bullet </translate >
<translate >
** And so on

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: 

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

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. 

;Animals
: They move around and devour other creatures.

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

produces

Animals
They move around and devour other creatures.
Plants
They have roots and feed upon ground water and sun.
Note
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 [[PageLayout]], 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 [[Special:myLanguage/PageLayout|Page Layout]], 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 

[[Special:myLanguage/PageLayout|this page]]

which displays

this page

Internal links to subsections of a page use character '#' (hash) and should look like this 

[[Special:myLanguage/Tasks_and_Tools#Working_with_Languages|...]]

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. External links are given as the URL and a text separated by a space and delimited by single square brackets as in 

[https://en.wikipedia.org/wiki/KDE KDE's Wikipedia page]

which gives KDE's Wikipedia page.

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: 

</translate><span id="Working with Languages"></span> <translate>

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

External links are slightly different so 

[http://techbase.kde.org/Schedules our road map]

displays

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 Applications, you should use the AppItem template. Simply enter 

{|
{{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.
|}

This gives the following display:

Settings for localized handling of numbers, dates, etc

A short text.

A few more short lines about the app. This is optional.

Shortcuts and Gestures

Another short text. If you do not type Enter 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 <ref>text</ref> in the source where the footnote mark should appear. There has to be one <references /> somewhere in the source as well, usually towards the end of the page. This is where the text added by the <ref> tags will appear. For more info see the Wikipedia help page.

Illustrate Your Text

Add a single image, centered

[[File:KMail-kde4.png|250px|center]]

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 Image: and File: are synonyms. So that [[Image:KMail-kde4.png]] is the same as [[File:KMail-kde4.png]]. However Image: is deprecated, so prefer File: in new content.

see 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: 

[[File:file_name.png|thumb|this will be the caption]]

Add a caption without a thumbnail

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

Example: 

[[File:image.png|frame|left|this will be the caption]]

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 <br clear=all> tag between the file tag and the text in question.

Example: 

[[File:image.png]]
<br clear=all>
This text would normally flow down the sides of the image but now it will be found under the image

Use Tables to Precisely Place Multiple Images

{|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]]
|}

displays


Note that all the parameters for one image are contained within [[...]], 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 mediawiki

Embed a Video

As of July 2012 the MediaWiki 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:

{{#ev:service|id}}
{{#ev:service|id|width}}
{{#ev:service|id|width|align}}
{{#ev:service|id|width|align|desc}}
{{#evp:service|id|desc}}
{{#evp:service|id|desc|align}}
{{#evp:service|id|desc|align|width}}

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: 

{{#ev:youtube|dMH0bHeiRNg}}

And if you wanted scaled down to thumbnail size, on the right with a short description, you could use: 

{{#ev:youtube|dMH0bHeiRNg|100|right|This is an embedded video!}}


As of version 1.0, EmbedVideo supports embedding video content from the following services:

Site Service Name
Dailymotion dailymotion
Div Share divshare
Edutopia edutopia
FunnyOrDie funnyordie
Google Video googlevideo
Interia interia or interiavideo
Revver revver
sevenload sevenload
TeacherTube teachertube
YouTube youtube and youtubehd
Vimeo vimeo

Add Notes and Warnings

Important
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:

{{Info|This is general information}} displays

Information
This is general information


{{Note|Some important information at this point}} displays

Note
Some important information at this point


{{Tip|A helpful piece of advice, something to remember}}displays

Tip
A helpful piece of advice, something to remember


{{Warning|Take care - this is a dangerous thing to do}} 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. {{Remember|1=This is for things that definitely must not be forgotten}}

Remember
This is for things that definitely must not be forgotten


You can also change the heading:

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


Page Redirection

You can make a page to redirect to another page automatically by using: 

#REDIRECT [[Pagename]]

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 {{KDE3}} which displays Should you be writing about a KDE3 version and KDE SC 4 version on the same page, use icons for both — {{KDE4}} which displays

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: {{Icon|list-add}}. This will display the icon.

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

The icon can also be written as {{Plus}}, and the icon as {{Minus}}. You can also use {{Configure}} to get the icon, and {{Exit}} gets you the 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 {{Community-app}}


 See footnote


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


Support for this application can be found from the project's home page


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 {{Being_Edited}} which will display

Currently Being Edited
This page is currently being edited.
If this notice persists for an unreasonable time, please either notify irc.freenode.org #kde-www or report on Annew's Talk page

Note: Pages should not normally be marked for translation while they are being actively worked on


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 - {{Construction}}, which displays

Under Construction
This is a new page, currently under construction!


Links to Pages in the Neighbourhood

You can add links to a preceding or a following page using the following templates as described here: 

{{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: 

{{Prevnext2|nextpage=Following Pagename|nexttext=This page you should read later}}
{{Prevnext2|prevpage=Previous Pagename|prevtext=The page before this page}}

If you don't specify an indexname the name of the current page will be displayed.

Note
You should always specify a text for the pages you link to, and you should always use Special:myLanguage 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:

{{Bug|123456}}

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

Adding a List of Sub-Pages

== Subpages of {{FULLPAGENAME}} ==
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}

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

Subpages of Toolbox

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


Retrieved from "https://wikisandbox.kde.org/index.php?title=Toolbox&oldid=476141"