Bookstack - Aufbau und Verwendung

• Was ist BookStack?
• Aufbau der Plattform
• Die Startseite
• Bereich Bücher
• Bereich Regale
• Navigieren in einem Buch
• Die Suchfunktion in der Kopfleiste
• Ihr persönliches Profil
• Rechte und Rollen

Was ist BookStack?

Das Gauß-IT-Zentrum (GITZ) der TU Braunschweig stellt Anleitungen für Studierende und Beschäftigte bereit. 
Als Grundlage hierfür wird BookStack verwendet, eine vielseitige Opensource-Software. Unsere Anleitungen sind erreichbar unter: https://books.rz.tu-bs.de/. Die Software orientiert sich an dem Vorbild einer Bibliothek, in der verschiedene Bücher und verschiedene Themenkategorien in Regalen existieren.

Aufbau der Plattform

Die Startseite

Die Startseite gliedert sich übersichtlich in vier klar definierte Bereiche. Die Kopfleiste erfüllt die Funktion der Basisstruktur und fungiert als Navigation auf dieser Seite. In ihr finden Sie die praktische Suchfunktion, die Ihnen die Möglichkeit gibt, mit Hilfe von Stichwörtern gezielt nach Büchern oder Regalen zu suchen. Zudem bieten die Reiter 'Bücher' und 'Regale' die Option, auf weitere Seiten zu navigieren. Im Abschnitt 'Bücher' werden Ihnen analog zur Startseite die vorhandenen Bücher präsentiert. 'Regale' hingegen präsentiert eine Reihe von thematisch sortierten Kategorien, in denen Bücher, die ein bestimmtes Thema betreffen, eingegliedert sind. Mithilfe des Buttons 'Anmelden' haben Sie die Möglichkeit, sich mit Ihrer persönlichen TU-Benutzerkennung anzumelden. Dies könnte die Auswahl der Bücher, die Ihnen angezeigt werden, beeinflussen. Daher empfehlen wir Ihnen, sich bei der Nutzung von BookStack anzumelden. Ein einfacher Klick auf das Logo von BookStack oder auf den Titel 'Anleitung des GITZ' in der linken Kopfzeile führt Sie zu jeder Zeit zurück zur Startseite.

Der verbleibende Bildschirmbereich teilt sich in drei Segmente auf. Im linken Abschnitt finden Sie Bücher, die Sie kürzlich angesehen haben oder Seiten, die vor kurzem aktualisiert wurden. Ein einfacher Mausklick führt Sie direkt zu dem angegebenen Buch, Regal oder der jeweiligen Buchseite. Auf der rechten Seite des Bildschirms befinden sich handhabbare Aktionen. Hier haben Sie die Möglichkeit, die Bücher im mittleren Bereich entweder als Liste oder in einer Gitteransicht darstellen zu lassen. Es besteht auch die Option, sich alle verwendeten Stichworte (Tags) für Bücher anzeigen zu lassen. Die Funktion "Details anzeigen" ermöglicht Ihnen zudem, im linken Bereich des Bildschirms detaillierte Informationen zu den einzelnen Büchern, Seiten oder Regalen zu erhalten. Des Weiteren können Sie zwischen einem Dunkel- und einem Hellmodus für die Seitenansicht wechseln. Der zentrale Bereich präsentiert Ihnen eine Auswahl an Büchern, die Sie nach Namen, Erstellungsdatum oder Aktualisierungsdatum sortieren können. Ein einfacher Mausklick ermöglicht es Ihnen, das gewünschte Buch zu öffnen.

Bereich Bücher

In diesem Abschnitt finden Sie alle Bücher des GITZ, die eine Fülle an Anleitungen und Informationen bieten. Das Menü "Bücher" ist strukturiert wie die Startseite. Auf der linken Seite werden Ihnen beliebte und neue Buchvorschläge präsentiert. Auf der rechten Seite stehen Ihnen verschiedene Aktionen zur Verfügung. Hier können Sie die Anzeigeoption (Liste oder Gitteransicht) wählen und Tags anzeigen lassen. Im zentralen Bereich können Sie Bücher nach Namen, Erscheinungsdatum und letztem Update sortieren. Mit einem einfachen Klick können Sie die Bücher öffnen und durchstöbern.

Bereich Regale

