From KDE TechBase
    This page is a duplicate of and its contents will be progressively merged to userbase. Please do no longer update here.

    This page offers examples of formatting code for common tasks

    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. Code for the various box templates can be taken from this 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


    • Almonds
    • Nuts
      • Cashews
    • Raisins


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

    # Sift
    # Mix
    ## Stir thoroughly
    # Bake


    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


    • Nuts
      1. Cashew
      2. Crazy
    • Other things


    # Nuts
    #* Cashew
    #* Crazy
    # Other things


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

    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 are produced using ; and : alternately. They are best for giving short descriptions for a group of related objects.

    : They move around and devour other creatures.
    : They have roots and feed upon ground water and sun.


    They move around and devour other creatures.
    They have roots and feed upon ground water and sun.
    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 TechBase page, and external URL links.

    For an internal link the format [[Typographical_Guidelines]], 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/Typographical_Guidelines|Typographical Guidelines]], 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/Typographical_Guidelines|this page]]

    which displays

    this page

    External links are slightly different so

    [ our road map]


    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


    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;"


    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

    This is general information

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

    Some important information at this point

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

    A helpful piece of advice, something to remember

    {{Warning|Take care - this is a dangerous thing to do}} displays

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

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

    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.

    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 #kde-www or report on Annewilson's Talk page.

    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!

    Adding a List of Sub-Pages

    == Subpages of {{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.

    Adapt here the way to get those pages because the list is empty on the translated pages since FULLPAGENAME no longer returns Toolbox but Toolbox/xx