[erledigt] Vorlage für Commandref-Verlinkung (Link2CmdRef)

Begonnen von Markus Bloch, 30 Januar 2018, 13:04:05

Vorheriges Thema - Nächstes Thema

Markus Bloch

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
Developer für Module: YAMAHA_AVR, YAMAHA_BD, FB_CALLMONITOR, FB_CALLLIST, PRESENCE, Pushsafer, LGTV_IP12, version

aktives Mitglied des FHEM e.V. (Technik)

ph1959de

Hallo Markus,

ich schau's mir mal an - dürfte nicht allzu schwierig sein.

Peter
Aktives Mitglied des FHEM e.V. | Moderator im Forenbereich "Wiki"

Uwe B.

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.
Grüße - Uwe

Lache nie über die Dummheit der anderen. Sie ist deine Chance.

FHEM 5.9 auf Ubuntu Srv 19.04 u. RasPi Zero W Raspbian Stretch; CUNX mit Modulen HM u. slowRF433; RFXtrx433E; FB 7590; FRITZ!DECT 200; Wetter HM WDS100-C6-O OC3; Xiaomi Flower Sense; Broadlink RM Mini u. Pro; EZcontrol XS1

Markus Bloch

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
Developer für Module: YAMAHA_AVR, YAMAHA_BD, FB_CALLMONITOR, FB_CALLLIST, PRESENCE, Pushsafer, LGTV_IP12, version

aktives Mitglied des FHEM e.V. (Technik)

Uwe B.

Grüße - Uwe

Lache nie über die Dummheit der anderen. Sie ist deine Chance.

FHEM 5.9 auf Ubuntu Srv 19.04 u. RasPi Zero W Raspbian Stretch; CUNX mit Modulen HM u. slowRF433; RFXtrx433E; FB 7590; FRITZ!DECT 200; Wetter HM WDS100-C6-O OC3; Xiaomi Flower Sense; Broadlink RM Mini u. Pro; EZcontrol XS1

Markus Bloch

Developer für Module: YAMAHA_AVR, YAMAHA_BD, FB_CALLMONITOR, FB_CALLLIST, PRESENCE, Pushsafer, LGTV_IP12, version

aktives Mitglied des FHEM e.V. (Technik)

Amenophis86

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.
Aktuell dabei unser neues Haus mit KNX am einrichten. Im nächsten Schritt dann KNX mit FHEM verbinden. Allein zwei Dinge sind dabei selten: Zeit und Geld...

ph1959de

#7
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
Aktives Mitglied des FHEM e.V. | Moderator im Forenbereich "Wiki"

Markus Bloch

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
Developer für Module: YAMAHA_AVR, YAMAHA_BD, FB_CALLMONITOR, FB_CALLLIST, PRESENCE, Pushsafer, LGTV_IP12, version

aktives Mitglied des FHEM e.V. (Technik)

Uwe B.

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.

Grüße - Uwe

Lache nie über die Dummheit der anderen. Sie ist deine Chance.

FHEM 5.9 auf Ubuntu Srv 19.04 u. RasPi Zero W Raspbian Stretch; CUNX mit Modulen HM u. slowRF433; RFXtrx433E; FB 7590; FRITZ!DECT 200; Wetter HM WDS100-C6-O OC3; Xiaomi Flower Sense; Broadlink RM Mini u. Pro; EZcontrol XS1

ph1959de

Danke Uwe - das war ja superfix.

@Markus - für mich wäre der aktuelle Stand jetzt ok; ist damit dieser "Request" von Dir [erledigt]?  ;)
Aktives Mitglied des FHEM e.V. | Moderator im Forenbereich "Wiki"

Markus Bloch

Developer für Module: YAMAHA_AVR, YAMAHA_BD, FB_CALLMONITOR, FB_CALLLIST, PRESENCE, Pushsafer, LGTV_IP12, version

aktives Mitglied des FHEM e.V. (Technik)

Amenophis86

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.
Aktuell dabei unser neues Haus mit KNX am einrichten. Im nächsten Schritt dann KNX mit FHEM verbinden. Allein zwei Dinge sind dabei selten: Zeit und Geld...

Uwe B.

Grüße - Uwe

Lache nie über die Dummheit der anderen. Sie ist deine Chance.

FHEM 5.9 auf Ubuntu Srv 19.04 u. RasPi Zero W Raspbian Stretch; CUNX mit Modulen HM u. slowRF433; RFXtrx433E; FB 7590; FRITZ!DECT 200; Wetter HM WDS100-C6-O OC3; Xiaomi Flower Sense; Broadlink RM Mini u. Pro; EZcontrol XS1

justme1968

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.
hue, tradfri, alexa-fhem, homebridge-fhem, LightScene, readingsGroup, ...

https://github.com/sponsors/justme-1968