Autor Thema: [gelöst][fhemweb.js] Direkthilfe; hier: Position des Hilfetextes  (Gelesen 1766 mal)

Offline Ellert

  • Developer
  • Hero Member
  • ****
  • Beiträge: 3593
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.
« Letzte Änderung: 06 September 2018, 10:45:50 von Ellert »
Gefällt mir Gefällt mir x 2 Liste anzeigen

Offline Ellert

  • Developer
  • Hero Member
  • ****
  • Beiträge: 3593
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.

Offline rudolfkoenig

  • Administrator
  • Hero Member
  • *****
  • Beiträge: 20884
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.

Offline Ellert

  • Developer
  • Hero Member
  • ****
  • Beiträge: 3593
Es muss nicht Doppelklick sein, man sollte markieren und kopieren können, und man sollte die Anzeige schliessen können.

Offline PatrickR

  • Developer
  • Sr. Member
  • ****
  • Beiträge: 692
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.
lepresenced - Tracking von Bluetooth-LE-Tags (Gigaset G-Tag) mittels PRESENCE

"Programming today is a race between software engineers striving to build bigger and better idiot-proof programs, and the universe trying to produce bigger and better idiots. So far, the universe is winning." - Rich Cook

Offline Ellert

  • Developer
  • Hero Member
  • ****
  • Beiträge: 3593
Den Textbereich zu schliessen ist nicht unbedingt notwendig, ein Reload tut es auch.

Offline Ellert

  • Developer
  • Hero Member
  • ****
  • Beiträge: 3593
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.
Gefällt mir Gefällt mir x 1 Liste anzeigen

Offline rudolfkoenig

  • Administrator
  • Hero Member
  • *****
  • Beiträge: 20884
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 :)

Offline Ellert

  • Developer
  • Hero Member
  • ****
  • Beiträge: 3593
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?

Offline rudolfkoenig

  • Administrator
  • Hero Member
  • *****
  • Beiträge: 20884
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.



Offline Ellert

  • Developer
  • Hero Member
  • ****
  • Beiträge: 3593
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>
 

Offline Ellert

  • Developer
  • Hero Member
  • ****
  • Beiträge: 3593
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.

Offline rudolfkoenig

  • Administrator
  • Hero Member
  • *****
  • Beiträge: 20884
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?

Offline Ellert

  • Developer
  • Hero Member
  • ****
  • Beiträge: 3593
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.
« Letzte Änderung: 30 August 2018, 23:17:48 von Ellert »

Offline Ellert

  • Developer
  • Hero Member
  • ****
  • Beiträge: 3593
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.