Last modified 9 years ago Last modified on 10/27/08 11:07:11

Schema für Hardware Informationen im Wiki

Methode

Methode zur Abbildung unserer Hardware Datenbank und Informationssammlung.

Die beiden wichtigsten Werkzeuge hierfür sind:

  • Wiki Seiten als eine Art Datenblatt (nach einem bestimmtem Schema benannt)

  • Tags um Metainformation zu den Datenblättern abbilden zu können.

Benennung der Wiki Seiten

Einzelne Bauteile sind als eigene Wiki Page abgelegt. Der Seitenname folgt dabei einem speziellen Schema und sollte sich an folgendes halten:

Gruppe Bauteil Details

Wobei

  • Gruppe
    • Beispiel: Motor, Controller, Spoke, etc.
    • Die Gruppen werden im Wiki Index abgebildet.
    • Für viele Gruppen existieren PageTemplates.
  • Bauteil
    • Konkrete Bauteil Bezeichnung
    • Beispiel: Crystalyte 20A, Nine Continent 17A, P75S75
    • Hersteller Name ist optional
  • Detail (optional)
    • Versionsnummern, Spannungs-/Leistungs- Angaben, Längen

Um Seiten auch ohne CamelCase im Titel anlegen zu können ist folgende Schreibweise möglich:

 * [wiki:"Motor Crystalyte 408 HR"]

Ergebnis und gutes Beispiel:


Hilfe zu Tags

Jede Wiki Seite die ein Bauteil darstellt wird mittels Tags mit Metainformationen versehen. Die Möglichkeiten hiervon sind vielseitig.

  • Referenzieren von bestimmten Gruppen von Daten in Datenblättern und Wiki Seiten. Bsp:

Auf der Wiki Seite (Datenblatt) zu dem Motor Crystalyte 408 wird eine Liste weiterer Motoren mit eingebaut:

== Weitere Motoren ==

[[ListTaggedSimple(hardware motor)]]
  • Alle Tags können beim editieren einer Wiki Seite rechts unten mit Lehrzeichen getrennt angegeben werden.
  • Tags sind generell Case Sensitiv.

Beispiele für Tags

  • Bauteilgruppe
    • Siehe Gruppen für die Wiki Seiten oben.
  • Anwendungsgebiet
  • Technische Daten (12V, 100mmAchse)
  • Datenblatt Status (datenblatt, create, check) su.
  • Seit kreativ, alle Metainfo die ein Bauteil mit anderen verbindet bzw. von den anderen abtrennt ist wichtig.
  • Kontrolliert ob evtl. schon vorhandene Tags passen können und erweitert schon vorhandene Wiki Seiten.

Bilder und Technische Zeichnungen

Ein Standards um Bilder zu handhaben:

  • Hardware Bild im Datenblatt
    750px horizontal, keep aspect, 40% scale, kein link
    
  • Technische Zeichnungen
    original format, 30% scale, link
    
  • Platinen Bilder
    1500px horizontal, keep aspect, 30% scale, link
    
  • Bilder bitte immer mit Quellen im Kommentar hochladen. Beispiel:
    Bild Beschreibung - (Quelle: Name oder URL)
    

Sprache

Eine Internationalisierung dieser Seite ist geplant aber technisch noch nicht umgesetzt. Solange ein paar Anhaltspunkte:

  • Amtssprache ist erstmal Deutsch
  • Die Wiki Seiten Namen bitte in Englisch halten (Speichen 116mm) ist schon mal ein schlechtes Beispiel.
  • tags bitte auch tendenziell auf Englisch setzen. Deutsch ist hier allerdings eher möglich als bei den Wiki Seiten Namen.
  • Bild Datei Namen sind in Deutsch und Englisch möglich.

DDN: #Fnord-B4by10n


Hardware Datenblatt Status

Alle Datenblätter sind mit einem Status markiert.

Status: Dieses Datenblatt befindet sich im Aufbau.

  • Neues Datenblatt
  • Garnicht oder Teilweise ausgefüllt.

Status: Dieses Datenblatt muss Überarbeitet werden.

  • Details, Bild fehlen
  • Muss noch geprüft werden.
  • Request for Comment

Status: Dieses Datenblatt ist Vollständig.

  • Angaben zu Werten sind Vollständig und geprüft.
  • Ein Bild ist vorhanden.
  • optional, Zusatzinformation, Erfahrungsbericht, Discussion, Technische Zeichnung

Status: Zu diesem Eintrag benoetigen wir noch Daten.

  • Information Wanted!
  • Extras, Sonstiges, Toys

Zu jedem Status wird ein entsprechendes Tag geschrieben:

  • Datenblatt ist Vollständig (Grün) - 'datenblatt'
  • Datenblatt muss Überarbeitet werden (Gelb) - 'datenblatt check'
  • Datenblatt befindet sich im Aufbau (Rot) - 'datenblatt create'

Die Arbeit an der Datenbank gibt es dann auf einem Blick: HardwareDatenbankStatus