Help:Contents: Difference between revisions

From KDE TechBase
mNo edit summary
m (apparently the kde-class link generator template was moved to 'class'. I initially thought: qt|class, kde|class, just like qt:class, kde:class... but maybe 'kde' is too confusing with 'kde3' and 'kde4)
Line 27: Line 27:
: Use this template to add a warning.
: Use this template to add a warning.


; [[Template:qt|<nowiki>{{qt|class}}</nowiki>]]
; [[Template:qt|<nowiki>{{qt|class-name}}</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.


; [[Template:class|<nowiki>{{class}}</nowiki>]]
; [[Template:class|<nowiki>{{class|class-name}}</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.


; [[Template:path|<nowiki>{{path|path-to-filename}}</nowiki>]]
; [[Template:path|<nowiki>{{path|path-or-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 18:19, 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-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.
{{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.