Difference between revisions of "User:Hans/Examples"

Jump to: navigation, search
Line 18: Line 18:
 
The tables of contents is generated from the section headings.}}
 
The tables of contents is generated from the section headings.}}
  
=== Text formatting? ===
+
=== Paragraphs and newlines ===
 +
 
 +
Paragraphs are created by separating two blocks of text with at least one empty line.
 +
For example, this does not create a new paragraph.
 +
 
 +
This is a new paragraph.
 +
 
 +
A newline can be inserted manually like this,<br />
 +
but use it sparely.
 +
 
 +
=== Text formatting ? ===
  
 
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.

Revision as of 12:35, 3 June 2011

Basic formatting

Section headings

Section headings are created as follows:

== Level 2 ==
=== Level 3 ===
==== Level 4 ====
===== Level 5 =====
====== Level 6 ======
Note-box-icon.png
 
Note
Level 1 is reserved for the page title and should not be used.
The tables of contents is generated from the section headings.


Paragraphs and newlines

Paragraphs are created by separating two blocks of text with at least one empty line. For example, this does not create a new paragraph.

This is a new paragraph.

A newline can be inserted manually like this,
but use it sparely.

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

Dialog-information.png
 
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

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


1 # The input and output box also support syntax highlighting
2 # Initialise common code
3 $preIP = dirname( __FILE__ );
4 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

Dolphin1.png

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

Desktop-config-customized.png
Desktop-settings-rightclick.png
Desktop-theme-details-dialog.png
Plasma-multiple-themes.png

Quotes

This is a quote from another page

Information, Note, Tip and Warning box

Dialog-information.png
 
Information
This is general information


Note-box-icon.png
 
Note
Some important information at this point


Ktip.png
 
Tip
A helpful piece of advice, something to remember


Warning.png
 
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

Dolphin1.png
The dedicated file manager focusing on usability

KDE3 and KDE SC 4 versions

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


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


Content is available under Creative Commons License SA 4.0 unless otherwise noted.