Parametererklärungen für die SF Doku

[Chris M.]

Wer muss denn da was nachvollziehen?

Ich
Ich bekomme die Info, dass es ein Seiten-Update gab per Mail. Und je nach Text in der Mail überlege ich mir das Ergebnis anzusehen oder auf später zu verschieben...

Ich weiss schon was du meinst aber manchmal braucht es mehr Zeit einen Kommentar zu schreiben, als z.B. einen kleinen Fehler zu beheben.

Ja, das ist mir klar. Bei Trivialitäten muss der Kommentar auch nicht lange sein, ein "Typo" bei korrigierter Rechtschreibung ist z.B. absolut ausreichend.

Was dem Entwickler die fehlende Doku ist dem Editor das fehlende Changelog

Ne, dass kann ich nicht stehen lassen. Ein Entwickler ist auch angehalten die Änderungen beim Hochladen in's SVN mit einem sinnvollen Kommentar zu versehen.

Der Unterschied ist der, dass ein Entwickler das so lange ignoriert, biss er mal suchen muss, ab welcher Version sich ein Bug eingeschlichen hat und sich dann fürchterlich ärgert in dem Saustall nicht schnell zu finden, was er sucht. Ab dann geht's meistens wie von selbst. Code kommentieren ist ähnlich...

Daher nochmal die Frage: gibt es nicht irgendein nettes System a la doxygen o.ä. das man dafür verwenden könnte, um inline zu dokumentieren? (hier wäre aber eher Erfahrung damit gefragt, weniger es zu ergooglen..)

Ergoogelt habe ich mir (aber inzwischen wieder vergessen...) dass es wohl eine relative Standard-Möglichkeit gibt. Und was noch viel wichtiger ist, dadurch lassen sich die Ein- und Ausgänge der Funktionen so beschreiben, dass man auch ein JS-Minify für die großen Jungs drüber laufen lassen kann, da es plötzlich versteht was es macht und so viel aggressiver loslegen kann.

Reale Erfahrung wäre da schön...

[greentux]

Ja, was soll ich sagen. Wir dokumentieren damit in der Firma jeglichen Code. Es ist eine recht schnelle Einarbeitung nötig, aber dann sind die Vorteile sichtbar.
Festgehalten werden dort primär Funktionsbeschreibungen, Parameter, security impacts etc. Die Userdoku entsteht dann weiterhin extern. Als Input ist der Doxygen Inhalt aber durchaus nützlich.

[makki]

War Doku nicht die Sache für die Mädchen, die den Source nicht lesen wollen
Nee, im Ernst, ich denke die CV ist besser als 90% was da sonst so am Markt rumfleucht, was ich kenne..
Aber daran, verständliche Doku, mangelte es noch

Daher nochmal die Frage: gibt es nicht irgendein nettes System a la doxygen o.ä. das man dafür verwenden könnte, um inline zu dokumentieren? (hier wäre aber eher Erfahrung damit gefragt, weniger es zu ergooglen..)
Im finalen kann man das ja rausmachen (jsmin&Co) damit der wesentliche Vorteil: schlank - bleibt.

Makki

[greentux]

Was dem Entwickler die fehlende Doku ist dem Editor das fehlende Changelog

[swiss]

Wer muss denn da was nachvollziehen? Ich weiss schon was du meinst aber manchmal braucht es mehr Zeit einen Kommentar zu schreiben, als z.B. einen kleinen Fehler zu beheben.

[Chris M.]

Hallo liebe SF Wiki Editoren,

könnt ihr bitte bei den Änderungen immer auch einen kurzen (prägnanten...) Text unter "Zusammenfassung:" mit einfügen?

So lassen sich später die Änderungen viel besser nachvollziehen.

[swiss]

Stimmt. Ich werde das gleich korrigieren. Danke

[Peter]

Tabelle Format Befehle

Hallo in der Tabelle für die Format Befehle ist ein Fehler.
Der Punkt ist verschoben.
Statt %0.f muss %.0f stehen.
SourceForge.net: Format - Open Automation

Gruß Peter

[makki]

image_url in gweather:
Ist Defaultmässig intern Google wenn man es NICHT angibt; die Idee war, das jemand dem die Icons von Google nicht gefallen oder whatever, eine URL zu einem lokalen Icon-Set angeben könnte (wo dann natürlich alle möglichen wie bei google auch liegen müssen)

Makki

[vento66]

nee, das Wettersymbol wird ja angezeigt, aber makki ist ja auch schon erwacht, und der hat das schliesslich verbrochen

[swiss]

Warscheinlich ist das wie ein kameraobjekt beim HS. Da muss einfach die URL zum Wettersymblo eingetragen werden. Dann erscheint je nach Wetterlage z.B. das Sonne oder Regen Symbol.

[vento66]

Für was steht eigentlich img_url im Wetter widget?

[Chris M.]

Da zum flavour noch nichts steht und das anscheinend nicht so offensichtlich ist wie von mir erwartet:

In der http://wiregate/visu/?config=demo sieht man ganz gut die Möglichkeiten der flavours wenn man (im Design Pure!) auf die Sub-Seite "Flavour Test" geht. Dort gibt es eine ganze Latte an weiteren Sub-Seiten die die jeweiligen Flavours zeigen.

Ein Flavour (= Geschmacksrichtung) ist dementsprechend ein "Sub-Design", d.h. es lässt seitenindividuelle Anpassungen zu den bekannten Designs Pure, Discreet, Alaska, ... zu.
Bei Pure werden die Farben der horizontalen Linien und die Farbe der Sub-Seiten-Link angepasst.

So kann man z.B. Widgets themenartig zusammenfassen. Alles was die Sicherheit angeht auf Seiten mit Lithium-Flavour. Der Garten bekommt ein Boron-Flavour. Und die Wasserversorgung ein Antimony-Flavour. Etc. pp.

Wer sich jetzt über die "seltsammen" Namen wundert:
Da das ganze ja CometVisu heißt, liegt natürlich die Assoziation zu Kometen nahe.
Das Pure-Design möchte, wie es der Name schon sagt, ein möglichst reines und einfaches Design sein, das durch Reduktion edel wirkt.
Also ist es schwarz wie das Weltall und die Farben sollen glühen - folglich sind die Farben von den Flammfärbungen einzelner chemischer Elemente abgeleitet...

[swiss]

Das Handbuch nimmt langsam Formen an Danke für die Beiträge Info, Mapping und Styling. Langsam kommen wir dem Ziel näher


Ich sehe gerade dass toggle noch garnicht erwähnt wurde (in der Widgetübersicht). Für was ist dieses Widget gut? Bzw. Was kann Toggle was man nicht mit switch oder trigger abbilden könnte?

[Chris M.]

Ja, ich hatte mich auch auf das Info-Widget bezogen.

Grundsätzlich sorgt Styling dafür dass abhängig vom anzuzeigenden Wert das Desgin der Darstellung leicht modifiziert wird, wie beispielsweise den Text rot oder grün darzustellen.

Das Mapping dagen ändert den Inhalt der Darstellung. Also statt 0/1 wird z.B. Aus/An angezeigt.

In der Widget-Demo unter Betriebsart wird (wie man ja gut im Editor sehen kann) das Mapping "KonnexHVAC" (passend zum DPT20.102) verwendet, so dass der Wert vom Multitrigger daneben auch richtig angezeigt wird.