[Doku] Themensammlung zu MQTT allgemein

[Homoran]

@hydrotec sagte in [Doku] Themensammlung zu MQTT allgemein:

Das kann ich auch verstehen, doch warum nur 80 Zeichen, ich find das schon etwas wenig.

nö, das ist je nach abgebildeter Schriftgröße, die übliche Zeilenlänge

Das Problem im Moment ist, dass es bei einem einfachen Umbruch auch in der Ansicht umbricht, was nicht passieren sollte.

Arbeitest du mit Apfeln?

[hydrotec]

@homoran sagte in [Doku] Themensammlung zu MQTT allgemein:

Arbeitest du mit Apfeln?

Nein, mit Fenster.
Bzw. direkt auf GitHub.

[Homoran]

@hydrotec sagte in [Doku] Themensammlung zu MQTT allgemein:

@homoran sagte in [Doku] Themensammlung zu MQTT allgemein:

Arbeitest du mit Apfeln?

Nein, mit Fenster.
Bzw. direkt auf GitHub.

Auch nur mit einem einfachen Enter?
ohne STRG oder sonstwelchen Luxus???

Müsste so aussehen

[hydrotec]

@homoran

Spätestens nach 80 Zeichen in einer Zeile setze ich doppeltes Leerzeichen für den Zeilenumbruch.

[Homoran]

@hydrotec sagte in [Doku] Themensammlung zu MQTT allgemein:

setze ich doppeltes Leerzeichen für den Zeilenumbruch.

das ist der Fehler!

einfach <ENTER>

[hydrotec]

@homoran

OK, verstanden.
Dann habe ich wohl den Hinweis in der Style Dokumentation missverstanden.
Werde alles noch einmal umformatieren.
Geht ja schnell

[Asgothian]

@hydrotec sagte in [Doku] Themensammlung zu MQTT allgemein:

Ich hatte versucht, mich weitestgehenst an die Styleguide Dokumentation zu halten.
Und so wirklich glücklich bin ich mit der jetzigen Formatierung auch nicht.
Wie ich ja schon einmal erwähnt hatte, sind das meine ersten Gehversuche zu Markdown.
Wenn es dir nichts ausmacht, und du die Zeit dafür hast, könntest du mir bitte ein Beispiel zur Verfügung stellen,
wie du das umsetzen würdest. Also nicht die ganze Seite, nur ein zwei Blöcke, für mich zur Vorlage.
Gerne direkt in der von mir erstellten Doku.
Letztendlich soll es ja allen hilfreich sein, und ich kann mich zu Markdown weiterbilden.
Vorab schon ein Dankeschön.

Mach ich, aber erst heute Abend.

A.

[hydrotec]

@asgothian sagte in [Doku] Themensammlung zu MQTT allgemein:

Mach ich, aber erst heute Abend.

Wie du Zeit hast, Danke

[Homoran]

@hydrotec sagte in [Doku] Themensammlung zu MQTT allgemein:

Dann habe ich wohl den Hinweis in der Style Dokumentation missverstanden.

Anscheinend.
Der Zeilenumbruch sollte im RAW zu sehen sein, damit es dort nicht zu unendlichen Zeilenlängen kommt.
80 Zeichen ist auch nicht wirklich in Stein gemeißelt

[hydrotec]

@homoran
OK, hab die Doku noch einmal etwas angepasst.
Jetzt sieht es auch für mich besser aus.

@Asgothian
Für den Fall, das du das mit der Formatierung gemeint hast, dann hat es sich wohl erledigt.
Solltest du dennoch Verbesserungen vornehmen wollen, gerne doch.

Bin für jeden Hinweis dankbar.

So, jetzt erst einmal Mittagspause
Angenehmen Nachmittag noch.

[Asgothian]

@hydrotec sagte in [Doku] Themensammlung zu MQTT allgemein:

Für den Fall, das du das mit der Formatierung gemeint hast, dann hat es sich wohl erledigt.
Solltest du dennoch Verbesserungen vornehmen wollen, gerne doch.
Bin für jeden Hinweis dankbar.

Es hat sich zum Teil erledigt. Die seltsamen Zeilenumbrüche sind weg, die fehlende Strukturierung fehlt immer noch und sprachlich gibt es immer noch einiges an Stolpersteinen, i.e. Formulierungen die man bei einem Gespräch so anwenden würde, die aber in einem Text fehl am Platz sind. Als Beispiel nur dieses:

"Diese Struktur wird meistens von den Herstellern vorgegeben, kann jedoch ebenso von Anwendern definiert werden. Kommt darauf an, um was für eine Art von Gerät es sich handelt."