In diesem Abschnitt finden Sie verschiedene Themenkategorien, die als Regale fungieren und in die die Bücher eingeordnet sind. Dies ist vergleichbar mit den thematisch sortierten Regalen einer Bibliothek. Die Themenbereiche können nach Namen, Erstellungsdatum und Aktualisierungsdatum sortiert werden. Auf der linken Seite werden sowohl beliebte und neue Regale als auch jene, die Sie bereits angesehen haben, hervorgehoben. Im rechten Abschnitt des Bildschirms finden Sie verschiedene Aktionen. Hier können Sie zwischen einer Listen- und einer Gitteransicht für die Regale wählen und sich die verwendeten Tags anzeigen lassen.

Navigieren in einem Buch

Um ein Buch zu öffnen, müssen Sie es mit einem einfachen Mausklick anklicken. Hierdurch gelangen Sie zum Inhaltsverzeichnis des Buches.

Sie erhalten Zugriff auf das Inhaltsverzeichnis des Buches. Mit einem einfachen Mausklick können Sie problemlos zwischen den verschiedenen Seiten navigieren. Links finden Sie eine Suchfunktion sowie Informationen zu den verwendeten Tags und den letzten Aktualisierungen des geöffneten Buches. Die Suchfunktion ermöglicht Ihnen, das Buch gezielt zu durchsuchen. Geben Sie einfach einen Suchbegriff ein und bestätigen Sie mit der Enter-Taste. Um die Suche zu beenden, können Sie den Button „Filter löschen“ in der Mitte der Seite verwenden.

Auf der rechten Seite finden Sie zusätzliche Details sowie die Exportfunktion, die es Ihnen ermöglicht, das Buch in verschiedenen Dateiformaten herunterzuladen. Sollten Sie eingeloggt sein, haben Sie zusätzlich Zugang zu den Funktionen 'Favouriten' und 'Beobachten'. Um das Buch, ein bestimmtes Kapitel oder eine Seite leicht wiederzufinden, können Sie es durch Klicken auf den 'Favouriten'-Button zu Ihren Favoriten hinzufügen, die Sie dann über ein separates Menü einsehen können. Mit einem weiteren Klick können Sie es ebenfalls wieder aus den Favoriten entfernen. Über den 'Beobachten'-Button können Sie sich benachrichtigen lassen, wenn das Buch, das Kapitel oder die Seite aktualisiert wird.

Im Inhaltsverzeichnis werden Seiten in blauer Farbe und Kapitel in gelber Farbe dargestellt. Wenn Sie ein Kapitel anklicken, wird eine neue Seite mit den verschiedenen Unterseiten dieses Kapitels angezeigt. Sie können das Kapitel ebenso mit der Suchfunktion durchstöbern. Zudem wird eine Navigationsleiste für das Buch angezeigt, die Ihnen hilft zu verstehen, wo Sie sich gerade im Buch befinden. Haben Sie eine Seite ausgewählt, öffnet sich diese und Sie können sich durch Scrollen auf ihr bewegen. Die Seitennavigation zeigt dabei stets Ihren aktuellen Standort auf der Seite an. Des Weiteren finden Sie über dem Buch eine Leiste, die Ihnen zu jeder Zeit den Pfad anzeigt, auf dem Sie sich gerade befinden.

Wenn Sie innerhalb des Buches navigieren möchten, können Sie dies entweder mittels der Buchnavigation oder durch Anklicken des dargestellten Pfades oberhalb des geöffneten Buches bewerkstelligen. Das oberste in Grün dargestellte Element repräsentiert das Buch selbst. Bei einem Klick darauf wird Ihnen das allgemeine Inhaltsverzeichnis angezeigt.  Unter der Seite haben Sie die Möglichkeit durch Mausklick zur vorherigen oder nächsten Seite im Buch zu springen.

Die Suchfunktion in der Kopfleiste

Möchten Sie alle unsere Anleitungen durchstöbern, so empfiehlt sich die Nutzung unserer Suchfunktion, welche Sie in der Kopfzeile finden. Ein einfacher Klick in das Suchfeld genügt, um Ihre Suche zu initiieren. Nachdem Sie Ihren Suchbegriff eingegeben haben, bestätigen Sie diesen bitte mittels der Enter-Taste. Im mittleren Bereich des Bildschirms werden Ihnen sodann die Suchergebnisse präsentiert. In unserem Farbschema erscheinen Bücher in einem sanften Grün, Seiten erstrahlen in Blau. Kapitel werden durch ein sonniges Gelb repräsentiert, während Regale in Rot dargestellt werden.

