Help:Contents: Difference between revisions

From KDE TechBase
(typo)
m (fix link)
Line 1: Line 1:
Before you start to add or change content, you should read about our '''[[Wiki Structure]]'''.
Before you start to add or change content, you should read about our '''[[Help:Wiki Structure|Wiki Structure]]'''.


== Wiki Syntax ==
== Wiki Syntax ==

Revision as of 15:09, 7 January 2007

Before you start to add or change content, you should read about our Wiki Structure.

Wiki Syntax

To get started with the MediaWiki syntax, read

The most important commands are summarized in the Wikipedia Cheatsheet. Information about how to migrate content can be found here.

Tips

Syntax highlighting
Wrap your C++ Qt/KDE code snippets in <code cppqt n> and </code> to get syntax highlighting (cpp == c++, qt == qt) and numbered lines (n). Replace "cpp" with the language used, e.g. rubyqt for Ruby and pythonqt for Python (soon).

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 tempate. 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}}
Use this template to generate a link to a Qt class, e.g. QWidget.
{{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}}/{{KDE4}}
Use this template to mark the content of a page as applicable for either KDE 3 or KDE 4. Don't tag technology agnostic pages.
{{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.