Quelltext der Seite Handbuch:Erweiterung/BlueSpiceBookshelf/4-4

<bookshelf src="Buch:Benutzerhandbuch" />
{{Textbox|boxtype=note|header=BlueSpice Version bis 4.4:|text=Diese Hilfeseite gilt für die Buchfunktionalität von BlueSpice bis Version 4.4. Für BlueSpice 4.5+, gehen Sie zur [[Handbuch:Erweiterung/BlueSpiceBookshelf|aktuellen Dokumentation.]]|icon=yes}}

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 <code><nowiki><bookshelf /></nowiki></code>-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ü [[Handbuch:Erweiterung/BlueSpiceDiscovery|Globale Aktionen]] erreichbar.
[[Datei:Handbuch:bookshelf-verwaltung.png|alt=Bücherverwaltung; als Beispiel die allgemeinen Bücher|zentriert|mini|650x650px|Bücherverwaltung]]

<span><br /></span>
Um ein neues Buch zu erstellen:

#'''Klicken''' Sie die <code>+</code>-Schaltfläche'.
#'''Geben''' Sie einen ''Buchtitel'' ein.
#'''Wählen''' Sie als ''Art des Buches'' "Allgemeine Bücher".[[Datei:Handbuch:buch erstellen.png|alt=Neues Buch hinzufügen mit Beschreibung des Buches|mini|550x550px|Buch erstellen|ohne]]
#'''Klicken''' Sie auf  ''Fertig''. Die Bearbeitungsseite des Buches wird nun geladen.
{{Hinweisbox|boxtype=Wichtig|icon=|Note text=Das Buch wird erst im Wiki angelegt, wenn mindestens eine Seite im Buch gespeichert wurde.|bgcolor=}}

===Seiten hinzufügen===
Sie befinden sich nun im Bearbeitungsmodus des Buches.
[[Datei:Handbuch:bookshelf-schaltflächen.png|alt=Bearbeitungsschaltflächen des Buches|zentriert|mini|200x200px|Bearbeitungsschaltflächen]]

#'''Klicken''' Sie die  ''Plus-''Schaltfläche (1).  Es öffnet sich ein Dialogfenster.
#'''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).
#'''Klicken''' Sie ''Fertig''.
# '''Fügen''' Sie weitere Seiten '''hinzu'''.
# '''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.[[Datei:Handbuch:bookshelf-speichern.png|alt=Buchseiten zu Bibliothek hinzufügen|zentriert|mini|400x400px|Buchseiten speichern]]
{{Hinweisbox|boxtype=Tipp|icon=|Note text=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.|bgcolor=}}
Das Buch wird nun im Bücherregal des Wikis angezeigt.  Das Bücherregal ist über die Einstiegslinks in der Hauptnavigation erreichbar.

{{Hinweisbox|boxtype=Hinweis|icon=|Note text=Es gibt keine Möglichkeit, direkt vom Bücherregal in die Bücherverwaltung zu wechseln.|bgcolor=}}

