ubuntuusers.de

Textbausteine

Das Wiki von ubuntuusers.de kennt eine Reihe von automatisierten Textbausteinen (Vorlagen), deren Benutzung im folgenden erläutert werden. Textbausteine dienen dazu, um

Sie erleichtern dem Autor die Einhaltung der Syntax und dienen auch dazu, einen Artikel ansprechend zu gestalten. Beispiel Experten-Textbaustein:

Experten-Info:

Die Textbausteine werden technisch gesehen in Makros und Parsern unterschieden. Der wesentliche Unterschied zwischen Makros und Parsern ist, dass Makros einen festen Text haben bzw. nur einige wenige Parameter übergeben werden können, während Parser frei mit Text gefüllt werden können. Makros erkennt man an den eckigen Klammern, Parser erkennt man an den geschweiften Klammern.

Die meisten der hier beschriebenen Textbausteine finden sich in der Editorleiste im Menü "Textbausteine":

wiki_leiste.png

Am Anfang eines Artikels

Baustelle

Verwendung: Nur in Artikeln zu verwenden, die gerade in der Baustelle erstellt werden.

Syntax

[[Vorlage(Baustelle, Datum, Bearbeiter)]]

Parameter
Datum Das geplante Fertigstellungsdatum
Bearbeiter Der (eigene) Benutzernutzername. Enthält der Name Leer- oder Sonderzeichen, so muss man ihn zwingend in Anführungszeichen schreiben. Weitere Bearbeiter können durch Kommas getrennt hinzugefügt werden.

Beispiel

Code:

[[Vorlage(Baustelle, 4.2.2042, "Bearbeiter 1", Bearbeiter2)]]

Ergebnis:

Artikel in Arbeit

Dieser Artikel wird momentan von Bearbeiter 1 und Bearbeiter2 erstellt. Als Fertigstellungsdatum wurde der 4.2.2042 angegeben.


Achtung: Insbesondere heißt das, dass dieser Artikel noch nicht fertig ist und dass wichtige Teile fehlen, oder sogar falsch sein können. Bitte diesen Artikel nicht als Anleitung für Problemlösungen benutzen!

Getestet

Verwendung: Am Anfang eines Wiki-Artikels. Hiermit wird gekennzeichnet, für welche Ubuntuversionen der Artikel Gültigkeit hat. Die getestet-Box ist in den Artikeln, die mehrere Programme auflisten, wie z.B. Übersichtsseiten, nicht erforderlich.

Syntax

[[Vorlage(Getestet, Ubuntuversion/-versionen)]]

Parameter
Ubuntuversion/-versionen Eine durch Kommata getrennte Liste des ersten Teils des Codenamens. Dabei bitte nur die Ubuntu-Versionen aufführen, mit denen der Artikel auch wirklich getestet wurde.

Beispiel

Code:

 [[Vorlage(Getestet, focal, bionic)]] 

Ergebnis:

Dieser Artikel wurde für die folgenden Ubuntu-Versionen getestet:


Du möchtest den Artikel für eine weitere Ubuntu-Version testen? Mitarbeit im Wiki ist immer willkommen! Dazu sind die Hinweise zum Testen von Artikeln zu beachten.

Besonderheiten: getestet "general"

Code:

[[Vorlage(Getestet, general)]]

Ergebnis:

Dieser Artikel wurde für die folgenden Ubuntu-Versionen getestet:

Dieser Artikel ist größtenteils für alle Ubuntu-Versionen gültig.

Achtung!

Bitte beachten: "Getestet, general" ist nicht das gleiche wie "Getestet für alle aktuellen Ubuntu-Versionen"!

"getestet: general" wird nur dann eingesetzt, wenn der Artikel allgemein gültig ist. Das können in der Regel nur Konzepte (Booten, Dienste, usw.) sein, Programme sind so gut immer versionsabhängig. Eine Ausnahme stellen beispielsweise die grundlegenden Werkzeuge coreutils und eine ganze Reihe von Shell-Befehle: dar, die aus Kompatibilitätsgründen sehr selten geändert werden.

Artikel, in den die Installation eines Pakets und Dateien aus den universe oder multiverse Quellen enthalten, die Installation via PPA, Fremdquelle, Fremdpaket, Snap, Flatpak u.ä. oder die manuelle Installation können grundsätzlich nie "getestet: general" bekommen!

ungetestet

