DE/Wiki FAQ

From Tinkerunity
Jump to: navigation, search
English Deutsch


Dies ist ein FAQ zum Wiki. Ein allgemeines Tinkerforge FAQ ist unter http://www.tinkerforge.com/de/doc/FAQ.html zu finden.

Allgemeines zum Wiki

Das Wiki besteht aus einem deutschsprachigen und einem englischsprachigen Teil. Um im Artikel-Namensraum eine Eindeutigkeit zu gewährleisten gibt es Konventionen wie Artikel benannt werden. So beginnt jeder Artikelname mit "DE/" oder "EN/", jenachdem ob er in Deutsch oder Englisch verfasst werden soll. Bei Projekt-Artikeln kommt zusätzlich "Projekte/" oder "Projects" hinzu. Leerzeichen werden durch Unterstriche ersetzt.

Beispiele:

EN/An_English_Wiki_Article
EN/Projects/An_English_Project
DE/Ein_Deutscher_Wiki_Artikel
DE/Projekte/Ein_Deutsches_Projekt

Wie erstelle ich einen Artikel?

Um einen Artikel zu erstellen ist einfach der Pfad zum Artikel aufzurufen. Anschließend erscheint eine Seite auf der der Artikel angelegt werden kann.

Wie das Wiki benutzt wird, können wir hier nicht erklären. Bitte siehe dazu in der Mediawiki Dokumentation nach, z.B. unter dem Thema Textgestaltung. Viele Infos kann man aber auch bekommen wenn man sich z.B. bestehende Artikel ansieht. Um den Code zu sehen klicke einfach auf Bearbeiten/Edit.

Jenachdem ob ein "normaler" Wiki-Artikel, eine Projekt Seite oder eine neue Kategorie angelegt werden soll, muss anderes vorgegangen werden. Nachfolgend kurze Howtos:



Wiki Artikel

Als Beispiel soll hier ein deutscher Wiki Artikel angelegt werden.

Seite anlegen

Rufe die URL deiner Seite im Browser auf

http://www.tinkerunity.org/wiki/index.php/DE/Mein_Artikel

und klicke auf Bearbeiten/Edit

Template einbinden

Jeder Wiki Artikel sollte als erstes das Page_Template einbinden. Dieses sorgt dafür, dass der Artikel in die richtige Kategorie (DE/EN) einsortiert wird und die Sprachumschaltung eingefügt wird.

{{Page_Template| lang = DE | site_en = My_Article | site_de = Mein_Artikel}}

In welche Sprachkategorie ein Artikel einsortiert wird legt "lang" fest. Trage dahinter "DE" für deutsche Artikel oder "EN" für englische Artikel ein. Der deutsche und englische Artikelname ist jeweils hinter "site_de" und "site_en" einzutragen. Hierbei ist "DE/" und "EN/" wegzulassen.

Inhalt schreiben

Für Wiki Artikel gibt es keine Vorlage welche Punkte enthalten sein sollen.


Speichern/Vorschau

Bevor man einen Artikel speichert, kann man sich eine Vorschau ansehen. Wichtig ist, dass man irgendwann speichert, da sonst die Änderungen verloren sind.




Projekt Artikel

Als Beispiel soll hier ein Projekt auf Deutsch dokumentiert werden. In dem Artikel wird als Programmiersprache Python verwendet.

Seite anlegen

Rufe die URL deiner Seite im Browser auf

http://www.tinkerunity.org/wiki/index.php/DE/Projekt/Mein_Projekt

und klicke auf Bearbeiten/Edit

Template einbinden

Jeder Projekt Artikel sollte als erstes das Project_Template einbinden. Dieses sorgt dafür, dass der Artikel in die richtige Kategorie (DE/EN) einsortiert wird und die Sprachumschaltung eingefügt wird.

{{Project_Template| lang = DE | prog_lang = Python | site_en = Deutscher_Projekt_Titel | site_de = English_Project_Title}}

In welche Sprachkategorie ein Artikel einsortiert wird legt "lang" fest. Trage dahinter "DE" für deutsche Artikel oder "EN" für englische Artikel ein. Unter "prog_lang" trage deine verwendete Programmiersprache ein. Möglichkeiten sind z.B. "C", "C++" oder "PHP" ein. Dies sorgt dafür, dass der Artikel in die jeweilige Programmiersprachen-Kategorie eingetragen wird. Existiert diese Kategorie noch nicht, so kann sie von dir angelegt werden (siehe unten). Verwendest du mehrere Programmiersprachen in deinem Projekt, so trenne diese mit ",". Also z.B. "C,C++". Der deutsche und englische Artikelname ist jeweils hinter "site_de" und "site_en" einzutragen. Hierbei ist "DE/" und "EN/" wegzulassen.

