Toolbox: Difference between revisions

From KDE Wiki Sandbox
No edit summary
(Marked this version for translation)
Line 1: Line 1:
<languages />
<languages />
<translate>
<translate>
<!--T:1-->
{{Info|This page offers examples of formatting code for common tasks}}
{{Info|This page offers examples of formatting code for common tasks}}


==Add an Introductory Screenshot and Description==  
==Add an Introductory Screenshot and Description== <!--T:2-->


<!--T:3-->
Whenever possible we begin an application's top-level page with this.  The code to achieve it is
Whenever possible we begin an application's top-level page with this.  The code to achieve it is


<!--T:4-->
{{Input|1=<nowiki>{|class="tablecenter vertical-centered"
{{Input|1=<nowiki>{|class="tablecenter vertical-centered"
|[[Image:YourScreenshot.png|250px|thumb]]
|[[Image:YourScreenshot.png|250px|thumb]]
Line 12: Line 15:
|}</nowiki>}}
|}</nowiki>}}


==Format Your Text==  
==Format Your Text== <!--T:5-->


===Use Headings===  
===Use Headings=== <!--T:6-->


<!--T:7-->
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.
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''===  
===Use '''bold''' and ''italic''=== <!--T:8-->


<!--T:9-->
Blips are used to specify bold and italic words.
Blips are used to specify bold and italic words.


<!--T:10-->
Use <nowiki>'''bold text'''</nowiki> to specify '''bold text''' and
Use <nowiki>'''bold text'''</nowiki> to specify '''bold text''' and
<nowiki>''italic text''</nowiki> to specify ''italic text''.
<nowiki>''italic text''</nowiki> to specify ''italic text''.


<!--T:11-->
In order to ensure we get easy and accurate translations, please adhere to the ''[[Typographical_Guidelines|typographical guidelines]].''
In order to ensure we get easy and accurate translations, please adhere to the ''[[Typographical_Guidelines|typographical guidelines]].''


