RN-Wissen.de:Editierhilfe: Unterschied zwischen den Versionen

Aktuelle Version vom 19. Oktober 2006, 11:02 Uhr

Diese Seite erklärt, wie du eine RN-WIKI Seite gestalten kannst. Die wichtigsten Formatierungsmöglichkeiten werden auf dieser Seite aufgelistet, du solltest diese Seite unbedingt öfters lesen oder auch ausdrucken. Weitergehende Möglichkeiten werden in der Hilfe beschrieben.

Generell kann man WIKI Texte erstmal wie ganz normale Texte in einem Editor oder Textverarbeitung eingeben. Nur zum hervorheben von Überschriften, dem verlinken von Seiten oder Gestaltung von Tabellen etc. bedarf es einigen Besonderheiten die hier beschrieben werden.

Wie man Überschriften kennzeichnet

Die Überschriften innerhalb einer Wiki-Seite sind besonders wichtig, da sie bei umfangreichen Seiten auch für ein automatische Inhaltsverzeichnis genutzt werden. Im Editierfenster sollte man Überschriften durch Gleichheitszeichen Kennzeichnen.

Also so:

== Neuer Abschnitt ==
=== Unterabschnitt ===
==== Unter-Unterabschnitt ====

Das ganze sieht später so aus:

Fett und kursiv schreiben

Um einzelne Wörter und Passagen hervorzuheben kann man fette oder kursive Schrift nutzen Im Editierfenster gibt man dazu folgendes ein:

''Kursiv''
'''fett'''
''das kursiv''
'''''kursiv und fett'''''

Das ganze sieht dass später so aus:

Zeilenumbruch und Absätze

Ein einzelner Zeilenumbruch
wird ignoriert.

Aber durch eine leere Zeile wird ein neuer
Absatz erzeugt.

Man kann aber einen Zeilenumbruch durch<br/>erzwingen.

Das ganze sieht dass später so aus:

Listen für Aufzählungen erzeugen

* Listen sind praktisch:
** sie sorgen für Struktur
** sie sehen sauber aus
*** Man kann sie schachteln
* Das Listenzeichen (der Stern)<br/>muss das 
erste Zeichen der Zeile sein.

Das ganze sieht dass später so aus:

Nummerierte Listen

# Nummerierte Listen sind auch gut
## Genau so übersichtlich
## und einfach zu erzeugen

Das ganze sieht dass später so aus:

Einrücken von Zeilen

:Zeilen können
::eingerückt werden
:::sogar mehrfach

Das ganze sieht dass später so aus:

Listen und Einrückungen vermischen

Man sollte aber nur davon Gebrauch machen wenn es der Übersichtlichkeit dient oder notwendig ist. Wenn man es zu oft auf einer Seite nutzt, kann die Seite schnell verwirrt wirken.

* Man kann Listen
*: und Einrückungen
*:: sogar mischen
*# und verschachteln
*#* so wie hier

Das ganze sieht dann so aus:

Trennstrich einfügen

Zwischen Absätzen / Kapiteln die ganrichts miteinander zutun haben kann man zur Abtrennung einen Trennstrich einfügen.

Bla bla bla
----
Die vier Bindestriche werden für Trennstrich sorgen

Das ganze sieht dann so aus:

Quellcode und ähnliches darstellen

Dazu reicht bei wenigen Zeilen das voranstellen eines Leerzeichens.

 Wenn eine Zeile mit einem Leerzeichen beginnt,
  wird sie genau so formatiert
    wie sie geschrieben wurde.
  Dabei wird ein Zeichensatz mit fester
  Zeichenbreite verwendet. Die
          Zeilen werden nicht umgebrochen.
 Das ist nützlich um:
  * vorformatierten Text einzufügen
  * Programmcode oder Algorithmen anzuzeigen
  * Diagramme mit Zeichen zu gestalten
  * einfache Tabellen zu erzeugen

 VORSICHT: Wenn du die Zeilen zu lang machst,
 erzeugst du dadurch eine sehr breite Seite,
 die dadurch schlecht zu lesen ist.

Das ganze sieht dann so aus:

Wenn eine Zeile mit einem Leerzeichen beginnt,
 wird sie genau so formatiert
   wie sie geschrieben wurde.
 Dabei wird ein Zeichensatz mit fester
 Zeichenbreite verwendet. Die
         Zeilen werden nicht umgebrochen.