Und auch wenn es kleinlich erscheint - es sind viel zu viele Kommata im Text

Ich geh da heute Abend mal drüber.

A.

[Homoran]

@asgothian sagte in [Doku] Themensammlung zu MQTT allgemein:

Ich geh da heute Abend mal drüber.

Bitte bedenkt aber, dass diese "Vorgaben" formal zwar korrekt sind, in Bezug auf die geplante Leserschaft aber nicht zu stark in unverständliches Fachchinesisch gewandelt werden sollte.

[FredF]

@hydrotec sagte in [Doku] Themensammlung zu MQTT allgemein:

EDIT:
Wieviele Zeichen sind denn in der offiziellen Doku mmöglich, bevor ein automatischer Zeilenumbruch stattfindet.
Weiss das zufällig jemand?

Da gibt es soweit ich weis keine Grenze. Bei den Änderungen die ich auf git gemacht hatte, habe ich mich auch immer versucht an den 80 Zeichen zu orientieren.
Allerdings sind die Zeilenumbrüche nur beim editieren in Github zu sehen, beim speichern verschwinden sie und in der Doku dann auch nicht mehr zu sehen.

[Homoran]

@fredf sagte in [Doku] Themensammlung zu MQTT allgemein:

Da gibt es soweit ich weis keine Grenze.

so kenne ich das auch. Das geht "unendlich". Dann wird der horizontale Scrollbalken schwer aktiv

[Asgothian]

@homoran sagte in [Doku] Themensammlung zu MQTT allgemein:

@asgothian sagte in [Doku] Themensammlung zu MQTT allgemein:

Ich geh da heute Abend mal drüber.

Bitte bedenkt aber, dass diese "Vorgaben" formal zwar korrekt sind, in Bezug auf die geplante Leserschaft aber nicht zu stark in unverständliches Fachchinesisch gewandelt werden sollte.

Ich werd es versuchen

[Homoran]

@asgothian sagte in [Doku] Themensammlung zu MQTT allgemein:

Ich werd es versuchen

Danke!

Sonst hab ich wieder die Arbeit alles downwardkompatibel zu reverten

[Asgothian]

@homoran @hydrotec
Um es mir einfach zu machen hab ich einen Fork von @hydrotec's Doku repo angelegt und da mal Hand an den Text gelegt. Ich hoffe das

• die Anpassungen nicht zu komplex geworden sind
• ich mich damit nicht zu weit aus dem Fenster gelehnt habe

Zum lesen: hier

A.

[OstfrieseUnterwegs]

@hydrotec
Du hast in der Grafik die Richtungen bei Subscribe und Publish nicht konsistent. In Konfig B sind die Pfeile zwischen MQTT Client und Broker falsch rum.
Außerdem würde ich nicht sagen, dass ein Topic eine Verzeichnisstruktur ist, sondern eher (natürlich nur ein Vorschlag)

Topics können zur Vereinfachung hierarchisch, ähnlich wie wie Verzeichnisstrukturen, aufgebaut sein. Die Hierarchien sind dabei nicht vorgegeben oder standardisiert. So kann es z.B. <Raum>/<Gerätetyp>/<Gerät>/<Attribut> (Wohnzimmer/Lichter/Deckenlicht/Verbindungsstatus) genau so genau so geben, wie <Gerätetyp>/<Raum>/<Gerät>/<...>
Tipp: Bei vielen Geräten kann man konfigurieren, wie sie ihre Informationen dem Broker mitteilen und wie die Topics strukturiert sein sollen. Eine einheitliche Struktur erleichtert die spätere Bearbeitung.

[hydrotec]

@asgothian

Vielen lieben Dank, das du dir die zeit genommen hast. Nach erstem Überfliegen bin ich echt begeistert.
Werde mir das morgen noch einmal in Ruhe ansehen, heute Abend ist mir leider was dazwischen gekommen.

@ostfrieseunterwegs sagte in [Doku] Themensammlung zu MQTT allgemein:

Du hast in der Grafik die Richtungen bei Subscribe und Publish nicht konsistent.

Da hast du vollkommen Recht. Hab die Pfeile einfach nur durchgeschleust.
Werde ich noch anpassen. Dankeschön für den Hinweis.
Deine Beschreibung zu den Topics werde ich mir morgen auch noch einmal zu Gemüte führen.

[Homoran]

@ostfrieseunterwegs sagte in [Doku] Themensammlung zu MQTT allgemein:

Außerdem würde ich nicht sagen, dass ein Topic eine Verzeichnisstruktur ist, sondern eher (natürlich nur ein Vorschlag)

ich hatte den Begriff "Datenpaket" vorgeschlagen