Benutzung

Best Practice

Gruppierung von Inhalten

Inhalte bzw. Seiten sind grundsätzlich unabhängig vom Status ihrer Veröffentlichung im thematisch passenden Buch einzusortieren. Bücher dienen der Gruppierung von Inhalten, nicht, um Berechtigungen und Status der Veröffentlichung abzubilden. Seiten, die nur intern sichtbar sein sollen, sollen in einem Kapitel intern zusammengefasst werden.

Gliederung von Seiten

Textformatierung

Inhalte aus anderen Dokumenten übernehmen

Bei der Übernahme von Inhalten, insbesondere aus Word-, PDF-Dokumenten und Web-Seiten ist darauf zu achten, dass Inhalte ohne Formatierung übernommen werden. Nach dem Kopieren (Strg + C) sollen diese mit Strg + Shift + V eingefügt werden.

Werden Inhalte aus Mails oder PDFs übernommen, werden Zeilenumbrüche mit übernommen. Zeilenumbrüche müssen entfernt und durch ein Leerzeichen ersetzt werden, damit der Textfluss gegeben ist.

Aus der PDF:

Hallo. Ich bin ein kleiner Blindtext. Und zwar[Umbruch]
schon so lange ich denken kann. Es war nicht[Umbruch]
leicht zu verstehen, was es bedeutet, ein blinder[Umbruch]
Text zu sein: Man ergibt keinen Sinn.

In Bookstack:

Hallo. Ich bin ein kleiner Blindtext. Und zwar[Leerzeichen]schon so lange ich denken kann. Es war nicht[Leerzeichen]leicht zu verstehen, was es bedeutet, ein blinder[Leerzeichen]Text zu sein: Man ergibt keinen Sinn.

Zudem sind vor und nach Überschriften keine Leerzeilen einzufügen:

Überschrift
[Leerzeile]
Hallo. Ich bin ein kleiner Blindtext.
[Leerzeile]
[Bild]
[Leerzeile]

Überschrift
Hallo. Ich bin ein kleiner Blindtext.
[Bild]

Verlinkungen

Anmerkungsfelder und Inline Code

Achtung: Wird verwendet, um besonders wichtige Sachverhalte darzustellen

Tipp: Wird verwendet, um besonders hilfreiche Tipps darzustellen

Information: Wird verwendet, um zusätzliche Hinweise darzustellen

Wird im Text beschrieben, dass ein Button o. ä. angeklickt werden soll, dann diesen mit dem Inline Code kennzeichnen:

Im Tab Bewertung sehen Sie die Bewertungen. Klicken Sie auf Speichern und beenden. (Strg + 8)

Formulierungen

Anleitungen

Bilder

Bilder können per Drag and Drop auf die Seite, mit Strg + v aus der Zwischenablage oder über den integrierten Zeichnungseditor eingefügt werden. Die letzten beiden Wege erzeugen PNGs. Bilder sollten

Dateiformat

Bilder können im JPEG- und PNG-Format eingefügt werden. Um die bestmögliche Bildqualität bei gleichzeitig geringer Dateigröße zu erzielen, sollte das passende Format gewählte werden:

Als JPEG gespeicherte Screenshots können Artefakte (unscharfe Kanten) enthalten, während bei im PNG-Format gespeicherten natürlichen Fotos Flächenbildung und Verfärbungen entstehen.

Formatierung

Screenshot beschriften und einfügen

Manchmal müssen in einem Screenshot Elemente hervorgehoben werden. Dazu wie folgt vorgehen:

  1. Screenshot erstellen, in Zwischenablage speichern
  2. Bildvorlage durch Doppelklick mit integrierten Editor öffnen
  3. Screenshot mit Strg + v aus der Zwischenablage einfügen
  4. Bilder nicht skalieren, da sie sonst unscharf werden
  5. gewünschte Stellen markieren, dazu vorhandene Elemente (Rahmen, Pfeile, Badges) duplizieren und auf Screenshot legen; Priorität der zu verwendenden Farben: Rot, Schwarz, Weiß, Blau
  6. Anzeigegröße auf 100 % stellen

    image.png

  7. Den mit Markierungen überlagerten Screenshot im Editor erneut screenshoten
  8. Screenshot mit Strg + v in Seite einfügen
  9. falls notwendig, Anzeigegröße im Rastermaß von 150 px verringern

    image.png

  10. Bildvorlage nicht speichern

Alternativtexte

Die. o. g. Punkte sind eine Zusammenfassung der Präsentation "Gute Alternativtexte schreiben" von Manu Heim der ETH Zürich.

Bei Unklarheit hier im Quellcode das unterste Bild anschauen. Im Quellcode lässt sich auch der Alternativtext von JPEGs anpassen.

Zeichnungseditor