Das ist nützlich um:
 * vorformatierten Text einzufügen
 * Programmcode oder Algorithmen anzuzeigen
 * Diagramme mit Zeichen zu gestalten
 * einfache Tabellen zu erzeugen

VORSICHT: Wenn du die Zeilen zu lang machst,
erzeugst du dadurch eine sehr breite Seite,
die dadurch schlecht zu lesen ist.

Programmcode Beispiele einfügen

Zum einfügen von Quellcode (Basic,C usw.) sollte diese Variante verwendet werden. Sie hat gegenüber der letzten Methode den Vorteil das im Code auch Leerzeilen (Absätze) vorhanden sein können:

<nowiki>
<pre class="code">
Zeile 1
Zeile 2
Zeile 3

VORSICHT: Wenn du die Zeilen zu lang machst,
erzeugst du dadurch eine sehr breite Seite,
die dadurch schlecht zu lesen ist.

...

</nowiki> </pre>

Das ganze sieht dann so aus:

Zeile 1
Zeile 2
Zeile 3

VORSICHT: Wenn du die Zeilen zu lang machst,
erzeugst du dadurch eine sehr breite Seite,
die dadurch schlecht zu lesen ist.

...

Textabschnitte zentrieren

<div align="center">
Das ist ein zentrierter Text. Er kann ruhig über mehrere Zeilen oder Absätze gehen. 
</div>

Das ganze sieht dann so aus:

Unsichtbarer Kommentar

Kann man nutzen um Anmerkungen für andere Artikel-Mitarbeiter zu hinterlassen

Etwas Text und ein <!-- unsichtbarer Kommentar -->

Das ganze sieht dann so aus:

Farbiger Rahmen für besonders wichtige Anmerkungen

Wenn man auf einer Webseite etwas besonderes hervorheben will, kann man auch einen farbigen Rahmen drumrum setzen. Davon sollte man aber nur wenig Gebrauch machen

{{FarbigerRahmen|
Dieser Text wird farbig umrandet!

Das ist rot! Rot ist hier fest vorgegeben!
}}

Das ganze sieht dann so aus:

Wenn man gerade an längerem Artikel arbeitet

Wenn man gerade an einem längeren Artikel arbeitet und verhindern möchte das zwischenzeitlich andere Änderungen vornehmen, so kann man auf dem Artikel ein Warnschild vermerken. Einfach einmal im Artikeltext folgendes einfügen:

{{Baustelle|username}}

Man sollte Artikel abe rnur für kurze Zeit , also nicht über Tage so kennzeichnen.

Wenn man den Ausbau des Artikels durch andere Wiki Teilnehmer vorantreiben möchte

Wenn man der Meinung ist der Artikel ist noch recht unvollständig und sollte doch recht schnell von anderen Usern ergänzt werden. Dann kann man durch einen einfachen Befehl einen grünen Hinweis am unteren Ende einblenden lassen. Dazu fügen Sie am unteren Artikelende einfach folgendes ein:

{{Ausbauwunsch|Mehr Grundlagen und vor allem mal praktische Programmbeispiele / Algorithmen etc.}}

oder

{{Ausbauwunsch|Was Euch noch dozu einfällt}}

im Artikel sieht das ganze dann etwa so aus:

Hochstellen von Zahlen

Um Zahlen hoch zu stellen, zum Beispiel in Formeln, gibt man folgendes ein:

T<sup>1</sup>

Tieferstellen von Zahlen

Um Zahlen hoch zu stellen, zum Beispiel in Formeln, gibt man folgendes ein:

H<sub>2</sub>O

Tabellen sehr einfach erzeugen

Jede Tabelle beginnt mit einer geschweiften Klammer { gefolgt von einem senkrechten Strich | und endet mit einem Strich | gefolgt von einer geschweiften Klammer }. Die öffnende Klammer muss als erstes Zeichen der Zeile stehen.

Eine neue Tabellenzeile wird mit |- erzeugt. Innerhalb jeder Zeile können beliebig viele Zellen stehen. Eine Zelle wird mit einem senkrechten Strich am Zeilenanfang (|) eingeleitet. Mit zwei senkrechten Strichen (||) können mehrere Zellen in einer Textzeile zusammengeschrieben werden.

Eine Tabelle (ohne Rand) mit zwei Tabellenzeilen mit je zwei Zellen sieht im Text so aus:

{| border=1
 |Zelle 1
 |Zelle 2
 |-
 |Zelle 3
 |Zelle 4
 |}

Das ganze sieht dann so aus:

Man kann den Rahmen auch weglassen indem man "Border=1" wegläst. Mehr dazu unter Tabellen erzeugen

Tabelle um wichtigen Absatz in Kasten hervorzuheben

Man kann eine Tabelle auch nutzen um einen farbigen Kasten für einen kleinen Textabschnitt zu erzeugen. Besonders hilfreich ist dabei die Vorlage Blauetabelle oder Blaueschmaltabelle. Man erzeuft so einfach eine Tabelle mit nur einer Spalte und Zeile:

{|{{Blaueschmaltabelle}}
|Beispieltext: Eine Slave ID besteht aus den oberen 7 Bit eines Bytes. Das unterste
Bit gibt an ob auf den Baustein lesend (Bit=1) oder schreibend (Bit=0) zugegriffen wird.
Zur Vereinfachung geben wir hier im Wiki grundsätzlich die [[I2C]]-Adresse als 8 Bit
Wert an. Dabei wird von dem Schreibzugriff (Bit 0=0) ausgegangen. Der Vorteil dieser
Darstellung: Man kann dem Wert sofort im Programm nutzen und sich so die Adressen 
besser einprägen. Um vom [[I2C]]-Baustein lesen zu können, muss lediglich die 1 zur
Slave ID addiert werden. Benötigt man doch die 7 Bit Darstellung, so ist einfach
128 abzuziehen.
|}

Das ganze sieht dann so aus:

Gibt man statt "Blaueschmaltabelle" die Vorlage "Blauetabelle" an, so sieht es so aus::

Tabellenvorlage um ein 8 Bit Register darzustellen

Bei Microcontrollern haben oft einzelne Bit´s eines Registers (z.B. Timerregister etc.)eine bestimmte Bezeichnung und Aufgabe. Um die Bezeichnung der Bit´s übersichtlich aufzulisten gibt es diese Registertabellenvorlage. Hier muss man lediglich alle Registernamen (von Bit 7 bis 0) aufzählen.

 
{{Registertabelle8Bit|OCIE2|TOIE2|TICIE1|OCIE1A|OCIE1B|TOIE1|OCIE0|TOIE0}}

Das ganze sieht dann sehr übersichtlich aus:

Links auf andere Seiten im Wiki

Das Wiki lebt von den Links auf Seiten innerhalb des Wikis. Lings sind einfach zu setzen indem man den Titel des Artikel in doppelte rechteckige Klammern setzt. Man sollte im Text so oft wie Möglich den Gebrauch davon machen. Achtung: Wenn Sie ein Wort oder Satz so einklammern für das noch kein Artikel vorhanden ist, so wird dieser später automatisch angelegt wenn man drauf klickt. Man erkennt dies an der roten Farbe. Verweise auf nicht vorhandene Artikel sollte man jedoch nicht machen.

[[Testseite]]

[[Atmel]]

