Zum Inhalt springen

Internal:HowToITSAnleitungswiki: Unterschied zwischen den Versionen

Aus ITS-SD-Anleitungen
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
Zeile 44: Zeile 44:
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.
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 ===
=== 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>
<inputbox>
type=create
type=create
Zeile 53: Zeile 54:
</inputbox>
</inputbox>


Eine komplette Artikelvorlage findest du [[Vorlage:Artikelvorlage|hier]]. Verändere diese selbst nicht, sondern gehe wie folgt vor:
Die komplette Artikelvorlage findest du [[Vorlage:Artikelvorlage|hier]]. Verändere diese selbst nicht.
# Rufe die [[Vorlage:Artikelvorlage|Artikelvorlage]] in einem neuen Fenster oder Tab auf.
 
# Rufe nun das Anleitungswiki in einem neuem Tab auf.
# Gib oben im Suchfeld den Namen deiner neuen Anleitung ein (Achtung, kann man nachher nicht ändern. Also Namen bitte zuerst überlegen.)
# Die Seite wird nicht gefunden. Klickst du nun auf den roten Text, kommst du direkt in den Bearbeitungsmodus des neuen Artikels mit der Bezeichnung, die du im Suchfeld eingegeben hast. Passt dir der Artikelname doch nicht, gib im Suchfeld einfach was anderes ein.
# Wenn du im Bearbeitungsmodus deines neuen Anleitungsartikels bist, gehe in den Tab mit der [[Vorlage:Artikelvorlage|Artikelvorlage]]. Wähle "Bearbeiten".
# Kopiere nun den gesamten Text aus dem Bearbeitungsmodus der Vorlage und füge diesen in deine Anleitung im Bearbeitungsmodus ein. Schließe den Tab der Artikelvorlage einfach.
# Nimm deine individuellen Änderungen vor. Lasse dir diesen HowTo-Artikel als Hilfestellung auf.
<br> <br>
<!-- Hier soll der Link zu einem Preloading Text sein, sodass man direkt auf die Artikel-Vorlage kommt-->
[https://wiki-test.it-services.ruhr-uni-bochum.de/ITS-SD-Anleitungen/index.php/Page?action=edit&preload=Vorlage:Artikelvorlage Link um neuen Artikel zu erstellen und dabei Vorlage nutzen (funktioniert noch nicht)]
=== Infobox===
=== 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:
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:

Version vom 17. Juni 2025, 07:46 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

  1. Zuerst kommen die Einleitungssätze zur Anleitung. Daneben die Infobox.
  2. Anschließend strukturierst du deinen Artikel mit Hilfe der Überschriften (s.u.).
  3. Es sollte immer zuerst der Schritt in Textform kommen und danach das Bild dazu. Zur Einbettung von Bildern und korrekten Benennung s.u..
  4. 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.

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.
  • 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:

Kurzbeschreibung der Bilddatei
Kurzbeschreibung der Bilddatei

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




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.