[Doku] Themensammlung zu MQTT allgemein
-
@hydrotec sagte in [Doku] Themensammlung zu MQTT allgemein:
hab ich sie in der Grafik so belassen, wie sie allgemein gebräuchlich sind.
ist ja korrekt, da wo sie sind sollen sie ja auch so bleiben.
Mein Vorschlag war den "freien" Platz in der Grafik für eine Legende/Glossar zu nutzen@hydrotec sagte in [Doku] Themensammlung zu MQTT allgemein:
Weiter unten in der Beschreibung, sind Erläuterungen enthalten, was diese Begriffe bedeuten.
hab ich gesehen und auch erwähnt. aber.....
ich hatte das Bild angeklickt, das geht in einem zweiten Tab/Fenster auf und da kann man den Chart viel besser sehen (was er verdient hat!). Da dacht eich nur, es wäre schön jetzt auch die drei Befgriffe noch erklärt zu haben.@hydrotec sagte in [Doku] Themensammlung zu MQTT allgemein:
Wieso es jedesmal zu einem Zeilenumbruch kommt ...
Den hab ich, wie in dem Style Guide gefordert, nach 80 Zeichen eingefügt.
Auszug Style GuideDokumente sollen einen Zeilenumbruch bei 80 Zeichen haben.
Es ist echt schwer, das umzusetzen, ohne das der Lesefluss gestört wird.
ich weiss. Das habe ich ja verstanden,
Der Hintergrund ist, dass im RAW Modus auch der Inhalt noch lesbar bleiben soll und nicht 280Zeichen je Zeile enthält.
Üblicherweise bedeutet bei MD ein einfacher Zeilenumbruch im RAW, dass er im endgültigen Zusatnd nicht zu sehen ist.
Dafür bedarf es einen doppelten Zeilenumbruch im RAW.
Den hast du nicht.Das hatte ich als Info für @Asgothian gedacht
-
@homoran sagte in [Doku] Themensammlung zu MQTT allgemein:
schön jetzt auch die drei Befgriffe noch erklärt zu haben.
In der Zwischenzeit hatte ich die Grafik noch einmal angepasst.
Jetzt habe ich keinen Platz mehr.
Ich werd mir das noch einmal ansehen, vielleicht fällt mir noch was anderes ein.@homoran sagte in [Doku] Themensammlung zu MQTT allgemein:
Der Hintergrund ist, dass im RAW Modus auch der Inhalt noch lesbar bleiben soll und nicht 280Zeichen je Zeile enthält.
Das kann ich auch verstehen, doch warum nur 80 Zeichen, ich find das schon etwas wenig.
Und wenn ich mir die ein oder andere Seite auf GitHub ansehe, da werden durchaus mehr Zeichen pro Zeile verwendet.
Deswegen wundert mich das etwas, und ich möchte es auch nicht einfach nur ignorieren.
Schließlich handelt es sich ja um eine offizielle Dokumentation.EDIT:
Wieviele Zeichen sind denn in der offiziellen Doku mmöglich, bevor ein automatischer Zeilenumbruch stattfindet.
Weiss das zufällig jemand? -
@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?
-
@homoran sagte in [Doku] Themensammlung zu MQTT allgemein:
Arbeitest du mit Apfeln?
Nein, mit Fenster.
Bzw. direkt auf GitHub.
-
@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
-
Spätestens nach 80 Zeichen in einer Zeile setze ich doppeltes Leerzeichen für den Zeilenumbruch.
-
@hydrotec sagte in [Doku] Themensammlung zu MQTT allgemein:
setze ich doppeltes Leerzeichen für den Zeilenumbruch.
das ist der Fehler!
einfach <ENTER>
-
OK, verstanden.
Dann habe ich wohl den Hinweis in der Style Dokumentation missverstanden.
Werde alles noch einmal umformatieren.
Geht ja schnell -
@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.
-
@asgothian sagte in [Doku] Themensammlung zu MQTT allgemein:
Mach ich, aber erst heute Abend.
Wie du Zeit hast, Danke
-
@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 -
@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. -
@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.
-
@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.
-
@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. -
@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
-
@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
-
@asgothian sagte in [Doku] Themensammlung zu MQTT allgemein:
Ich werd es versuchen
Danke!
Sonst hab ich wieder die Arbeit alles downwardkompatibel zu reverten
-
@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.
-
@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.