Der integrierte Editor bietet die Möglichkeit, Zeichnungen zu erstellen. Das Ergebnisbild wird als PNG gespeichert uns ist später wieder bearbeitbar. Er hat folgende Vorteile:

Er hat aber auch folgende Nachteile gegenüber klassisch eingefügten Bildern:

  1. Screenshot oder Bilder sollen mit dem Button Zeichnung einfügen/bearbeiten bearbeitet werden:

Icons

🔗 https://www.urz.uni-leipzig.de/servicedesk-und-hilfe/kontakt-zum-servicedesk
📧 servicedesk@uni-leipzig.de
☎ +49 341 97-33333

▶️ Referat vs. Erklärfilm

Icons sind nur in Ausnahmefällen zu verwenden.

Anhänge

Inhalte sollten nativ, d. h. direkt mit dem vorhandenen Editor, eingepflegt werden. Die Verwendung von Anhängen ist nicht zu empfehlen. Anhänge

Formatierung

Text

Formatierung Tastenkombination für Windows
 Tastenkombination für Mac
Fett Strg + B ⌘ + b
kursiv Strg + I ⌘ + i
unterstrichen Strg + U

⌘ + u
Best Practice mit Bookstack (intern) Strg + Shift + K ⌘ + ⇧ + k
Universität Leipzig (extern) Strg + K
Inline Code Strg + 8
 ⌘ + ⇧ + e
ohne Formatierung einfügen
 Strg + Shift + v
 ⌘ + ⇧ + ⌥ + v

Große Überschrift (Strg + 1)

Mittlere Überschrift (Strg +2)

Kleine Überschrift (Strg + 3)

Sehr kleine Überschrift (Strg + 4)

Anmerkungen und Zitate

(1x Strg + 9) zusätzliche Information

(2x Strg + 9) hilfreiche Tipps

(3x Strg + 9) Warnung

(4x Strg + 9) besonders wichtige Sachverhalte

Zitate erstellt man mit Strg + 6

Damit kann man Skripte und Code mit automatischer Formatierung darstellen, damit der Code besser lesbar ist:

{
    "_comment:" "Code Highlighting mit Strg + 7",
    "Code:" "JSON",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "age": 45,
    "weight": 67,
    "admin": true
}

Listen und Nummerierungen

Unsortierte Liste (Strg + P)

Sortierte Liste (Strg + O)

  1. Chef
  2. Abteilungsleiter
  3. Teamleiter
  4. Mitarbeiter

Tabellen

Sie eignen sich zur strukturierten Darstellung, sind jedoch insbesondere für die Darstellung auf mobilen Geräten ungeeignet und sollten daher vermieden werden.

grammatische Personen

Singular Plural
1. Person ich wir
2. Person du ihr
3. Person er, sie, es sie

Bilder/Grafiken/Zeichnungen

Entscheidungsbaum über die Einrichtungsstruktur der UL

Begriffe und Formulierungen

Die "Wie wird das nochmal geschrieben?"-Liste

Inhalte wiederverwenden

Arbeiten mit ID-Seiten

ID-Seiten beinhalten Informationen, Texte, Bilder, die per Einbettung auf beliebig vielen Seiten genutzt werden können. Der Inhalt muss dabei nur auf der einen ID-Seite aktualisiert werden.

Eine englische Erklärung dazu befindet sich hier: Reusing Page Content · BookStack.

Eine ID-Seite muss eine öffentlich sichtbare Seite sein. Für die Einbettung der Seite oder eines Abschnittes wird der entsprechende Teil bzw. markiert und in dem Pop-up-Menü auf das Link-Symbol. Es wird ein Einbettungscode generiert.

Die Einbettung funktioniert nicht bei Aufzählungszeichen! Will man die originale ID-Seite finden, fügt man die ID-Nummer in die URL ein: https://kb.el.uni-leipzig.de/link/xxx

Dieser Code wird auf der Seite, wo der Inhalt eingefügt werden soll, hineinkopiert.
Beispiel zur Einbettung des EL-Kontaktes:

Support

📧 servicedesk@uni-leipzig.de
☎ +49 341 97-33333
Mo - Do 9 - 16 Uhr
Fr            9 - 14 Uhr
🔗 Servicedesk

📧 elearning@uni-leipzig.de
☎ +49 341 97-33334
Mo - Do 9 - 15 Uhr
Fr            9 - 14 Uhr

Seiten als Vorlage

Eine erstellte Seite kann als Vorlage für weitere neue Seiten genutzt werden. Bei der erstellten Seite klickt man rechts oben auf das Icon Vorlagen.

Möchte man die geöffnete Seite als Vorlage sichern, setzt man den Haken bei Seite ist eine Vorlage. Soll hingegen diese geöffnete Seite mit einer Vorlage gestaltet werden, sucht man darunter die entsprechende Vorlage.

Wird eine Vorlage genutzt, werden bereits erstellte Inhalte auf der Seite gelöscht!