User:Hans/Examples

From KDE UserBase Wiki
Revision as of 11:50, 3 June 2011 by Hans (talk | contribs)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Unordered for now

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.

Application screenshot and description

The dedicated file manager focusing on usability

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

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

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/

Links

This is a link to a wiki page: Dolphin

A link with custom text

An external link

Images

More examples in the

A single centered image

Thumbnail with caption

This is a caption