===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 [[Handbuch:Erweiterung/ExtendedSearch|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: [[Handbuch:Erweiterung/BlueSpiceUniversalExport/Anpassung|''BlueSpice cloud'']]).

==Arten von Büchern==
{| class="wikitable" style=""
|+
!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:

#'''Öffnen''' Sie das Buch in der Bücherverwaltung.
#'''Wählen''' Sie alle zu exportierenden Seiten oder Kapitel aus, indem Sie auf die entsprechenden Kontrollkästchen klicken. Unterkapitel werden automatisch ausgewählt.
#'''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.<span /><br />

==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.
[[Datei:Handbuch:book-manager-actions.png|alt=Bearbeiten der Bücher in der Bücherverwaltung|zentriert|mini|650x650px|Aktionen in der Bücherverwaltung]]

<span><br /></span>
*'''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==
===Anzeigeoptionen===
{{#dpl:title=Handbuch:Erweiterung/BlueSpiceConfigManager|include=#BlueSpiceBookShelf}}

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

===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: 

#In Apache Tomcat die Datei ''web.xml'' aufrufen: <syntaxhighlight lang="c">
sudo -s
nano /opt/tomcat/webapps/manager/WEB-INF/web.xml
</syntaxhighlight>
#Dort folgende Zeilen suchen und den gewünschten Wert eingeben (z.B. für 250MB=26214400) <syntaxhighlight lang="c">
<max-file-size>262144000</max-file-size>
<max-request-size>262144000</max-request-size>
</syntaxhighlight>
#Für die Webapp BShtml2PDF gibt es ebenso eine Einstellung für die maximale Dateigröße: <syntaxhighlight lang="c">
nano /opt/tomcat/webapps/BShtml2PDF/WEB-INF
</syntaxhighlight>
#Dort folgende Zeilen ebenso entsprechend anpassen auf: <syntaxhighlight lang="c">
<param-name>maxMemSize</param-name> <param-value>26214400</param-value>
<param-name>maxFileize</param-name> <param-value>26214400</param-value>
</syntaxhighlight>
#Apache Tomcat neu starten <syntaxhighlight lang="c">
service tomcat restart
</syntaxhighlight>

==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''-<span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="c101058e7ea21bbbf2a5ac893088e90b" data-hasqtip="4">Tag</span> 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.

==<span class="mw-headline ve-pasteProtect" id="Ein_Buch_duplizieren">Ein Buch duplizieren</span>==
Sie können eine vollständige Kopie des Buches erstellen, indem Sie es duplizieren:

'''So duplizieren Sie ein Buch:'''

#'''Geben Sie''' einen ''Zielnamen'' ein: Der Standardwert ist der Buchname mit dem Suffix ''(Kopie)''. Ändern Sie dies, um einen anderen Buchtitel zu erstellen.
#'''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.

<span><br /></span>
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.

'''Über die duplizierten Seiten:'''

*'''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.
*'''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.

==Buchnavigation anpassen==
Das Standardlayout der Buchnavigation eignet sich gut für Bücher mit wenig Kapiteln und kurzen Kapiteltiteln und sieht so aus:
[[Datei:Handbuch:1658307435800.png|alternativtext=Standard-Buchnavigation|zentriert|mini|354x354px|Standard-Buchnavigation]]

<span><br /></span>
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:

[[Datei:Handbuch:1658307591178.png|alternativtext=Angepasste Kapitelnavigation|zentriert|mini|257x257px|Angepasste Kapitelnavigation]]

<span><br /></span>
Hierzu fügen Sie auf der Seite MediaWiki:Common.css folgende Formatierung hinzu:<syntaxhighlight lang="css">
/*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 */
</syntaxhighlight>

==Buch-Inhaltsverzeichnis auf einer Seite einbinden {{Bsvs|bsvFrom=4.4}}==
Über das [[Handbuch:Erweiterung/ContentDroplets|Content Droplet]] "Buch-Inhaltsverzeichnis" läßt sich das Inhaltsverzeichnis des Buches oder eines einzelnen Kapitels auf einer beliebigen Wiki-Seite einfügen.
[[Datei:droplet-Buch-Inhaltsverzeichnis.png|alternativtext=Kapitel aus einem Admin-Handbuch|zentriert|mini|650x650px|Buch-Inhaltsverzeichnis]]

==Einen Link zum PDF-Download erstellen==
Mit dem [[Handbuch:Erweiterung/ContentDroplets|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.{{Box Links|Thema1=[[Referenz:BlueSpiceBookshelf]]|Thema2=[[Handbuch:Erweiterung/BlueSpiceBookshelf/PDF_Ausgabe_anpassen|PDF-Ausgabe anpassen]]|Thema3=}}<span /><br />

{{Translation}}
[[Category:Organisation]]
[[Category:Konzept]]