UPGRADE IP 9 verfügbar!
Timberwolf VISU jetzt mit NEUEM Layout Editor
Freie Anordnung, Reihenfolge und Größe der Widgets - viele weitere Verbesserungen
Infos im Wiki: https://elabnet.atlassian.net/l/cp/06SeuHRJ

NEU! Insider & Leistungsmerkmale FÜR ALLE freigeschaltet
Damit kann nun jeder das Upgrade vornehmen und VISU & IFTTT testen. Alle Info hier: viewtopic.php?f=8&t=5074

[Implemented] Inline Dokumentation direkt in LE resp. Custom-LE Code

Hier bitte Eure Diskussionen und Feature Requests zu neuen Logikmodulen und Funktionen des Logik-Editors

Ersteller
danik
Reactions:
Beiträge: 391
Registriert: Mo Sep 10, 2018 8:40 pm
Hat sich bedankt: 256 Mal
Danksagung erhalten: 266 Mal

Inline Dokumentation direkt in LE resp. Custom-LE Code

#1

Beitrag von danik »

Hi

Ich schreibe mir heute die Infos zu den von mir erstellten Custom-LE in eine Textdatei.

Schön wäre es, wenn man in der Custom-LE einen Doku-Bereich hätte, wo man seine Notizen unterbringen kann, gleich im Code-Block. Vielleicht geht dies ja heute schon irgendwie.

Noch besser wäre es, die Doku zu Custom-LE und Standard-LE so unterzubringen, dass mit einem Button gleich die hinterlegte Doku zum Logik aufgerufen werden kann.

- Inhalt/Beschrieb
- Eingänge
- Ausgänge
- Version

Ich könnte mir vorstellen dies macht es dann auch einfacher in der Weitergabe von Custom-LE.

Ev. ist da Thema ja schon auf der Agenda, habe aber nichts gefunden.

Gruss
Dani
Zuletzt geändert von Robert_Mini am Mo Nov 18, 2019 11:09 am, insgesamt 3-mal geändert.
TW 3500L (#882) + TW 950Q (#321, im Moment inaktiv), VPN offen, Reboot nach Rücksprache

Robert_Mini
Reactions:
Beiträge: 3741
Registriert: So Aug 12, 2018 8:44 am
Hat sich bedankt: 1164 Mal
Danksagung erhalten: 2058 Mal

#2

Beitrag von Robert_Mini »

Guter Vorschlag!

Würde mir ergänzend noch die Möglichkeit eines Attachments wünschen, da ich oft auch auf Papier was skizziere, was mit Worten nicht beschreibbar ist :o ;)

Robert
Timberwolf Server 2500 / #117 (VPN offen + reboot nach Rückfrage) / zusätzlich: 3500M/#935, 3500L/#1297

S. Kolbinger
Elaborated Networks
Reactions:
Beiträge: 588
Registriert: Mi Aug 15, 2018 11:34 am
Hat sich bedankt: 82 Mal
Danksagung erhalten: 558 Mal

#3

Beitrag von S. Kolbinger »

Hallo Dani,
danik hat geschrieben: Fr Jul 19, 2019 1:09 pm Schön wäre es, wenn man in der Custom-LE einen Doku-Bereich hätte, wo man seine Notizen unterbringen kann, gleich im Code-Block. Vielleicht geht dies ja heute schon irgendwie.
super Vorschlag! :handgestures-thumbupright:
Ich habe darauf hin ein wenig gesucht und folgenden Link gefunden:
https://stackoverflow.com/questions/244 ... ed-in-json
Das könnte man bereits jetzt nutzen.

Wie würde dir folgende Variante gefallen:

Code: Alles auswählen

{
	"__comment__": 
	{
		"Version": [
			"1.0"
		],
		"Beschreibung": [
			"Hier kann man die Funktion der Logik beschreiben.",
			"Solange man sich an die Syntax von Json hält," ,
			"ist das kein Problem ;-)"
		],
		"Eingänge":[
			"Hier kann man die Eingänge genauer beschreiben",
			"Bei Zeilenumbrüchen muss einen neuen String anfangen"
		],
		"Ausgänge":[
			"Analog zur den Eingängen"
		]
	},
	"Level":[
	],
	"Module":[
	],
	"Input":[
	],
	"Output":[
	]
}

