FHEMWiki:Über FHEMWiki

Administratives

Administratives zum und über dieses Wiki.

Begrüßung neuer Mitschreiber

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

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

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

Administratoren

Einrichtung eines Benutzerkontos über Mail an einen der Administratoren...

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	Don't	...
Do	...	Don't	...

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.
'''== Gerät 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
== 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" 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:

1. derzeitige Kategorie "Server Hardware" wird zur Unterkategorie von "Hardware" und heißt nur noch "Server". Alle Unterkategorien "wandern mit".
2. alle Unterkategorien von "Glossary" werden ersatzlos entfernt.
3. Grundlegende Änderungen an der Struktur bitte nur nach entsprechender Diskussion.

Kategoriestruktur als Mindmap