Wiki Editing Hints

From Qt Wiki
Revision as of 17:08, 3 March 2015 by Simow (talk | contribs) (Multi Language Articles)
Jump to navigation Jump to search


In order to make editing in the Qt Wiki a little more comfortable

Templates

One can make use of the MediaWiki Templates. This page summarizes the current state of available Templates:

Template Name You type You get
Template:DocLink creates a link to the doc.qt.io reference documentation {{DocLink|QString}} QString
Template:DocLinkAnchor creates a link to the doc.qt.io documentation with anchor to the member {{DocLinkAnchor|QLabel|clear}} clear
Template:DocLinkAnchorLbl creates a link like DocLinkAnchor but with additional attribute for the link label in case you want to reference a QProperty that has the anchor name text-prop but you want to reference setText() or text() explicitly. {{DocLinkAnchorLbl|QLabel|text-prop|setText()}} setText()

Multi Language Articles

When creating new articles the first language should always be English. When translating an Article you just append the ISO-639-1 Language Code separated by a slash to the URL and hit Enter. The Wiki now tells you that the page can be created.

Example:

Tables

The Mediawiki help page on Tables is useful reading to anyone who edits tables.

Syntax Highlghting

The wiki uses the standard GeSHi syntax highlighter.

The only customisation made, has been to add the <code> tag to the highlighted list handled by GeSHi. The default language is set to C++. Change the language with the lang="" attribute (for example <code lang="javascript">).