Hmmm :think:
Robert_Mini hat geschrieben: Fr Jul 19, 2019 1:24 pm Würde mir ergänzend noch die Möglichkeit eines Attachments wünschen, da ich oft auch auf Papier was skizziere, was mit Worten nicht beschreibbar ist :o ;)
Im Prinzip könnte man dann auch eine Skizze (von PNG nach Base64 konvertiert) dazu hängen.

Wenn man sich dann noch über Konventionen einig wird, können wir es später einfacher in die Oberfläche integrieren.

Was ist eure Meinung dazu?
Besonders diejenigen unter euch, die sich schon intensiver mit Custom-Logiken beschäftigt haben, können hier wertvollen Input liefern. :clap:
Gruß,
Stefan K.

Ersteller
danik
Reactions:
Beiträge: 391
Registriert: Mo Sep 10, 2018 8:40 pm
Hat sich bedankt: 256 Mal
Danksagung erhalten: 266 Mal

#4

Beitrag von danik »

S. Kolbinger hat geschrieben: Fr Jul 19, 2019 4:12 pm
Ich habe darauf hin ein wenig gesucht und folgenden Link gefunden:
https://stackoverflow.com/questions/244 ... ed-in-json
Das könnte man bereits jetzt nutzen.

Wie würde dir folgende Variante gefallen:
Finde ich gut, einfach und funktional.

