[Bug] Kontexthilfe: Meldung abgeschnitten bei HTML-Element

Begonnen von Christoph Morrison, 14 November 2018, 23:07:53

Vorheriges Thema - Nächstes Thema

Christoph Morrison

Hallo,

ich finde die Kontexthilfe (Attribut auswählen -> unter dem Attribut erscheint ein Auszug aus der Commandref) sehr gut. Mir ist aber aufgefallen, dass die Texte abgeschnitten werden, wenn ein HTML-Element in dem Snippet enthalten ist (siehe Screenshots).

holiday2we wird ab <a href="#perl">$we</a> abgeschnitten.
<li>holiday2we<br>
        Wenn dieses Attribut gesetzt wurde, dann wird die <a
        href="#perl">$we</a> Variable als &quot;true&quot; betrachtet, wenn der
        Wert der <a href="#holiday">holiday</a> Variable zu diesem Attribut
        nicht &quot;none&quot; ist.<br>
        Falls es eine Komma getrennte Liste ist, dann ist es wahr, falls einer
        der referenzierten Instanzen nicht &quot;none&quot; ist.<br>
        Beispiel:<br>
        <ul>


configfile wird ab <a href="#save">save</a> abgeschnitten:

    <a name="configfile"></a>
    <li>configfile<br>
       Enth&auml;lt den Namen der FHEM Konfigurationsdatei. Wenn <a
       href="#save">save</a> ohne Argumente aufgerufen wird dann wird die
       Ausgabedatei unter diesem Dateinamen gespeichert.
    </li><br>


Andere habe ich nicht versucht. Chrome/MacOS Version 70.0.3538.102



betateilchen

Zitat von: Christoph Morrison am 14 November 2018, 23:07:53
ich finde die Kontexthilfe (Attribut auswählen -> unter dem Attribut erscheint ein Auszug aus der Commandref) sehr gut.

und ich wäre froh, wenn man diesen Krampf abschalten könnte...
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

rudolfkoenig

Das Problem ist nicht neu, es liegt an dem begrenzten "Parser" in fhemweb.js, der aus dem kompletten Hilfetext die Daten extrahiert. Wir hatten schon eine Diskussion deswegen in diesem Thema.

Ich habe fhemweb.js geaendert, damit statt regexp der DOM-Parser des Browsers verwendet wird, damit ist der Regel fuer die Hilfe-Anzeige eines Attributes, Set- oder Get-Befehls: in der Modul-Dokumentationen einen passenden <a name="XXX"> Tag suchen, und den darauffolgenden <li> Tag anzeigen.

Damit sollten die erwaehnten Probleme geloest sein.
Ich habe gesehen, dass damit in DOIF die Anzeige nicht mehr funktoniert: Ich empfehle eine Neugestaltung der DOIF-Dokumentation, damit es den anderen Modulen gleicht.

Ellert

li-Tags: Das hatten wir auch schon mal. Werden jetzt die verschachtelten Listen angezeigt oder bleibt es wie aufgezeigt bei der Verstümmelung, siehe https://forum.fhem.de/index.php/topic,90592.msg831748.html#msg831748

Ich tendiere inzwischen zu der Ansicht die Direkthilfe auszubauen, solange keine Lösung gefunden wird, die bei jedem hin und her des Parsers verhindert das mindestens ca. 10% der Befehlsreferenz geändert werden müssen.

DS_Starter

Ausbauen finde ich jetzt persönlich keine so tolle Idee. Ich habe meine Module erst vor kurzem mit entsprechenden Aufwand auf die bestehende Attrhilfe ergänzt. Dann sollte es m.M. so bleiben bis es etwas besseres geben sollte.

Das html Problem habe ich momentan dadurch gelöst, dass es bei Attributen keine Links mehr gibt und über ein get eine eigene Hilfeseite mit Themen und Links aufgerufen werden kann.

LG
Heiko
ESXi@NUC+Debian+MariaDB, PV: SMA, Victron MPII+Pylontech+CerboGX
Maintainer: SSCam, SSChatBot, SSCal, SSFile, DbLog/DbRep, Log2Syslog, SolarForecast,Watches, Dashboard, PylonLowVoltage
Kaffeekasse: https://www.paypal.me/HMaaz
Contrib: https://svn.fhem.de/trac/browser/trunk/fhem/contrib/DS_Starter

Ellert

Zitat von: DS_Starter am 15 November 2018, 15:19:14
Ausbauen finde ich jetzt persönlich keine so tolle Idee. Ich habe meine Module erst vor kurzem mit entsprechenden Aufwand auf die bestehende Attrhilfe ergänzt. Dann sollte es m.M. so bleiben bis es etwas besseres geben sollte.

Das html Problem habe ich momentan dadurch gelöst, dass es bei Attributen keine Links mehr gibt und über ein get eine eigene Hilfeseite mit Themen und Links aufgerufen werden kann.

LG
Heiko
Der vorherige Zustand könnte bleiben, die DOIF und DOIFtools Hilfe wurde auch darufhin umgebaut.

Es gab eine Diskussion zu dem Thema, das Verfahren wurde sozusagen fest geschrieben und daher sollte jetzt nicht auf Zuruf einer einzelnen Stimme geändert werden, siehe https://forum.fhem.de/index.php/topic,90592.msg833723.html#msg833723

betateilchen

Zitat von: Ellert am 15 November 2018, 15:08:14
Ich tendiere inzwischen zu der Ansicht die Direkthilfe auszubauen, solange keine Lösung gefunden wird,

*unterschreib*
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

rudolfkoenig

Ich habe nicht vor den Parser zu aendern, da es meiner Ansicht nach jetzt kein "Hack" ist.

Ellert

Zitat von: rudolfkoenig am 15 November 2018, 19:14:47
Ich habe nicht vor den Parser zu aendern, da es meiner Ansicht nach jetzt kein "Hack" ist.
Das ist frustrierend, zumal es nicht kompatibel ist zu den bestehenden Hilfetexten.

Diese Texte sind Aufgrund Deiner Zusicherung angepasst worden. Wenn man sagt, dass etwas Bestand hat, dann bedeutet es üblicherweise mehr als  2 Monate.

Wenn es hier etwas wie Vertrauensschutzt gibt, dann sollte er hier greifen.
Insofern sollte es eine Lösung geben, die beim Misserfolg von li-Tag, als Fallback die a-Tags verwendet.

rudolfkoenig

Bei unseren letzten Diskussion war mir nicht bewusst, dass die Dokumentationsstruktur von DOIF komplett an der ueblichen/von mir beabsichtigten Commandref-Struktur vorbeigeht, und ich habe nicht vor, diese Art der Dokumentation zu unterstuetzen.

Ellert