Für eine präzisere Suche stehen Ihnen auf der linken Seite der Suchmaschine zusätzlich verschiedene Optionen zur Verfügung, mit denen Sie Ihre Suche eingrenzen können. Um diese spezifizierte Suche zu starten, betätigen Sie bitte den blauen Button ‚Update Search‘ am unteren Ende des Auswahlfelds. Aktiviert durch Ihren Klick, wird nun die detaillierte Suche ausgeführt. Möchten Sie die Suchmaschine verlassen, bieten sich Ihnen verschiedene Optionen an. Entweder Sie klicken in der Kopfleiste auf die Kategorien 'Regale' oder 'Bücher', oder Sie betätigen das Logo von BookStack, welches Sie direkt auf unsere Startseite führt.

Ihr persönliches Profil

Nachdem Sie sich mit Ihrer persönlichen TU-Nutzerkennung eingeloggt haben, können Sie durch einen Mausklick auf Ihren Profilnamen auf verschiedene Erweiterungen zugreifen.

Mit einem Klick auf den Reiter "Favoriten" gelangen Sie zu Ihrer persönlichen Favoriten-Übersicht. Dort finden Sie eine Zusammenstellung von Ihnen markierten Büchern, Kapiteln und Seiten, die Sie durch einen einfachen Mausklick öffnen können. Bücher werden grün dargestellt, Kapitel gelb und einzelne Seiten eines Buches blau.

Im Profil-Reiter können Sie einsehen, wie viele Seiten, Kapitel, Bücher oder Regale Sie erstellt haben. Diese Information ist jedoch nur relevant, wenn Sie Schreibberechtigungen für BookStack besitzen.

Im Abschnitt "Account" können Sie die Details zu Ihrem Profil, Zugang und Sicherheit, UI-Abkürzungen und Benachrichtigungseinstellungen einsehen. Unter "Profil" finden Sie Ihren Namen und Ihre verwendete E-Mail-Adresse. Zudem haben Sie die Möglichkeit, ein Profilbild auszuwählen und Ihre bevorzugte Sprache einzustellen. Vergessen Sie nicht, Ihre Änderungen zu speichern, nachdem Sie diese vorgenommen haben.

Im Bereich "Zugang und Sicherheit" haben Sie die Möglichkeit, für Ihren Account eine Multi-Faktor-Authentifizierung einzurichten, wenn Sie dies wünschen. Klicken Sie dazu auf die Schaltfläche "Verwalten" und wählen Sie zwischen der Handy-App-Authentifizierung oder der Backup-Code-Authentifizierung. Die Plattform führt Sie durch den gesamten Prozess.

Bei Bedarf können Sie unter dem Abschnitt "Einstellungen für UI-Abkürzungen" Anpassungen vornehmen. Aktivieren Sie die Tastenkombinationen durch einen Klick in das entsprechende Kästchen, geben Sie die gewünschten Tastenkombinationen in die vorgesehenen Felder ein und speichern Sie Ihre Änderungen durch Klicken auf "Tastenkürzel speichern".

Im letzten Register haben Sie die Möglichkeit, Ihre Benachrichtigungseinstellungen anzupassen und zu überprüfen, welche Elemente Sie beobachten und welche Sie ignorieren. Um ein Element aus dem Beobachtungsmodus zu entfernen, klicken Sie einfach auf das entsprechende Element, um es zu öffnen. Im Bereich "Details" auf der linken Seite können Sie schließlich durch Klicken auf das Augensymbol die Beobachtungsstufe festlegen.

Mit einem einfachen Klick auf „Dunkler Modus“ können Sie nahtlos zwischen den verschiedenen Anzeigeoptionen wechseln und den Wechsel zum „Hellen Modus“ durch erneutes Klicken vollziehen. Um sich abzumelden, klicken Sie bitte auf den Abmeldebutton. Nach der Abmeldung gelangen Sie durch einen Klick auf das BookStack-Logo zurück zur Startseite.

Rechte und Rollen

Standardrechte

Standardmäßig ist der Ersteller eines Buches der Besitzer und gleichzeitig die Person mit allen Rechten für das erstellte Buch. Zudem ist die Rolle Gauß-IT-Zentrum standardmäßig für alle vier Aktionen (Vererben, Anzeigen, Aktualisieren und Löschen) berechtigt. 

Die Standard-Rolle "Alle anderen" ist leer. Auch Nicht-Angemeldete, sind hier nicht drin. 

