FHEMWiki:Über FHEMWiki
Administratives zum und über FHEMWiki.
Administratives
Begrüßung neuer Mitschreiber
Begrüßungstext
|
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, muss die Einrichtung eines Benutzerkontos über E-Mail an einen der Administratoren beantragt werden.
Empfehlungen und Regeln
Mitschreiber und Überarbeiter sind gebeten, sich an die in den folgenden Abschnitten aufgeführten 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.
- 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 "=") sollten 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/sollten mit <code>Text</code> formatiert werden. Attribute für den Bereich können beispielsweise so spezifiziert werden: <pre style="width:50%;">
|
<nowiki>... </nowiki> | sollte nur dann verwendet werden, wenn der Text Wiki-Syntax enthält, die nicht aufgelöst werden soll (wie hier in den Formatierungsbeispielen). |
| [[Lemma]] | für die Verlinkung auf andere Fhem-Wikiseiten verwenden | [http://www.fhemwiki.de/wiki/Lemma]] | stellt einen unnötigen externen Link auf eine Wiki-interne Seite dar und sollte nicht benutzt werden. |
Strukturen und Konzepte
Die folgenden Strukturen und Konzepte haben sich bisher im FHEMWiki etabliert und sollten 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 (das Gerät XYZ) soll der prinzipielle Aufbau einer Wiki-Seite veranschaulicht werden:
| Quelltext | Darstellung | Bemerkungen |
|---|---|---|
'''Gerät XYZ''' ist ein...
|
Gerät XYZ ist ein... | Seitentitel (fett gedruckt) möglichst in einem einleitenden Satz / Abschnitt benutzen. |
|
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 | |
== Weblinks ==
|
Weblinks | Liste von Links auf externe Webseiten, Foren, etc. |
[[Kategorie:XYZ Gerät]]
|
Kategorie: XYZ Gerät | Kategorien werden gesammelt am Ende der Seite angezeigt |
Das Ganze noch einmal "am Stück" (als "Sourcecode") dargestellt:
'''Gerät XYZ''' ist ein... == Features / Funktionen == Die Haupteigenschaften von XYZ sind * a * b * c == Hinweise zum Betrieb mit Fhem == Um das Gerät von Fhem aus ansprechen zu können wird/werden benötigt... # Feuer, # Pfeife, # ... == Bekannte Probleme == Keine. == Weblinks == * Hersteller: [http://www.hersteller.de HerstellerName] [[Kategorie:XYZ Gerät]]
Auch die Gliederung (Einrückungen, Leerzeichen, Leerzeilen) sollten 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.
Noch "in Entwicklung" und noch nicht zur allgemeinen Verwendung freigegeben ist die Vorlage {{Infobox Hardware}} mit der eine einheitliche Infobox in allen Komponentenbeschreibungen erreicht werden soll. Bisher (Stand Anfang Oktober 2013) ist diese Vorlage in den Artikeln PCA301 und FS20 HGS zu Demonstrationszwecken und als Diskussionsgrundlage verwendet
Viele gute (und sicherlich auch ein paar schlechte) Beispiele sind in der Kategorie:Hardware und ihren Unterkategorien zu finden.
Kategoriestruktur / -konzept
FHEMWiki hat die im folgenden dargestellte Kategorienstruktur (mit Freeplane erstellte mindmap; gibt es bessere Darstellungsmöglichkeiten?). Die mit Ziffern markierten Kategorien treten unerwünschterweise mehrfach als Unterkategorie auf. Außerdem sind einige derzeit komplett leer oder enthalten nur einen Artikel / eine Unterkategorie. Auch diese Kategorien sollten umorganisiert bzw. sogar gelöscht werden.
Vorschläge:
- derzeitige Kategorie "Server Hardware" wird zur Unterkategorie von "Hardware" und heißt nur noch "Server". Alle Unterkategorien "wandern mit".
- Ergänzender Vorschlag: "Server" wird Unterkategorie von "Hardware Typen". Die jeweiligen Hersteller der Server bilden Unterkategorien von "Hardware Serien/Hardware Systeme.
- alle Unterkategorien von "Glossary" werden ersatzlos entfernt.
- Grundlegende Änderungen an der Struktur bitte nur nach entsprechender Diskussion.
- Unterteilung in zwei Hardware-Hauptkategorien mit jeweils einer Unterkategorieebene:
- 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: FHEM Server, Lichtsensoren, Feuchtesensoren, ...
- Keine Unterkategorie "sonstiges" da Aufgabe im Kategorienamen klar beschrieben sein muss
- Herstellerbezogene Hauptkategorie: 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, FritzBox, Raspberry Pi
- Sammlung von Einzelgeräten unter "andere Komponenten"
- Keine Unter-Unterkategorie um Übersichtlichkeit nicht erneut zu verlieren.
- Kein Eintrag von einzelnen HW-Modulen in die Hauptkategorie. Dies muss immer über eine Unterkategorie erfolgen.
- Aufgabenbezogene Hauptkategorie: Hardware Typen
- Vorschlag für weitere Hauptkategorien: FHEM Module, FHEM Konfiguration (Howtos, Code Snippets, FAQ), FHEM Development
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 Fhem-Wiki spezifischen (Format-)vorlagen (templates) sind bisher verfügbar:
| Titel | Syntax | Bemerkungen | Ref |
|---|---|---|---|
| Anker | {{Anker|Ankertext}} | Details: 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 sollte innerhalb der Seite nur einmal vorkommen. | hier |
| Baustelle | {{Baustelle}} | Fügt einen Rahmen mit dem angegebenen Text ein; stellt den Artikel in die Kategorie Baustelle ein | hier |
| Infobox Hardware | {{Infobox Hardware|Bild=...}} | Formatvorlage für die Beschreibung von Hardwarekomponenten | hier |
| Infobox Modul | {{Infobox Modul|Typ=...}} | Formatvorlage für die Beschreibung von (Hilfs-)Modulen | hier |
| Löschkandidat | {{Löschkandidat|Grund für die Löschung}} | Fügt einen Rahmen mit dem angegebenen Text ein; stellt den Artikel in die Kategorie Löschkandidaten ein; ein Administratore wird die Seite dann nach Prüfung des Löschantrags entfernen. | 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 |
| 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. | |
| 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: Hardware Artikel. Die Verwendung dieser Schablonen soll den einheitlichen Aufbau (Gliederung, Abfolge, etc.) von Artikeln über einen Themenbereich fördern.