Internal:HowToITSAnleitungswiki: Unterschied zwischen den Versionen

Aktuelle Version vom 19. August 2025, 13:26 Uhr

Dies ist der Anleitungsartikel für das ITS-Anleitungswiki. Zielgruppe sind Mitarbeitende von IT.SERVICES, die Anleitungen in dieses Wiki aufnehmen oder einen Anleitungsartikel ändern wollen.

Artikelstruktur

Zuerst kommen die Einleitungssätze zur Anleitung. Daneben die Infobox.
Anschließend strukturierst du deinen Artikel mit Hilfe der Überschriften (s.u.).
Es sollte immer zuerst der Schritt in Textform kommen und danach das Bild dazu. Zur Einbettung von Bildern und korrekten Benennung s.u..
Lösche aus der Artikelvorlage keine Vorlagen oder Infoboxen heraus.

Infobox

Am Anfang der Artikelvorlage findest du eine Infobox. Fülle diese aus, damit die Nutzenden mehr Informationen zu dem Service, zu dem die Anleitung gehört, finden können. Diese Infobox ist eine Tabelle.

Text strukturieren

Abschnitte mit Überschriften erstellen

Alle Überschriften werden in ein Inhaltsverzeichnis aufgenommen. Nutze sie also, um deine Anleitung zu strukturieren. Beginne mit 1-2 Einleitungssätzen, für welchen Service der Anleitungsartikel ist und nutze dann die Überschriften-Funktion, um den ersten Abschnitt der Einleitung zu beginnen.

Text formatieren

Nutze die Optionen des Visual Editors, um deinen Text zu formatieren. Klicke auf "Erweitert", um mehr Optionen zu sehen. Wer interessiert ist an der Wiki-Formatierung findet hier den Help-Artikel.

Links verwenden

Die Wikimedia-Hilfe bietet einen Artikel mit allen möglichen Verlinkungen. Alternativ kann im Editor über das Link-Zeichen ein Link gesetzt werden.

Vorschau nutzen um zu sehen, wie es aussehen wird

Der Bearbeitungsmodus einer Seite zeigt die Wiki-Formatierung aber nicht das Endergebnis. Klicke rechts oben im Bearbeitungsmodus auf "Vorschau" und erhalte einen direkten Blick auf deine Änderungen.

Bilder nutzen

Umgang mit Bildern

Anleitungen sollten für die Verständlichkeit bebildert sein. Gehe wie folgt mit Bildern um:

Benenne Sie aussagekräftig, also passend für deinen Anleitungsartikel. Wenn alle Bilder für Firefox-Anleitungen nur "Firefox.png" heißen, führt das zu Chaos. Benutze das Schema Artikelname_Bildname.dateiendung.

Über den Link "Datei hochladen" lädst du dein Bild hoch. "Zielname" wird nach dem Auswählen des Bildes automatisch ausgefüllt (lass es so). Schreibe bei "Beschreibung/Quelle" auf, woher das Bild kommt (z.B. Eigener Screenshot) und was das Bild zeigt. Anschließend wird die Bilddatei angezeigt, inklusive des Namens in diesem Wiki. Kopiere dir den Namen.

Manche Bilder können in mehreren Anleitungen verwendet werden. Schaue in die Dateiliste, um bereits im Wiki hochgeladene Bilder einsehen und ggf. selbst nutzen zu können.

Benutze nachfolgenden Code, um dein Bild unter dem Text des Anleitungsschrittes einzufügen. Den zuvor kopierten Dateinamen ersetzt du nach "Datei:":

[[Datei:Logo RUB BLAU rgb.jpg|800px|center|Kurzbeschreibung der Bilddatei]]

Das Ergebnis sieht dann so aus:

Kategorisieren

Damit Inhalte leicht gefunden, einfach miteinander verknüpft und eine Strukturierung ermöglicht werden kann, nutzen wir Kategorieren. Diese müssen den Artikeln manuell zugewiesen werden, am Ende des Artikels. Das geht wie folgt:

 [[Kategorie:Kategoriename]]

Im folgenden werden die Kategorien dokumentiert:

Bezeichnung	Nutzen für
Anleitung	Alle Artikel (ist die Oberkategorie) -> In der Artikelvorlage vorhanden
Netzwerk	WiFi, LAN, VPN
Software	Alle Anleitungen zu zentral lizenzierter Software
Email	RUBMail, RUBExchange
Collaboration	Alle Kollaborationsservices wie Exchange-Kalender, sciebo etc.
Sicherheit	?
Fileservices	Anleitungen zum Fileserver
RUB-Account	Alle Anleitungen zum RUB-Account wie Passwort, 2FA etc.
Videokonferenz	Alle Anleitungen zu Videokonferenzsystemen wie Zoom, DFN etc.

Vorlagen nutzen

