Handbuch:Erweiterung/BlueSpiceBookshelf/4-4

BlueSpice Version bis 4.4:Diese Hilfeseite gilt für die Buchfunktionalität von BlueSpice bis Version 4.4. Für BlueSpice 4.5+, gehen Sie zur aktuellen Dokumentation.

In BlueSpice pro können mehrere Wikiseiten zu einem strukturierten Buch mit Kapitelnavigation dargestellt werden. Das Buch kann auch als PDF-Datei mit Deckblatt gedruckt werden.

Eigenschaften von Büchern

Standardmäßig werden Bücher als "allgemeines Buch" erstellt. Allgemeine Bücher haben folgende Eigenschaften:

• Sie besitzen eine Buchnavigation.
• Auf Buchseiten wird anstelle der Hauptnavigation die Buchnavigation angezeigt.
• Eine Wikiseite, die zu einem allgemeinen Buch gehört ist durch ein <bookshelf />-Tag im Quelltext gekennzeichnet.
• Jede Seite kann nur in einem allgemeinen Buch enthalten sein.
• Bücher können komplett oder teilweise als PDF mit Deckblatt ausgedruckt werden.
• Sie sind alphabetisch im Bücherregal aufgelistet. Ein Ausblenden einzelner Bücher ist nicht möglich.
• Das Bücherregal ist über die Hauptnavigation erreichbar.

Ein Buch erstellen

Bücher werden auf der Seite Spezial:Bücherverwaltung erstellt. Diese Seite ist über den Link Verwaltung > Bücher im Menü Globale Aktionen erreichbar.

Bücherverwaltung

Um ein neues Buch zu erstellen:

1. Klicken Sie die +-Schaltfläche'.
2. Geben Sie einen Buchtitel ein.
3. Wählen Sie als Art des Buches "Allgemeine Bücher".
   

   Buch erstellen
4. Klicken Sie auf Fertig. Die Bearbeitungsseite des Buches wird nun geladen.

Wichtig!Das Buch wird erst im Wiki angelegt, wenn mindestens eine Seite im Buch gespeichert wurde.

Seiten hinzufügen

Sie befinden sich nun im Bearbeitungsmodus des Buches.

Bearbeitungsschaltflächen

1. Klicken Sie die Plus-Schaltfläche (1). Es öffnet sich ein Dialogfenster.
2. Suchen Sie nach einer Seite im Wiki und wählen Sie die gewünschte Seite aus. Soll in der Buchnavigation ein anderer Name angezeigt werden so können Sie ienen Anzeigetitle angeben (optional).
3. Klicken Sie Fertig.
4. Fügen Sie weitere Seiten hinzu.
5. Klicken Sie auf den Pfeil in der Speichern-Schaltfläche und wählen Sie Speichern und Kapitelnavigation in die Seite einfügen. Dieser Vorgang fügt in den Quelltext aller Wikiseiten des Buches das bookshelf-Tag ein. Hierdurch werden die Seiten entsprechend neu versioniert.
   

   Buchseiten speichern

Tipp:Sie können auf einen Seitentitel klicken, bevor Sie eine neue Seite erstellen. Diese wird dann als Unterkapitel eingefügt. Nachträglich können Sie Seiten über Drag & Drop mit der Maus in die gewünschte Position schieben.

Das Buch wird nun im Bücherregal des Wikis angezeigt. Das Bücherregal ist über die Einstiegslinks in der Hauptnavigation erreichbar.

Hinweis:Es gibt keine Möglichkeit, direkt vom Bücherregal in die Bücherverwaltung zu wechseln.

Massenhinzufügen von Seiten

Wenn Sie alle Seiten aus einer Kategorie oder alle Unterseiten einer Seite gesammelt in das Buch einfügen möchten, können Sie die Schaltfläche Massenhinzufügen (2) verwenden. Mit dieser wird ein Dialogfenster geöffnet, der verschiedene Kriterien zur Auswahl von Seiten enthält:

• Alle Seiten einer Kategorie hinzufügen: Hierbei werden auch Seiten aus dem Datei-Namensraum eingefügt, wenn diese der Kategorie zugeordnet sind.+
• Alle Unterseiten einer bestimmten Seite hinzufügen.
• Aus einer Seitensammlung hinzufügen: Seitensammlungen sind Seitenlisten im MediaWiki-Namensraum, die normalerweise über exportierte Suchergebnisse erstellt werden.

Nachdem Sie die gewünschten Seiten zum Buch hinzugefügt haben, klicken Sie auf Speichern. Nun haben Sie eine Wikiseite im Namensraum Buch. Die Seite stellt nun das Inhaltsverzeichnis der im Buch enthaltenen Wikiseiten bereit.

Metadaten einfügen

Während der Bearbeitung eines Buches können auch Metadaten hinzugefügt werden. Um Metadaten zu bearbeiten, wählen Sie den obersten Knoten des Buches (erste Seite) aus und klicken Sie auf das Schraubenschlüssel-Symbol. Ein Dialog wird geöffnet, in dem verschiedene Metadaten hinzugefügt oder entfernt werden können. Zu den wichtigsten Metadaten gehören:

• Titel
• Untertitel
• Autor 1 und 2
• Dokument Identifikation
• Dokumentenart
• Abteilung
• Ausführung
• Vorlage (PDF)
• Inhaltsverzeichnis (Nur Artikelbezeichnungen oder Artikel einbetten TOCs)

Grafik für die Galerieansicht hinzufügen

Fügen Sie ein Metadatenelement Bookshelf-Bild hinzu, um ein Cover-Foto für das Buch hinzuzufügen. Wählen Sie diese Option aus der Dropdown-Liste aus und klicken Sie auf Hinzufügen. Geben Sie anschließend den Namen des Bildes (ohne Präfix "Datei:") in das Wertefeld ein. Jedes aktuell im Wiki hochgeladene Bild kann verwendet werden. Anschließend wird das Bild in der Büchergalerie angezeigt. Das Bild wird allerdings nicht für den PDF-Export als Cover-Bild verwendet (Ausnahme: BlueSpice cloud).

Arten von Büchern

Art	Beschreibung	Kapitelnavigation
Allgemeine Bücher	Diese Bücher sind für alle Benutzer sichtbar. Allgemeine Bücher zeichnen sich durch ihre Buchnavigation aus. In fast allen Fällen wird ein Buch als "allgemeines Buch" angelegt.	ja
Eigene Bücher	Ein eigenes Buch ist nur für den Buchersteller in der Bücherliste sichtbar. Eigene Bücher werden meistens erstellt, um Wikiseiten gesammelt als PDF mit Deckblatt zu exportieren.	nein
Temporäre Bücher	Diese Auswahl steht auch Wiki-Nutzern zur Verfügung, die nicht im Wiki angemeldet sind. Diese Bücher werden nur temporär im Browser des Anwenders gespeichert und nicht im Wiki selbst. Wird der Browser-Cache gelöscht oder wechselt der Benutzer zu einem anderen Browser, steht das Buch nicht mehr zur Verfügung. Ziel von temporären Büchern ist hauptsächlich, dass sich Benutzer Wikiseiten gesammelt als PDF ausdrucken können.	nein

Ein Buch exportieren

Bücher, einzelne Kapitel oder sogar einzelne Buchseiten können als PDF-Dateien exportiert werden:

1. Öffnen Sie das Buch in der Bücherverwaltung.
2. Wählen Sie alle zu exportierenden Seiten oder Kapitel aus, indem Sie auf die entsprechenden Kontrollkästchen klicken. Unterkapitel werden automatisch ausgewählt.
3. Klicken Sie auf das Dropdown-Menü "Auswahl exportieren", um eine Liste der verfügbaren Formate zu öffnen. Durch Klicken auf eines der angebotenen Formate wird der Buchexport gestartet.
   

Aktionen in der Bücherverwaltung

Der Link Verwaltung > Bücher im Menü Globale Aktionen lädt die Seite Spezial:Bücherverwaltung. Hier können Sie Ihre Bücher bearbeiten.

Aktionen in der Bücherverwaltung

• Bearbeiten (1): Wechsel zum Bucheditor.
• Löschen (2): Löscht das Buch (das heißt, die Inhaltsseite des Buches im Namensraum Book, ohne die Wikiseiten selbst zu löschen).
• Duplizieren (3): Dupliziert die Buchseite und alle Seiten des Buches. Hierfür wird ein Namensraum ausgewählt.
• Exportieren (4): Exportiert alle Wiki-Seiten in diesem Buch als PDF. Ein Wechsel zum Bucheditor des Buches erlaubt es, einzelne Seiten als PDF zu exportieren.
• Zuweisen (5): Weist das Buch bestimmten Benutzern zu. Die Zuweisung kann von Benutzern unter den Benutzerwerkzeugen und von Administratoren in der Verwaltung eingesehen werden.

Konfiguration

Buchexport

Wiki-Administratoren können folgende Anpassungen für den Buchexport vornehmen:

• Freigabeinformationen im PDF anzeigen:
  Druckt den Zeitstempel für die letzte freigegebene Version unter der Überschrift im PDF aus (Datum der Freigabe und Datum der letzten Bearbeitung vor der Freigabe).
  
  

  FlaggedRevs-Info unter der Überschrift

• Das Namensraumpräfix bei Buchartikeln in der Ausgabe unterdrücken: Das Namensraumpräfix einer Seite wird im exportierten Buch (PDF) nicht angezeigt.

• Veraltete Seiten im PDF mit einem Wasserzeichen markieren: Zeigt das Wasserzeichen für abgelaufene Seiten in PDFs an.
• Veraltete Seiten im Druck mit einem Wasserzeichen markieren: Zeigt das Wasserzeichen für abgelaufene Seiten an, wenn eine Seite gedruckt wird.

Die Exporteinstellungen wirken sich darauf aus, wie die Seiten eines Buches beim PDF-Export generiert werden.

• Bookshelf: Liste mit Freigabekommentaren zeigen: Zeigt am Anfang des PDFs eine Liste der PDF-Seiten an, die eine freigegebene Version haben. Wenn der Begutachter beim Akzeptieren der Seite keinen Kommentar angegeben hat, ist das Feld Freigabekommentar leer.

Liste freigegebener Seiten

• Bookshelf: Liste von nicht freigebenen Seiten zeigen: Zeigt am Anfang des PDFs eine Liste mit den PDF-Seiten an, die lediglich als Erstentwurf existieren und keine freigegebene Version haben.
  
  

  Seiten im Erstentwurf
  
  
• Bookshelf: Liste von Seiten ohne FlaggedRevs-Information zeigen: Zeigt am Anfang des PDFs eine Liste mit den PDF-Seiten an, die keinen Freigabemechanismus haben.
  
  

  Seiten ohne Freigabemechanismus
• UEModulePDF: Informationen über Freigabestatus unterhalb der Überschrift anzeigen: Druckt den Zeitstempel für die letzte freigegebene Version unter der Überschrift im PDF aus (Datum der Freigabe und Datum der letzten Bearbeitung vor der Freigabe).
  
  

  FlaggedRevs-Info unter der Überschrift

Größenbegrenzung des Buchexports konfigurieren (Server)

Standardmäßig ist der Buchexport auf 50MB begrenzt. Um die maximal erlaubte Dateigröße zu erhöhen, führen Sie folgende Schritte durch:

1. In Apache Tomcat die Datei web.xml aufrufen:

   sudo -s
   nano /opt/tomcat/webapps/manager/WEB-INF/web.xml
   

2. Dort folgende Zeilen suchen und den gewünschten Wert eingeben (z.B. für 250MB=26214400)

   <max-file-size>262144000</max-file-size>
   <max-request-size>262144000</max-request-size>
   

3. Für die Webapp BShtml2PDF gibt es ebenso eine Einstellung für die maximale Dateigröße:

   nano /opt/tomcat/webapps/BShtml2PDF/WEB-INF
   

4. Dort folgende Zeilen ebenso entsprechend anpassen auf:

   <param-name>maxMemSize</param-name> <param-value>26214400</param-value>
   <param-name>maxFileize</param-name> <param-value>26214400</param-value>
   

5. Apache Tomcat neu starten

   service tomcat restart
   

Ein Buch löschen

Wenn Sie ein Buch löschen, entfernen Sie nur die Buchseite des Buches (also das Inhaltsverzeichnis). Die Wiki-Seiten im Buch werden jedoch nicht gelöscht. Bevor Sie das Buch löschen, werden Sie in einem Popup-Menü darüber informiert, dass das bookshelf-Tag nicht automatisch von den Seiten entfernt wird.

Die bookshelf-Tags haben nach dem Löschen des Buches keine Auswirkung auf die Wiki-Seiten. Wenn Sie sie manuell entfernen möchten, können Sie zur Seite Spezial:Text ersetzen gehen und ein "Suchen und Ersetzen" durchführen.

Ein Buch duplizieren

Sie können eine vollständige Kopie des Buches erstellen, indem Sie es duplizieren:

So duplizieren Sie ein Buch:

1. Geben Sie einen Zielnamen ein: Der Standardwert ist der Buchname mit dem Suffix (Kopie). Ändern Sie dies, um einen anderen Buchtitel zu erstellen.
2. Wählen Sie einen Namensraum: Wählen Sie einen Namensraum aus, der sich vom ursprünglichen Namensraum unterscheidet.

Wenn Sie nicht aufpassen, kann dies zu unbeabsichtigten Konsequenzen führen. Wenn Sie ein neues Buch erstellen, erstellen Sie auch Kopien aller Wiki-Seiten im Originalbuch. Da ein Namensraum nicht zweimal dieselbe Seite enthalten kann, müssen Sie die Dateien in einen anderen Namensraum kopieren.

Über die duplizierten Seiten:

• Buchseite: Eine neue Seite im Namensraum-Buch. Wenn Sie keinen neuen Titel eingeben, wird das Buch mit demselben Titel und dem Suffix (Kopie) erstellt. Z.B. Mitarbeiterhandbuch (Kopie). Diese Datei enthält eine Kopie der Struktur Ihres Originalbuchs mit den entsprechenden Links zu den duplizierten Seiten in der neuen Kopie.
• Wikiseiten: Alle im Originalbuch enthaltenen Seiten werden dupliziert. Folgende Szenarien sind möglich:
  • Gleicher Namensraum: Wenn Sie ein Buch im gleichen Namensraum duplizieren, werden keine tatsächlichen Duplikate des tatsächlichen Wikis erstellt. Stattdessen wird das Bookshelf-Tag so aktualisiert, dass es auf die Kopie des Buches verweist. Wenn Ihr ursprüngliches Buch beispielsweise die Seite "HR:Qualitätssicherung" enthält (das Buch befindet sich im Namensraum HR), enthält die Seite "Qualitätssicherung" jetzt das Bookshelf-Tag .
  • Anderer Namensraum: Wenn Sie die Buchkopie in einem anderen Namensraum erstellen, bleibt das Bookshelf-Tag in den Originaldateien unverändert. Die neuen Seiten im anderen Namensraum werden mit einem Bookshelf-Tag für die neue Buchkopie erstellt. Dies ist höchstwahrscheinlich das gewünschte Szenario.

Buchnavigation anpassen

Das Standardlayout der Buchnavigation eignet sich gut für Bücher mit wenig Kapiteln und kurzen Kapiteltiteln und sieht so aus:

Standard-Buchnavigation

In größeren Büchern und bei längeren Kapiteltiteln ist vielleicht eine kompaktere Darstellung mit engeren Abständen und kleinerer Schriftgröße gewünscht:

Angepasste Kapitelnavigation

Hierzu fügen Sie auf der Seite MediaWiki:Common.css folgende Formatierung hinzu:

/*Angepasste Kapitelnavigation */
h4.book-title {margin: 1em 0 0.5em -24px}

.bs-treenode-value {font-size:0.9em;  padding-bottom:4px; padding-left:20px; text-indent:-16px; width: 230px;}

.bs-treenodeitem > div {line-height:1.4em; padding-top:4px}
.bs-treenodeitem > div span.bs-icon {padding-left: 10px;}
.bs-treenodeitem > div > .bs-icon:before {margin-right: 0;}

#n-book-panel .bookshelfui-chapterpager {display:none} /*Umblättern verstecken */

Buch-Inhaltsverzeichnis auf einer Seite einbinden   v4.4+

Über das Content Droplet "Buch-Inhaltsverzeichnis" läßt sich das Inhaltsverzeichnis des Buches oder eines einzelnen Kapitels auf einer beliebigen Wiki-Seite einfügen.

Buch-Inhaltsverzeichnis

Einen Link zum PDF-Download erstellen

Mit dem Content-Droplet „Buch-PDF-Link“ kann auf einer Wiki-Seite ein Link eingefügt werden, der ein Buch direkt als PDF herunterlädt.

Berechtigungen

Um Bücher erstellen und bearbeiten zu können, müssen Benutzer im Buch-Namensraum die Berechtigung zum Bearbeiten besitzen. Darüber hinaus kann der Benutzer dem Buch nur Seiten hinzufügen, die dieser Benutzer lesen kann. Wenn ein Benutzer ein Buch exportieren will, das Seiten enthält, auf die dieser Benutzer keinen Zugriff hat, wird eine Fehlermeldung angezeigt.

Weiterführende Links

• Referenz:BlueSpiceBookshelf
• PDF-Ausgabe anpassen

Tag: XML-Tags, welche beliebig parametrisiert werden können und eine vom Programmierer gewünschte Ausgabe produzieren. Fügt man beispielsweise das <bs:bookshelf>-Tag ein, dann erhält der Artikel die Kapitelnavigation des PDF-Buches, in dem der Artikel verlinkt ist.

Kategorien helfen, Seiten im Wiki zur organisieren. Jede Kategorie ist im gesamten Wiki verfügbar.

Im Wiki abgetrennter Bereich, dessen Inhalte über spezielle Berechtigungen gelesen und bearbeitet werden können. Einen Namensraum erkennt man an einem Präfix vor dem Artikeltitel.

Wird im Wiki von einem "Artikel" gesprochen, so ist damit in der Regel der Inhalt einer Einzelseite gemeint. Im Zusammenhang mit im Wiki erstellten Büchern ist ein Artikel oft gleichbedeutend mit einem Buchkapitel.

---

Feedback zur Dokumentation ist im Community-Forum möglich.