7 Books

m ((username removed) (log details removed))
No edit summary
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<bookshelf src="Book:User manual" />
{{DISPLAYTITLE:Books}}
{{DISPLAYTITLE:Books}}


Line 16: Line 17:
==Creating a book==
==Creating a book==
Books are created from the page  ''Special:BookshelfBookManager''. This page can be reached from the ''[[Manual:Extension/BlueSpiceDiscovery|Global actions]]'' menu under  ''Management > Books''.
Books are created from the page  ''Special:BookshelfBookManager''. This page can be reached from the ''[[Manual:Extension/BlueSpiceDiscovery|Global actions]]'' menu under  ''Management > Books''.
[[File:Manual:book-manager.png|alt=Book manager|center|thumb|650x650px|Book manager]]




'''To create a book:'''
'''To create a book:'''
#'''Click''' the <code>+</code>-button.
#'''Click''' the <code>+</code>-button.
#'''Enter''' a ''Book title.''
#'''Enter''' a ''Book title.''
#'''Select''' Sie als ''Art des Buches'' "General books" as type of the book.
#'''Select''' "General books" as type of the book.[[File:Manual:create-book.png|alt=Create a book|center|thumb|550x550px|Create a book]]
#'''Click''' ''Done''. The book editor loads next.
#'''Click''' ''Done''. The book editor loads next.
{{Messagebox|boxtype=important|icon=|Note text=The book is only created in the wiki when at least one page has been saved in the book.|bgcolor=}}
{{Messagebox|boxtype=important|icon=|Note text=The book is only created in the wiki when at least one page has been saved in the book.|bgcolor=}}
Line 28: Line 29:
===Adding pages===
===Adding pages===
You are now in the book editing mode.
You are now in the book editing mode.
[[File:Manual:bookshelf-schaltflächen.png|alt=Book edit buttons|center|thumb|220x220px|Book edit buttons]]


#'''Click''' the  ''Plus'' button (1).  A dialog window opens.
#'''Click''' the  ''Plus'' button (1).  A dialog window opens.
Line 33: Line 35:
#'''Click''' ''Done''.
#'''Click''' ''Done''.
#'''Add''' additional pages.
#'''Add''' additional pages.
#'''Click''' the arrow of the ''Save'' button and select ''Save and add chapter navigation.'' This process inserts the <code><nowiki><bookshelf /></nowiki></code> tag into the source code of all wiki pages in the book. This causes a revision of the pages.[[File:Manual:save chapternavigation.png|alt=Add chapter navigation|center|thumb|350x350px|Add chapter navigation]]
{{Messagebox|boxtype=tip|icon=|Note text=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.|bgcolor=}}
{{Messagebox|boxtype=tip|icon=|Note text=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.|bgcolor=}}
#'''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. [[Datei:Handbuch:bookshelf-speichern.png|alternativtext=Buchseiten speichern|zentriert|mini|400x400px|Buchseiten speichern]]
The book is now displayed on the wiki bookshelf. The bookshelf can be reached via the entry links in the main navigation.
Das Buch wird nun im Bücherregal des Wikis angezeigt.  Das Bücherregal ist über die Einstiegslinks in der Hauptnavigation erreichbar.


{{Messagebox|boxtype=note|icon=|Note text=Es gibt keine Möglichkeit, direkt vom Bücherregal in die Bücherverwaltung zu wechseln.|bgcolor=}}
{{Messagebox|boxtype=note|icon=|Note text=There is no option to go directly from the bookshelf to the book manager.|bgcolor=}}


===Mass-adding of pages===
===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:
After clicking "Mass add", a dialog is opened. It contains different criteria for page selection:


