Difference between revisions of "Help:Contents"

Jump to: navigation, search
(Update documentation about syntax highlighting)
(Tips: Fix syntaxhighlight keyword.)
Line 20: Line 20:
 
== Tips ==
 
== Tips ==
 
; Syntax highlighting
 
; Syntax highlighting
: Wrap your C++ Qt/KDE code snippets in <TT >&lt;syntaxhighlighter lang="cpp"&gt;</TT >, <TT >&lt;syntaxhighlighter lang="cpp" line=""&gt;</TT >, <TT >&lt;syntaxhighlighter lang="cpp-qt"&gt;</TT > and <TT >&lt;/syntaxhighlighter&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. <!-- Use plain <TT >&lt;code></TT > for wikitext (for now) -->
+
: 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 ==

Revision as of 13:06, 28 June 2011


Contents

Help:Contents


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.
<span class="bsBugLink bsError bsError-NoConnection">{{bug|123456}}</span>
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.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal