Template:Class: Difference between revisions

Latest revision as of 11:17, 16 June 2022

The {{Class}} template creates a link to the API Documentation for a member Class of the KDE Frameworks.

Variables

{{Class|1=<className>|2=<library/module>|3=<frameworksVersion>|text=<linkText>}}

The numbered variables may be used without names as positional parameters, and the text= variable may be used with any quantity of other variables. Such as:

{{Class|<className>|<library/module>|<frameworksVersion>|text=<linkText>}}, or
{{Class|<className>||<frameworksVersion>|text=<link text>}}, or
{{Class|<className>|text=<linkText>}}

Usage Examples

{{Class|KColorDialog}} looks for the docs of the KColorDialog Class in the KDE Frameworks.
{{Class|KProcessList::KProcessInfo|kcoreaddons}} shows the docs for the KProcessList::KProcessInfo Class in the KCoreAddons library.
{{Class|KColorDialog|kdelibs|3.5}} shows the docs for the specified class in version 3.5 of the KDE Frameworks.
{{Class|KColorDialog|kdelibs|3.5|text=Color Dialog}} shows the docs for a different version and defines the link text.

@@ Line 1: / Line 1: @@
-[http://api.kde.org/classmapper.php?class={{{1}}}&module={{{2|kdelibs}}}&version={{{3|4.0}}} {{{1}}}]<noinclude>
+<includeonly>{{#ifexpr: {{{3|5}}} < 5 | [https://api.kde.org/mapsearcher.php?class={{{1}}}&module={{{2|ALL}}}&version={{{3}}}&go=Go {{{text|{{{1}}}}}}] | {{#if:{{{2|}}} | [https://api.kde.org/frameworks/{{lc:{{{2}}}}}/html/class{{{1}}}.html {{{text|{{{1}}}}}}] | [https://api.kde.org/frameworks/search.html?query={{{1}}} {{{text|{{{1}}}}}}] }}}}</includeonly><noinclude>
+The '''<nowiki>{{Class}}</nowiki> template''' creates a link to the [https://api.kde.org/frameworks/index.html API Documentation] for a member Class of the KDE Frameworks.
+=== Variables ===
+'''<big><nowiki>{{Class|1=</nowiki>''<className>''<nowiki>|2=</nowiki>''<library/module>''<nowiki>|3=</nowiki>''<frameworksVersion>''<nowiki>|text=</nowiki>''<linkText>''<nowiki>}}</nowiki></big>'''
+The numbered variables may be used without names as positional parameters, and the '''text=''' variable may be used with any quantity of other variables. Such as:
+:* '''''<nowiki>{{Class|<className>|<library/module>|<frameworksVersion>|text=<linkText>}}</nowiki>''''', or
+:* '''''<nowiki>{{Class|<className>||<frameworksVersion>|text=<link text>}}</nowiki>''''', or
+:* '''''<nowiki>{{Class|<className>|text=<linkText>}}</nowiki>'''''
 === Usage Examples ===
+* '''<nowiki>{{Class|KColorDialog}}</nowiki>''' looks for the docs of the KColorDialog Class in the KDE Frameworks.
-* <nowiki>{{class|kcolordialog}}</nowiki> looks for the docs of KColorDialog in kdelibs from KDE trunk.
+* '''<nowiki>{{Class|KProcessList::KProcessInfo|kcoreaddons}}</nowiki>''' shows the docs for the KProcessList::KProcessInfo Class in the KCoreAddons library.
-* <nowiki>{{class|Syndication::Feed|kdepimlibs}}</nowiki> shows optional parameter for lookup in other modules.
+* '''<nowiki>{{Class|KColorDialog|kdelibs|3.5}}</nowiki>''' shows the docs for the specified class in version 3.5 of the KDE Frameworks.
-* <nowiki>{{class|kcolordialog|kdelibs|3.5}}</nowiki> shows optional parameter to look up the docs in a different version.
+* '''<nowiki>{{Class|KColorDialog|kdelibs|3.5|text=Color Dialog}}</nowiki>''' shows the docs for a different version and defines the link text.
 [[Category:Template]]</noinclude>