Difference between revisions of "User:Hans/Examples2"

Jump to: navigation, search
(Information, Note, Tip and Warning box)
(Information, Note, Tip and Warning box)
Line 322: Line 322:
 
=== Information, Note, Tip and Warning box ===
 
=== Information, Note, Tip and Warning box ===
  
{| class="wikitable"
+
{|
 
!style="width:50%"|You type
 
!style="width:50%"|You type
 
!style="width:50%"|You get
 
!style="width:50%"|You get
Line 341: Line 341:
 
{{Warning|Take care - this is a dangerous thing to do}}</nowiki>}}
 
{{Warning|Take care - this is a dangerous thing to do}}</nowiki>}}
 
|{{Warning|Take care - this is a dangerous thing to do}}
 
|{{Warning|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.
 +
 +
{|
 +
!style="width:50%"|You type
 +
!style="width:50%"|You get
 
|-
 
|-
 
|{{Input|1=<nowiki>
 
|{{Input|1=<nowiki>
Line 347: Line 354:
 
|}
 
|}
  
{{Tip|3=Tip - headings|1=You can change the heading of the boxes using <code>3=New heading</code>, for example <code><nowiki>{{Remember|3=Don't Forget This!|1=You must make sure that...}}</nowiki></code>.}}
+
{{Tip|3=Tip - headings|1=You can change the heading of boxes using <code>3=New heading</code>, for example <code><nowiki>{{Remember|3=Don't Forget This!|1=You must make sure that...}}</nowiki></code>.}}
  
 
== Special text? ==
 
== Special text? ==

Revision as of 11:36, 4 June 2011

Basic formatting

Section headings

You type You get
== Level 2 ==
=== Level 3 ===
==== Level 4 ====
===== Level 5 =====
====== Level 6 ======

Level 2

Level 3

Level 4

Level 5
Level 6

Section headings define the structure of the page and is used to generate the Table of Contents. They are created by putting two or more = characters at each end of the section heading.

Flag-red.png
 
Remember
= Level 1 = is reserved for page titles and should not be used.


Paragraphs and newlines

You type You get
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.

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

This starts a new paragraph.

You can manually insert a newline like this.
Use this feature sparingly.

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

Text formatting

You type You get
'''Bold text'''
Bold text
''Italic text''
Italic text
''Bold and italic text''
Bold and italic text

See Typographical Guidelines for more information about when to use what.

Lists

Description You type You get
Bulleted lists
* One
* Two
** Two point one
* Three
  • One
  • Two
    • Two point one
  • Three
Numbered lists
# One
# Two
## Two point one
# Three
  1. One
  2. Two
    1. Two point one
  3. Three
Definition lists
;item 1
: definition 1
;item 2
: definition 2-1
: definition 2-2
item 1
definition 1
item 2
definition 2-1
definition 2-2
Note-box-icon.png
 
Note
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.


Indenting text

You type You get
No indent (normal)
:First indent
No indent (normal)
First indent
Note-box-icon.png
 
Note
Multiple indents can cause problems and should not be used anymore.


Escape wiki markup

You type You get
To make '''bold text''',
use <nowiki>'''bold text'''</nowiki>
To make bold text, use '''bold text'''

Sometimes it is useful to not apply the wiki markup, for example when you want to demonstrate how to use the markup. In such cases you can put <nowiki> and </nowiki> between the text that should remain unformatted.

Common elements

Links

Description You type You get
Internal links
[[Special:myLanguage/Dolphin|Dolphin]]
Dolphin
Links with custom text
[[Special:myLanguage/Dolphin|Custom text]]
Custom text
External links
[http://kde.org An external link]
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

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

More examples

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

Icons

You type You get
Click on {{Icon|plasma}} to open the desktop Tool Box.
Click on Icon-plasma.png to open the desktop Tool Box.

The best way to refer to icons in the GUI is to display the icon in the text. The argument (in the example above plasma) is the same as the icon name that icon themes use.

If the icon does not exist, it has to be uploaded to the wiki:

  • The icons can often be found locally in the directory usr/share/icons/oxygen/
  • Find the icon image file, preferably in 16x16 px
  • Copy the image file to your home directory and add Icon- in front of the filename. The rest of the filename should remain the same, so for example plasma.png would be Icon-plasma.png
  • Upload the icon to UserBase. See Update an Image for more information about how to upload images

Code

You type You get
Here is some <code>code</code> in running text.
Here is some code in running text.


Input box
You type
{{Input|1=<nowiki>
The code in this box is input by the user
  Indent with whitespace 
</nowiki>}}
You get
The code in this box is input by the user
  Indent with whitespace 


Output box
You type
{{Output|1=<nowiki>
This is some output the user would read from e.g. Konsole
It works in a similar way as the input box above
</nowiki>}}
You get
This is some output the user would read from e.g. Konsole
It works in a similar way as the input box above


Syntax highlighting
You type
{{Input|<syntaxhighlight lang="php" line>
# The input and output box also support syntax highlighting
# This is useful for displaying source code, in this example some PHP code

# Initialise common code
$preIP = dirname( __FILE__ );
require_once( "$preIP/includes/WebStart.php" );
</syntaxhighlight>}}
You get
1 # The input and output box also support syntax highlighting
2 # This is useful for displaying source code, in this example some PHP code
3 
4 # Initialise common code
5 $preIP = dirname( __FILE__ );
6 require_once( "$preIP/includes/WebStart.php" );

Quotes

You type You get
<blockquote>This is a quote from another page</blockquote>
This is a quote from another page

Information, Note, Tip and Warning box

You type You get
{{Info|This is general information}}
Dialog-information.png
 
Information
This is general information


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


{{Tip|A helpful piece of advice}}
Ktip.png
 
Tip
A helpful piece of advice


{{Warning|Take care - this is a dangerous thing to do}}
Warning.png
 
Warning
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.

You type You get
|{{Remember|1=This definitely must not be forgotten}}
Flag-red.png
 
Remember
This definitely must not be forgotten
Ktip.png
 
Tip
You can change the heading of boxes using 3=New heading, for example {{Remember|3=Don't Forget This!|1=You must make sure that...}}.


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

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.

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:


 Dialog-information.pngSee footnote


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