Es stehen verschiedene Vorlagen in diesem Wiki zur Verfügung. Vorlagen sind in der Wiki-Welt nichts anderes als Artikel, die im Vorlagen-Bereich liegen. Meistens bestehen diese aus einzelnen Textbausteinen, die dann innerhalb eines Wikiartikels eingesetzt werden.

Artikelvorlage nutzen

Erstelle eine neue Anleitung mit Hilfe der unten stehenden Infobox. Gib einfach den gewünschten Seitentitel ein und du kommst direkt zur Artikelvorlage.

Die komplette Artikelvorlage findest du hier. Verändere diese selbst nicht.

Infobox

Rechts oben neben dem Einleitungssatz sollte eine Infobox eingefügt werden, die mit nachfolgendem Code aufgerufen werden kann. Achtung: Durch den Aufruf kann die Vorlage nicht geändert werden, man muss also eher die Seite öffnen und den Text aus der Vorlage kopieren, wenn man sie verwenden will:

 {{Vorlage:Infobox}}

Ergebnis:

Diese Anleitung gehört zum Service
Service	Hier Servicename laut unserer Webseite eintragen
Mehr Informationen	Hier HTTPS-Link eintragen

Hinweis

Wichtige Hinweise sollten stylistisch vom Rest des Textes abgehoben werden. Dazu kann folgende Hinweis-Vorlage Hinweis-Vorlage verwendet werden. Du rufst sie auf mit nach folgendem Befehl und ersetzt das Wort Beispieltext einfach mit deinem Text.

 
{{Vorlage:Hinweis|text=Beispieltext}}

Ergebnis:

Beispieltext

Artikelende

Jeder Artikel wird kategorisiert. Mometan gibt es für die Orientierung eine Kategorie. Daher kommt an das Ende jedes Artikels:

 [[Kategorie:Anleitung]]

Am Ende jedes Artikels sollte diese Vorlage stehen:

 {{Vorlage:FragenundProbleme}}

Ergebnis:

Weitere Unterstützung

Bei Fragen und Problemen können Sie sich an unseren Helpdesk wenden.

@@ Zeile 1: / Zeile 1: @@
 Dies ist der Anleitungsartikel für das ITS-Anleitungswiki. Zielgruppe sind Mitarbeitende von IT.SERVICES, die Anleitungen in dieses Wiki aufnehmen oder einen Anleitungsartikel ändern wollen.
-== Infobox ==
-Am Anfang der Artikelvorlage findest du eine Infobox. Fülle diese aus, damit die Nutzenden mehr Informationen zu dem Service, zu dem die Anleitung gehört, finden können.
 == Artikelstruktur ==
@@ Zeile 10: / Zeile 7: @@
 # Lösche aus der Artikelvorlage keine Vorlagen oder Infoboxen heraus.
-== Text strukturieren mit Überschriften ==
+== Infobox ==
+Am Anfang der Artikelvorlage findest du eine Infobox. Fülle diese aus, damit die Nutzenden mehr Informationen zu dem Service, zu dem die Anleitung gehört, finden können. Diese Infobox ist eine Tabelle.
+== Text strukturieren ==
+=== Abschnitte mit Überschriften erstellen ===
 Alle Überschriften werden in ein Inhaltsverzeichnis aufgenommen. Nutze sie also, um deine Anleitung zu strukturieren. Beginne mit 1-2 Einleitungssätzen, für welchen Service der Anleitungsartikel ist und nutze dann die Überschriften-Funktion, um den ersten Abschnitt der Einleitung zu beginnen.