Inhalt schreiben

Für Projekt Artikel gibt es eine Struktur die eingehalten werden sollte. Wenn du noch keinen Artikel geschrieben hast, dann schaue dir z.B. dieses Beispielprojekt an. Natürlich kann diese Struktur angepasst werden. So können Teile weggelassen werden, wenn Sie nicht sinnvoll sind oder andere Teile hinzugefügt werden wenn sie benötigt werden.

Allgemeine Struktur:

== Beschreibung ==
* Kurze Beschreibung deines Projekts
* Was tut es?

== Benutzte Teile ==
* Was benötige ich um dieses Projekt nachzubauen? 
* Wo bekommt man diese her?

== Aufwand ==
* Wie lange benötigt man zum Nachbau (Schätzung)?
* Was sind die Schwierigkeiten?
* Sind besondere Fähigkeiten notwendig?

=== Hardware ===
* Beschreibung der Hardware
* Bilder des Aufbaus
<center>
<gallery widths=150px heights=150px perrow=4 caption="Deine Bilderbezeichnung">
File:Dein_Bild.jpg
File:Dein_Bild2.jpg
...
</gallery>
</center>


=== Software ===
* Beschreibung der Software
* Einbinden des Sourcecodes 
** direkt über source oder extern verlinkt
<source lang="python">
</source>


Bilder hinzufügen/hochladen

Eine Möglichkeit um Bilder hochzuladen ist, ein Link auf das spätere Bild zu erstellen:

  [[File:Project_Projectname_imagetitle.jpg

Nachdem die Seite gespeichert wurde kann auf den kaputten Link geklickt werden und das Bild hochgeladen werden. Anschließend sollte auf der Seite das Bild angezeigt werden. Sollen mehrere Bilder eingebettet werden empfielt sich eine Gallerie:

  <center>
  <gallery widths=150px heights=150px perrow=4 caption="Caption description here">
  File:project_projectname_imagetitle1.jpg
  File:project_projectname_imagetitle1.jpg
  ...
  </gallery>
  </center>

Es ist leider nicht möglich Bilder in der Gallerie direkt hochzuladen. Bitte benutze dafür die zuvor genannte Methode um zuerst alle Bilder mit den korrekten Dateinamen hochzuladen. Natürlich können auch andere Bildformate außer jpg verwendet werden.

Videos einbetten

Es können Videos gehostet auf Youtube, Vimeo oder anderen Seiten eingebettet werden. Hierfür ist die EmbedVideo Extension im Wiki installiert, siehe hier.

Syntax:

  {{#ev:service|id}}

Beispiele:

  {{#ev:youtube|youtube_video_id}}
  {{#ev:youtubehd|youtube_video_id}}
  {{#ev:vimeo|vimeo_video_id}}

Eine komplette Liste der unterstützen Services findet man im oben genannten Link.

Speichern/Vorschau

Bevor man einen Artikel speichert kann man sich eine Vorschau ansehen. Wichtig ist, dass man irgendwann speichert, da sonst die Änderungen verloren sind.

Neue Kategorie anlegen

Jede Kategorie besitzt auch eine eigene Seite im Wiki auf der die dazugehörigen Artikel angezeigt werden.

Seite anlegen

Rufe die URL deiner Seite im Browser auf

http://www.tinkerunity.org/wiki/index.php/Category:DE/Kategoriename

oder

http://www.tinkerunity.org/wiki/index.php/Category:EN/Categoryname

und klicke auf Bearbeiten/Edit

Template einbinden

Jede Kategorie sollte als erstes das Category_Template einbinden. Dieses sorgt dafür, dass Sprachumschaltung eingefügt wird.

{{Category_Template| lang = DE | site_en = Projects | site_de = Projekte}}

Ob die Kategorie im deutschen oder englischen Wikiteil eingetragen wird legt "lang" fest. Trage dahinter "DE" oder "EN" ein. Der deutsche und englische Kategoriename ist jeweils hinter "site_de" und "site_en" einzutragen. Hierbei ist "DE/" und "EN/" etc. wegzulassen.

Seite anlegen

Schreibe eine kurze Beschreibung der Kategorie.

Speichern/Vorschau

Bevor man einen Artikel speichert, kann man sich eine Vorschau ansehen. Wichtig ist, dass man irgendwann speichert, da sonst die Änderungen verloren sind.