===Add a Code Snippet===  
===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 [[Typographical_Guidelines|the typographical guideline page]]
We have templates to assist in correctly displaying code snippets.  Examples of use in various situations are available on [[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 [[Typographical_Guidelines|Typographical Guidelines]]
If you have problems displaying pipe characters in your code snippet, please see the explanation and markup detailed on [[Typographical_Guidelines|Typographical Guidelines]]


===Add Indents===  
===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.
:"''':'''" 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 ===
=== 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.
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>
</translate><span id="Bulleted Lists"></span><translate>


=== Bulleted Lists ===  
=== Bulleted Lists === <!--T:19-->


<!--T:20-->
<nowiki>*</nowiki> is the symbol to use for bulletted lists.  ** gives a second level:<br />
<nowiki>*</nowiki> is the symbol to use for bulletted lists.  ** gives a second level:<br />


<!--T:21-->
{{Input|1=<nowiki>
{{Input|1=<nowiki>
* Almonds
* Almonds


<!--T:22-->
* Nuts
* Nuts
** Cashews
** Cashews


<!--T:23-->
* Raisins
* Raisins
</nowiki>}}
</nowiki>}}
produces
produces


<!--T:24-->
* Almonds
* Almonds


<!--T:25-->
* Nuts
* Nuts
** Cashews
** Cashews


<!--T:26-->
* Raisins
* Raisins


=== Enumerations ===  
=== Enumerations === <!--T:27-->


<!--T:28-->
Enumerations are produced in the same way, using '#'.
Enumerations are produced in the same way, using '#'.


<!--T:29-->
{{Input|1=<nowiki>
{{Input|1=<nowiki>
# Sift
# Sift
Line 74: Line 94:
</nowiki>}}
</nowiki>}}


<!--T:30-->
produces
produces


<!--T:31-->
# Sift
# Sift
# Mix
# Mix
Line 81: Line 103:
# Bake
# Bake


=== Combining Bulleted Lists and Enumerations ===
=== Combining Bulleted Lists and Enumerations === <!--T:32-->


<!--T:33-->
You can have an enumerated sublist in a bulleted list and vice versa, like this:
You can have an enumerated sublist in a bulleted list and vice versa, like this:


<!--T:34-->
{{Input|1=<nowiki>
{{Input|1=<nowiki>
* Nuts
* Nuts
Line 92: Line 116:
</nowiki>}}
</nowiki>}}


<!--T:35-->
produces
produces


<!--T:36-->
* Nuts
* Nuts
*# Cashew
*# Cashew
Line 99: Line 125:
* Other things
* Other things


<!--T:37-->
while
while


<!--T:38-->
{{Input|1=<nowiki>
{{Input|1=<nowiki>
# Nuts
# Nuts
Line 108: Line 136:
</nowiki>}}
</nowiki>}}


<!--T:39-->
produces
produces


<!--T:40-->
# Nuts
# Nuts
#* Cashew
#* Cashew
Line 115: Line 145:
# Other things
# Other things


<!--T:41-->
{{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=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)}}


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


=== Itemizations ===
=== Itemizations === <!--T:43-->


<!--T:44-->
Itemizations are produced using ''';''' and ''':''' alternatively.  They are best for giving short descriptions for a group of related objects.
Itemizations are produced using ''';''' and ''':''' alternatively.  They are best for giving short descriptions for a group of related objects.


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


<!--T:46-->
;Plants
;Plants
: They have roots and feed upon ground water and sun.
: They have roots and feed upon ground water and sun.
Line 132: Line 167:
produces
produces


<!--T:47-->
;Animals
;Animals
: They move around and devour other creatures.
: They move around and devour other creatures.


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


<!--T:49-->
{{Note|1=As allways, please keep each item in a section of its own; it helps translators a lot.}}
{{Note|1=As allways, please keep each item in a section of its own; it helps translators a lot.}}


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


<!--T:51-->
There are two kinds of links to learn, internal ones, to another userbase page, and external URL links.
There are two kinds of links to learn, internal ones, to another userbase page, and external URL links.


<!--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  
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  


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


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


<!--T:55-->
{{Input|1=<nowiki>[http://techbase.kde.org/Schedules our road map]</nowiki>}} displays  
{{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.
[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.
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.


==Illustrate Your Text==  
==Illustrate Your Text== <!--T:57-->


===Add a single image, centered===  
===Add a single image, centered=== <!--T:58-->


<!--T:59-->
{{Input|1=<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}
{{Input|1=<nowiki>[[Image: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.
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.


===Make the Image Clickable, and Add a Caption===  
===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.
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.
A caption can also be added as a parameter, but will only show if '|thumb' is present.


===Use Tables to Precisely Place Multiple Images===  
===Use Tables to Precisely Place Multiple Images=== <!--T:64-->


<!--T:65-->
{{Input|1=<nowiki>{|class="tablecenter" style="border: 1px solid grey;"
{{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-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
Line 178: Line 227:
|}</nowiki>}}
|}</nowiki>}}


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


<!--T:67-->
{|class="tablecenter" style="border: 1px solid grey;"
{|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 188: Line 239:




<!--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.
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.


==Add Notes and Warnings==  
==Add Notes and Warnings== <!--T:69-->


<!--T:70-->
Where a note or warning is relevant within your text, use these templates:
Where a note or warning is relevant within your text, use these templates:


<!--T:71-->
<nowiki>{{Info|This is general information}}</nowiki> displays
<nowiki>{{Info|This is general information}}</nowiki> displays
{{Info|This is general information}}
{{Info|This is general information}}


<!--T:72-->
<nowiki>{{Note|Some important information at this point}}</nowiki> displays
<nowiki>{{Note|Some important information at this point}}</nowiki> displays
{{Note|Some important information at this point}}
{{Note|Some important information at this point}}


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


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


<!--T:76-->
You can also change the heading:
You can also change the heading:


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


==KDE3 and KDE SC 4 Versions of Applications==  
==KDE3 and KDE SC 4 Versions of Applications== <!--T:78-->


<!--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 an icon  <nowiki>{{KDE3}}</nowiki>  
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 an icon  <nowiki>{{KDE3}}</nowiki>  
which displays {{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 - <nowiki>{{KDE4}}</nowiki> which displays {{KDE4}}
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}}


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


=== Inserting GUI Icons ===
=== Inserting GUI Icons === <!--T:81-->


<!--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.
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.


<!--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.
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.


<!--T:84-->
The {{Plus}} icon can also be wirtten as <code><nowiki>{{Plus}}</nowiki></code>, and the {{Minus}} icon as <code><nowiki>{{Minus}}</nowiki></code>.
The {{Plus}} icon can also be wirtten as <code><nowiki>{{Plus}}</nowiki></code>, and the {{Minus}} icon as <code><nowiki>{{Minus}}</nowiki></code>.


===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}}


<!--T:93-->
''Don't forget to remove it when you have finished!''
''Don't forget to remove it when you have finished!''


===Adding a New Complex Page===  
===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
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}}
{{Construction}}


===Links to Pages in the Neighbourhood===  
===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:
You can add links to a preceding or a following page using the following templates as described here:
{{Input|1=<nowiki>{{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}}</nowiki>}}
{{Input|1=<nowiki>{{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}}</nowiki>}}
{{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}}
{{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}}


<!--T:99-->
For first pages with no preceeding page or last pages with no following page use this:
For first pages with no preceeding page or last pages with no following page use this:
{{Input|1=<nowiki>{{Next|Following Pagename|This page you should read later}}</nowiki>}}
{{Input|1=<nowiki>{{Next|Following Pagename|This page you should read later}}</nowiki>}}
Line 267: Line 342:
{{Prev|Previous Pagename|The page before this page}}
{{Prev|Previous Pagename|The page before this page}}


==Adding a List of Sub-Pages==  
==Adding a List of Sub-Pages== <!--T:100-->


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


<!--T:102-->
is very useful when you want to list subpages with active links, such as  
is very useful when you want to list subpages with active links, such as  


=== Subpages of {{FULLPAGENAME}}===  
=== Subpages of {{FULLPAGENAME}}=== <!--T:103-->


<!--T:104-->
It does, however, also list all "other-language" pages, so use with discretion.
It does, however, also list all "other-language" pages, so use with discretion.


<!--T:105-->
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}




<!--T:106-->
----
----




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

Revision as of 10:14, 4 June 2011

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

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

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

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.


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 allways, please keep each item in a section of its own; it helps translators a lot.


Add a Link

There are two kinds of links to learn, internal ones, to another 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

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.

Illustrate Your Text

Add a single image, centered

[[Image: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.

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.

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.

Add Notes and Warnings

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:

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


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 an icon {{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 wirtten as {{Plus}}, and the icon as {{Minus}}.

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: 

{{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}}


For first pages with no preceeding page or last pages with no following page use this: 

{{Next|Following Pagename|This page you should read later}}
{{Prev|Previous Pagename|The page before this page}}


Adding a List of Sub-Pages

{{Input|1=== 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=170357"