Help:Contents: Difference between revisions

From KDE TechBase
mNo edit summary
Line 12: Line 12:
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.


; <nowiki>{{movepage|url}}</nowiki>
; [[Template:movepage|<nowiki>{{movepage|url}}</nowiki>]]
: Use this template to mark a page as not finished.
: Use this template to mark a page as not finished.


; <nowiki>{{improve}}</nowiki>
; [[Template:Improve|<nowiki>{{improve}}</nowiki>]]
: Pages which need cleanups or contain empty sections and todos are marked with this tempate.
: Pages which need cleanups or contain empty sections and todos are marked with this tempate.


; <nowiki>{{tip|text}}</nowiki>
; [[Template:tip|<nowiki>{{tip|text}}</nowiki>]]
: Use this template to add a tip for the reader.
: Use this template to add a tip for the reader.


; <nowiki>{{note|text}}</nowiki>
; [[Template:note|<nowiki>{{note|text}}</nowiki>]]
: Use this template to add an explanatory note.
: Use this template to add an explanatory note.


; <nowiki>{{warning|text}}</nowiki>
; [[Template:warning|<nowiki>{{warning|text}}</nowiki>]]
: Use this template to add a warning.
: Use this template to add a warning.


; <nowiki>{{qt|class}}</nowiki>
; [[Template:qt|<nowiki>{{qt|class}}</nowiki>]]
: Use this template to generate a link to a Qt class, e.g. QWidget.
: Use this template to generate a link to a Qt class, e.g. QWidget.


; <nowiki>{{kde|class}}</nowiki>
; [[Template:class|<nowiki>{{class}}</nowiki>]]
: Use this template to generate a link to a KDE class, e.g. KDialog.
: Use this template to generate a link to a KDE class, e.g. KDialog.


; <nowiki>{{path|path-to-filename}}</nowiki>
; [[Template:path|<nowiki>{{path|path-to-filename}}</nowiki>]]
: Use this template for paths and filenames, this way all of them have a consistent style.
: Use this template for paths and filenames, this way all of them have a consistent style.



Revision as of 17:13, 27 December 2006

To get started with the MediaWiki syntax, read

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}}
Pages which need cleanups or contain empty sections and todos are marked with this tempate.
{{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}}
Use this template to generate a link to a Qt class, e.g. QWidget.
{{class}}
Use this template to generate a link to a KDE class, e.g. KDialog.
{{path|path-to-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.
{{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.