Vorlage:Link2CmdRef: Unterschied zwischen den Versionen
(→Beispiele: .) |
K (cat correct) |
||
(14 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
<includeonly> | <includeonly>[https://fhem.de/commandref{{#ifeq: {{{Lang|}}}|de|_DE}}.html#{{{Anker|#}}} {{{Label|commandref{{#if:{{{Anker|}}}|/{{{Anker}}}}}}}}]</includeonly><noinclude> | ||
}}</includeonly><noinclude> | |||
'''Dokumentation''' | '''Dokumentation''' | ||
__TOC__ | __TOC__ | ||
== Gegenstand == | == Gegenstand == | ||
Diese Vorlage generiert einen Link auf einen Abschnitt der englischen (Standard) oder deutschen commandref | Diese Vorlage generiert einen Link auf einen Abschnitt der englischen (Standard) oder der deutschen commandref. | ||
== Benutzung == | == Benutzung == | ||
<code><nowiki>{{Link2CmdRef|Anker=Beispiel-Modul|Lang=de|Label=Modul Beispiel-Modul}}</nowiki></code> | <code><nowiki>{{Link2CmdRef|Anker=Beispiel-Modul|Lang=de|Label=Modul Beispiel-Modul}}</nowiki></code> | ||
;Anker ( | ;Anker (optional) | ||
:Name des FHEM-Moduls wie in der commandref - jeder andere ('''''vorher zu ermittelnde''''') Ankername (Befehle, Geräte-Spezifikationen, spezielle Attribute oder andere Abschnitte) in der commandref funktioniert auch... | :Name des FHEM-Moduls wie in der commandref - jeder andere ('''''vorher zu ermittelnde''''') Ankername (Befehle, Geräte-Spezifikationen, spezielle Attribute oder andere Abschnitte) in der commandref funktioniert auch...; fehlt der Parameter oder wird | ||
:: ''Anker=#'' | |||
: verwendet, geht der Link auf die gesamte commandref bzw. deren Anfang | |||
: typische Modulanker sind: | |||
:: ''Modul'' = Die Modul-Dokumentation selbst | |||
:: ''Modul''set = Der Abschnitt ''Set'' des Moduls | |||
:: ''Modul''get = Der Abschnitt ''Get'' des Moduls | |||
:: ''Modul''attr = Der Abschnitt ''Attribute'' des Moduls | |||
:: ''Modul''define = Der Abschnitt ''Define'' des Moduls | |||
: Mitunter sind die Ankernamen der Unterabschnitte in der commandref auch in der Form ''Modul_Schlüsselwort'' (mit einem zusätzlichen trennenden Unterstrich) benannt worden! | |||
: Ebenso werden zum Teil Grossbuchstaben am Beginn der Schlüsselworte (Set, Get, Define, ...) verwendet | |||
: Also: immer besser testen! | |||
;Lang (optional) | ;Lang (optional) | ||
:Wert ''de'' (für deutsche commandref) wird erkannt, alle anderen Werte ignoriert; bei fehlendem Parameter wird ''en'' (default) angenommen | :Wert ''de'' (für deutsche commandref) wird erkannt, alle anderen Werte ignoriert; bei fehlendem Parameter wird ''en'' (default) angenommen | ||
;Label ( | ;Label (optional) | ||
: | :Text, der verlinkt angezeigt wird; fehlt der Parameter, wird als Standard-Text ''commandref'' eingesetzt bzw. commandref/Anker - wenn ein Anker angegeben wurde. | ||
<templatedata> | |||
{ | |||
"params": { | |||
"Lang": { | |||
"label": "Sprache", | |||
"description": "Die anzuzeigende Sprache in der Commandref (\"de\" => Deutsch, \"en\" => Englisch)", | |||
"example": "de", | |||
"type": "string", | |||
"default": "en" | |||
}, | |||
"Anker": { | |||
"label": "Anker", | |||
"description": "Name des Ankerziels der anzeigt werden soll. Typischerweise ist das der Name eines FHEM-Moduls oder entsprechender Unterabschnitte. Sofern nicht angegeben, wird die Commandref normal angezeigt von Beginn an.", | |||
"type": "string" | |||
}, | |||
"Label": { | |||
"label": "Linktext", | |||
"description": "Der Text, der als Verlinkung angezeigt werden soll. Falls nicht angegeben, wird ein Standard-Text verwendet." | |||
} | |||
}, | |||
"description": "Generiert ein Link zur FHEM Commandref." | |||
} | |||
</templatedata> | |||
== Beispiele == | == Beispiele == | ||
* <nowiki>{{Link2CmdRef|Anker=PRESENCE|Label=Modul PRESENCE}}</nowiki><br>{{Link2CmdRef|Anker=PRESENCE|Label=Modul PRESENCE}} <br />Link auf die englische Modulbeschreibung von PRESENCE | * <nowiki>{{Link2CmdRef|Anker=PRESENCE|Label=Modul PRESENCE}}</nowiki><br>{{Link2CmdRef|Anker=PRESENCE|Label=Modul PRESENCE}} <br />Link auf die englische Modulbeschreibung von PRESENCE | ||
* <nowiki>{{Link2CmdRef|Anker=PRESENCE|Lang=de|Label=Modul PRESENCE}}</nowiki><br>{{Link2CmdRef|Anker=PRESENCE|Lang=de|Label=Modul PRESENCE}} <br />Link auf die deutsche Modulbeschreibung von PRESENCE | * <nowiki>{{Link2CmdRef|Anker=PRESENCE|Lang=de|Label=Modul PRESENCE}}</nowiki><br>{{Link2CmdRef|Anker=PRESENCE|Lang=de|Label=Modul PRESENCE}} <br />Link auf die deutsche Modulbeschreibung von PRESENCE | ||
* <nowiki>{{Link2CmdRef | * <nowiki>{{Link2CmdRef}}</nowiki><br>{{Link2CmdRef}} <br />Link auf die gesamte englische commandref (deren Anfang) | ||
* <nowiki>{{Link2CmdRef| | * <nowiki>{{Link2CmdRef|Lang=de}}</nowiki><br>{{Link2CmdRef|Lang=de}} <br />Link auf die gesamte deutsche commandref (deren Anfang) | ||
[[Kategorie:Vorlage]] | |||
</noinclude> | </noinclude> |
Aktuelle Version vom 13. Februar 2020, 13:03 Uhr
Dokumentation
Gegenstand
Diese Vorlage generiert einen Link auf einen Abschnitt der englischen (Standard) oder der deutschen commandref.
Benutzung
{{Link2CmdRef|Anker=Beispiel-Modul|Lang=de|Label=Modul Beispiel-Modul}}
- Anker (optional)
- Name des FHEM-Moduls wie in der commandref - jeder andere (vorher zu ermittelnde) Ankername (Befehle, Geräte-Spezifikationen, spezielle Attribute oder andere Abschnitte) in der commandref funktioniert auch...; fehlt der Parameter oder wird
- Anker=#
- verwendet, geht der Link auf die gesamte commandref bzw. deren Anfang
- typische Modulanker sind:
- Modul = Die Modul-Dokumentation selbst
- Modulset = Der Abschnitt Set des Moduls
- Modulget = Der Abschnitt Get des Moduls
- Modulattr = Der Abschnitt Attribute des Moduls
- Moduldefine = Der Abschnitt Define des Moduls
- Mitunter sind die Ankernamen der Unterabschnitte in der commandref auch in der Form Modul_Schlüsselwort (mit einem zusätzlichen trennenden Unterstrich) benannt worden!
- Ebenso werden zum Teil Grossbuchstaben am Beginn der Schlüsselworte (Set, Get, Define, ...) verwendet
- Also: immer besser testen!
- Lang (optional)
- Wert de (für deutsche commandref) wird erkannt, alle anderen Werte ignoriert; bei fehlendem Parameter wird en (default) angenommen
- Label (optional)
- Text, der verlinkt angezeigt wird; fehlt der Parameter, wird als Standard-Text commandref eingesetzt bzw. commandref/Anker - wenn ein Anker angegeben wurde.
Generiert ein Link zur FHEM Commandref.
Parameter | Beschreibung | Typ | Status | |
---|---|---|---|---|
Sprache | Lang | Die anzuzeigende Sprache in der Commandref ("de" => Deutsch, "en" => Englisch)
| Zeichenfolge | optional |
Anker | Anker | Name des Ankerziels der anzeigt werden soll. Typischerweise ist das der Name eines FHEM-Moduls oder entsprechender Unterabschnitte. Sofern nicht angegeben, wird die Commandref normal angezeigt von Beginn an. | Zeichenfolge | optional |
Linktext | Label | Der Text, der als Verlinkung angezeigt werden soll. Falls nicht angegeben, wird ein Standard-Text verwendet. | Unbekannt | optional |
Beispiele
- {{Link2CmdRef|Anker=PRESENCE|Label=Modul PRESENCE}}
Modul PRESENCE
Link auf die englische Modulbeschreibung von PRESENCE - {{Link2CmdRef|Anker=PRESENCE|Lang=de|Label=Modul PRESENCE}}
Modul PRESENCE
Link auf die deutsche Modulbeschreibung von PRESENCE - {{Link2CmdRef}}
commandref
Link auf die gesamte englische commandref (deren Anfang) - {{Link2CmdRef|Lang=de}}
commandref
Link auf die gesamte deutsche commandref (deren Anfang)