Code:

[[Vorlage(Getestet, )]]

Ergebnis:

Dieser Artikel wurde für die folgenden Ubuntu-Versionen getestet:

Dieser Artikel ist mit keiner aktuell unterstützten Ubuntu-Version getestet! Bitte teste diesen Artikel für eine Ubuntu-Version, welche aktuell unterstützt wird. Dazu sind die Hinweise zum Testen von Artikeln zu beachten.

Diese Markierung darf ausschließlich gesetzt werden, wenn ein Artikel mit der Zeit veraltet ist und nach und nach alle anderen Ubuntuversionen aus dem Getestet-Makro herausgefallen sind. Artikel mit "ungetestet"-Markierung bleiben dann noch bis zu sechs Monate im Wiki und werden anschließend ins Archiv verschoben. Wird diese Vorlage im Sinne von "ungetestet" benutzt, so ist auch gleichzeitig in der zugehörigen Diskussion ein entsprechender Hinweis zu veröffentlichen.

Ubuntu Touch

Analog zur Vorlage „Getestet“ funktioniert die Vorlage „UT“. Sie ist vorerst temporär eingebaut, um Artikel die spezifisch für Ubuntu Touch sind, zu kennzeichnen.

Code:

[[Vorlage(UT, focal)]]

Ergebnis:

Dieser Artikel bezieht sich auf Ubuntu Touch, die Variante von Ubuntu für mobile Geräte mit Touchscreen.

Dieser Artikel ist mit keiner derzeit unterstützten Ubuntu-Touch-Version getestet! Bitte diesen Artikel testen!

Die Vorlage wird bei Bedarf noch verändert oder in die bestehende Vorlage eingebaut.

Wissensblock

Verwendung: Verweise auf grundlegende Artikel, die zum Verständnis des Artikels hilfreich sind. Der Wissensblock ist neben dem Getestet-Tag ein zentraler Bestandteil eines Artikels. Hier sollten die für den Artikel relevanten Grundlagen verlinkt sein. Gehört in fast jeden Artikel.

Syntax

{{{#!vorlage Wissen 
[:Link zu Wikiartikel1: Beschreibung1]
[:Link zu Wikiartikel2: Beschreibung2]
[:Link zu Wikiartikel3: Beschreibung3], optional
}}}

Parameter
[:Link zu Wikiartikel: Beschreibung] Pro Zeile ein Link zum jeweiligen Grundlagenartikel

Einen vorgefertigten Wissensblock mit allen Grundlagenartikeln findet man in Wiki/Kopiervorlage. Möchte man z.B. bei verschiedenen Installationsvarianten darauf hinweisen, das eine Möglichkeit ausreicht, kann man den Zusatz optional verwenden.

Beispiel

Code:

{{{#!vorlage Wissen
[:Pakete installieren: Installation von Programmen]
[:Editor: Einen Editor öffnen]
[:Terminal: Ein Terminal öffnen], optional
}}}

Ergebnis:

Zum Verständnis dieses Artikels sind folgende Seiten hilfreich:

Im Text verwendet man einfach die entsprechende Nummer in eckigen Klammern als Verweis auf den Wissensblock. Inyoka setzt dann automatisch den entsprechenden Link.

Code:

 ... Das Paket '''foo''' kann dann einfach installiert[1] werden.

Ergebnis:
"... Das Paket foo kann dann einfach installiert[1] werden."

Dabei reicht es, ein Mal - beim ersten Vorkommen eines im Wissensblock aufgeführten Eintrags - einen Verweis zu setzen.

Inhaltsverzeichnis

Bild Inhaltsverzeichnis

Verwendung: Direkt vor dem Einleitungstext platziert, verschafft das Inhaltsverzeichnis einen Überblick und dient dazu, bestimmte Abschnitte schnell anspringen zu können. Das Inhaltsverzeichnis wird automatisch aus den Überschriften generiert.

Syntax

[[Inhaltsverzeichnis(Überschriftenstufe)]]

Optionen
Überschriftenstufe Die Tiefe des Inhaltsverzeichnisses. Erlaubt sind Zahlen von 1 bis 6. Wird Überschriftenstufe nicht angegeben, wird die Voreinstellung 3 genommen.

Experten-Markierung

Verwendung: Zeigt an, das der Artikel eher für fortgeschrittene Nutzer gedacht ist.

Syntax

