Wie Logiken dokumentieren?

[starwarsfan]

Hallo miteinander,

aus gegebenem Anlass stellt sich mir die Frage, wie ihr eure Logiken dokumentiert. Schreibt ihr das alles in die Textbox unter den Logikbausteinen?

Mir fehlt an dieser Stelle eine Art Textbaustein, den man auf/in einer Logikseite platzieren kann, um irgendwelchen Infotext darin zu pflegen. Es geht mir relativ häufig so, dass ich die Idee hinter einer Logik erst wieder anhand der Verknüpfungen der Bausteine nachvollziehen muss. Das ist gerade dann mühsam, wenn man nicht jeden Tag etwas daran macht...

@Christian: Ist soetwas ggf. sogar geplant?

[gaert]

Geplant ist aktuell "nur" ein großes Textfeld in den Eigenschaften einer Logikseite, aber keine Textbox innerhalb der Logik. Vielleicht genügt dir dies ja schon?!

[ggt]

Du meinst „Textfeld“ unterhalb des Names in den Eigenschaften Logikseite?
Wenn ja, dann müsste man beim Bearbeiten der Logik das in einem Editor dokumentieren und anschließend -> in die Eigenschaften der Logikseite und in das Textfeld einfügen.

Besser wäre wenn man das gleich in der Logikseite dokumentieren könnte.

[mwKNX]

... also ein Block, der ein Textfeld darstellt!?
So etwas sollte doch vielleicht einfach zu programmieren sein.

[MatthiasS]

Ich würde auf dem Logikblatt platzierbare Textfelder schon begrüßen. Da habe ich mich so dran gewöhnt. Es geht j auch teilweise darum, weiterführende Infos zu vermerken, z.B. Parameter an Konfig-Eingängen usw.

[gaert]

Momentan (bzw. in der nächsten Version) sieht's so aus (10.000 Zeichen maximal, Richtext):
Bildschirmfoto 2016-02-22 um 15.20.25.png



Klar - Textboxen innerhalb der Logik stehen lange auf der Liste, ist nur noch nicht umgesetzt... Die kommende Version wird ein Mega-Update - dauert aber noch etwas. Vielleicht baue ich solche Textboxen noch ein - ansonsten demnächst!

PS:
Der Text unter einem LBS kann schon jetzt (nach dem Update) ebenfalls 10.000 Zeichen lang sein... Als "Workaround" kann man also problemlos "Dummy-LBS" einfügen (z.B. ein Gatter oder so). Beim Aktivieren des Projekts werden "untätige" LBS ohnehin intern gelöscht - spielt also keine Rolle für die Funktion.

Unabhängig davon: Eine richtige Textbox kommt schon noch

[starwarsfan]

Hallo miteinander

Ich würde auf dem Logikblatt platzierbare Textfelder schon begrüßen. Da habe ich mich so dran gewöhnt. Es geht j auch teilweise darum, weiterführende Infos zu vermerken, z.B. Parameter an Konfig-Eingängen usw.

Ack! Genau für solche Usecases.

Momentan (bzw. in der nächsten Version) sieht's so aus (10.000 Zeichen maximal, Richtext):
[ATTACH=CONFIG]n916971[/ATTACH]

In diesem Feld könnte man zwar auch alles Mögliche dokumentieren, das Handling wäre aber mehr als umständlich. Für die Doku ausserhalb der Logik selbst sicher ok, aber mir geht es eher darum, direkt bei den Logiken relevante Informationen niederschreiben zu können.

Klar - Textboxen innerhalb der Logik stehen lange auf der Liste, ist nur noch nicht umgesetzt... Die kommende Version wird ein Mega-Update - dauert aber noch etwas. Vielleicht baue ich solche Textboxen noch ein - ansonsten demnächst!

Na super! Dann ist doch alles geritzt.

PS:
Der Text unter einem LBS kann schon jetzt (nach dem Update) ebenfalls 10.000 Zeichen lang sein... Als "Workaround" kann man also problemlos "Dummy-LBS" einfügen (z.B. ein Gatter oder so). Beim Aktivieren des Projekts werden "untätige" LBS ohnehin intern gelöscht - spielt also keine Rolle für die Funktion.

Ok, gut zu wissen. Danke für die Infos!

[mwKNX]

Die kommende Version wird ein Mega-Update - dauert aber noch etwas. Vielleicht baue ich solche Textboxen noch ein - ansonsten demnächst!

Danke, großer Edomi-Meister!

[saegefisch]

prima, Christian, das hört sich sehr hilfreich an. Danke.

Bei der Verwendung der LBS habe ich noch einen Wunsch: Wenn ich den richtigen LBS suche, kann man in der Auswahl keine Hilfe zu einem LBS ansehen. Ich hole mir dann nach einander die möglichen LBS kurz in den Logikeditor und lasse mir dann die LBS-Hilfe anzeigen. Danach lösche ich die anderen LBS wieder. Den Umweg würde ich gerne vermeiden bei der kreativen Suche nach eine guten Lösung für eine Logik.
Daher: Kannst Du es ermöglichen, bereits bei der LBS-Auswahl das Hilfe-PopUp zu einem LBS anzeigen zu können, bevor man einen LBS einbaut? Oder habe ich da etwas übersehen, wie es bereits geht?

Danke!

[gaert]

Wäre es so genehm? Die Größe der Textbox passt sich selbständig an den Inhalt an...

Bildschirmfoto 2016-02-22 um 21.04.23.png

[gaert]

saegefisch
Darüber denke ich schon lange nach - geht mir nämlich auch oft so Kommt also irgendwann...

Bis dahin kannst Du aber im "Hauptmenü" auf das (?) klicken (unter Logout) und dort "Logikbausteine" auswählen. Dann werden alle LBS aufgelistet (zur Zeit noch ohne Ordner) und Du kannst die entsprechende Hilfe angucken...

Die Hilfe ist natürlich auch in jedem anderen Fenster aufrufbar - das (?) oben rechts in der Ecke. Dann musst Du erst auf "Inhalt" klicken...

[saegefisch]

1+

[gaert]

Ohne Worte... (im nächsten Update dann verfügbar)

Ich werde übrigens die Möglichkeit zum Löschen/Bearbeiten rausnehmen (außer für LBS 19xxxxxx natürlich). Zur Sicherheit quasi, damit man nicht aus Versehen einen System-LBS löscht... Auf Dateiebene könnte man dies natürlich nach wie vor, aber dann weiß man ja was man tut (hoffentlich).
Bildschirmfoto 2016-02-23 um 00.24.49.png

[coliflower]

Ich werde übrigens die Möglichkeit zum Löschen/Bearbeiten rausnehmen ..

Anstatt Bearbeiten, Ansicht wäre prima … Ich schaue mir immer gerne etwas ab (lernen)
Das wäre einfacher / nicht so „aufwändig“ wie auf der Dateiebene ...

[panzaeron]

gaert
Ich bin immer wieder erstaunt wie schnell Du die Wünsche der Benutzer umsetzt, auch komplexe Dinge wie die 10000 Zeichen mit Sonderzeichen
Auch wenn ich EDOMI noch nicht Einsetze, ein großes Dankeschön für deine viele viele viele geleistet Arbeit