Difference between revisions of "User:Hans/Examples2"

Revision as of 08:24, 4 June 2011

Basic formatting

Section headings

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

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.

 

Remember
Level 1 is reserved for the page title and should not be used.

Paragraphs and newlines

This is a paragraph.
This belongs to the same paragraph.

This starts a new paragraph.

You can manually insert a newline like this. <br />
Use this feature sparingly.

Paragraphs are created by separating two blocks of text with at least one empty line.

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

Indenting text

No indent (normal)

First indent

Further indents can cause problems and should not be used

Escape wiki markup ?

Sometimes it is useful to escape the wiki markup, for example if you want to show the markup of how to write '''bold text''' without the text turning bold. In such cases you can put <nowiki> and </nowiki> between the text that should remain unformatted.

Common elements

Code

In running text code is written like this.

The code in this box is input by the user
  Indent with whitespace 

This is some output the user would read from e.g. Konsole
It works in a similar way as the input box above

1 # The input and output box also support syntax highlighting
2 # This is useful for displaying source code, see example below
3 
4 # Initialise common code
5 $preIP = dirname( __FILE__ );
6 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

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

More examples

More detailed examples can be found on http://www.mediawiki.org/wiki/Help:Images.

Icons

Click on to open the desktop Tool Box.

 

Tip
(to be rewritten) The argument should be the same as the icon name in icon themes. If the icon doesn't exist yet, see ?? for more information about how to upload it.

Quotes

This is a quote from another page

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

Special text?

Dates

Dates are written as 18 Mar 2011. The month is either spelled out completely or in abbreviated form (first three letters), and the year is in 4-digit format. The day may be single or double-digit.

Keyboard keys and shortcuts

Press Enter

You can use Alt + Shift + E to edit a page in UserBase.

Menus and sequence of choices?

A sequence of menu choices should look like this: File -> Create New -> Folder...

Other sequences have a similar look, for example System Settings -> Hardware -> Multimedia

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.

Community applications

For community applications not distributed as core KDE applications, add {{Community-app}} to the bottom of the page. It shows up like this:

 See footnote