[[Vorlage(Fortgeschritten)]]

Beispiel

Artikel für fortgeschrittene Anwender

Dieser Artikel erfordert mehr Erfahrung im Umgang mit Linux und ist daher nur für fortgeschrittene Benutzer gedacht.

Allgemeine Formatierungshilfen

Befehle

Verwendung: Für Shell-Befehle

Syntax

{{{#!vorlage Befehl
Shell-Befehl
Shell-Befehl
}}}

Beispiel

cat /etc/fstab
sudo fdisk -l 

Für die Ausgabe von Shell-Befehlen ist ein einfacher Code-Block zu verwenden (in der Menüleiste das Symbol Forum/Syntax/pre.png, Auswahl "Rohtext").

Allgemeine Beispiele für Programmaufrufe im Terminal werden wie folgt formatiert. Hier ein Beispiel für das fiktive Programm foobar:

foobar [OPTIONEN] DATEI 

Parameter wie OPTIONEN, DATEI etc. werden in Großbuchstaben geschrieben. Ist die Angabe einer Option, eines Dateinamens usw. wahlfrei, so wird dies durch die umschließenden eckigen Klammer [ und ] gekennzeichnet: [OPTIONEN]. Pflichtangaben, wie im obigen Beispiel DATEI, erhalten keine Klammern. Auf die Verwendung anderer Klammern wie { } < > ( ) sollte verzichtet werden, da sie auf der Kommandozeile eine Sonderrolle spielen.

Hinweise

Verwendung: Besondere Hervorhebung von Sachverhalten.

Syntax

{{{#!vorlage Hinweis
Hinweistext
}}}

Beispiel

Hinweis:

Hinweistext

Warnungen

Verwendung: Hinweis auf potenzielle Gefahren.

Syntax

{{{#!vorlage Warnung
Warnungstext
}}}

Beispiel

Achtung!

Warnungstext

Experten-Info

Verwendung: Bereitstellung von zusätzlichen Hintergrundinformationen, die aber für das Grundverständnis des Artikels nicht notwendig sind.

Syntax

{{{#!vorlage Experten
Hintergrundinformation
}}}

Beispiel

Experten-Info:

Hintergrundinformation

Paketinstallation

Je nach Quelle eines Paketes, sind unterschiedliche Textbausteine vorhanden:

Textbausteine für Pakete aus den Ubuntuquellen:

  • Paketinstallation - Standard, der im Wiki durchgehend verwendet werden soll

  • Pakete-Makro - ältere Version, welche normalerweise im Wiki nicht mehr zum Einsatz kommt.

Andere Quellen:

Paketinstallation

Verwendung: Erstellt eine wikikonform formatierte Paketliste, welche eine Kopiervorlage für die Kommandozeile für apt-get sowie einen ausführbaren Link für apturl generiert.

Hinweis:

Damit die apturl-Installationsliste im eigenen Browser auch richtig funktioniert, muss apturl installiert und richtig konfiguriert sein.

Die Paketinstallation-Vorlage ist der Standard im Wiki und sollte immer dann verwendet werden, wenn Pakete aus den offiziellen Paketquellen von Ubuntu installiert werden sollen. Ist ein Wikiartikel für mehrere Ubuntu-Versionen getestet, aber die Paketnamen der Pakete unterscheiden sich zwischen den Versionen, kann die Vorlage auch mehrfach in einem Artikel verwendet werden, also für jede Ubuntu-Version eine eigene.

Syntax

Achtung!

Bitte besonders darauf achten, dass direkt hinter den Paketnamen keine Leerstelle verbleibt, da sonst die Link-Liste für die apturl-Installation nicht vollständig angezeigt wird und nur teilweise verwendbar ist (angezeigt werden nur die Pakete, die nach der Leerstelle aufgeführt sind, installiert werden beim Anklicken hingegen nur die nicht angezeigten Pakete!). Stand: Januar 2020

{{{#!vorlage Paketinstallation
paketname, Information
paketname, Information
}}}

Parameter und Optionen
paketname Der Name des Paketes - dieser muss immer angegeben werden.
Information Optional, sollte aber mindestens die Komponente enthalten. Ist ein Paket erst ab einer bestimmten Version verfügbar, so sollte auch diese Information dort festgehalten sein.

Beispiel

Code:

