Projekt:Tipps und Tricks

Auf dieser Seite sollen einige Tipps und Tricks gesammelt werden, um die Arbeit am Wiki und die Erstellung einheitlich aussehender Artikel einfacher zu machen.

Zunächst ein paar Grundbegriffe.

Vorlage

Eine Vorlage ist ein Baustein, der in eine Seite eingefügt werden kann und die mit Parametern spezifiziert werden kann. Vorlagen werden mit doppelten geschweiften Klammern eingefügt.

Tag

Ein Tag entspricht der HTML-Notation in spitzen Klammern und stellt zusätzliche Funktionalitäten bereit, etwa um Quellcode hervorzuheben oder Diagramme mit Tools wie Mermaid oder PlantUML einzufügen

Links mit Icons

Folgende Vorlagen erzeugen Links mit nebenstehenden Icons:

• Vorlage:Inf-Schule erzeugt inf-schule.de 🇩🇪
  • {{Inf-Schule|1.2.3.4|Experimente mit dem Hex-Editor}} → "Experimente mit dem Hex-Editor" auf inf-schule.de 🇩🇪
• Vorlage:W3Schools erzeugt w3schools.com 🇬🇧
  • {{W3Schools|TAGS/ref_colornames.asp|HTML-Farbnamen}} → "HTML-Farbnamen" auf w3schools.com 🇬🇧
• Vorlage:OInf erzeugt oinf.ch 🇨🇭
  • {{OInf|kurs/programmieren/methoden/|Methoden}} → "Methoden" auf oinf.ch 🇨🇭
• Vorlage:VisuAlgo erzeugt VisuAlgo.net 🇬🇧🇨🇳🇮🇩
  • {{VisuAlgo|en/convexhull|Konvexe Hüllen}} → "Konvexe Hüllen" auf VisuAlgo.net 🇬🇧🇨🇳🇮🇩
• Vorlage:Hermeneus erzeugt Lektionstext bei Hermeneus
  • {{Hermeneus|ad/jfdlp|Graculus superbus et pavo}} → Graculus superbus et pavo bei Hermeneus

Zur Erstellung von neuen Vorlagen für Links mit Icon kann die Vorlage:Link mit Icon genutzt werden. Diese Vorlage soll nur genutzt werden, um neue Vorlagen zu erzeugen, nicht um direkt in Inhaltsseiten eingesetzt zu werden.

Flaggen

Flaggen wie 🇩🇪 können mit der Vorlage:Flagge erzeugt werden und sollten hinter jeden Weblink gesetzt werden, um anzuzeigen, in welchen Sprachen diese Website zur Verfügung steht. Als Parameter muss der Vorlage die zweibuchstabige Länder-Abkürzung übergeben werden: DE für Deutschland, FR für Frankreich usw. Diese Codes können auch kombiniert werden, um mehrere Flaggen nacheinander anzuzeigen.

• {{Flagge|DE}} → 🇩🇪
• {{Flagge|FR}} → 🇫🇷
• {{Flagge|DEATCH}} → 🇩🇪🇦🇹🇨🇭

Tastenkombinationen

Für die Darstellung von Tastenkombinationen gibt es die Vorlage:Tastatur. Die Tasten, die gedrückt werden, müssen als Parameter angegeben werden.

• {{Tastatur|StrgAltEntf}} → StrgAltEntf
• {{Tastatur|ShiftWinS}} → ShiftS
• {{Tastatur|HALLO} → HALLO

Grundsätzlich sollten die Buchstabentasten als Großbuchstaben dargestellt werden. Um Verwirrungen zwischen großem i und kleinem L auszuschließen, darf das I auch als Kleinbuchstabe i dargestellt werden.

Quelltext

Längere Abschnitte von Programmcode sollten mit dem Tag <syntaxhighlight lang="SPRACHE">...</syntaxhighlight> eingefügt werden. Im visuellen Editor geht das noch einfacher mit dem Menüpunkt Einfügen → Codeblock.

Wenn man eine Sprache angibt, werden die Schlüsselwörter und Syntaxelemente dieser Sprache farbig hervorgehoben. Wenn nichts hervorgehoben werden soll, muss text als Sprache angegeben werden. Eine Liste der erlaubten Sprachen findet sich hier.

Zeilennummern können mit dem Attribut line hinzugefügt werden: <syntaxhighlight lang="SPRACHE" line>...</syntaxhighlight>.

Mit dem Attrobut start kann zusätzlich festgelegt werden, mit welcher Zeilennummer begonnen werden soll zu zählen: <syntaxhighlight lang="SPRACHE" line start="STARTZEILENNUMMER">...</syntaxhighlight>.

Beispiele

<syntaxhighlight lang="html"> <ol type="I"> <li>Punkt 1</li> <li>Punkt 2</li> </ol> </syntaxhighlight>	<ol type="I"> <li>Punkt 1</li> <li>Punkt 2</li> </ol>
<syntaxhighlight lang="lua" line="1"> function quadrat(x) return x * x end </syntaxhighlight>	function quadrat(x) return x * x end
<syntaxhighlight lang="python" line start="42"> def swap(A, i, j): A[j],A[i] = A[i],A[j] </syntaxhighlight>	def swap(A, i, j): A[j],A[i] = A[i],A[j]

Für einzelne Schnipsel in einer Programmiersprache, die in den Fließtext eingebettet werden soll, kann das Attribut inline gesetzt werden: <syntaxhighlight lang="SPRACHE" inline>...</syntaxhighlight>. Um sich Tippaufwand zu ersparen und den Wikitext lesbarer zu halten, gibt es für die häufig in diesem Wiki verwendeten Sprachen Extra-Vorlagen:

• Vorlage:Java
• Vorlage:Python
• Vorlage:JavaScript
• Vorlage:CSS
• Vorlage:HTML
• Vorlage:XML

Diesen Vorlagen muss nur der Programmcode mitgegeben werden: {{CSS|border: 2px solid black;}} → border: 2px solid black;