*Alle Seiten einer Kategorie hinzufügen: Hierbei werden auch Seiten aus dem Datei-Namensraum eingefügt, wenn diese der Kategorie zugeordnet sind.+
* All pages of a category
*Alle Unterseiten einer bestimmten Seite hinzufügen.
* All subpages of a certain page
*Aus einer Seitensammlung  hinzufügen: Seitensammlungen sind Seitenlisten im MediaWiki-Namensraum, die normalerweise über exportierte [[Handbuch:Erweiterung/ExtendedSearch|Suchergebnisse]] erstellt werden.
* From a page collection - page collections are lists of pages located in the MediaWiki namespace. They are usually created from [https://en.wiki.bluespice.com/wiki/Manual:Extension/BlueSpiceExtendedSearch#Export search results].
* By a semantic property - pages can be selected based on the value of a certain semantic property.
 
After adding your book pages click S''ave'' at the bottom of the page. Now you have created a page in the namespace ''Book''. It simply contains the list of pages that have been added to the book.


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==
==Adding metadata==
Während der Bearbeitung eines Buches  können auch Metadaten  hinzugefügt werden.
While editing a book (adding or removing pages), meta-data for the book can be added. References to these metadata can be included in the PDF template. To edit metadata, select the top-most node of the book (first page) and click the wrench icon. A dialog will be opened where various meta-data can be added or removed:
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
* Title
*Untertitel
* Subtitle
*Autor 1 und 2
* Author 1 and 2
*Dokument Identifikation
* Document-ID
*Dokumentenart
* Document type
*Abteilung
* Department
*Ausführung
* Version
*Vorlage (PDF)
* Template (PDF): If you maintain multiple PDF templates for books, you can select one of them here.
*Inhaltsverzeichnis (Nur Artikelbezeichnungen oder Artikel einbetten TOCs)
* Table of Contents (Only article titles, or Embed article TOCs)


==Adding a cover image==
==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.
<span>To add a cover photo for the book, add a metadata item</span> ''Bookshelf image''<span>. Select this option from the dropdown and click</span> ''Add''<span>. Once the meta data is added enter the name of the image in the value field. Any image currently uploaded to the wiki can be used. Type the name without the "File:" prefix (enter the image name and file extension).</span>
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==
==Types of books==
{| class="wikitable"
{| class="wikitable"
|+
!Type
!Art
!Description
!Beschreibung
!Chapter navigation
!Kapitelnavigation
|-
|-
|'''Allgemeine Bücher'''
|'''General books'''
|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.
|Visible to all users. Only general books can have a chapter navigation. In almost all cases a book is set up as a "general book".
|ja
|Yes
|-
|-
|'''Eigene Bücher'''
|'''Own books'''
|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.
|An own book is only visible in the bookshelf to the user who created the book. Such a book does not have a chapter navigation. Own books are usually created to export wiki pages as a PDF with a cover sheet.
|nein
|No
|-
|-
|'''Temporäre Bücher'''
|'''Temporary books'''
|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.
|This selection is also available to wiki users who are not logged into the wiki and is therefore mainly useful for public wikis. These books are only temporarily stored in the user's browser and not in the wiki itself. If the browser cache is deleted or the user switches to another browser, the book is no longer available. The main aim of temporary books is so that users can collectively print out wiki pages as PDFs.
|nein
|No
|}
|}


==Exporting a book==
==Exporting a book==
Bücher, einzelne Kapitel oder sogar einzelne Buchseiten können als PDF-Dateien exportiert werden:
Books, individual chapters or even individual book pages can be exported as PDF files:


#'''Öffnen''' Sie das Buch im Bucheditor.
# '''Open''' the book in the book manager.
#'''Wählen''' Sie alle zu exportierenden Seiten oder Kapitel aus, indem Sie auf die entsprechenden Kontrollkästchen klicken. Unterkapitel werden automatisch ausgewählt.
# '''Select''' each of the pages or chapters to export by clicking the appropriate check boxes. Sub-chapters are selected automatically.
#'''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.<br />
# '''Click''' the Export Selections drop-down menu to open a list of the available formats.<br />


==Actions in the book manager==
==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.
Der Link Verwaltung > Bücher im Menü ''Globale Aktionen'' lädt die Seite ''Spezial:Bücherverwaltung''. Hier können Sie Ihre Bücher bearbeiten.
[[Datei:Handbuch:book-manager-actions.png|alternativtext=Aktionen in der Bücherverwaltung|zentriert|mini|650x650px|Aktionen in der Bücherverwaltung]]
[[File:Manual:book-manager-actions-EN.png|alt=Book manager actions|center|thumb|650x650px|Book manager actions]]
 
* <span>'''Edit'''</span> (1): Links to the Book editor where you can edit the book contents and metadata.
 
* '''Delete''' (2): Deletes the book page in the namespace ''Book'' '''without''' deleting the wiki pages.
*'''Bearbeiten''' (1): Wechsel zum Bucheditor.
* '''Duplicate''' (3): Duplicates this book, including '''all the pages''' of the book to a different namespace.
*'''Löschen''' (2): Löscht das Buch (das heißt, die Inhaltsseite des Buches im Namensraum ''Book'', '''ohne''' die Wikiseiten selbst zu löschen).
* '''Export''' (4): Exports all wiki pages in this book to PDF.
*'''Duplizieren''' (3): Dupliziert die  Buchseite und '''alle''' Seiten des Buches. Hierfür wird ein Namensraum ausgewählt.
* '''Assign''' (5): Assigns the book to designated users. These users are the responsible editors of the book.
*'''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==
==Configuration==
===Display options===
===Display options===
{{#dpl:title=Handbuch:Erweiterung/BlueSpiceConfigManager|include=#BlueSpiceBookShelf}}
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceBookShelf}}


===Export===
===Export===
Wiki-Administratoren können folgende Anpassungen für den Buchexport vornehmen:
Wiki-Administratoren können folgende Anpassungen für den Buchexport vornehmen:
{{#dpl:title=Handbuch:Erweiterung/BlueSpiceConfigManager|include=#Export}}
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#Export}}


===Configuring size limits for the book export (Server)===
===Configuring the file size limits (server)===
Standardmäßig ist der Buchexport auf 50MB begrenzt. Um die maximal erlaubte Dateigröße zu erhöhen, führen Sie folgende Schritte durch:  
By default, the book export is limited to 50MB in file size. To adjust this value, complete the following steps:  


#In Apache Tomcat die Datei ''web.xml'' aufrufen: <syntaxhighlight lang="c">
#In Apache Tomcat, open the file ''web.xml'': <syntaxhighlight lang="c">
sudo -s
sudo -s
nano /opt/tomcat/webapps/manager/WEB-INF/web.xml
nano /opt/tomcat/webapps/manager/WEB-INF/web.xml
</syntaxhighlight>
</syntaxhighlight>
#Dort folgende Zeilen suchen und den gewünschten Wert eingeben (z.B. für 250MB=26214400) <syntaxhighlight lang="c">
#Look for the following lines and adjust the value (e.g. for 250MB=26214400) <syntaxhighlight lang="c">
<max-file-size>262144000</max-file-size>
<max-file-size>262144000</max-file-size>
<max-request-size>262144000</max-request-size>
<max-request-size>262144000</max-request-size>
</syntaxhighlight>
</syntaxhighlight>
#Für die Webapp BShtml2PDF gibt es ebenso eine Einstellung für die maximale Dateigröße: <syntaxhighlight lang="c">
#The web app BShtml2PDF also has a setting that needs to be adjusted: <syntaxhighlight lang="c">
nano /opt/tomcat/webapps/BShtml2PDF/WEB-INF
nano /opt/tomcat/webapps/BShtml2PDF/WEB-INF
</syntaxhighlight>
</syntaxhighlight>
#Dort folgende Zeilen ebenso entsprechend anpassen auf: <syntaxhighlight lang="c">
#Enter your values in the following lines: <syntaxhighlight lang="c">
<param-name>maxMemSize</param-name> <param-value>26214400</param-value>
<param-name>maxMemSize</param-name> <param-value>26214400</param-value>
<param-name>maxFileize</param-name> <param-value>26214400</param-value>
<param-name>maxFileize</param-name> <param-value>26214400</param-value>
Line 133: Line 132:
service tomcat restart
service tomcat restart
</syntaxhighlight>
</syntaxhighlight>
==Deleting a book==
==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''-<span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="c101058e7ea21bbbf2a5ac893088e90b" data-hasqtip="4">Tag</span> nicht automatisch von den Seiten entfernt wird.
When you delete a book, you only remove the book page of the book (that is, the table of contents) in the "Book" namespace. However, the wiki pages in the book are not deleted. Before deleting the book, a pop-up menu informs you that the ''bookshelf-tag'' will not be automatically removed from the pages.
 
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.
 
==<span class="mw-headline ve-pasteProtect" id="Ein_Buch_duplizieren">Duplicating a book</span>==
Sie können eine vollständige Kopie des Buches erstellen, indem Sie es duplizieren:


'''So duplizieren Sie ein Buch:'''
The ''bookshelf'' tags have no effect on the wiki pages after deleting the book page. If you want to remove them manually, you can go to the page ''Special:ReplaceText'' and do a "find and replace".


#'''Geben Sie''' einen ''Zielnamen'' ein: Der Standardwert ist der Buchname mit dem Suffix ''(Kopie)''. Ändern Sie dies, um einen anderen Buchtitel zu erstellen.
==Duplicating a book ==
#'''Wählen Sie einen <span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="4e8b643999af9bbcd46206fddd4f6f53" data-hasqtip="5">Namensraum</span>''': Wählen Sie einen <span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="4e8b643999af9bbcd46206fddd4f6f53" data-hasqtip="6">Namensraum</span> aus, der sich vom ursprünglichen <span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="4e8b643999af9bbcd46206fddd4f6f53" data-hasqtip="7">Namensraum</span> unterscheidet.
You can create an entire copy of the book by duplicating it:


'''To duplicate a book:'''


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 <span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="4e8b643999af9bbcd46206fddd4f6f53" data-hasqtip="8">Namensraum</span> nicht zweimal dieselbe Seite enthalten kann, müssen Sie die Dateien in einen anderen <span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="4e8b643999af9bbcd46206fddd4f6f53" data-hasqtip="9">Namensraum</span> kopieren.
#'''Enter''' a ''target name'': The default value is the book name with the suffix ''(copy)''. Change this to create a different book title.
#'''Select''' a ''namespace'': Choose a namespace that is different from the original namespace.


'''Über die duplizierten Seiten:'''
If you are not careful, you might experience some unintended consequences. By creating a new book, you also create copies of all the wiki pages in the original book. Since a namespace cannot contain the same page twice, you have to copy the files to a different namespace.


*'''Buchseite:''' Eine neue Seite im <span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="4e8b643999af9bbcd46206fddd4f6f53" data-hasqtip="10">Namensraum</span>-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.
'''About the duplicated files:'''
*'''Wikiseiten:''' Alle im Originalbuch enthaltenen Seiten werden dupliziert. Folgende Szenarien sind möglich:
**'''Gleicher <span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="4e8b643999af9bbcd46206fddd4f6f53" data-hasqtip="11">Namensraum</span>:''' Wenn Sie ein Buch im gleichen <span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="4e8b643999af9bbcd46206fddd4f6f53" data-hasqtip="12">Namensraum</span> duplizieren, werden keine tatsächlichen Duplikate des tatsächlichen Wikis erstellt. Stattdessen wird das Bookshelf-<span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="c101058e7ea21bbbf2a5ac893088e90b" data-hasqtip="13">Tag</span> 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 <span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="4e8b643999af9bbcd46206fddd4f6f53" data-hasqtip="14">Namensraum</span> HR), enthält die Seite "Qualitätssicherung" jetzt das Bookshelf-<span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="c101058e7ea21bbbf2a5ac893088e90b" data-hasqtip="15">Tag</span> <code></code>.
**'''Anderer <span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="4e8b643999af9bbcd46206fddd4f6f53" data-hasqtip="16">Namensraum</span>:''' Wenn Sie die Buchkopie in einem anderen <span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="4e8b643999af9bbcd46206fddd4f6f53" data-hasqtip="17">Namensraum</span> erstellen, bleibt das Bookshelf-<span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="c101058e7ea21bbbf2a5ac893088e90b" data-hasqtip="18">Tag</span> in den Originaldateien unverändert. Die neuen Seiten im anderen <span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="4e8b643999af9bbcd46206fddd4f6f53" data-hasqtip="19">Namensraum</span> werden mit einem Bookshelf-<span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="c101058e7ea21bbbf2a5ac893088e90b" data-hasqtip="20">Tag</span> für die neue Buchkopie erstellt. Dies ist höchstwahrscheinlich das gewünschte Szenario.


*'''Book page:''' A new page in the namespace book. If you don't enter a new title, the book will be created with the same title and the suffix ''(Copy). E.g. Employee Manual (Copy).'' This file includes a copy of the structure of your original book with the corresponding links to the duplicated pages in the new copy.
*'''Wiki pages''': All pages contained in the original book are duplicated. The following scenarios are possible:
**'''Same namespace:''' If you duplicate a book in the same namespace, no actual duplicates of the actual wiki are created. Instead, the bookshelf tag is updated to point to the copy of the book. For example, if your original book contains the page ''HR:Quality assurance''  (the book is in the namespace HR), the ''Quality assurance'' page now contains the bookshelf tag <code><nowiki></nowiki></code>.
**'''Different namespace''': If you create the book copy in a different namespace, the bookshelf tag in the original files remains unchanged. The new pages in the different namespace are created with a bookshelf tag for the new book copy. This is most likely the scenario you want.
==Permissions==
==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.{{Box Links|Thema1=[[Referenz:BlueSpiceBookshelf]]|Thema2=[[Handbuch:Erweiterung/BlueSpiceBookshelf/PDF_Ausgabe_anpassen|PDF-Ausgabe anpassen]]|Thema3=}}<br />
To create and edit books, users need ''edit'' rights in Book namespace. Additionally, a user can only add pages to the book that that user can read. If a user tries to export a book to PDF that contains pages for which the user does not have permissions, the user will get an error message.
==Tips for working with books ==


*Use a competent team to decide on the content that should be transferred into an online book.
*Decide on how to handle existing numerations or references.
*Seize the opportunity: Get rid of unnecessary content (or don't include it in your book).
*Decide on standards for documents: When does it make sense to link documents in the wiki? When is is sensible to include the document's content into a wiki article?
*Decide on a fitting course of action: Do you want to create the articles in the wiki first, and compile them in a book structure afterwards, or do you want to create the book structure first, and create and edit the articles contained gradually?
{{Box Links-en
|Topic1=[[Reference:BlueSpiceBookshelf]]
|Topic2=
|Topic3=[[Manual:Extension/BlueSpiceBookshelf/Customized_PDF_Output|Customizing page breaks]]}}
{{Translation}}
{{Translation}}
[[Category:Organisation]]
 
[[Category:Organization]]

Revision as of 14:54, 8 July 2022


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.

Book manager
Book manager


To create a book:

  1. Click the +-button.
  2. Enter a Book title.
  3. Select "General books" as type of the book.
    Create a book
    Create a 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.

Book edit buttons
Book edit buttons
  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.
  1. Click the arrow of the Save button and select Save and add chapter navigation. This process inserts the <bookshelf /> tag into the source code of all wiki pages in the book. This causes a revision of the pages.
    Add chapter navigation
    Add chapter navigation
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.

The book is now displayed on the wiki bookshelf. The bookshelf can be reached via the entry links in the main navigation.

Note:There is no option to go directly from the bookshelf to the book manager.


Mass-adding of pages

After clicking "Mass add", a dialog is opened. It contains different criteria for page selection:

  • All pages of a category
  • All subpages of a certain page
  • From a page collection - page collections are lists of pages located in the MediaWiki namespace. They are usually created from search results.
  • By a semantic property - pages can be selected based on the value of a certain semantic property.

After adding your book pages click Save at the bottom of the page. Now you have created a page in the namespace Book. It simply contains the list of pages that have been added to the book.

Adding metadata

While editing a book (adding or removing pages), meta-data for the book can be added. References to these metadata can be included in the PDF template. To edit metadata, select the top-most node of the book (first page) and click the wrench icon. A dialog will be opened where various meta-data can be added or removed:

  • Title
  • Subtitle
  • Author 1 and 2
  • Document-ID
  • Document type
  • Department
  • Version
  • Template (PDF): If you maintain multiple PDF templates for books, you can select one of them here.
  • Table of Contents (Only article titles, or Embed article TOCs)

Adding a cover image

To add a cover photo for the book, add a metadata item Bookshelf image. Select this option from the dropdown and click Add. Once the meta data is added enter the name of the image in the value field. Any image currently uploaded to the wiki can be used. Type the name without the "File:" prefix (enter the image name and file extension).

Types of books

Type Description Chapter navigation
General books Visible to all users. Only general books can have a chapter navigation. In almost all cases a book is set up as a "general book". Yes
Own books An own book is only visible in the bookshelf to the user who created the book. Such a book does not have a chapter navigation. Own books are usually created to export wiki pages as a PDF with a cover sheet. No
Temporary books This selection is also available to wiki users who are not logged into the wiki and is therefore mainly useful for public wikis. These books are only temporarily stored in the user's browser and not in the wiki itself. If the browser cache is deleted or the user switches to another browser, the book is no longer available. The main aim of temporary books is so that users can collectively print out wiki pages as PDFs. No

Exporting a book

Books, individual chapters or even individual book pages can be exported as PDF files:

  1. Open the book in the book manager.
  2. Select each of the pages or chapters to export by clicking the appropriate check boxes. Sub-chapters are selected automatically.
  3. Click the Export Selections drop-down menu to open a list of the available formats.

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.

Book manager actions
Book manager actions
  • Edit (1): Links to the Book editor where you can edit the book contents and metadata.
  • Delete (2): Deletes the book page in the namespace Book without deleting the wiki pages.
  • Duplicate (3): Duplicates this book, including all the pages of the book to a different namespace.
  • Export (4): Exports all wiki pages in this book to PDF.
  • Assign (5): Assigns the book to designated users. These users are the responsible editors of the book.

Configuration

Display options

  • Show book chapter pager after content: Displays previous/next book page navigation at the end of each book page. (1)
  • Show book chapter pager before content: Displays previous/next book page navigation at the beginning of each book page. (2)
    Book navigation
    Book navigation

  • Use the display title from book source on article: Shows the title from the book navigation as page title instead of the page name.
book display title
book display title
Note:If the page additionally contains a {{DISPLAYTITLE}} tag, the display title of the page is shown instead of the book title.


  • Prepend article table of contents and headlines with book numberation: The page TOC does not start with the main heading 1, but with the actual number from the book chapter (see screenshot). If users have activated in their user preferences to "auto-number headings", the numbering system is matched accordingly.
    Prepended chapter numbers
    Prepended chapter numbers
  • Supress namespace prefix of book articles in output: The namespace prefix of an article is not shown in PDFs.


Export

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


Configuring the file size limits (server)

By default, the book export is limited to 50MB in file size. To adjust this value, complete the following steps:

  1. In Apache Tomcat, open the file web.xml:
    sudo -s
    nano /opt/tomcat/webapps/manager/WEB-INF/web.xml
    
  2. Look for the following lines and adjust the value (e.g. for 250MB=26214400)
    <max-file-size>262144000</max-file-size>
    <max-request-size>262144000</max-request-size>
    
  3. The web app BShtml2PDF also has a setting that needs to be adjusted:
    nano /opt/tomcat/webapps/BShtml2PDF/WEB-INF
    
  4. Enter your values in the following lines:
    <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

When you delete a book, you only remove the book page of the book (that is, the table of contents) in the "Book" namespace. However, the wiki pages in the book are not deleted. Before deleting the book, a pop-up menu informs you that the bookshelf-tag will not be automatically removed from the pages.

The bookshelf tags have no effect on the wiki pages after deleting the book page. If you want to remove them manually, you can go to the page Special:ReplaceText and do a "find and replace".

Duplicating a book

You can create an entire copy of the book by duplicating it:

To duplicate a book:

  1. Enter a target name: The default value is the book name with the suffix (copy). Change this to create a different book title.
  2. Select a namespace: Choose a namespace that is different from the original namespace.

If you are not careful, you might experience some unintended consequences. By creating a new book, you also create copies of all the wiki pages in the original book. Since a namespace cannot contain the same page twice, you have to copy the files to a different namespace.

About the duplicated files:

  • Book page: A new page in the namespace book. If you don't enter a new title, the book will be created with the same title and the suffix (Copy). E.g. Employee Manual (Copy). This file includes a copy of the structure of your original book with the corresponding links to the duplicated pages in the new copy.
  • Wiki pages: All pages contained in the original book are duplicated. The following scenarios are possible:
    • Same namespace: If you duplicate a book in the same namespace, no actual duplicates of the actual wiki are created. Instead, the bookshelf tag is updated to point to the copy of the book. For example, if your original book contains the page HR:Quality assurance (the book is in the namespace HR), the Quality assurance page now contains the bookshelf tag .
    • Different namespace: If you create the book copy in a different namespace, the bookshelf tag in the original files remains unchanged. The new pages in the different namespace are created with a bookshelf tag for the new book copy. This is most likely the scenario you want.

Permissions

To create and edit books, users need edit rights in Book namespace. Additionally, a user can only add pages to the book that that user can read. If a user tries to export a book to PDF that contains pages for which the user does not have permissions, the user will get an error message.

Tips for working with books

  • Use a competent team to decide on the content that should be transferred into an online book.
  • Decide on how to handle existing numerations or references.
  • Seize the opportunity: Get rid of unnecessary content (or don't include it in your book).
  • Decide on standards for documents: When does it make sense to link documents in the wiki? When is is sensible to include the document's content into a wiki article?
  • Decide on a fitting course of action: Do you want to create the articles in the wiki first, and compile them in a book structure afterwards, or do you want to create the book structure first, and create and edit the articles contained gradually?

Related info



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

Discussions