{{{#!vorlage Paketinstallation
paket0
paket1, main
paket2, restricted ab focal
paket3, universe, ab Disco
paket4, multiverse ab focal, universe ab Bionic
paket5, security, ab Eoan - sowas aber auch
paket6, ppa
}}}

Ergebnis:

  • paket0

  • paket1 (main)

  • paket2 (restricted ab focal)

  • paket3 (universe, ab Disco)

  • paket4 (multiverse ab Bionic, universe ab Focal)

  • paket5 (security, ab Eoan - sowas aber auch)

  • paket6 (ppa)

Befehl zum Installieren der Pakete:

sudo apt-get install paket0 paket1 paket2 paket3 paket4 paket5 paket6 

Oder mit apturl installieren, Link: apt://paket0,paket1,paket2,paket3,paket4,paket5,paket6

Pakete-Makro

Hinweis:

Der Textbaustein Pakete-Makro sollte normalerweise nicht mehr verwendet werden. Siehe Textbaustein Paketinstallation.

Verwendung: Erstellt aus einer Paketliste die Befehlszeile für apt-get. Diese Befehlszeile kann dann einfach per Kopieren & Einfügen in ein Terminal übertragen werden.

Syntax

[[Vorlage(Pakete, Paketliste)]]

Parameter
Paketliste Eine kommaseparierte Liste von Paketnamen

Beispiel

Code:

[[Vorlage(Pakete, paket1, paket2)]]

Ergebnis:

Paketliste zum Kopieren:

sudo apt-get install paket1 paket2 

PPA-Vorlage

Verwendung: Erstellt einen wikikonformen Abschnitt für das Einfügen von Launchpad/PPAs inklusive Warnung und Link zu den PPA-Quellen.

Syntax

[[Vorlage(PPA, PPA-Besitzer, PPA-Name)]]

Beispiel (Code für die Pidgin-Quellen)

Code:

 [[Vorlage(PPA, pidgin-developers, ppa)]] 

Ergebnis:

Adresszeile zum Hinzufügen des PPAs:

  • ppa:pidgin-developers/ppa

Hinweis!

Zusätzliche Fremdquellen können das System gefährden.


Ein PPA unterstützt nicht zwangsläufig alle Ubuntu-Versionen. Weitere Informationen sind der Wiki/Vorlagen/PPA/ppa.png PPA-Beschreibung des Eigentümers/Teams pidgin-developers zu entnehmen.

Fremdquellen-Vorlage

Verwendung: Für Pakete aus anderen Quellen als Ubuntu oder Launchpad. Können diese Quellen auch authentifiziert werden, so kann man den Baustein Fremdquellen authentifizieren Vorlage verwenden.

Syntax

[[Vorlage(Fremdquelle, URL zur Fremdquelle, Ubuntuversionen, Komponenten)]]

Parameter und Optionen
URL Link zur Quelle
Ubuntuversion(en) Liste der Versionensnamen, falls vorhanden. Die einzelnen Versionen müssen klein geschrieben werden und sind durch eine Leerzeichen und / oder Komma getrennt. Beispiel: bionic focal oder bionic, focal
Komponenten Sind in dieser Quelle auch Komponenten angegeben, so sind diese hier aufzuführen. Mehrere Komponenten werden einfach durch ein Leerzeichen getrennt geschrieben. Beispiel: main universe

Beispiel 1: versionsabhängige Quelle mit einer Komponente

Code:

