"Device specific help" um "Wiki Eintrag" erweitern

Begonnen von chr2k, 03 Dezember 2015, 09:55:56

Vorheriges Thema - Nächstes Thema

chr2k

Könnte man nicht die Zeile in der auch der nützliche Link "Device specific help" am Ende eines jeden Devices mit einem Link zum dementsprechend passenden fhemwiki.de Eintrag verlinken? (natürlich nur, wenn es auch ein wiki Eintrag gibt. Bei einem fehlenden Wiki Eintrag würde dann bspw eine extra dafür erstelle Seite angezeigt werden, oder eben der Link erst nicht angezeigt werden)?!

Ich fände das sehr nützlich, da es einige klicks und eingaben erspart um zum entsprechenden Wiki Eintrag zu kommen.

Was haltet ihr davon?

marvin78

Zum einen ist der jeweilige Modulautor für die Hilfe (Eintrag in commandref) zuständig. Manche Modulautoren machen ähnliches sogar (Verweis auf Wiki, Forum oder ähnliches). Ich denke, der Modulautor macht an der Stelle, was er für sinnvoll erachtet.

Im Wiki steht so viel Zeug, dass in der vorhandenen Form nicht korrekt oder zumindest fragwürdig ist, dass ich es für nicht generell für sinnvoll erachte dort hin zu verlinken.

Die commandref ist eine commandref. Klar, kurz, prägnant. Das und das Wiki sind, meiner Ansicht nach, klar zu trennen.

Wuppi68

lieber würde ich an dieser Stelle einen Link nach DE oder EN finden :-)

Beste Beispiel dafür ist DOIF. Im Englisch Part steht kaum etwas drinnen, dafür ist der Deutsche Part annähernd perfekt.
Jetzt auf nem I3 und primär Homematic - kein Support für cfg Editierer

Support heißt nicht wenn die Frau zu Ihrem Mann sagt: Geh mal bitte zum Frauenarzt, ich habe Bauchschmerzen

marvin78

Naja Das sind eher Beispiele und kein Doku. Sowas gehört eher ins Wiki (DOIF) ;)

In anderen Fällen ist es eher umgekehrt (bei der Mehrheit). Die englische Doku ist vorhanden, die Deutsche nicht. In dem Fall gibt es dann sogar einen Link auf die englische Doku. Die englische Doku hat im Übrigen auch Priorität. Der DOIF Autor könnte aber durchaus einen Link auf die deutsche Variante setzen.

dev0


chr2k

Zitat von: marvin78 am 03 Dezember 2015, 10:23:21
Die commandref ist eine commandref. Klar, kurz, prägnant. Das und das Wiki sind, meiner Ansicht nach, klar zu trennen.

Über das "klar" lässt sich streiten  ;D
Mir fehlen Wiki Einträge mit guten Beispielen mehr als so manche commandref.

Ich möchte natürlich nicht der commandref ihre Sinnhafitgkeit machen, ich dachte mir nur, dass es vom handling her einfacher wäre,schnellerund einfacher auf diverse Anleitungen zum Modul xy lediglich 1-2 klicks zu haben, anstatt das wiki aufzurufen, suchbegriff eingeben usw.

chr2k

Zitat von: Wuppi68 am 03 Dezember 2015, 10:27:26
lieber würde ich an dieser Stelle einen Link nach DE oder EN finden :-)

Beste Beispiel dafür ist DOIF. Im Englisch Part steht kaum etwas drinnen, dafür ist der Deutsche Part annähernd perfekt.

Auch ne gute Idee (die ich gerne zusätzlich zu meinem Startpost anregen möchte). Aber wenn dann beide Links DE und EN. Ich kann mir bspw nicht merken wleches Modul ne besser EN oder DE commandref hat.

Vielleicht sollte man wenn man eine Hilfe zum Modul XY aufrufen möchte schlicth und ergreifend die commandref in DE und in EN unterneinander angezeigt bekommen, damit man sich das, was man braucht rauspicken kann.

Markus Bloch

Zitat von: chr2k am 06 Dezember 2015, 17:36:15
Auch ne gute Idee (die ich gerne zusätzlich zu meinem Startpost anregen möchte). Aber wenn dann beide Links DE und EN. Ich kann mir bspw nicht merken wleches Modul ne besser EN oder DE commandref hat.

Vielleicht sollte man wenn man eine Hilfe zum Modul XY aufrufen möchte schlicth und ergreifend die commandref in DE und in EN unterneinander angezeigt bekommen, damit man sich das, was man braucht rauspicken kann.

Das funktioniert nur, wenn man die commandref in einzelne HTML-Dateien pro Modul&Sprache aufteilt. Eine Diskussion zu diesem Thema gab es bereits hier: http://forum.fhem.de/index.php/topic,39854.0.html

Viele Grüße

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)

chr2k

Zitat von: Markus Bloch am 06 Dezember 2015, 18:37:25
Diskussion zu diesem Thema gab (gibt) es bereits hier

Hallo Markus,

da mein Eingangswunsch ja vielleicht besser in der commandref aufgehoben wäre (Verlinkung zur Wikipedia) und auch noch andere Vorschläge hier in diesem Thread gelandet sind meine Bitte an dich: Könntest du in dem von dir genannten Thread auf diesen Hinweisen (oder zumindest die Wünsche von hioer dort kundtun)?

Danke  8)

Wenn du vielleicht die Vorschläge dort reinkopierst, könnte man hier auch dicht machen.