Schnelldurchlauf (TL;DR)

Sichten- und Bearbeiten-Rechte für Abteilungs-Kollegen

Möchte man einen Artikel für die Sichtung und Bearbeitung für seine Abteilung freigeben, so muss:

1) seine Abteilung unter "Berechtigung für Rolle überschreiben" ausgewählt werden,
2) "Anzeigen" und "Aktualisieren"  angehakt werden und
3) die Berechtigung gespeichert werden. 

TU-Intern lesend freigeben (Authentifizierte TU-Mitglieder)

Möchte man eine Anleitung für authentifizierte TU-Angehörige freigeben, so wählt man

1) die Rolle "TU-Internal" unter "Berechtigung für Rolle überschreiben" aus,
2) setzt den Haken bei "Anzeigen" und
3) speichert die Berechtigung ab. 

Public freigeben (nicht angemeldete Benutzer)

Möchte man eine Anleitung publizieren, sodass auch nicht angemeldete Benutzer die Anleitungen lesen können (häufigster Fall), so wählt man

1) die Rolle "Public" unter "Berechtigung für Rolle überschreiben" aus,
2) setzt den Haken bei "Anzeigen" und
3) speichert die Berechtigung ab. 

Wenn man ein Element auf Public setzt, muss man eine weiter Rolle in welchen man zugeordnet ist mit Schreibebrechtigung versehen. 

so ist es falsch

so ist es richtig

 

Rollen

Folgende Rollen sind in Bookstack implementiert.

Rollen aus LDAP-Gruppen (bzw. gecos)

• Gauß-IT-Zentrum (Standardmäßig voll berechtigt, aber nicht direkt erkennbar). PS: Wenn man der Rolle Gauß-IT-Zentrum alle Häckchen setzt (Vererben, Anzeigen, Aktualisieren und Löschen) entspricht dies der Standardeinstellung.
  
• TU-Internal (Berechtigung muss für erstellte Inhalte gesetzt werden (z.B. Anzeigen)

Rollen die in Bookstack von einem Kreis von Mitarbeitern gepflegt werden

• team_infoportal

System Rollen (Standard-Rollen)

• Public (Für nicht authentifizierte Personen die Standardrolle). (Standardmäßig für nichts berechtigt, aber nicht direkt erkennbar). PS: Wenn man der Rolle Public alle Häckchen entfernt, (Vererben, Anzeigen, Aktualisieren und Löschen) entspricht dies der Standardeinstellung.

Alle Anderen: Dies ist zu verstehen las "Null-Rolle". Hier befinden sich keine Personen

Eigenschaften dieser Rollen

Die Rollen "Gauß-IT-Zentrum", "Anwendungen", "Entwicklung", "Netze", "Server", "Support" und "TU-Internal" ("authentifizierte Benutzer") sind Rollen die aus dem LDAP automatisch befüllt werden.

Um also allen Personen einer Abteilung bestimmte Rechte zu gewähren, muss die entsprechende Abteilung in den Rollen ausgewählt werden.

Um Allen TU-Angehörigen Anleitungen zum Lesen zur Verfügung zu stellen, wählen wir die Rolle "TU-Internal" aus.

Die Rolle team_infoportal wird von Kollegen des Teams Infoportal gepflegt, sodass nur ein eingeschränkter Personenkreis die Anleitungen überhaupt erst sehen kann.

Die Rollen "Editor", "Viewer" und "Public" sind System-Rollen. Wir nutzen die Rolle "Public" um nicht-authentifizierten Benutzern das Recht "Anzeigen" ("lesen") zuzuweisen.

Rechte

Folgende rechte kann man den Rollen zuteilen

• Anzeigen
• Aktualisieren
• Löschen

Das Recht "Anzeigen" berechtigt die Personen einer Rolle das Buch/Kapitel/die Seite zu sehen.

"Aktualisieren", bedeutet, dass Personen der Rolle das Objekt (Buch/Kapitel/Seite) bearbeiten können.

"Löschen" berechtigt dazu ein Objekt zu löschen.

 

 

Besitzer

Man kann den Besitz eines Objektes (Buch/Kapitel/Seite) an weitere Benutzer übertragen. Diesen ist es dann möglich die Berechtigungen zu bearbeiten.

Sollte ein Besitzer nicht mehr greifbar sein, kann nur noch der Bookstack-Administrator die Rechte bzw. den Besitz anpassen.