Manual:Extension/BlueSpiceBookshelf/4-4

In BlueSpice pro, several wiki pages can be displayed for a structured book with chapter navigation. The book can also be printed as a PDF file with a cover sheet.

Characteristics of books

By default, books are created as a "general book". General books have the following characteristics:

• They povide a chapter navigation.
• On book pages, the book navigation is displayed instead of the main navigation.
• A wiki page that belongs to a general book is identified by a <bookshelf /> tag in the source code.
• Each page can only be included in one general book.
• Books can be printed completely or partially as a PDF with a cover sheet.
• They are listed alphabetically on the bookshelf. It is not possible to hide individual books.
• The bookshelf can be reached via the main navigation.

Creating a book

Books are created from the page Special:BookshelfBookManager. This page can be reached from the Global actions menu under Management > Books.

To create a book:

1. Click the +-button.
2. Enter a Book title.
3. Select Sie als Art des Buches "General books" as type of the book.
4. Click Done. The book editor loads next.

Important!The book is only created in the wiki when at least one page has been saved in the book.

Adding pages

You are now in the book editing mode.

1. Click the Plus button (1). A dialog window opens.
2. Search for a page in the wiki and select it. Soll in der Buchnavigation ein anderer Name angezeigt werden so können Sie ienen Anzeigetitle angeben (optional).
3. Click Done.
4. Add additional pages.

Tip:You can click a page title of a book page before adding a new book page. This is then inserted as a sub-chapter. You can move pages to the desired position later using drag & drop with the mouse.

1. Click the arrow of the Save button and select Save and add chapter navigation. Dieser Vorgang fügt in den Quelltext aller Wikiseiten des Buches das bookshelf-Tag ein. Hierdurch werden die Seiten entsprechend neu versioniert.

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

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

Mass-adding of pages

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.

Adding metadata

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)

Adding a cover image

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. Nachdem die Metadaten hinzugefügt wurden, geben Sie den Namen des Bildes in das Wertefeld ein. Jedes aktuell im Wiki hochgeladene Bild kann verwendet werden. Geben Sie den Namen ohne das Präfix "Datei:" ein, also nur den Namen und die Erweiterung des Bildes. Anschließend wird das Bild auf der Vorschauseite des Buches angezeigt und als Hintergrundbild im PDF-Cover verwendet.

Types of books

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

Exporting a book

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

1. Öffnen Sie das Buch im Bucheditor.
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.
   

Actions in the book manager

Der Link Verwaltung > Bücher im Menü Globale Aktionen lädt die Seite Spezial:Bücherverwaltung. Hier können Sie Ihre Bücher bearbeiten. alternativtext=Aktionen in der Bücherverwaltung|zentriert|mini|650x650px|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.

Configuration

Export

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

Configuring size limits for the book export (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
   

Deleting a book

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.

Duplicating a book

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.

Permissions

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.Template:Box Links

---

To submit feedback about this documentation, visit our community forum.