FHEMWiki:Über FHEMWiki

Aus FHEMWiki
Wechseln zu: Navigation, Suche

Administratives zum und über FHEMWiki.


Emblem-question-yellow.svg Aktuelle Wiki-Baustellen

Änderungen im Wiki, die an den verlinkten Stellen diskutiert / angeregt wurden


Administratives

Begrüßung neuer Mitschreiber

Info green.png Begrüßungstext
  • Wünsche
  • Hinweis auf Administratives (also hierher)
  • Bitte um Einarbeitung in Wiki-Mitarbeit
  • Erste / nächste Schritte

Neu angemeldete Benutzer können mit in etwa folgendem Text auf ihrer Benutzer-Diskussionsseite begrüßt werden:

Ein solcher Text wird automatisch generiert durch Eintragung von {{subst:ph1959de/Hallo}} auf der Diskussionsseite des neuen Benutzers.

Administratoren

Zur Vermeidung von Spam und Vandalismus im Wiki gibt es generell keine Schreibberechtigung für anonyme Benutzer. Wer mitarbeiten will, muss die Einrichtung eines Benutzerkontos über E-Mail an einen der Administratoren beantragen.

Empfehlungen und Regeln

Mitschreiber und Überarbeiter sind gebeten, sich an die in den folgenden Abschnitten zusammengestellten Empfehlungen zu halten.

Erste Schritte / "Getting Started"

  • Lesen, lesen, lesen
  • bestehende Artikel ergänzen, verbessern, überarbeiten
  • neue Artikel anlegen, hierbei beachten:
    • Titel sorgfältig wählen; spätere Änderungen sind zwar möglich aber unnötiger Aufwand. Sollte doch einmal etwas falsch gelaufen sein, dann bitte nicht mit dem richtigen Titel eine neue Seite anlegen, sondern die falsch benannte verschieben (verbirgt sich unter "Mehr" oben neben dem Suchfeld).
    • Einordnen in die bestehende Kategorienstruktur
    • neuen Artikel - wo sinnvoll - in bestehenden Artikeln verlinken
    • Nicht jede kleine Änderung über "Seite speichern" kontrollieren, sondern mit "Vorschau zeigen" Zwischenschritte überprüfen
  • Nach und nach komplexere Dinge wie Vorlagen und spezielle Formatierungen (Tabellen, Divs, etc.) verwenden

Gewünschtes Verhalten / "Do and Don't"

