Dokumentation global: longtitude, latitude und altitude

Begonnen von Christoph Morrison, 16 Januar 2019, 20:39:39

Vorheriges Thema - Nächstes Thema

Christoph Morrison

Hallo,

ich habe zwei Patches für die (bisher fehlende?) Doku zu den drei Attributen longitude, latitude und altitude für global gemacht.

commandref_frame.html
commandref_frame_DE.html

Ich habe die Doku mit commandref_join.pl lokal gebaut und sie sah gut aus.

rudolfkoenig

Einer dieser Patches, die man lieber nicht angeschaut haette :)

- longitude/latitude ist in SUNRISE_EL dokumentiert. Es gehoert nicht hierher (da hast Du recht), es wurde aber hier zum erstenmal verwendet. altitude ist hier auch drin, wird aber vom Modul nicht verwendet. Und die Formatierung der deutschen Version verwendet extrem viele komische Tags. Habe ich jetzt alles bereinigt, Attribute durch links ersetzt, Tags entfernt.

- NHN habe ich weggelassen, weil wir das Schwerefeld der Erde nicht beruecksichtigen. MAMSL sagt mir nichts, ich kenne nur MSL, das habe ich aber auch mit weggelassen. Hoffentlich verwenden die Module I2C_BMP180,I2C_BME280 und feels_like altitude richtig, meine Module verwenden das nicht.

- bitte in der Doku kein UTF-8.

- bitte in der Zukunft Patches direkt anhaengen, ich will die Daten auch noch haben, nachdem bitbucket Geschichte ist.

Christoph Morrison

Zitat von: rudolfkoenig am 17 Januar 2019, 20:50:58
Einer dieser Patches, die man lieber nicht angeschaut haette :)

Gern geschehen. Ging mir übrigens mit der tag soup in der Commandref auch so, aber ich finde Patches halt besser als Kopfschütteln oder Sarkasmus. Musst sie ja nicht nehmen, ne?  :)

Zitat von: rudolfkoenig am 17 Januar 2019, 20:50:58
- longitude/latitude ist in SUNRISE_EL dokumentiert. Es gehoert nicht hierher (da hast Du recht), es wurde aber hier zum erstenmal verwendet. altitude ist hier auch drin, wird aber vom Modul nicht verwendet. Und die Formatierung der deutschen Version verwendet extrem viele komische Tags. Habe ich jetzt alles bereinigt, Attribute durch links ersetzt, Tags entfernt.

Meinst du mit "komische Tags" dass darauf Wert gelegt wurde, valides HTML zu schreiben, das keine Vergewaltigung der intendierten Semantik darstellt? Zum Beispiel Variablen als Variablen markiert? Oder gar richtige Absätze anstelle von br-Elementen?

Zitat von: rudolfkoenig am 17 Januar 2019, 20:50:58
- NHN habe ich weggelassen, weil wir das Schwerefeld der Erde nicht beruecksichtigen. MAMSL sagt mir nichts, ich kenne nur MSL, das habe ich aber auch mit weggelassen. Hoffentlich verwenden die Module I2C_BMP180,I2C_BME280 und feels_like altitude richtig, meine Module verwenden das nicht.

MAMSL (meteres above mean sea level) ist das, was ein Englischsprecher erwarten würde, wenn man im Deutschen von NHN spricht. Und für Englischsprecher ist die englische Doku doch, oder habe ich das falsch verstanden?

Mag ja sein dass du das Schwerefeld der Erde nicht berücksichtigen willst, allerdings ist NHN seit 1993 in Deutschland (und Resteuropa, unter anderem Namen) der Standard, den du auch z.B. mit dem Kompass eines Smartphones bekommen, auf Karten oder Hinweisschildern lesen wirst. D.h. ein 10m NHN ist überall in Europa identisch, während sich der alte NN davon unterschied und überall NHN benutzt wird, u.a. auch im GPS.

Zitat von: rudolfkoenig am 17 Januar 2019, 20:50:58
- bitte in der Doku kein UTF-8.

Warum lieferst du die Commandref dann als UTF-8 aus bzw. sagst dem Browser dass er es als UTF-8 behandeln soll wenn kein UTF-8 in der Doku sein soll?
<meta http-equiv="Content-type" content="text/html; charset=UTF-8">
Wäre ja auch eigentlich besser als echter Header aufgehoben, so muss der Browser erstmal raten was er da bekommt bis er zum Meta-Element vorgedrungen ist. Eine BOM ist ja auch nicht dran ...

Achso, aus dem svn bekam ich übrigens folgendes:

$ file commandref_frame_DE.html
commandref_frame_DE.html: HTML document text, UTF-8 Unicode text


Also kein UTF-8 in ein UTF-8-Dokument?

Zitat von: rudolfkoenig am 17 Januar 2019, 20:50:58
- bitte in der Zukunft Patches direkt anhaengen, ich will die Daten auch noch haben, nachdem bitbucket Geschichte ist.

Keine Ahnung warum du einen Patch, den du mit dem nächste Commit ins Subversion dort im Commit-Log haben wirst, glaubst noch auf Bitbucket zu brauchen ... aber klar, gerne, wird ganz sicher nicht mehr vorkommen.

betateilchen

Zitat von: Christoph Morrison am 17 Januar 2019, 21:43:45
Meinst du mit "komische Tags" dass darauf Wert gelegt wurde, valides HTML zu schreiben, das keine Vergewaltigung der intendierten Semantik darstellt? Zum Beispiel Variablen als Variablen markiert? Oder gar richtige Absätze anstelle von br-Elementen?

Ich denke, es ging Rudi weniger um "valides HTML"  als darum, sich an die Konventionen für die commandref zu halten, insbesondere daran, welche HTML tags überhaupt für die commandref "erlaubt" sind und welche nicht.

Je mehr tags in der commandref auftauchen, umso komplizierter wird ihre Darstellung in FHEM. Insbesondere, wenn man die Texte nicht in einem Browser anschaut, sondern z.B. in einer telnet Session durch Aufrufen von "help"
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!