Gruss
Dani
TW 3500L (#882) + TW 950Q (#321, im Moment inaktiv), VPN offen, Reboot nach Rücksprache

Robert_Mini
Reactions:
Beiträge: 3741
Registriert: So Aug 12, 2018 8:44 am
Hat sich bedankt: 1164 Mal
Danksagung erhalten: 2058 Mal

#5

Beitrag von Robert_Mini »

Also die Konvention für die Doku (Langtext ergänzend zu den Mouse Over Texten) auf Basis des Beispielscodes oben finde ich grundsätzlich in Ordnung.
Wichtig wäre, dass man die Doku über die Oberfläche einsehen kann, ohne Editieren des Quellcodes.

Das mit png nach base64 halte ich jetzt für nicht sehr komfortabel (aber auch nicht für überlebenswichtig).

Robert
Timberwolf Server 2500 / #117 (VPN offen + reboot nach Rückfrage) / zusätzlich: 3500M/#935, 3500L/#1297

StefanW
Elaborated Networks
Reactions:
Beiträge: 9689
Registriert: So Aug 12, 2018 9:27 am
Wohnort: Frauenneuharting
Hat sich bedankt: 4831 Mal
Danksagung erhalten: 7633 Mal
Kontaktdaten:

#6

Beitrag von StefanW »

Diese Funktionalität wie Anzeigen, Konverteren nach Base64 usw. kann ja dann die Oberfläche übernehmen.

Denkt doch mal weiter drauf rum und wir haben einen sehr schönen Feature Request

Stefan
Stefan Werner
Product Owner für Timberwolf Server, 1-Wire und BlitzART
Bitte WIKI lesen. Allg. Support nur im Forum. Bitte keine PN
Zu Preisen, Lizenzen, Garantie, HW-Defekt an service at elabnet dot de

Link zu Impressum und Datenschutzerklärung oben.

Robert_Mini
Reactions:
Beiträge: 3741
Registriert: So Aug 12, 2018 8:44 am
Hat sich bedankt: 1164 Mal
Danksagung erhalten: 2058 Mal

#7

Beitrag von Robert_Mini »

Alles klar. Wenn die Oberfläche das base64 übernimmt, dann ist es natürlich i.O.
Einschränkung auf png wäre aber kontraproduktiv, da man dann keine Fotos anhängen kann, was im Smartphone Zeitalter oft Ersatz für Scans ist.

Mir wäre in diesem Zusammenhang "wichtig", dass die Speichern/Duplizieren Buttons mit eingeklappt werden (weniger Platz / mehr Übersicht da längere Liste ohne Scrollen sichtbar, der "Link" zur Doku aber sichtbar bleibt.

Hab mir das gerade nochmal an der Oberfläche angesehen.
@danik: Hast du schon mal einen längeren Text als Beschreibung eingegeben (wird bei bei Mouse Over auf den Beschreibungstext ganz angezeigt) und die Mouse-Over Texte bei Custom Logiken bei Ein- und Ausgängen angesehen.
==> Ich finde eigentlich, dass das fast alles (außer die Bilder) abdeckt / kenne aber die Zeichenbegrenzung des Beschreibungstextes nicht.

Einziger Nachteil: für Standardlogiken nicht anpassbar, dafür gibt es aber auch einen FR:
viewtopic.php?f=9&t=1215&p=10592#p10592

lg
Robert
Timberwolf Server 2500 / #117 (VPN offen + reboot nach Rückfrage) / zusätzlich: 3500M/#935, 3500L/#1297

Ersteller
danik
Reactions:
Beiträge: 391
Registriert: Mo Sep 10, 2018 8:40 pm
Hat sich bedankt: 256 Mal
Danksagung erhalten: 266 Mal

#8

Beitrag von danik »

Hi
Hab mir das gerade nochmal an der Oberfläche angesehen.
@danik: Hast du schon mal einen längeren Text als Beschreibung eingegeben (wird bei bei Mouse Over auf den Beschreibungstext ganz angezeigt) und die Mouse-Over Texte bei Custom Logiken bei Ein- und Ausgängen angesehen.
==> Ich finde eigentlich, dass das fast alles (außer die Bilder) abdeckt / kenne aber die Zeichenbegrenzung des Beschreibungstextes nicht.
Angesehen ja, aber noch mit falschen Fokus. Aber in der Tat ist dies gerade bei den Ein- und Ausgängen recht hilfreich, auch mit längeren Texten. Ergänzt um die Möglichkeit der Beschreibung und weiterem Text direkt in der Custom-Logik (ich habe noch gerne Datums- und Historieinformationen) für mich ideal, mit der Möglichkeit zur formatierten Anzeige der Zusatzinformation in der Oberfläche wie von Dir erwähnt.

Was mir noch auffällt: Anpassungen an einer Custom-LE im Editor werden noch nicht gespeichert oder übernommen. Ev. noch ein Bug?

Gruss
Dani
TW 3500L (#882) + TW 950Q (#321, im Moment inaktiv), VPN offen, Reboot nach Rücksprache

Robert_Mini
Reactions:
Beiträge: 3741
Registriert: So Aug 12, 2018 8:44 am
Hat sich bedankt: 1164 Mal
Danksagung erhalten: 2058 Mal

#9

Beitrag von Robert_Mini »

Ja - known bug.
Timberwolf Server 2500 / #117 (VPN offen + reboot nach Rückfrage) / zusätzlich: 3500M/#935, 3500L/#1297

StefanW
Elaborated Networks
Reactions:
Beiträge: 9689
Registriert: So Aug 12, 2018 9:27 am
Wohnort: Frauenneuharting
Hat sich bedankt: 4831 Mal
Danksagung erhalten: 7633 Mal
Kontaktdaten:

#10

Beitrag von StefanW »

Skizzen (Mockup) von dem was ihr haben wollt, wären sehr hilfreich.

Weil es ist nicht gesagt, dass wir aus den textfragmenten wir uns das gleiche vorstellen, was ihr Euch vorstellt. Außerdem können dann alle leichter darüber abstimmen.

Also WO GENAU soll welche Taste sein (ein- wie ausgeklappt), WO GENAU soll welcher Text erscheinen... usw

lg

Stefan
Stefan Werner
Product Owner für Timberwolf Server, 1-Wire und BlitzART
Bitte WIKI lesen. Allg. Support nur im Forum. Bitte keine PN
Zu Preisen, Lizenzen, Garantie, HW-Defekt an service at elabnet dot de

Link zu Impressum und Datenschutzerklärung oben.
Antworten

Zurück zu „Feature Requests & Diskussionen Timberwolf Logik (Module & Editor)“