Template:DocLink: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
(expand functionality to subsume related templates)
(more complete documentation)
Line 1: Line 1:
<includeonly><span class="plainlinks">[http://doc.qt.io/qt-5/{{lc:{{{1}}}}}.html#{{{2|}}} {{{3|{{{2|{{{1}}}}}}}}}]</span></includeonly><noinclude>
<includeonly><span class="plainlinks">[http://doc.qt.io/qt-5/{{lc:{{{1}}}}}.html#{{{2|}}} {{{3|{{{2|{{{1}}}}}}}}}]</span></includeonly><noinclude>
This template creates a link to pages in doc.qt.io. The link can be configured by 3 parameters, of which only the first is mandatory:
* The first parameter usually corresponds to the class name, but can refer to any link under doc.qt.io
* The second parameter corresponds to an anchor, to allow linking to a specific section of the page. It defaults to an empty string, so the link points to the top of the page.
* The third parameter is an optional label. It defaults to the anchor name, if it's provided, or to the first parameter.


Usage:
Usage:
Line 5: Line 9:
* <tt><nowiki>{{DocLink|QWidget|properties}}</nowiki></tt> produces: {{DocLink|QWidget|properties}}
* <tt><nowiki>{{DocLink|QWidget|properties}}</nowiki></tt> produces: {{DocLink|QWidget|properties}}
* <tt><nowiki>{{DocLink|QWidget|size-prop|size()}}</nowiki></tt> produces: {{DocLink|QWidget|size-prop|size()}}
* <tt><nowiki>{{DocLink|QWidget|size-prop|size()}}</nowiki></tt> produces: {{DocLink|QWidget|size-prop|size()}}
* <tt><nowiki>{{DocLink|PaintSystem.html||QPainter}}</nowiki></tt> produces: {{DocLink|PaintSystem.html||QPainter}} (note the empty anchor parameter)
</noinclude>
</noinclude>

Revision as of 12:50, 21 October 2015

This template creates a link to pages in doc.qt.io. The link can be configured by 3 parameters, of which only the first is mandatory:

  • The first parameter usually corresponds to the class name, but can refer to any link under doc.qt.io
  • The second parameter corresponds to an anchor, to allow linking to a specific section of the page. It defaults to an empty string, so the link points to the top of the page.
  • The third parameter is an optional label. It defaults to the anchor name, if it's provided, or to the first parameter.

Usage:

  • {{DocLink|QWidget}} produces: QWidget
  • {{DocLink|QWidget|properties}} produces: properties
  • {{DocLink|QWidget|size-prop|size()}} produces: size()
  • {{DocLink|PaintSystem.html||QPainter}} produces: QPainter (note the empty anchor parameter)