[[RN-Control#Stückliste|Direkt zur Stückliste verlinken]] 

Das ganze sieht dann so aus:

Wie bei dem letzten Link zu erkennen ist, kann man auch direkt zu einem Kapitel innerhalb einer WIKI-Seite verlinken.

Externe Links auf andere Seiten im Internet

Mit externen Links auf andere Seiten im Web sollte man sehr sparsam umgehen. Zum einen weil es oft etws unangenehm ist wenn der Leser beim blättern plötzlich auf eine anders gestaltete Seite gelangt und zum anderem damit das Wiki nicht zum Linkverzeichnis verkommt. Manchmal ist der Verweis auf externe Seite jedoch durchaus sinnvoll. In diesem Fall sollte man diese Links vorwiegend an das Seitenende / Artikelende stellen und durch die Überschrift Weblinks hervorheben das es hier auf externe Seiten geht. Man sollte das als Aufzählung gestalten, also so:

==Weblinks==
* [http://www.roboternetz.de Roboternetz]
* [http://www.roboternetz.de/robotertutorial1.html Kleines Roboter Tutorial]

Das ganze sieht dann so aus:

Wie zu erkennen ist, müssen Links auf externe Seiten nicht doppelt sondern nur einfach mit rechteckigen Klammern eingeklammert sein. Durch ein Leerzeichen wird rechts von dem Link die Seite beschrieben.

Hinweise auf artverwandte Artikel im Wiki RN-Wissen

Unabhägig von der Verlinkung im Text, ist es sinvoll unter den Text nochmal eine Auflistung von Verwanden Themen im gleichen WIKI vorzunehmen. So sehen Leser auf den ersten Blick was noch interessant für Sie sein kann. Man sollte das als Aufzählung unter der Überschift Siehe auch vornehmen, also so:

==Siehe auch==
* [[Buchvorstellungen]]
* [[Atmel]]

Das ganze sieht dann so aus:

Nicht vergessen ganz unten im Artikel die Kategorie anzugeben

Es sind mehrere Kategorien möglich. Bei der Zuordnung sollte man sich an den bisherigen Kategorien orientieren. Die Zuordnung erfolgt zum Beispiel so:

 [[Kategorie:Microcontroller]]
 [[Kategorie:Software]]
 [[Kategorie:Grundlagen]]
 [[Kategorie:Elektronik]]
 [[Kategorie:Robotikeinstieg]] 
 [[Kategorie:Mechanik]] 
 [[Kategorie:Sensoren]] 
 [[Kategorie:Microcontroller]] 
 [[Kategorie:Motoren]] 
 [[Kategorie:Projekte]]
 [[Kategorie:Praxis]] 
 [[Kategorie:Grundlagen]] 
 [[Kategorie:Quellcode C]]
 [[Kategorie:Quellcode Bascom]]

Bitte nur Kategorien zuteilen die schon im WIKI verwendet werden. Hier klicken um alle zu sehen: Spezial:Categories Neue Kategorien sollten nur von den Mod´s angelegt werden damit das ganze übersichtlich bleibt. Im Forum ode rin Artikeldiskussionen können jedoch neue vorgeschlagen werden.

Bilder einfügen

Das Einfügen von Bildern ist besonders einfach. Man braucht dazu kein Webspace im Internet, die Bilder können direkt von Eurer Festplatte übernommen werden. Man sollte allerdings nicht gleich aus jedem Artikel eine Bildergallerie machen, aber einige Bilder (mindestens eins) sind oft schon sehr sinnvoll. Man kann GIF, PNG und JPG hochladen, die Größe sollte möglichst 50kb nicht übersteigen (Ausnahmen bestätigen die Regel). Um ein Bild einzufügen gibt es verschiedene Methoden. Man kann etweder zuerst links in der Menüleiste auf Hochladen klicken und dann das Bild sehr einfach anwählen und hochladen. Dabei sollte man zu jedem Bild einen kurzen Bemerkungstext eingeben damit später das Bild über die Bildersuche wiedergefunden werden kann. Wurde das Bild hochgeladen, so merkt (kopiert) man sich den Namen.

Im Text gibt man dann folgendes an um das Bild einzubauen:

[[Bild:AtmelController.jpg]]

oder so 
[[Bild:AtmelController.jpg|thumb|Bildunterzeile für Beschreibung]]

bla bla

bla bla Text halt

Das schöne ist das duch die Anmerkung Thumb die bilder verkleinert und von Text umlaufen werden. Durch das anklicken kann der Leser später dennoch die volle Größe sehen. Dies Methode ist daher sinnvoll wenn die Bilder sehr groß sind. Ein kleines Bild macht oft optisch mehr her.
 

Das ganze sieht dann so aus:

oder so

Bildunterzeile für Beschreibung

bla bla

bla bla Text halt

Das schöne ist das duch die Anmerkung Thumb die bilder verkleinert und von Text umlaufen werden. Durch das anklicken kann der Leser später dennoch die volle Größe sehen. Dies Methode ist daher sinnvoll wenn die Bilder sehr groß sind. Ein kleines Bild macht oft optisch mehr her.

Alternativ kann man es auch so machen das man zuerst den Artikel Schreibt und an Stellen wo Bilder hin sollen, bereits einen Bildernamen einfügt.

[[Bild:Beispiel1.jpg]]
bla bla bla ... halt Text   
[[Bild:Beispiel2.jpg]]
usw.
 

Wenn man dann den Text anzeigen läßt, kann man durch anklicken dieser Bildermarken die Bilder bequem hochladen. Wichtig ist nur, das man auch später ein JPG-Bild und kein GIF-Bild hochläd wenn man einen JPG-Namen (Beispiel1.jpg) angegeben hat. Ansonsten kommt Fehlermeldung! Bitte auch beachten das es um eure Bilder geht oder ihr das Recht habt dieses ins Wiki zu stellen (Urheberrecht).

Das ganze sieht dann so aus:

Weitere Möglichkeiten siehe: Hilfe

Autor Frank