[[Vorlage(Fremdquelle, http://linux.dropbox.com/ubuntu, bionic, focal, main)]]

Ergebnis:

Um aus der Fremdquelle zu installieren, muss man die folgenden Paketquellen freischalten:

Hinweis!

Zusätzliche Fremdquellen können das System gefährden.

deb http://linux.dropbox.com/ubuntu VERSION bionic main

Beispiel 2: versionsunabhängige Quelle mit zwei Komponenten

Code:

[[Vorlage(Fremdquelle, http://download.bitdefender.com/repos/deb/, bitdefender non-free)]]

Ergebnis:

Um aus der Fremdquelle zu installieren, muss man unabhängig von der Ubuntu-Version die folgende Paketquelle freischalten:

Hinweis!

Zusätzliche Fremdquellen können das System gefährden.

deb http://download.bitdefender.com/repos/deb/ bitdefender non-free

Fremdquellen-authentifizieren-Vorlage

Verwendung: Mit folgendem Baustein können die Angaben zur Authentifizierung der Fremdquellen automatisch ausgegeben werden. Es stehen zwei Varianten zur Verfügung.

Syntax

[[Vorlage(Fremdquelle-auth, key PGP-Schlüsselnummer)]]
[[Vorlage(Fremdquelle-auth, URL zum PGP-Schlüssel)]]

Parameter Optionen
key PGP-Schüsselnummer Hinter dem Wort key ist die Schlüsselnummer anzugeben.
URL zum PGP-Schlüssel Der Link zur Schlüsseldatei.

Beispiel 1: Mit Angabe der Schlüsselnummer

Code:

[[Vorlage(Fremdquelle-auth, key 6E80C6B7)]]

Ergebnis:

Um die Fremdquelle zu authentifizieren, muss man den Signierungsschlüssel mit folgendem Befehl importieren:

sudo apt-key adv --recv-keys --keyserver keyserver.ubuntu.com 6E80C6B7  

Beispiel 2: Mit Angabe der URL

Code:

[[Vorlage(Fremdquelle-auth, http://download.virtualbox.org/virtualbox/debian/sun_vbox.asc)]]

Ergebnis:

Um die Fremdquelle zu authentifizieren, muss man den Signierungsschlüssel herunterladen ⮷ und in der Paketverwaltung hinzufügen. Alternativ dazu kann man auch im Terminal den folgenden Befehl ausführen:

wget -q -O "-" http://download.virtualbox.org/virtualbox/debian/sun_vbox.asc | sudo apt-key add - 

Fremdpaket-Vorlage

Verwendung: Vereinfachung der Angaben zur Installation von DEB-Paketen aus Fremdquellen. Es stehen drei Varianten zur Verfügung.

Syntax

[[Vorlage(Fremdpaket, Projekthoster, Projektname, Ubuntuversion(en))]]
[[Vorlage(Fremdpaket, "Anbieter", URL Downloadübersicht, Ubuntuversion(en))]]
[[Vorlage(Fremdpaket, "Anbieter", dl, URL Datei, (weitere Download-URLs möglich), Ubuntuversion(en))]]

Parameter und Optionen
Projekthoster Mögliche Angaben sind: launchpad (Launchpad 🇬🇧) oder sourceforge(Sourceforge 🇬🇧 )
Projektname Der Name des unter Projekthoster zu findenden Projektes
Mit Direktlink zu einem oder mehreren Paketen
dl Stellt das Downloadsymbol (⮷) zur Verfügung.
URL Datei Direkter Link zu einem herunterladbaren Paket. Mehrere Pakete können durch Kommata getrennt angegeben werden. Bei mehr als zwei Dateien sollte jedoch auf eine Downloadübersicht verlinkt werden.
Ubuntuversion(en) Optionale Angabe. Wenn angegeben, müssen die Versionen klein geschrieben werden. Beispiel: focal, bionic

Beispiele

Code:

[[Vorlage(Fremdpaket, launchpad, songbird, focal, bionic)]]

Ergebnis:

Beim Launchpad-Projekt songbird werden DEB-Pakete angeboten. Die Pakete können für Ubuntu 20.04 und heruntergeladen werden. Nachdem man sie für die korrekte Ubuntu-Version und Architektur geladen hat, müssen die DEB-Pakete noch installiert werden.

Hinweis!

Fremdpakete können das System gefährden.

Code:

[[Vorlage(Fremdpaket, sourceforge, utube)]]

Ergebnis:

Beim SourceForge-Projekt utube werden DEB-Pakete angeboten. Die unterstützten Ubuntu-Versionen und Architekturen werden aufgelistet. Nachdem man sie für die korrekte Ubuntu-Version und Architektur geladen hat, müssen die DEB-Pakete noch installiert werden.

Hinweis!

Fremdpakete können das System gefährden.

Code:

[[Vorlage(Fremdpaket, "[http://skype.com/intl/de/ Skype] {de}", http://www.skype.com/download/skype/linux/choose/, focal)]]

Ergebnis:

Von Skype 🇩🇪 werden DEB-Pakete ⮷ angeboten. Die Pakete können für Ubuntu 20.04 heruntergeladen werden. Nachdem man sie für die korrekte Ubuntu-Version und Architektur geladen hat, müssen die DEB-Pakete noch installiert werden.

Hinweis!

Fremdpakete können das System gefährden.

Code:

 [[Vorlage(Fremdpaket, Skype, dl, https://repo.skype.com/latest/skypeforlinux-64.deb, https://repo.skype.com/latest/skypeforlinux-64.deb, bionic, focal)]] 

Ergebnis:

Von Skype werden folgende DEB-Pakete angeboten:

Die Pakete können für Ubuntu 20.04 heruntergeladen werden. Nachdem man sie für die korrekte Ubuntu-Version und Architektur geladen hat, müssen die DEB-Pakete noch installiert werden.

Hinweis!

Fremdpakete können das System gefährden.

Installation via PIP

Verwendung: Für die Installation via pip.

Syntax

[[Vorlage(PipInstallation, Python-Modul)]]

Beispiel

Code:

[[Vorlage(PipInstallation, ansible)]]

Ergebnis:

Der Python Paketmanager pip stellt häufig aktuellere Versionen von Programmen als in den Paketquellen bereit. Folgendermaßen lässt sich das Programm darüber installieren:

pip3 install ansible       # Programm wird nur für den aktuellen Nutzer installiert  

Hinweis!

Fremdsoftware kann das System gefährden.

Fremdquelle-, Fremdpakete- und Fremdsoftware-Warnung

Verwendung: Ein "Muss" für Pakete und Software, die nicht aus den offiziellen Paketquellen von Ubuntu stammen. Bei der Verwendung der oben aufgeführten Vorlage zur Paketinstallation aus Paketquellen außerhalb der offiziellen Quellen von Ubuntu werden die Warnung teilweise automatisch gesetzt.

Ebenso ist die Fremdsoftware-Warnung einzusetzen, wenn die Installation von Fremdsoftware über weitere mögliche Wege beschrieben wird, z.B. snap, Flatpak, Appimage, ein manuelles Installations-Skript oder Paketmanagern von Programmiersprachen wie z.B. pip oder npm

Der "Kommentar" (siehe unten) ist bei allen drei Vorlagen immer optional und kann auch komplett weggelassen werden.

Fremdpakete

Gilt nur für ein Paket aus einer externen Quelle (z.B. ein Paket, welches von der Projekthomepage heruntergeladen wurde)

[[Vorlage(Fremd, Paket, "Kommentar")]]

Ergebnis:

Hinweis!

Fremdpakete können das System gefährden.


Anmerkung: Kommentar

Fremdquellen

Gilt nur für Pakete, welche aus externen Quellen installiert werden, die in der eigenen sources.list eingetragen sind.

[[Vorlage(Fremd, Quelle, "Kommentar")]]

Ergebnis:

Hinweis!

Zusätzliche Fremdquellen können das System gefährden.


Anmerkung: Kommentar

Fremdsoftware

Bei Software, welche nicht über die Paketverwaltung aus den Paketquellen installiert wird (beispielsweise Archive mit vorkompilierten Binärdateien, Browser-Erweiterungen, programmspezifische Add-ons, etc.) ist grundsätzlich die Fremdsoftware-Warnbox zu setzen:

[[Vorlage(Fremd, Software, "Kommentar")]]

Ergebnis:

Hinweis!

Fremdsoftware kann das System gefährden.


Anmerkung: Kommentar

Sonstige Bausteine

Hier sind Textbausteine aufgeführt, die normalerweise nur vom Wikiteam gesetzt werden, oder veraltet sind.

Ausbaufähig-Markierung

Verwendung: Ist ein Artikel unvollständig oder kann noch erweitert werden (wichtig: unvollständig heißt aber trotzdem in sich schlüssig und nicht fehlerhaft!), dann kann man diese Makro nutzen.

Syntax

[[Vorlage(Ausbaufähig, "Begründung")]]

Parameter
Begründung Ein kurzer, aussagekräftiger Text, der den fehlenden Teil beschreibt.

Beispiel

Ausbaufähige Anleitung

Dieser Anleitung fehlen noch einige Informationen. Wenn Du etwas verbessern kannst, dann editiere den Beitrag, um die Qualität des Wikis noch weiter zu verbessern.


Anmerkung: Es fehlt noch der komplette Abschnitt zur Konfiguration.

Fehlerhaft-Markierung

Verwendung: Stimmen Angaben bzw. ganze Abschnitte in einem Wiki Artikel nicht, so kann dieser mit der "Fehlerhaft"-Markierung versehen werden, die das Problem beschreibt.

Syntax

[[Vorlage(Fehlerhaft, "Begründung")]]

Parameter
Begründung Ein kurzer, aussagekräftiger Text, der den fehlerhaften Teil beschreibt.

Beispiel

Fehlerhafte Anleitung

Diese Anleitung ist fehlerhaft. Wenn du weißt, wie du sie ausbessern kannst, nimm dir bitte die Zeit und bessere sie aus.


Anmerkung: Das Programm lässt sich so nicht kompilieren, es fehlen anscheinend Header-Dateien.

Verlassen-Markierung

Verwendung: Diese Markierung wird normalerweise nur für Baustellen Artikel genutzt, die der Originalautor nicht mehr zu Ende bringt (warum auch immer). Dieser Artikel kann von jedem Nutzer ohne weitere Rückfragen zu Ende geführt werden.

Syntax

[[Vorlage(Verlassen, "Begründung")]]

Optionen
Begründung Ein kurzer, aussagekräftiger Text.

Beispiel

Verlassene Anleitung

Dieser Artikel wurde von seinem Ersteller verlassen und wird nicht mehr weiter von ihm gepflegt. Wenn Du den Artikel fertigstellen oder erweitern kannst, dann bessere ihn bitte aus.


Anmerkung: Der Installationsteil muss komplettiert werden, der Teil zu Bedingung fehlt komplett.

Überarbeitungs-Markierungen

Wird ein Artikel zur Überarbeitung in die Baustelle verschoben, kommen zwei Vorlagen zum Einsatz:

  1. Die Vorlage "Kopie" wird von Inyoka normalerweise automatisch gesetzt wenn der Artikel in die Baustelle verschoben wird, um den Artikel zu markieren, der als Originalkopie einer Seite im normalen Wiki verbleibt.

  2. Die Vorlage "Überarbeitung" ist für die Baustelle, in der der Artikel überarbeitet wird.

Syntax

[[Vorlage(Kopie, Seite)]]
[[Vorlage(Überarbeitung, Datum, Original, Autor)]]

Parameter
Seite Der Name der Seite, wie er in der Baustelle heißt.
Datum Voraussichtliche Fertigstellung der Baustelle. Möchte man das Datum auslassen, so muss ein Leerstring ("") angegeben werden.
Original Der Name des Artikels im Wiki.
Autor Optional; der Name des Benutzers, der den Artikel überarbeitet. Bei Benutzernamen mit Leerzeichen muss der gesamte Namen in Anführungszeichen stehen.

Beispiel

[[Vorlage(Überarbeitung, "", foo, "Max Mustermann")]]

Ergebnis:

Artikel wird überarbeitet

Dieser Artikel wird momentan überarbeitet.

Solltest du dir nicht sicher sein, ob an dieser Anleitung noch gearbeitet wird, kontrolliere das Datum der letzten Änderung und entscheide, wie du weiter vorgehst.


Achtung: Insbesondere heißt das, dass dieser Artikel noch nicht fertig ist und dass wichtige Teile fehlen oder sogar falsch sein können. Bitte diesen Artikel nicht als Anleitung für Problemlösungen benutzen!

Weitere Vorlagen

Zu diesen Vorlagen gibt es eine eigene Hilfe-Seite:

  • Projekte - Vorlage zur übersichtlichen Darstellung von verschiedenen Projekten

  • Infobox - Vorlage um übliche Informationen außerhalb des Fließtextes gebündelt anzuzeigen

Vorlagen in Boxen verwenden

Um innerhalb einer Hinweis- Warn- oder Expertenbox z.B. einen Befehl zu integrieren, muss das Ende der inneren Befehlsvorlage mit \ maskiert werden, weil sonst die }}} als Ende der ersten Vorlage interpretiert werden; nachfolgender Text würde nicht mehr in der Box dargestellt und am Ende die }}} der äußeren Vorlage stehen bleiben.

Beispiel

{{{#!vorlage Hinweis
Das Programm muss mit
{{{#!vorlage Befehl
start
\}}}
gestartet werden
}}}

Ergebnis:

Hinweis:

Das Programm muss mit

start 

gestartet werden

Diese Revision wurde am 21. Januar 2024 17:45 von chris34 erstellt.
Die folgenden Schlagworte wurden dem Artikel zugewiesen: Wiki, ungetestet, Inyoka, Syntax