summaryrefslogtreecommitdiff
path: root/Howtos
diff options
context:
space:
mode:
authorCedric Spindler <cedric.spindler@gmail.com>2019-09-04 13:01:06 +0200
committerCedric Spindler <cedric.spindler@gmail.com>2019-09-04 13:01:06 +0200
commitbd5244a8e7e91c523dc10525c10ceeb5a81d361a (patch)
tree136ac1497957b1285d3df9a9844cdb06746b7517 /Howtos
parentd7b111dc61a77ae22a0dfec17cfd8e01ec1012f4 (diff)
Update instructions on how to use header levels
Diffstat (limited to 'Howtos')
-rw-r--r--Howtos/Anleitung_Wiki-Formatierung.mdwn29
-rw-r--r--Howtos/Formatting_wiki_pages.mdwn3
2 files changed, 20 insertions, 12 deletions
diff --git a/Howtos/Anleitung_Wiki-Formatierung.mdwn b/Howtos/Anleitung_Wiki-Formatierung.mdwn
index e4b47852..f3ceb12a 100644
--- a/Howtos/Anleitung_Wiki-Formatierung.mdwn
+++ b/Howtos/Anleitung_Wiki-Formatierung.mdwn
@@ -8,12 +8,11 @@ This is my custom sidebar for this page.
[[!calendar pages="Howtos/*"]]
"""]]
-Allgemeines zum Wiki-Prinzip
-============================
+## Allgemeines zum Wiki-Prinzip
Damit Informationen im Internet (genauer WWW) dargestellt werden können, müssen diese entsprechend formatiert sein. Dazu wird unter anderem die "Sprache" HTML verwendet, die jedoch für viele Leute zu umständlich ist.
-Damit es aber *"einfacher"* wird, damit jeder sein Wissen beitragen kann, wurde eine Syntax erfunden, die "wiki wiki" (=hawaiianisch für schnell) eingegeben werden kann und damit viel einfacher sein soll als HTML. Die meisten kennen es wohl zumindest vom Hörensagen von der [Wikipedia](http://de.wikipedia.org/) her. Dort wird allerdings eine andere Software eingesetzt, namens "Mediawiki" .
+Damit es aber *"einfacher"* wird, damit jeder sein Wissen beitragen kann, wurde eine Syntax erfunden, die "wiki wiki" (=hawaiianisch für schnell) eingegeben werden kann und damit viel einfacher sein soll als HTML. Die meisten kennen es wohl zumindest vom Hörensagen von der [Wikipedia](http://de.wikipedia.org/) her. Dort wird allerdings eine andere Software eingesetzt, namens "Mediawiki".
Auf unserem Wiki wird hingegen die Software [ikiwiki](http://ikiwiki.info) verwendet. Die Unterschiede zu Mediawiki sind allerdings nicht sehr gross.
@@ -56,11 +55,14 @@ Wird erzeugt durch diese Syntax:
1. Erste Zeile
1. Zweite Zeile
-Überschriften
-=============
+## Überschriften
Überschriften sollen helfen, etwas Struktur in den Text zu bekommen. Praktischer Nebeneffekt ist, dass ganz oben im Dokument automatisch ein Inhaltsverzeichnis aus allen Überschriften erzeugt wird, zu denen dann per Mausklick gesprungen werden kann.
+Beim Verfassen von Wiki-Seiten sollten nur Überschriften ab Ebene 2 benutzt
+werden, weil die Ebene 1 bereits für den automatisch generierten Seitentitel
+in Verwendung ist.
+
Einfach an den Zeilenanfang ein bis sechs Rautesymbole # gefolgt von der Überschrift anführen.
# \#Überschrift Ebene 1
@@ -79,8 +81,11 @@ Zudem gibt es noch eine weitere Schreibweise für Überschriften, indem diese ei
-------------------
Mit dieser Schreibweise wird dasselbe erreicht wie oben, aber der Wikitext ist für manche Leute selbsterklärender.
+Es steht jedoch nur eine einzige Ebene Überschriften zur verfügung wenn die o.g. Regel "Nur Überschriften ab Ebene 2" befolgt wird.
+Deshalb wird empfohlen, auf diese Schreibweise zu verzichten.
+
+## (Hyper-)Links
-##(Hyper-)Links
Um von einem Dokument eine Verbindung zu einem anderen zu erstellen, werden sog. Hyperlinks eingesetzt. Links werden durch Umklammerung eines Textes durch doppelte eckige Klammern erstellt:\[[Dokumentname\]]. Dabei können interne Links im Wiki oder auch Links zu externen Webseiten oder Emailadressen verwendet werden (siehe Beispiele).
Soll einen anderer Text, als der Linktext angezeigt werden, dann kann man dies durch \[[Linktext\|Dokumentname\]] erreichen.
@@ -105,8 +110,7 @@ Die folgenden Beispiele stellen den Mediawiki-Stil dar, werden aber auch unterst
Vorsicht: Wenn doppelte eckige Klammern im Text verwendet werden sollen, müssen diese mit dem Backslash \\ eingeleitet werden, sonst wird es als Link verarbeitet.
-Bilder und Grafiken
-===================
+## Bilder und Grafiken
* \[\[!img logo_44px.png\]\] -> [[!img logo_44px.png]]
@@ -116,8 +120,7 @@ Bilder und Grafiken
* Größenanpassung bei Grafiken auf fremden Servern geht aber nur per HTML-Syntax, genauso, wenn verzerrt werden soll: \< img src="https://wiki.starship-factory.ch/logo_44px.png" width="30" height="30" alt="SF-Logo" \> -> <img src="https://wiki.starship-factory.ch/logo_44px.png" width="30" height="30" alt="SF-Logo">
-Spezialseiten
-=============
+## Spezialseiten
* \[\[!brokenlinks pages="* and !recentchanges"\]\] -> [[!brokenlinks pages="* and !recentchanges"]]
@@ -127,14 +130,16 @@ Spezialseiten
* [[!waypoint lat="47.54071N" lon="7.61427W" name="Starship-Factory" tag="city" embed]]
-#Umlautprobleme
+## Umlautprobleme
+
Auf dern Besucherlaptops mit schweizer Tastatur funktioniert die Compose-Taste nicht. Daher kann man keine grossgeschriebenen Umlaute schreiben.
Daher hier eine Copy-Paste-Zusammenfassung der Umlaute und anderer wichtiger Zeichen:
ÖÄÜöäü
-#Praktische Symbole
+## Praktische Symbole
+
\\{OK} [[smileys/thumbs-up.png]] \\{X} [[smileys/icon-error.png]]
\\{i} [[smileys/icon-info.png]] \\(?) [[smileys/question.png]] \\(./) [[smileys/checkmark.png]]
diff --git a/Howtos/Formatting_wiki_pages.mdwn b/Howtos/Formatting_wiki_pages.mdwn
index bb929431..174d5228 100644
--- a/Howtos/Formatting_wiki_pages.mdwn
+++ b/Howtos/Formatting_wiki_pages.mdwn
@@ -28,6 +28,9 @@ To create a header, start a line with one or more `#` characters followed
by a space and the header text. The number of `#` characters controls the
size of the header:
+Please use only headers starting at level 2, as level one will be used by
+the autogenerated page title.
+
# # h1
## ## h2
### ### h3