FHEM Forum

FHEM - Entwicklung => FHEM Development => Thema gestartet von: Ellert am 26 August 2018, 20:05:00

Titel: [gelöst][fhemweb.js] Direkthilfe; hier: Position des Hilfetextes
Beitrag von: Ellert am 26 August 2018, 20:05:00
Ich finde es ist eine gute Idee die Hilfetexte beider Auswahl anzuzeigen.

Mir ist jedoch aufgefallen, dass die Texte vom Auswahlfeld weit entfernt angezeigt werden, so dass meisten gescrollt werden muss, um sie lesen zu können.
Ich denke, die Texte werden dadurch leicht übersehen und der Komfort der Hilfeanzeige nicht wahrgenommen.

Gibt es eine Mehrheit dafür, dass die Anzeige der Direkthilfe unmittelbar unter den Auswahlfeldern positioniert werden sollte?

Schön wäre es auch wenn der Text wieder verschwindet, wenn er nicht mehr benötigt wird, z.B. bei Mausklick ausserhalb des Hilfetextbereiches.
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: Ellert am 27 August 2018, 09:51:18
Mit dem anliegenden Patch wird die Hilfe unter der jeweilligen Auswahlbox angezeigt, der Text verschwindet per Doppelklick auf ihn, siehe Bild.

Ich würde mich freuen, wenn die Idee Eingang in die offizielle Version finden würde.
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: rudolfkoenig am 27 August 2018, 10:47:36
Ich habe Einwaende gegen Double-Click: ich will nicht anfangen neue Bedienmethoden einzufuehren.
Und ich bin auch nicht sicher, dass das Einschieben der Hilfe an unterschiedlichen Positionen eine gute Idee ist, ich kann mich aber anpassen, falls sich dafuer eine Mehrheit findet.
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: Ellert am 27 August 2018, 11:42:18
Es muss nicht Doppelklick sein, man sollte markieren und kopieren können, und man sollte die Anzeige schliessen können.
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: PatrickR am 27 August 2018, 13:03:32
Ich finde die Hilfe direkt unter der Auswahlbox auch besser. Bei dem Doppelklickthema wäre vermutlich ein x oder Ähnliches intuitiv. Kann aber zugegebenermaßen nicht abschätzen, ob ein Wegklicken überhaupt nötig ist.

Patrick


Von unterwegs gesendet.
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: Ellert am 27 August 2018, 16:30:47
Den Textbereich zu schliessen ist nicht unbedingt notwendig, ein Reload tut es auch.
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: Ellert am 29 August 2018, 20:18:36
Die Direkthilfe scheint noch nicht sehr bekannt zu sein, trotzdem gibt es schon 4 Befürworter, daher noch ein Patch, der auch die Möglichkeit bietet, den Textbereich zu schliessen.
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: rudolfkoenig am 30 August 2018, 16:05:39
Diese Loesung verschiebt die Felder, wenn man nichts findet.
Ich habe jetzt nach langem Experimentieren eine andere Variante eingebaut, und auch die Suche nach dem Text etwas geaendert.

Ich betrachte es trotzdem als experimental: sobald die ersten Beschwerden zu nicht gefundenen Hilfetexten kommen, wandert das Ganze wieder nach unten, wo es unauffaellig ist. Wer es dann noch braucht, der soll ein Monitor passender Groesse anschaffen :)
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: Ellert am 30 August 2018, 18:04:21
Die Suche nach li-Tags ist schon sehr speziell, es werden kaum noch Einträge gefunden und wenn, dann nicht komplett angezeigt.
Beispiel FHEMWEB widgetOverride
Es werden die Widgets nicht angezeigt.
Beispiel global
Es wird zu jedem Attribut nur "archivedir" angezeigt.

Die Suche nach li-Tags bricht bei verschachtelten Listen ab.

Eine Sprungmarke zu nehmen, finde ich vorteilhafter, weil:
- in Antworten direkt zu einer bestimmten Stelle der Commandref verlinkt werden kann
- innerhalb der Commandref Bezüge hergestellt werden können
- die Verwendung von li-Tags einen ggf. einen Umbau der Hilfetexte erfordert, Sprungmarken sind mit weniger Aufwand eizufügen.
- da die nächste Sprungmarke das Ende des Hilfetextes markiert, kann der Autor das Texteende selbst bestimmen, ohne die Formatierung zu beeinflussen
- li-Tags lassen vermutlich weniger Spielraum bei weiteren Formatierungen, wie z.B. die Nutzung von dl,dt u. dd-Tags, die speziell für Beschreibungslisten vorgesehen sind.

Was spricht gegen Sprungmarken?
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: rudolfkoenig am 30 August 2018, 18:48:25
Zitat
Was spricht gegen Sprungmarken?
Dass kaum/keine set/get Befehle gefunden werden. Keiner sagt was gegen die generelle Verwendung von Sprungmarken, ich finde es nur nicht geeignet zum Auffinden/Auftrennen der Doku fuer diesen Zweck.

