User:Hans/Examples: Difference between revisions

    From KDE UserBase Wiki
    No edit summary
    No edit summary
    Line 21: Line 21:


    Examples of ''italic text'', '''bold text''' and '''''bold and italic text'''''. See [[Typographical Guidelines]] for more information about when to use what.
    Examples of ''italic text'', '''bold text''' and '''''bold and italic text'''''. See [[Typographical Guidelines]] for more information about when to use what.
    == Common elements ==
    === Code ===
    In running text <code>code is written like this</code>.
    {{Input|1=The code in this box is inputted by the user
    {{Tab}}Indented one tab
    {{Tab3}}Indented three tabs
    Note that the pipe character {{!}} has to be written as <nowiki>{{!}}</nowiki> in the markup
    }}
    {{Output|1=The user would read this in e.g. Konsole
    It works in a similar way as the input box above}}
    {{Input|<syntaxhighlight lang="php" line>
    # The input and output box also support syntax highlighting
    # Initialise common code
    $preIP = dirname( __FILE__ );
    require_once( "$preIP/includes/WebStart.php" );
    </syntaxhighlight>}}


    === Lists ===
    === Lists ===
    Line 78: Line 53:
    :First indent
    :First indent
    ::Further indents can cause problems and should not be used
    ::Further indents can cause problems and should not be used
    == Common elements ==
    === Code ===
    In running text <code>code is written like this</code>.
    {{Input|1=The code in this box is inputted by the user
    {{Tab}}Indented one tab
    {{Tab3}}Indented three tabs
    Note that the pipe character {{!}} has to be written as <nowiki>{{!}}</nowiki> in the markup
    }}
    {{Output|1=The user would read this in e.g. Konsole
    It works in a similar way as the input box above}}
    {{Input|<syntaxhighlight lang="php" line>
    # The input and output box also support syntax highlighting
    # Initialise common code
    $preIP = dirname( __FILE__ );
    require_once( "$preIP/includes/WebStart.php" );
    </syntaxhighlight>}}


    === Links ===
    === Links ===

    Revision as of 12:13, 3 June 2011

    Basic formatting

    Section headings

    Section headings are created as follows:

    == Level 2 ==
    === Level 3 ===
    ==== Level 4 ====
    ===== Level 5 =====
    ====== Level 6 ======
    

    Note

    Level 1 is reserved for the page title and should not be used.
    The tables of contents is generated from the section headings.


    Text formatting?

    Examples of italic text, bold text and bold and italic text. See Typographical Guidelines for more information about when to use what.

    Lists

    Information

    Bulleted lists are preferred whenever possible.


    Bulleted lists

    • One
    • Two
      • Two point one
    • Three

    Numbered lists

    1. One
    2. Two
      1. Two point one
    3. Three

    Definition lists

    item 1
    definition 1
    item 2
    definition 2-1
    definition 2-2

    Intending text

    No indent (normal)

    First indent
    Further indents can cause problems and should not be used

    Common elements

    Code

    In running text code is written like this.


    The code in this box is inputted by the user
        Indented one tab
                Indented three tabs 
    Note that the pipe character | has to be written as {{!}} in the markup


    The user would read this in e.g. Konsole
    It works in a similar way as the input box above


    # The input and output box also support syntax highlighting
    # Initialise common code
    $preIP = dirname( __FILE__ );
    require_once( "$preIP/includes/WebStart.php" );
    

    Links

    This is a link to a wiki page: Dolphin

    A link with custom text

    An external link

    Images

    More examples on http://www.mediawiki.org/wiki/Help:Images.

    A single centered image

    text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text

    text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text

    Thumbnail with caption

    This is a caption

    text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text

    Multiple images in a grid

    Information, Note, Tip and Warning box

    Information

    This is general information

    Note

    Some important information at this point

    Tip

    A helpful piece of advice, something to remember

    Warning

    Take care - this is a dangerous thing to do


    Filenames and paths

    This is an example of a filename: some_file.txt

    A path is written in a similar way: ~/some/path/

    Application pages

    Application screenshot and description

    The dedicated file manager focusing on usability

    KDE3 and KDE SC 4 versions

    If you write about the KDE3 version of an application, you should use this icon.


    If information about the KDE SC 4 version appears an the same page, you can use this icon.