Quelltext der Seite RN-Wissen.de:Editierhilfe

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 [[RN-Wissen:Hilfe|Hilfe]] beschrieben.

Generell kann man WIKI Texte erstmal wie ganz normale Texte in einem Editor ode rTextverarbeitung 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:

<pre><nowiki>
== Neuer Abschnitt ==
=== Unterabschnitt ===
==== Unter-Unterabschnitt ====
</nowiki></pre>

Das ganze sieht später so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
== Neuer Abschnitt ==
=== Unterabschnitt ===
==== Unter-Unterabschnitt ====
</div>

----

== 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:

<pre><nowiki>''Kursiv''
'''fett'''
''das kursiv''
'''''kursiv und fett'''''
</nowiki></pre>

Das ganze sieht dass später so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
'''das ist fett'''
''das kursiv''
'''''das kursiv und fett'''''
</div>


----

== Zeilenumbruch und Absätze ==

<pre><nowiki>
Ein einzelner Zeilenumbruch
wird ignoriert.

Aber durch eine leere Zeile wird ein neuer
Absatz erzeugt.

Man kann aber einen Zeilenumbruch durch<br/>erzwingen.
</nowiki></pre>
Das ganze sieht dass später so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
Ein einzelner Zeilenumbruch
wird ignoriert.

Aber durch eine leere Zeile wird ein neuer
Absatz erzeugt.

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


----

== Listen für Aufzählungen erzeugen ==
<pre><nowiki>
* 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.
</nowiki></pre>

Das ganze sieht dass später so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
* 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.
</div>

----

== Nummerierte Listen ==

<pre><nowiki>
# Nummerierte Listen sind auch gut
## Genau so übersichtlich
## und einfach zu erzeugen
</nowiki></pre>
Das ganze sieht dass später so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
# Nummerierte Listen sind auch gut
## Genau so übersichtlich
## und einfach zu erzeugen

</div>

----

== Einrücken von Zeilen ==
<pre><nowiki>
:Zeilen können
::eingerückt werden
:::sogar mehrfach
</nowiki></pre>
Das ganze sieht dass später so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
:Zeilen können
::eingerückt werden
:::sogar mehrfach
</div>

----

== 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.
<pre><nowiki>
* Man kann Listen
*: und Einrückungen
*:: sogar mischen
*# und verschachteln
*#* so wie hier
</nowiki></pre>
Das ganze sieht dann so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
* Man kann Listen
*: und Einrückungen
*:: sogar mischen
*# und verschachteln
*#* so wie hier
</div>


----

== Quellcode und ähnliches darstellen ==
Dazu reicht bei wenigen Zeilen das voranstellen eines Leerzeichens.
<pre><nowiki>
 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.
</nowiki></pre>
Das ganze sieht dann so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
 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.
</div>

----

== 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: 

<pre>
<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.

...
</pre>
</nowiki>
</pre>

Das ganze sieht dann so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
<pre>
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.

...
</pre>

</div>


----

== Textabschnitte zentrieren ==
<pre><nowiki>
<div align="center">
Das ist ein zentrierter Text. Er kann ruhig über mehrere Zeilen oder Absätze gehen. 
</div>
</nowiki></pre>
Das ganze sieht dann so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
<div align="center">
Das ist ein zentrierter Text. Er kann ruhig über mehrere Zeilen oder Absätze gehen. 
</div>
</div>


----

== Unsichtbarer Kommentar ==
Kann man nutzen um Anmerkungen für andere Artikel-Mitarbeiter zu hinterlassen
<pre><nowiki>
Etwas Text und ein <!-- unsichtbarer Kommentar -->
</nowiki></pre>
Das ganze sieht dann so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
Etwas Text und ein <!-- unsichtbarer Kommentar -->
</div>


----


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

<pre>
<nowiki>
T<sup>1</sup>
</nowiki>
</pre>

<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
T<sup>1</sup>
</div>

----

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

<pre>
<nowiki>
H<sub>2</sub>O
</nowiki>
</pre>

<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
H<sub>2</sub>O
</div>

----

== Tabellen sehr einfach erzeugen==
Jede Tabelle beginnt mit einer geschweiften Klammer '''{''' gefolgt von einem senkrechten Strich '''<nowiki>|</nowiki>''' und endet mit einem Strich '''<nowiki>|</nowiki>''' gefolgt von einer geschweiften Klammer '''}'''. Die öffnende Klammer '''muss''' als erstes Zeichen der Zeile stehen. 

Eine neue Tabellenzeile wird mit <tt>|-</tt> erzeugt. Innerhalb jeder Zeile können beliebig viele Zellen stehen. Eine Zelle wird mit einem senkrechten Strich am Zeilenanfang (<tt>|</tt>) eingeleitet. 
Mit zwei senkrechten Strichen (<tt>||</tt>) 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:
 <nowiki>{| border=1
 |Zelle 1
 |Zelle 2
 |-
 |Zelle 3
 |Zelle 4
 |}</nowiki>

Das ganze sieht dann so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
{| border=1
|Zelle 1
|Zelle 2
|-
|Zelle 3
|Zelle 4
|}
</div>

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

----

==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.'''
<pre><nowiki>
[[Testseite]]

[[Atmel]]
</nowiki></pre>
Das ganze sieht dann so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
[[Testseite]]

[[Atmel]]
</div>


----

==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:
<pre><nowiki>
==Weblinks==
* [http://www.roboternetz.de Roboternetz]
* [http://www.roboternetz.de/robotertutorial1.html Kleines Roboter Tutorial]
</nowiki></pre>
Das ganze sieht dann so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">

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

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 artverwante 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:
<pre><nowiki>
==Siehe auch==
* [[Buchvorstellungen]]
* [[Atmel]]
</nowiki></pre>
Das ganze sieht dann so aus:
<div style="border:2px solid #ffd700; margin-left:auto; margin-right:auto; padding:0.3em; text-align:left; max-width:20em;">
==Siehe auch==
* [[Buchvorstellungen]]
* [[Atmel]]
</div>


----

== Nicht vergessen ganz unten im Artikel die Kategorie anzugeben==
Es sind mehrere Kategorien möglich. Bei der Zuordnung sollte man sich an den [[Spezial:Categories|bisherigen Kategorien]] orientieren.
Die Zuordnung erfolgt zum Beispiel so:
<pre>
<nowiki>
 [[Kategorie:Microcontroller]]
 [[Kategorie:Software]]
 [[Kategorie:Grundlagen]]
 [[Kategorie:Elektronik]]
 [[Kategorie:Robotikeinstieg]] 
 [[Kategorie:Mechanik]] 
 [[Kategorie:Sensoren]] 
 [[Kategorie:Microcontroller]] 
 [[Kategorie:Motoren]] 
 [[Kategorie:Projekte]]
 [[Kategorie:Praxis]] 
 [[Kategorie:Grundlagen]] 
</nowiki>
</pre>

----

Weitere Möglichkeiten siehe:
[[RN-Wissen:Hilfe|Hilfe]]

''Autor Frank''