Help:Contents: Difference between revisions

From KDE TechBase
m (Reverted edits by Asuranis (talk) to last revision by Icwiener)
No edit summary
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|Help:Contents}}
{{Template:I18n/Language Navigation Bar|Help:Contents}}
<languages />
<translate>


Before you start to add or change content, please read:
Before you start to add or change content, please read:
Line 9: Line 12:


== Wiki Syntax ==
== Wiki Syntax ==
To get started with the MediaWiki syntax, read:
To get started with the MediaWiki syntax, read:
* [http://en.wikipedia.org/wiki/Help:Editing Help on Editing]
* [http://en.wikipedia.org/wiki/Help:Editing Help on Editing]
* [http://meta.wikimedia.org/wiki/Help:Table Wikitables]
* [http://meta.wikimedia.org/wiki/Help:Table Wikitables]
* [http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax Syntax for displaying images]
* [http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax Syntax for displaying images]
* [http://en.wikipedia.org/wiki/Help:Magic_words Magic words]
* [http://en.wikipedia.org/wiki/Help:Magic_words Magic words]
Line 19: Line 24:


== Tips ==
== Tips ==
; Syntax highlighting
; Syntax highlighting
: Wrap your C++ Qt/KDE code snippets in <tt>&lt;syntaxhighlight lang="cpp"&gt;</tt>, <tt>&lt;syntaxhighlight lang="cpp" line=""&gt;</tt>, <tt>&lt;syntaxhighlight lang="cpp-qt"&gt;</tt> and <tt>&lt;/syntaxhighlight&gt;</tt> to get syntax highlighting (<tt>cpp</tt> for C++, <tt>cpp-qt</tt> for Qt) and numbered lines (<tt>line=""</tt>). Replace <tt>cpp</tt> with [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages the language used], e.g. <tt>ruby</tt> for Ruby and <tt>python</tt> for Python (soon). Use <tt>ini</tt> for {{path|.desktop}} files, <tt>xml</tt> for XML files.
: Wrap your C++ Qt/KDE code snippets in <tt>&lt;syntaxhighlight lang="cpp"&gt;</tt>, <tt>&lt;syntaxhighlight lang="cpp" line=""&gt;</tt>, <tt>&lt;syntaxhighlight lang="cpp-qt"&gt;</tt> and <tt>&lt;/syntaxhighlight&gt;</tt> to get syntax highlighting (<tt>cpp</tt> for C++, <tt>cpp-qt</tt> for Qt) and numbered lines (<tt>line=""</tt>). Replace <tt>cpp</tt> with [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages the language used], e.g. <tt>ruby</tt> for Ruby and <tt>python</tt> for Python (soon). Use <tt>ini</tt> for {{path|.desktop}} files, <tt>xml</tt> for XML files.


== New Templates ==
== New Templates ==
To get a list of pages using a template, go to corresponding template page (e.g. [[Template:movepage]]) and click "''What links here''" in the toolbox.
To get a list of pages using a template, go to corresponding template page (e.g. [[Template:movepage]]) and click "''What links here''" in the toolbox.


Line 60: Line 67:
; [[Template:Box|<nowiki>{{Box|caption|text|width|float}}</nowiki>]]
; [[Template:Box|<nowiki>{{Box|caption|text|width|float}}</nowiki>]]
: Use this template to create a box with a caption and a text. The width parameter is optional and can be specified absolute (400px) or relative (50%). The last parameter is the float value, which is also optional and defaults to center.
: Use this template to create a box with a caption and a text. The width parameter is optional and can be specified absolute (400px) or relative (50%). The last parameter is the float value, which is also optional and defaults to center.
</translate>

Revision as of 08:55, 1 June 2012


Help:Contents


Other languages:

Before you start to add or change content, please read:

Wiki Syntax

To get started with the MediaWiki syntax, read:

Tips

Syntax highlighting
Wrap your C++ Qt/KDE code snippets in <syntaxhighlight lang="cpp">, <syntaxhighlight lang="cpp" line="">, <syntaxhighlight lang="cpp-qt"> and </syntaxhighlight> to get syntax highlighting (cpp for C++, cpp-qt for Qt) and numbered lines (line=""). Replace cpp with the language used, e.g. ruby for Ruby and python for Python (soon). Use ini for .desktop files, xml for XML files.

New Templates

To get a list of pages using a template, go to corresponding template page (e.g. Template:movepage) and click "What links here" in the toolbox.

{{movepage|url}}
Use this template to mark a page as not finished.
{{improve|explanation}}
Pages which need cleanups or contain empty sections and/or todos are marked with this template. Add an explanation if you want (optional)
{{tip|text}}
Use this template to add a tip for the reader.
{{note|text}}
Use this template to add an explanatory note.
{{warning|text}}
Use this template to add a warning.
{{qt|class-name}} and {{qt3|class-name}}
Use this template to generate a link to a Qt class, e.g. QWidget. For Qt3 classes use {{qt3|class-name}}
{{class|class-name}}
Use this template to generate a link to a KDE class, e.g. KDialog.
{{path|path-or-filename}}
Use this template for paths and filenames, this way all of them have a consistent style.
{{bug|123456}}
Use this template to automatically create a link to KDE's bugzilla.
{{KDE3}}
Use this template to mark the content of a page as applicable for either KDE 3. Don't tag technology agnostic pages. For KDE4 content, use [[Category:KDE4]].
{{TutorialBrowser|series|name|pre|next|reading}}
A template for tutorial navigation
{{Box|caption|text|width|float}}
Use this template to create a box with a caption and a text. The width parameter is optional and can be specified absolute (400px) or relative (50%). The last parameter is the float value, which is also optional and defaults to center.