Ich habe die Suche wieder umgestellt auf /<a[^"]*"'+val/, und es wird alles bis zum naechsten <a ausgegeben, ist aber auch nicht perfekt.
Die richtige Loesung waere das Einfuehren von Tags, was die Browser nicht anzeigen, bedeutet aber den Umbau saemtlicher Hilfetexte, was wiederum illusorisch ist.

Bin knapp vor dem Entfernen des Features: wenn man es nicht richtig kann, dann sollte man es lassen.


Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: Ellert am 30 August 2018, 19:35:59
Ich verspreche mir von der Direkthilfe weniger Fragen mit Bezug auf Attribute, weil die Infos gleich angezeigt werden.
Daher fände ich es Schade, wenn die Direkthilfe wieder ausgebaut werden würde.

Es muss nur deutlich gemacht werden, dass vor jeden 1. Parameter in attr, set, und get, der in der Commandref beschrieben wird, eine Sprungmarke zu setzen ist, also für Attribut das  "widgetOverride" die Sprungmarke

<a name="widgetOverride"></a>
 
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: Ellert am 30 August 2018, 19:56:32
Mir ist gerade aufgefallen das alle a-Tags das Ende des Hilfetextes markieren

var o1 = data.indexOf('<a', 1); müsste wieder zu var o1 = data.indexOf('<a name', 1); werden.
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: rudolfkoenig am 30 August 2018, 20:52:36
Das reicht nicht, es gibt auch viele <a href="..."> Tags, z.Bsp. <a href="#dummy">dummy</a>

Habe ich schon erwaehnt, dass es nicht vollkommen ist?
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: Ellert am 30 August 2018, 23:12:08
Ok, es war kein Versuch es zu perfektionieren, ich müsste dann die Referenzierungen innerhalb der Commandref herausnehmen. Denn der Hilfetext
 endet ja nicht bei einem < a href= ...>, das wäre aber Schade.
Danke für die Geduld.
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: Ellert am 30 August 2018, 23:48:26
Der Hilfetext in einem DOIF sieht typischerweise so aus
Zitat
<a name="cmdpause"></a>
<b>Zwangspause für das Ausführen eines Kommandos seit der letzten Zustandsänderung</b>&nbsp;&nbsp;&nbsp;<a href="#DOIF_Inhaltsuebersicht">back</a><br>
<br>
... weiterer Text ...

nächstes Attribut
<a name="repeatsame"></a>
Es gibt immer einen Link zum Inhaltsverzeichnis. Das bedeutet der Hilfetext wird nur bis dort angezeigt.

Daher darf "<a href..." nicht als Ende des Hilfetextes betrachtet werden, sondern nur "<a name...".

Und wenn ein Hilfetext an einer bestimmten Stelle enden soll, muss dort sowas wie <a name="irgendetwas das niemals eine Sprungmarke ist"></a> angeben, damit ein vorzeitiges Ende erkannt wird.
Titel: Antw:[gelöst][fhemweb.js] Direkthilfe; hier: Position des Hilfetextes
Beitrag von: Ellert am 31 August 2018, 17:13:50
Da die Vorhandene Textgestaltung sehr vielfältig ist und das Erkennen des Endes eines Bereiches schwierig ist, könnte man darauf verzichten das Ende zu erkennen.
Der angezegiteText beginnt an der richtigen Stelle, kann aber beliebig weiter gescrollt werden.

Vielleicht ist das eine akzeptierbare Lösung.

Ich habe ein Bild und die angepasste fhemweb.js angehängt.
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: Ellert am 06 September 2018, 08:31:00
@rudolfkoenig
Kann ich davon ausgehen, dass die akttuell implementierte Lösung erstmal Bestand hat?

Dann könnte ich diesen Zustand als Grundlage für Anpassungen der Commandref (DOIFtools, DOIF) nutzen.
Titel: Antw:[fhemweb.js] Direkthilfe für attr, get und set; hier: Position des Hilfetextes
Beitrag von: rudolfkoenig am 06 September 2018, 09:15:24
Zitat
Kann ich davon ausgehen, dass die akttuell implementierte Lösung erstmal Bestand hat?
Da ich keine geniale Idee/Loesung habe, habe ich nicht vor was zu aendern => ja.
Titel: Antw:[gelöst][fhemweb.js] Direkthilfe; hier: Position des Hilfetextes
Beitrag von: KernSani am 28 Dezember 2018, 00:24:27
Ich krame diesen Thread mal wieder hervor . irgendwie ist das Feature an mir vorbei gegangen und ich kann auch den Original-Thread nicht finden. Ich finde es aber gut und habe es bei mir eingebaut. Was ich jetzt noch gut fände:
* wenn das auch für Readings funktionieren würde. Spontan würde ich an ein mouseOver denken
* wenn es mehr Modul-Autoren unterstützen würden :-)

Guten Rutsch!