@@ Zeile 17: / Zeile 19: @@
 Nutze die Optionen des Visual Editors, um deinen Text zu formatieren. Klicke auf "Erweitert", um mehr Optionen zu sehen. Wer interessiert ist an der Wiki-Formatierung findet [https://www.mediawiki.org/wiki/Help:Formatting/de hier den Help-Artikel].
+=== Links verwenden ===
+Die Wikimedia-Hilfe bietet [https://www.mediawiki.org/wiki/Help:Links/de einen Artikel] mit allen möglichen Verlinkungen.
+Alternativ kann im Editor über das Link-Zeichen ein Link gesetzt werden.
 === Vorschau nutzen um zu sehen, wie es aussehen wird ===
@@ Zeile 28: / Zeile 34: @@
 * Benenne Sie aussagekräftig, also passend für deinen Anleitungsartikel. Wenn alle Bilder für Firefox-Anleitungen nur "Firefox.png" heißen, führt das zu Chaos. Benutze das Schema '''Artikelname_Bildname.dateiendung'''.
-* Über den Link "Datei hochladen" lädst du dein Bild hoch. Anschließend wird es angezeigt, inklusive des Namens in diesem Wiki. Kopiere dir den Namen.
+* Über den Link "Datei hochladen" lädst du dein Bild hoch. "Zielname" wird nach dem Auswählen des Bildes automatisch ausgefüllt (lass es so). Schreibe bei "Beschreibung/Quelle" auf, woher das Bild kommt (z.B. Eigener Screenshot) und was das Bild zeigt. Anschließend wird die Bilddatei angezeigt, inklusive des Namens in diesem Wiki. Kopiere dir den Namen.
-* Benutze nachfolgenden Code, um dein Bild unter dem Text des Anleitungsschrittes einzufügen:
+* Manche Bilder können in mehreren Anleitungen verwendet werden. Schaue in die [[Spezial:Dateien|Dateiliste]], um bereits im Wiki hochgeladene Bilder einsehen und ggf. selbst nutzen zu können.
+* Benutze nachfolgenden Code, um dein Bild unter dem Text des Anleitungsschrittes einzufügen. Den zuvor kopierten Dateinamen ersetzt du nach "Datei:":
   <nowiki>[[Datei:Logo RUB BLAU rgb.jpg|800px|center|Kurzbeschreibung der Bilddatei]]</nowiki>
 Das Ergebnis sieht dann so aus:
 [[Datei:Logo RUB BLAU rgb.jpg|800px|center|Kurzbeschreibung der Bilddatei]]
+== Kategorisieren ==
+Damit Inhalte leicht gefunden, einfach miteinander verknüpft und eine Strukturierung ermöglicht werden kann, nutzen wir Kategorieren. Diese müssen den Artikeln manuell zugewiesen werden, am Ende des Artikels. Das geht wie folgt:
+ <nowiki> [[Kategorie:Kategoriename]]</nowiki>
+Im folgenden werden die Kategorien dokumentiert:
+{| class="wikitable" style="margin:auto"
+|-
+! Bezeichnung !! Nutzen für
+|-
+| Anleitung || Alle Artikel (ist die Oberkategorie) -> In der Artikelvorlage vorhanden
+|-
+| Netzwerk || WiFi, LAN, VPN
+|-
+| Software || Alle Anleitungen zu zentral lizenzierter Software
+|-
+| Email || RUBMail, RUBExchange
+|-
+| Collaboration || Alle Kollaborationsservices wie Exchange-Kalender, sciebo etc.
+|-
+| Sicherheit || ?
+|-
+| Fileservices || Anleitungen zum Fileserver
+|-
+| RUB-Account || Alle Anleitungen zum RUB-Account wie Passwort, 2FA etc.
+|-
+| Videokonferenz || Alle Anleitungen zu Videokonferenzsystemen wie Zoom, DFN etc.
+|}
 == Vorlagen nutzen ==
 Es stehen verschiedene Vorlagen in diesem Wiki zur Verfügung. Vorlagen sind in der Wiki-Welt nichts anderes als Artikel, die im Vorlagen-Bereich liegen. Meistens bestehen diese aus einzelnen Textbausteinen, die dann innerhalb eines Wikiartikels eingesetzt werden.
+=== Artikelvorlage nutzen ===
+Erstelle eine neue Anleitung mit Hilfe der unten stehenden Infobox. Gib einfach den gewünschten Seitentitel ein und du kommst direkt zur Artikelvorlage.
+<inputbox>
+type=create
+width=80
+break=no
+preload=Vorlage:Artikelvorlage
+buttonlabel=Neuen Artikel anlegen
+placeholder=Seiten Titel eingeben
+</inputbox>
+Die komplette Artikelvorlage findest du [[Vorlage:Artikelvorlage|hier]]. Verändere diese selbst nicht.
 === Infobox===
 Rechts oben neben dem Einleitungssatz sollte eine Infobox eingefügt werden, die mit nachfolgendem Code aufgerufen werden kann. Achtung: Durch den Aufruf kann die Vorlage nicht geändert werden, man muss also eher die Seite [[Vorlage:Infobox|öffnen]] und den Text aus der Vorlage kopieren, wenn man sie verwenden will:
@@ Zeile 42: / Zeile 90: @@
 Ergebnis:
 {{Vorlage:Infobox}} <br> <br> <br>
+=== Hinweis ===
+Wichtige Hinweise sollten stylistisch vom Rest des Textes abgehoben werden. Dazu kann folgende Hinweis-Vorlage [[Vorlage:Hinweis|Hinweis-Vorlage]] verwendet werden. Du rufst sie auf mit nach folgendem Befehl und ersetzt das Wort Beispieltext einfach mit deinem Text.
+ <nowiki>
+{{Vorlage:Hinweis|text=Beispieltext}}
+ </nowiki>
+Ergebnis:
+{{Vorlage:Hinweis|text=Beispieltext}}
 === Artikelende===
+Jeder Artikel wird kategorisiert. Mometan gibt es für die Orientierung eine Kategorie. Daher kommt an das Ende jedes Artikels:
+ <nowiki> [[Kategorie:Anleitung]]</nowiki>
 Am Ende jedes Artikels sollte diese Vorlage stehen:
   <nowiki> {{Vorlage:FragenundProbleme}} </nowiki>
 Ergebnis:
 {{Vorlage:FragenundProbleme}}