Hallo zusammen,
ich hatte bereits mehrfach den Fall, wo ich gerne Abschnitte (einzelne Abschnitte oder spezifische Attribute) aus der Commandref im Wiki verlinken möchte. Ich würde mir daher einen Vorlage analog zu Link2Forum wünschen, wo man einen Link zur Commandref einfügen kann, ohne eine URL anzugeben.
Bsp:
{{Link2Commandref|Hash=PRESENCE}} => https://fhem.de/commandref.html#PRESENCE
{{Link2Commandref|Lang=DE|Hash=PRESENCE_presenceThreshold}} => https://fhem.de/commandref_DE.html#PRESENCE_presenceThreshold
Vielen Dank
Gruß
Markus
Hallo Markus,
ich schau's mir mal an - dürfte nicht allzu schwierig sein.
Peter
Etwa so
https://wiki.fhem.de/wiki/Vorlage:Link2CmdRef
??
Bei den spezifischen Stellen wie z. B. Dein PRESENCE_presenceThreshold oder andere Bereiche mit Anker muss man allerdings aus der commandref den Anker(text) trotzdem erst einmal ermitteln.
Den Vorteil der Vorlage sehe ich nur darin, dass bei sich ändernden URL der commandref nur an einer Stelle im Wiki nachgezogen werden braucht.
Ja, genau sowas habe ich gesucht. Sollte man mal unter https://wiki.fhem.de/wiki/FHEMWiki:%C3%9Cber_FHEMWiki#Vorlagen dokumentieren.
Zitat von: Uwe B. am 30 Januar 2018, 16:16:57
Den Vorteil der Vorlage sehe ich nur darin, dass bei sich ändernden URL der commandref nur an einer Stelle im Wiki nachgezogen werden braucht.
Darum gehts mir ja auch. ;)
Gruß
Markus
Zitat von: Markus Bloch am 30 Januar 2018, 16:44:21
Sollte man mal ...
das höre ich meine Frau sprechen ... ::)
Ansonsten: done.
Vielen Dank Uwe, Super Arbeit!
Es passt jetzt nicht 100% hier her, aber bevor ich das Fass aufmache könntet ihr mal eure Meinung dazu äußern.
Zitat von: Uwe B. am 30 Januar 2018, 16:16:57
Bei den spezifischen Stellen wie z. B. Dein PRESENCE_presenceThreshold oder andere Bereiche mit Anker muss man allerdings aus der commandref den Anker(text) trotzdem erst einmal ermitteln.
Macht es nicht Sinn, dass die Anker in der CommandRef alle klein geschrieben werden? Hat den Vorteil, dass man beim verlinken nicht auch noch auf die Groß- und Kleinschreibung achten muss.
Zitat von: Uwe B. am 30 Januar 2018, 16:16:57
Etwa so
https://wiki.fhem.de/wiki/Vorlage:Link2CmdRef
Danke Uwe.
Zitat von: Markus Bloch
Ja, genau sowas habe ich gesucht. Sollte man mal unter https://wiki.fhem.de/wiki/FHEMWiki:%C3%9Cber_FHEMWiki#Vorlagen dokumentieren.
Habe ich gerade in die Liste aufgenommen.
@Uwe, @Markus: derzeit ist der Linktext (Label) Pflichtparameter. Würde sich hier nicht ein Standardwert "commandref" (oder ...?) anbieten? So wird es doch vermutlich bisher an den meisten Stellen zu formulieren sein (Markus, Du hast ja schon einige Verweise auf die commandref umgestellt; kannst Du das bestätigen?). Das würde die Verwendung der Vorlage noch weiter vereinfachen.
Möglicherweise könnte man sogar den Anker als Pflichtparameter weglassen und dann auf die gesamte commandref verlinken?
Peter
Hallo Peter,
Zitat von: ph1959de am 31 Januar 2018, 08:36:32
@Uwe, @Markus: derzeit ist der Linktext (Label) Pflichtparameter. Würde sich hier nicht ein Standardwert "commandref" (oder ...?) anbieten? So wird es doch vermutlich bisher an den meisten Stellen zu formulieren sein (Markus, Du hast ja schon einige Verweise auf die commandref umgestellt; kannst Du das bestätigen?). Das würde die Verwendung der Vorlage noch weiter vereinfachen.
Umgestellt habe ich persönlich noch nichts, das hat alles der Uwe gestern Abend noch gemacht. Ich wollte mich heute daran begeben, Generell würde ich als Standardbezeichnung auch "commandref" verwenden. Wenn es um spezifische Attribute geht, würde ich dann das Label ändern in den Attributnamen bspw.
Zitat von: ph1959de am 31 Januar 2018, 08:36:32
Möglicherweise könnte man sogar den Anker als Pflichtparameter weglassen und dann auf die gesamte commandref verlinken?
Finde ich gut.
Zitat von: Amenophis86 am 31 Januar 2018, 06:55:29
Es passt jetzt nicht 100% hier her, aber bevor ich das Fass aufmache könntet ihr mal eure Meinung dazu äußern. Macht es nicht Sinn, dass die Anker in der CommandRef alle klein geschrieben werden? Hat den Vorteil, dass man beim verlinken nicht auch noch auf die Groß- und Kleinschreibung achten muss.
Nachteil, alle Module müssen angefasst werden + ein Haufen toter Links ausserhalb der FHEM-Infrastruktur (Blogs, etc.)
Die Nachteile bzw. der Aufwand überwiegen für mich den Nutzen.
Gruß
Markus
Zitat von: ph1959de am 31 Januar 2018, 08:36:32
derzeit ist der Linktext (Label) Pflichtparameter. Würde sich hier nicht ein Standardwert "commandref" (oder ...?) anbieten? ... Das würde die Verwendung der Vorlage noch weiter vereinfachen.
Möglicherweise könnte man sogar den Anker als Pflichtparameter weglassen und dann auf die gesamte commandref verlinken?
Done.
Danke Uwe - das war ja superfix.
@Markus - für mich wäre der aktuelle Stand jetzt ok; ist damit dieser "Request" von Dir [erledigt]? ;)
Ja natürlich, das Thema ist "[erledigt]" ;)
Zitat von: Markus Bloch am 31 Januar 2018, 10:17:30
Nachteil, alle Module müssen angefasst werden + ein Haufen toter Links ausserhalb der FHEM-Infrastruktur (Blogs, etc.)
Die Nachteile bzw. der Aufwand überwiegen für mich den Nutzen.
Verstehe ich und macht Sinn.
So - die Bestandsseiten sind nun angepasst...
ich hätte noch einen verbesserungsvorschlag: aktuell wird als default der link immer durch das wort commandref dargestellt. das wird schnell unübersichtlich wenn mehrere solche links dicht beisammen im text stehen.
besser wäre es wenn als default text der referenzierte anker, oder commandref:<anker> dargestellt wird. oder auch <anker> in der commandref. das ist zwar länger, passt aber vermutlich besser in die meisten bisherigen sätze.
Zitat von: justme1968 am 31 Januar 2018, 19:32:46
ich hätte noch einen verbesserungsvorschlag: aktuell wird als default der link immer durch das wort commandref dargestellt. das wird schnell unübersichtlich wenn mehrere solche links dicht beisammen im text stehen.
besser wäre es wenn als default text der referenzierte anker, oder commandref:<anker> dargestellt wird. oder auch <anker> in der commandref. das ist zwar länger, passt aber vermutlich besser in die meisten bisherigen sätze.
@Uwe B. - nachdem Du den ganzen Bestand angepasst hast (herzlichen Dank dafür), kannst Du das vermutlich besser beurteilen. Ich finde Andre's Vorschlag gut und denke, dass er sich auch relativ einfach in die Vorlage einbinden lässt. Was meinst Du?
@Markus Bloch - Uwe hat bei den Umstellungen im "Bestand" festgestellt, dass es bei den Sprungmarken / Ankern in der commandref Dubletten gibt. Lässt sich das bei der Generierung der commandref irgendwie abhandeln - z.B. mit einer Mitteilung an den Modulowner?
Vorlage ist angepasst.
Default bei fehlendem Label ist jetzt:
- commandref (bei fehlendem Anker) bzw.
- commandref/Anker
Das # als Trenner wird von Mediawiki fehlinterpretiert, habe keine Lust eine Lösung zu suchen. Mit "/" sieht es doch auch gut aus... 8)
Die bereits eingetragenen Seiten werden nach und nach vom Wiki aktualisiert werden (Cache-Verfall).
Wer gleich den Effekt sehen will:
https://wiki.fhem.de/wiki//Artikel?action=purge
Zitat von: Uwe B. am 25 April 2018, 11:43:46
Mit "/" sieht es doch auch gut aus... 8)
Ähm, nö ;)
Hier (https://wiki.fhem.de/w/index.php?title=MQTT_DEVICE&diff=prev&oldid=26319) sah der Satz unter "Define" z.B. so aus: Die Syntax für das Anlegen eines MQTT-Devices ist der
commandref/MQTT_DEVICEdefine zu entnehmen
Das sieht eher nach einem Fehler im Wiki-Text als nach Absicht aus ;)
Ich denke, nur
commandref würde vollkommen reichen.