Oli
Titel: Antw:[gelöst][fhemweb.js] Direkthilfe; hier: Position des Hilfetextes
Beitrag von: Ellert am 28 Dezember 2018, 20:25:20
... und ich kann auch den Original-Thread nicht finden ...
Ist nur in den FHEM Code changes zu finden, dies ist der daraus entstandene Thread.
Titel: Antw:[gelöst][fhemweb.js] Direkthilfe; hier: Position des Hilfetextes
Beitrag von: HomeAuto_User am 30 Oktober 2019, 20:42:56
Hallo,

ich greife mal das Thema erneut auf weil nun schon die Fälle aufgetreten sind, das User sich melden weil der falsche Punkt angezeigt wird.
Grund hierfür ist, das in unterschiedlichen Modulen der gleiche <a name="Wert"> genutzt wird um dahin zu springen.

Bsp Meldung / Beschwerde: https://forum.fhem.de/index.php/topic,58397.msg986472.html#msg986472
Damals wurde mit diesem Patch (https://svn.fhem.de/trac/changeset/17747/trunk) das ganze eingeläutet wenn wir es richtig nachvollzogen haben.

Solange dort nicht eine Anpassung erfolgt, so wird es in Zukunft immer diesen Konflikt geben. Modulentwickler und User werden sich nie die Mühe machen alle <a name="Wert"> Sprungmarken anzusehen ob Ihr wert schon vorhanden ist. Derzeit reden wir komplett von über 3000. Wäre es nicht besser, wenn man das Modul beim auslesen ergänzt um dann nur im passenden Modul den Abschnitt zu sehen?

Wenn wir es so lassen, wird das Problem stillschweigend hingenommen und in Zukunft schiebt der eine die Schuld auf den anderen.

Für eine Lösungsfindung kommt ja in Frage:
- Option entfernen komplett (wäre aber für viele Benutzer unschön)  :(
- Erweiterung der Option auf den Modulname zusätzlich  ;)
- Festlegung oder Entscheidung wie dieses in Zukunft gehandhabt wird.  ::)
- weitere Möglichkeiten erörtern ...  :o

MfG
Titel: Antw:[gelöst][fhemweb.js] Direkthilfe; hier: Position des Hilfetextes
Beitrag von: rudolfkoenig am 01 November 2019, 16:06:52
Da ich das Problem nicht sofort verstanden habe, auch weil es mAn mit dem Thema dieses Threads nur sehr indirekt was zu tun hat, versuche ich es anders zu formulieren:
- in der HTML Doku gibt es etliche nicht eindeutige Sprungmarken
- wenn man vom Inhaltsverzeichnis am Anfang des Commandrefs zum Text springen will, dann landet man u.U. an der falschen Stelle
- der Loesungsvorschlag lautet, beim Zusammenstellen des Commandrefs aus den einzelnen Modulen die Sprungmarken mit einem Stichwort wie "module" zu egaenzen, und diese ergaenzten Sprungmarken im Inhaltsverzeichnis zu verwenden.
Titel: Antw:[gelöst][fhemweb.js] Direkthilfe; hier: Position des Hilfetextes
Beitrag von: Sidey am 01 November 2019, 16:17:07
Ja, wenn das Stichwort module den Namen des Moduls darstellt, dann könnten Module die gleichen Attributnamen als Sprungmarken definieren.

Die Anzeige der inline Hilfe müsste dann ebenso bei der Suche nach einem Hilfeeintrag auch den Modulnamen mit verwenden.

Gesendet von meinem Moto Z (2) mit Tapatalk

Titel: Antw:[gelöst][fhemweb.js] Direkthilfe; hier: Position des Hilfetextes
Beitrag von: HomeAuto_User am 01 November 2019, 16:17:53
Hallo Rudi,

Da ich das Problem nicht sofort verstanden habe, auch weil es mAn mit dem Thema dieses Threads nur sehr indirekt was zu tun hat, versuche ich es anders zu formulieren:
- in der HTML Doku gibt es etliche nicht eindeutige Sprungmarken
- wenn man vom Inhaltsverzeichnis am Anfang des Commandrefs zum Text springen will, dann landet man u.U. an der falschen Stelle
- der Loesungsvorschlag lautet, beim Zusammenstellen des Commandrefs aus den einzelnen Modulen die Sprungmarken mit einem Stichwort wie "module" zu egaenzen, und diese ergaenzten Sprungmarken im Inhaltsverzeichnis zu verwenden.

danke für dein Statement und sorry wenn ich das Problem nicht dem richtigen Faden zuwies. Wir brauchten schon lange, den Ansatz zu finden oder wo es damals im Forum diskutiert wurde bzw. aufkam.
Du hast es mit deinen Punkten auf den Punkt kurz und knapp gebracht.

Zitat
- der Loesungsvorschlag lautet, beim Zusammenstellen des Commandrefs aus den einzelnen Modulen die Sprungmarken mit einem Stichwort wie "module" zu egaenzen, und diese ergaenzten Sprungmarken im Inhaltsverzeichnis zu verwenden.

Genau richtig  :D