Erwünscht ... damit... Unerwünscht ... weil
Vorschau verwenden damit die Änderungshistorie übersichtlich bleibt Experimente mit Seitentiteln führen zu Leichen, Waisen oder unnötigen Weiterleitungen
Diskussionen bitte auf den entsprechenden Seiten von Benutzern oder Artikeln führen = Ebene1 = Überschriften auf "Ebene 1" (ein "=") sollen im Wiki-Artikel nicht verwendet werden. Diese Ebene ist reserviert für den Artikel.
<pre>...</pre> benutzen, um "vorformatierten" Text (Code, .cfg-Ausschnitte, etc.) darzustellen. Alternativ kann auch jede Zeile mit einem Leerzeichen begonnen werden. Passagen im laufenden Text können/sollen mit <code>Text</code> formatiert werden. Attribute für den Bereich können beispielsweise so spezifiziert werden: <pre style="width:50%;"> (mit diesem Zusatz würde beispielsweise der Kasten um den vorformatierten Text nur die (linke) Hälfte der Seite einnehmen). <nowiki>... </nowiki> soll nur dann verwendet werden, wenn der Text Wiki-Syntax enthält, die nicht aufgelöst werden soll (wie hier in den Formatierungsbeispielen).
<source lang="...">...</source> benutzen, um Codebeispiele mit Syntaxhervorhebung darzustellen. Unterstützte Sprachen, die für FHEM relevant sein könnten sind z.B. bash, gnuplot, java, javascript, perl, php "Ich habe ...", "Man sollte..." ... sind als Formulierung selten sinnvoll. Die Beschreibungen sollen neutral formuliert (also nicht ich oder man) und präzise sein.
[[Lemma]] für die Verlinkung auf andere FHEM-Wikiseiten verwenden [http://wiki.fhem.de/wiki/Lemma] stellt einen unnötigen externen Link auf eine Wiki-interne Seite dar und soll nicht benutzt werden.
Lesbarer Quelltext Der Wiki-Quelltext soll soweit möglich lesbar sein und der "formatierten Version" entsprechen. Das betrifft insbesondere Leerzeilen. Allgemein sollen diese Wikipedia Richtlinien befolgt werden. HTML Tags ... sollen möglichst vermieden werden. So sollen z.B. neue Abschnitte nicht über <br (/)> Tags erzeugt/erzwungen werden. Meistens ist es möglich und empfohlen, einfach eine Leerzeile im Quelltext einzufügen (siehe auch hier).

Strukturen und Konzepte

Die folgenden Strukturen und Konzepte haben sich bisher im FHEMWiki etabliert und sollen im Allgemeinen eingehalten werden. Änderungen bitte nicht eigenmächtig vornehmen, sondern voher an entsprechender Stelle zur Diskussion stellen.

Artikelgliederung

In Anlehnung an die Gebräuche bei Wikipedia, sollen innerhalb eines Artikels nur die Gliederungsebenen "2" (==) und tiefer verwendet werden.

Beispiel: Neuer Artikel

Am Beispiel eines Artikels über ein Device bzw. Modul (das XYZ) soll der prinzipielle Aufbau einer Wiki-Seite veranschaulicht werden:

Quelltext Darstellung Bemerkungen
{{Infobox Hardware|...}} oder {{Infobox Modul|...}} Infobox, am rechten Seitenrand dargestellt Formatierte Tabelle mit spezifischen Daten; Beispiele: Module, Geräte
[[XYZ]] ist ein... XYZ ist ein... Seitentitel als Intra-Wiki-Link (wird dadurch fett gedruckt) möglichst in einem einleitenden Satz / Abschnitt benutzen.
'''== XYZ ==''' ist ein...   Seitentitel nicht als erste Überschrift wiederholen!
== Features / Funktionen ... == Features / Funktionen Überschrift, Ebene 2 (siehe Hilfe)
== Hinweise zum Betrieb mit FHEM == Hinweise zum Betrieb mit FHEM  
== Bekannte Probleme == Bekannte Probleme  
== Links == Weblinks Liste von Links auf externe Webseiten, Foren, etc.
[[Kategorie:XYZ Gerät]] Kategorie: XYZ Gerät (Unterkategorie von Kategorie:Hardware) Kategorien werden gesammelt am Ende der Seite angezeigt; Bei Verwendung der Vorlage "Infobox Modul" wird automatisch der jeweils richtige Kategorieeintrag erzeugt.

Das Ganze noch einmal "am Stück" (als "Sourcecode") dargestellt:

{{Infobox Hardware|...}} oder {{Infobox Modul|...}}
[[XYZ]] ist ein... 

== Features / Funktionen ==
Die Haupteigenschaften von XYZ sind
* a
* ...

== Hinweise zum Betrieb mit FHEM ==
Falls es besondere Einschränkungen / Voraussetzungen, etc. gibt...
# ...
# ...

== Bekannte Probleme ==
Keine (oder Liste der bekannten Probleme / Einschränkungen).

== Weblinks ==
* Erläuterung [http://www.xyz.de Linktitel]

[[Kategorie:XYZ Gerät]]

Auch die Gliederung (Einrückungen, Leerzeichen, Leerzeilen) sollen so oder ähnlich beibehalten werden, um auch Anderen die Arbeit im Quelltext zu erleichtern. Die aufgeführten Überschriften sollten enthalten sein, weitere können bei Bedarf natürlich eingefügt werden.

Kopiervorlagen für Seiten zu Geräten finden sich in der Dokumentation zur Vorlage {{Infobox Hardware}} mit der eine einheitliche Infobox in allen Komponentenbeschreibungen erreicht werden soll. Analog dazu gibt es die Vorlage {{Infobox Modul}} für FHEM Befehle und Module.

Viele gute (und sicherlich auch ein paar schlechte) Beispiele sind in der Kategorie:Hardware und ihren Unterkategorien zu finden.

Kategoriestruktur / -konzept

Kategoriestruktur als "Mindmap"

FHEMWiki hat die im Mindmap dargestellte Kategorienstruktur (Unterkategorien zu Hardware Typen sind der Übersichtlichkeit halber nicht vollständig erfasst). Bitte Artikel sinnvoll in bereits vorhandene Kategorie(n) einordnen. Neue Unterkategorien nur nach gründlicher Überlegung anlegen und gegebenenfalls zur Diskussion stellen. Bei Hardware bitte die Besonderheit beachten, dass regelmäßig die Aufnahme in 2 Kategorien zu erfolgen hat: in die hersteller-/protokollbezogene Hauptkategorie Kategorie:Hardware sowie die aufgabenbezogene Hauptkategorie Kategorie:Hardware Typen

Weitergehende Hinweise zur Kategorienstruktur:

  1. Grundlegende Änderungen an der Struktur (bspw. Neuanlage Hauptkategorien, Verschieben Unterkategorien,..) bitte nur nach entsprechender Diskussion
  2. Unterteilung in zwei Hardware-Hauptkategorien mit jeweils einer Unterkategorieebene:
    1. Aufgabenbezogene Hauptkategorie: "Hardware Typen"
      • Gedacht für Benutzer, die sich einen Überblick über die Aufgaben verschaffen wollen, die von FHEM verwaltet werden können.
      • Beispiele für Unterkategorien: Lichtsensoren, Feuchtesensoren, ...
      • Keine Unterkategorie "sonstiges" da Aufgabe im Kategorienamen klar beschrieben sein muss
    2. Herstellerbezogene Hauptkategorie: "Hardware" (aus historischen Gründen "Hardware" und nicht die treffendere Bezeichnung "Hardware Serien / Hardware Systeme")
      • Gedacht für Benutzer, die wissen wollen, welche Module innerhalb einer Serie existieren bzw. in FHEM integriert sind.
      • Beispiele für Unterkategorien: FS20, HMS, Homematic, ...
      • Sammlung von Einzelgeräten unter "Kategorie:Other Components"
    • Keine neuen Unter-Unterkategorien um Übersichtlichkeit nicht zu verlieren.
    • Kein Eintrag von einzelnen HW-Modulen in die Hauptkategorie. Dies soll immer über eine Unterkategorie erfolgen.
  3. keine Unterkategorien zu Kategorie:Glossary anlegen!
  4. Neue Kategorien bitte im Mindmap dokumentieren (Dateivorlage)

Vorlagen und Schablonen

Im Folgenden werden die Vorlagen (Wiki templates), Schablonen (Kopierbeispiele) und Muster aufgeführt, die in diesem Wiki zur Verfügung stehen.

Vorlagen

Die folgenden FHEMWiki spezifischen (Format-)vorlagen (templates) sind bisher verfügbar:

Titel Syntax Bemerkungen Ref
Anker {{Anker|Ankertext}} Fügt an der aktuellen Stelle im Artikel eine Sprungmarke ein, auf die mit [[Artikel#Ankertext]] referiert werden kann, wie sonst auf eine Überschrift. Ankertext darf innerhalb der Seite nur einmal vorkommen. hier
Baustelle {{Baustelle}} Fügt einen Rahmen mit einem fest vorgegebenen Text ein; stellt den Artikel in die Kategorie Baustelle ein hier
DocLink {{DocLink|#1|#2}} Generiert einen Link auf z.B. ELV Dokumente (zur Erleichterung der Anpassung an URL-Änderungen, wie im Mai/Juni 2015 bei ELV geschehen). Die Vorlage ist (Stand 08/2015) noch in Entwicklung und nur für ELV-Links verwendbar. hier
Infobox Hardware {{Infobox Hardware|Bild=...}} Formatvorlage für die Beschreibung von Hardwarekomponenten (Geräten). hier
Hinweis {{Hinweis|Text...}} fügt (in voller Seiten- oder Spaltenbreite) einen Rahmen mit Text ein hier
Infobox Modul {{Infobox Modul|Typ=...}} Formatvorlage für die Beschreibung von Modulen, Hilfsmodulen, Befehlen und inoffiziellen Modulen hier
Löschkandidat {{Löschkandidat|Grund für die Löschung}} Fügt einen Rahmen mit dem angegebenen Text ein; stellt den Artikel oder die Datei in die Kategorie Löschkandidaten ein; ein Administrator wird die Seite oder die Datei dann nach Prüfung des Löschantrags entfernen oder den Löschantrag zurückweisen. hier
Link2Forum {{Link2Forum|Area= |Topic= |Message= |LinkText= }} Erzeugt einen Link auf einen Bereich (Area), ein Thema (Topic) oder einen Beitrag (Message) im FHEM Forum. Thema und Beitrag werden mit numerischen Werten spezifiziert, mit dem Parameter LinkText= kann ein alternativer Text für den Link angegeben werden. hier
Link2FU {{Link2FU|user#|userName}} Erzeugt einen Link auf die Profilseite eines Benutzers im FHEM Forum. Parameter user# ist die Nummer des Benutzers im Forum; dieser Parameter muss angegeben werden. Optional kann der Benutzername angegeben werden. hier
Randnotiz {{Randnotiz|RNTyp=[g|Info|y|Warn|r|Fehl]|RNText=Text}} fügt einen Rahmen mit Text ein; mögliche Typen: Info (g(reen)), Warn (y(ellow)), Fehl (r(ed)) mit jeweils unterschiedlicher Hintergrundfarbe hier
stub {{stub}} Fügt einen Textrahmen ein und stellt den Artikel in die Kategorie NeedsEditing ein hier
Taste {{Taste|Text}} Formatiert den spezifizierten Text wie eine Taste hier
Todo {{Todo|was muss noch getan werden...}} Fügt einen Rahmen mit dem angegebenen Text ein; stellt den Artikel in die Kategorie NeedsEditing ein hier
       
Hallo {{subst:ph1959de/Hallo}} Begrüßung für neue Wiki-Benutzer; (derzeit noch) im privaten Namensraum, kann aber von anderen Benutzern so verwendet werden, da es mit dem Speichern der Seite in den endgültigen Text aufgelöst wird. Muss auf der Diskussionsseite des Benutzers eingetragen werden, der begrüßt werden soll.  
Vorschau {{subst:ph1959de/Vorschau}} Bitte um Benutzung der Vorschaufunktion; (derzeit noch) im privaten Namensraum, kann aber von anderen Benutzern so verwendet werden, da es mit dem Speichern der Seite in den endgültigen Text aufgelöst wird. Muss auf der Diskussionsseite des Benutzers eingetragen werden, der an die Benutzung der Vorschaufunktion erinnert werden soll.  
Mit *xxx* gekennzeichnete Vorlagen existieren derzeit noch nicht

Schablonen

Hier bitte Formatierungsbeispiele für bestimmte Anwendungssituationen einfügen (z. B.: wie binde ich Bilder ein, wie erzeuge ich Tabellen, Listen, usw.).

Viele Anregungen, Anleitungen, Regeln, Empfehlungen können auch aus der Wikipedia Hilfe übernommen werden.

Neue Seite(n)

Kopiervorlagen für neue Seiten. Beispiel: Neuer Artikel. Die Verwendung dieser Schablonen soll den einheitlichen Aufbau (Gliederung, Abfolge, etc.) von Artikeln über einen Themenbereich fördern.

Spezielle Kopiervorlagen finden sich auch in der Dokumentation zu einigen Formatvorlagen:

  • Infobox Hardware
  • Infobox Modul