Wiki Editing Hints: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 16: Line 16:
| {{DocLink|QString}}
| {{DocLink|QString}}
|-
|-
| [[Template:DocLinkAnchor]] create a link to the doc.qt.io documentation with anchor to the member
| [[Template:DocLinkAnchor]] creates a link to the doc.qt.io documentation with anchor to the member
| <nowiki>{{DocLinkAnchor|QLabel|text-prop}}</nowiki>
| <nowiki>{{DocLinkAnchor|QLabel|clear}}</nowiki>
| {{DocLinkAnchor|QLabel|text-prop}}
| {{DocLinkAnchor|QLabel|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 <tt>text-prop</tt> but you want to reference <tt>setText()</tt> or <tt>text()</tt> explicitly.
| <nowiki>{{DocLinkAnchorLbl|QLabel|text-prop|setText()}}</nowiki>
| {{DocLinkAnchorLbl|QLabel|text-prop|setText()}}
|}
|}



Revision as of 13:19, 2 March 2015


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()

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">).