Handbuch:Erweiterung/BlueSpiceBookshelf: Unterschied zwischen den Versionen

[freigegebene Version][freigegebene Version]
K
(Markierung: 2017-Quelltext-Bearbeitung)
 


- Fehler Der angegebene Quellartikel ("Book:Nutzerhandbuch") existiert nicht

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

Was ist Bookshelf?

Eigenschaften von Büchern[Bearbeiten | Quelltext bearbeiten]

  • Die
Erweiterung Bookshelf ist wesentlicher Bestandteil der Buchfunktion von BlueSpice. Damit können mehrere Artikel in einem strukturierten Buch zusammengefasst werden. Das so entstandene Buch enthält praktische Navigationsmöglichkeiten (nach Inhaltsverzeichnis oder Buchnavigation) und kann bei Bedarf auch als PDF-Datei gedruckt werden. Die PDF-Datei enthält ein individuelles Deckblatt, ein anklickbares Inhaltsverzeichnis und alle Anhänge der enthaltenen Artikel. Wo finde ich Bookshelf?
  • Buchübersicht ist über die Navigation erreichbar
  • Bücher werden in alphabetischer Reihenfolge angezeigt. Ein Ausblenden einzelner Bücher ist nicht möglich.
  • Bei Buchseiten wird anstelle der Hauptnavigation die Buchnavigation angezeigt.
  • Es gibt allgemeine, eigene und temporäre Bücher.
  • Nur allgemeine Bücher können eine Buchnavigation besitzen.
  • Jede Seite kann nur in einem allgemeinen Buch enthalten sein.
  • Bücher können komplett oder teilweise als PDF mit Deckblatt ausgedruckt werden.


Bücheransicht
Bücheransicht


Sobald eine Seite im Wiki geladen wird, die Teil eines Buches ist, wird das Buch geöffnet. Wenn eine Kapitelnavigation generiert wurde, erscheint diese entsprechend in der Navigationsleiste.

Kapitelnavigation
Kapitelnavigation

Bücherverwaltung[Bearbeiten | Quelltext bearbeiten]

Bookmaker1a.png Bookshelf8.png

Alle Bücher, die im Wiki verfügbar sind, sind über das linke Navigationsmenü auf der Registerkarte "Bücher" über das Buchsymbol erreichbar. Hier werden alle Arten von Büchern angezeigt, standardmäßig - "Allgemeine Bücher" und "Eigene Bücher". Die Ansicht der Bücher kann zwischen Listen- und Rasteransicht umgeschaltet werden. Durch Klicken auf eines der Bücher wird das ausgewählte Buch geöffnet.

Sobald das Buch geöffnet ist, erscheint sein Inhaltsverzeichnis in der linken Navigation unter derselben Registerkarte - "Buch". Dieses Inhaltsverzeichnis kann durch Kapitel erweitert bzw. reduziert werden und ermöglicht eine einfache Navigation durch das Buch.

Bücherverwaltung

Der Menüpunkt Globale Aktionen > Bücherverwaltung lädt die Seite Spezial:Bücherverwaltung. Hier können Sie Bücher erstellen und verwalten. Über die Plus-Schaltfläche erstellen Sie ein neues Buch.


Bücherverwaltung
Bücherverwaltung

Sie können folgende Aktionen für bestehende Bücher ausführen:
  • Bearbeiten (1): Link zur Bearbeitungsoberfläche, von wo Sie den Buchinhalt und die Metadaten eines Buches bearbeiten können.
  • Löschen (2): Löscht das Buch (das heißt, die Inhaltsseite des Buches im Namensraum Book, ohne die Wiki-Seiten selbst zu löschen).
  • Duplizieren (3): Dupliziert dieses Buch, einschließlich aller Seiten des Buches.
  • Exportieren (4): Exportiert die Wiki-Seiten in diesem Buch als PDF.
  • Zuweisen (5): Weist das Buch bestimmten Benutzern zu.
Aktionen in der Bücherverwaltung
Aktionen in der Bücherverwaltung

Ein Buch erstellen[Bearbeiten | Quelltext bearbeiten]

BlueSpiceBookmaker2.jpg

Bücher können über Spezial:Bücherverwaltung verwaltet werden. Sie können von der Übersicht der Bücher aus, wie im vorherigen Abschnitt beschrieben, über die Liste der Bücher oder durch Navigieren zu Spezial:Spezialseiten aufgerufen werden. In der Bücherverwaltung, wo eine Übersicht aller Bücher verfügbar ist, sind folgende Funktionen möglich:

  • Hinzufügen - durch Klicken auf die Schaltfläche "Hinzufügen"
  • Bearbeiten - durch Auswählen eines Buches und Klicken auf das Schlüsselsymbol
  • Kopieren - durch Auswählen eines Buches und Klicken auf das Symbol "Kopieren"
  • Löschen - durch Auswählen eines Buches und Klicken auf die Schaltfläche "Löschen"
  • Als PDF exportieren - durch Auswählen eines Buches und Klicken auf das PDF-Symbol
  • Einem Benutzer / einer Gruppe zuweisen - Ist abhängig von der Wiki-Konfiguration möglicherweise nicht verfügbar

Erstellen Sie ein neues Buch[Bearbeiten | Quelltext bearbeiten]

BlueSpiceBookmaker3.jpg BlueSpiceBookmaker4.jpg BlueSpiceBookmaker5.jpg BlueSpiceBookmaker6.jpg

Das Erstellen eines neuen Buches erfolgt durch Klicken auf die Schaltfläche "Plus". Hier geben Sie Name und Typ für das Buch an. Nachdem Sie auf "OK" geklickt haben, wird das Buch erstellt und BookEditor wird geöffnet. Seiten können nacheinander Um ein neues Buch zu erstellen:

  1. Gehen Sie zu Globale Aktionen> Bücherverwaltung.
  2. Wählen Sie die Schaltfläche Erstellen (+).
  3. Geben Sie einen Buchtitel und die Art des Buches ein.
  4. Klicken Sie auf anschließend Fertig. Die Bearbeitungsseite des Buches wird nun geladen.
    Buchtitel und Buchtyp eingeben
    Buchtitel und Buchtyp eingeben

Allgemeine Bücher[Bearbeiten | Quelltext bearbeiten]

Für alle Benutzer sichtbar. Allgemeine Bücher zeichnen sich oft durch eine hierfür generierte Buchnavigation aus.

Eigene Bücher[Bearbeiten | Quelltext bearbeiten]

Ein eigenes Buch ist nur für den Buchersteller in der Bücherliste sichtbar. Für eigene Bücher kann keine Kapitelnavigation in der Navigationsleiste erstellt werden. Eigene Bücher können jedoch wie allgemeine Bücher als PDF mit Titelblatt exportiert werden.

Temporäre Bücher[Bearbeiten | Quelltext bearbeiten]

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 ein Buch als PDF ausdrucken können.

Für temporäre Bücher kann daher keine Kapitelnavigation für das Wiki erstellt werden.

Bearbeitungsseite eines Buches[Bearbeiten | Quelltext bearbeiten]

Hier können einzelne Seiten zum Buch hinzugefügt werden, indem Sie auf die Schaltfläche "Hinzufügen" Plus-Schaltfläche (1) klicken. Es öffnet sich ein Dialogfeld, in das Sie den Namen der einzufügenden Seite eingeben können. über welches Sie die Seite auswählen und optional den Anzeigetitel im Buch angeben können. So können Sie nach und nach einzelne Seiten hinzufügen. Optional können Sie einen Anzeigetitel wählen, falls Sie im Buch nicht den eigentlichen Seitennamen verwenden möchten.
Eine Seite ins Buch einfügen
Eine Seite ins Buch einfügen

Massenhinzufügen von Seiten[Bearbeiten | Quelltext bearbeiten]

Nach Anklicken von "Massenhinzufügen" der Schaltfläche Massenhinzufügen (2) wird ein Dialog geöffnet, in dem der verschiedene Kriterien zur Auswahl von Seiten ausgewählt werden könnenenthält:

  • Alle Seiten einer Kategorie hinzufügen
  • Alle Unterseiten einer bestimmten Seite hinzufügen
  • Aus einer Seitensammlung - hinzufügen: Seitensammlungen sind Seitenlisten im MediaWiki-NamespaceNamensraum, die normalerweise über Suchergebnisse erstellt werden Suchergebnisse.
  • Über eine semantische Eigenschaft - : Seiten können basierend auf einem Wert einer bestimmten semantischen Eigenschaft ausgewählt 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.


Seitenverzeichnis des Buches speichern
Seitenverzeichnis des Buches speichern

Kapitelnavigation erstellen[Bearbeiten | Quelltext bearbeiten]

Nach dem Speichern eines Buches haben Sie im Namensraum Buch eine Wikiseite erstellt, die die Links zu den Buchseiten enthält. Die Kapitelnavigation muss anschließend noch separat erstellt werden.

Hierzu gehen Sie erneut auf die Bearbeitungsseite des Buches und generieren das Inhaltsverzeichnis über die Funktion Speichern und Kapitelnavigation in die Seiten einfügen der Speichern-Schaltfläche.

Kapitelnavigation zu Buchseiten hinzufügen
Kapitelnavigation zu Buchseiten hinzufügen


Dieser Vorgang fügt in den Quelltext aller Wikiseiten des Buches das bookshelf-Tag ein. Dieses Tag definiert, in welchem Buch die Seite enthalten ist.

Hinweis: Wenn Sie einem Buch nachträglich Seiten hinzufügen, müssen Sie die Kapitelnavigation erneut generieren, damit die neuen Seiten in der Buchnavigation erscheinen. Wenn Sie nur ein oder zwei neue Seiten hinzugefügt haben, können Sie das bookshelf-Tag auch manuell in den Quelltext der neuen Seiten einfügen.


Wichtig! Jede Wikiseite kann nur in einem Buch enthalten sein. Wenn eine Seite nachträglich zu einem zweiten Buch mit Kapitelnavigation hinzugefügt wird, führt die Wikiseite beim Laden immer automatisch in die Kapitelnavigation des Buches, das zuletzt seine Kapitelnavigation gespeichert oder aktualisiert hat.

Ein Buch bearbeiten[Bearbeiten | Quelltext bearbeiten]

Um ein Buch zu bearbeiten, klicken Sie auf den Namen des Buches in der Bücherverwaltung. Dies öffnet den die Bearbeitungsseite des Buches.

Beim Bearbeiten eines Buches wird im Wesentlichen das gleiche Verfahren wie beim Erstellen eines neuen Buches ausgeführt, wenn Sie dem Buch Seiten hinzufügen. Sie können Seiten auch löschen, indem Sie eine Seite in der Buchstruktur auswählen und auf die Schaltfläche "Löschen" klicken. Kapitel - und die allgemeine Buchstruktur - können durch Ziehen und Ablegen von Seiten in der Buchstruktur geändert werden. Durch Ziehen und Ablegen von Seite A über die Seite B wird Seite A unter der Seite B in der Buchhierarchie platziert.

Sie können Seiten auch löschen, indem Sie eine Seite in der Buchstruktur mit Rechtsklick auswählen und auf den Menüpunkt Löschen klicken.
Bucheditor
Bucheditor in BlueSpice 3.1
  • Bücherverwaltung (1): Link zur Hauptseite der Bücherverwaltung (nur bis v 3.1).
  • Quellwikiseite öffnen (2): Öffnet die Buchseite im Ansichtsmodus (nur bis v 3.1).
  • Quellwikiseite bearbeiten (3): Öffnet die Buchseite im Quelltext (nur bis v 3.1).
  • Seite hinzufügen (4): Schaltfläche zum Hinzufügen einer einzelnen Seite.
  • Massenhinzufügen (5): Schaltfläche zum Hinzufügen einer Reihe von Seiten (nach Kategorie, Unterseiten einer Seite, Seitensammlung oder semantischer Eigenschaft ).
  • Seite entfernen (6): Entfernt die ausgewählten Seiten.
  • Metadaten verwalten (7): Hinzufügen oder Entfernen von Metadaten.
  • Auswahl exportieren (8): Exportiert die ausgewählten Seiten in eine PDF-Datei.
  • Buchinhalt (9): Zeigt alle Seiten in der Buchhierarchie an. Seiten können per Drag & Drop angeordnet werden. Eine mehrstufige Organisation ist möglich.
  • Speichern (10): Speichert die Buchseite (also das Inhaltsverzeichnis des Buches)
  • Speichern und Kapitelnavigation in die Seiten einfügen (11): Speichert die Buchseite und fügt zusätzlich das nötige Tag für die Kapitelnavigation auf jeder Buchseite ein.
  • Abbrechen (12): Schließt die Bearbeitungsseite, ohne eventuelle Änderungen zu speichern.

Metadaten einfügen[Bearbeiten | Quelltext bearbeiten]

Während der Bearbeitung eines Buches (Hinzufügen oder Entfernen von Seiten) können auch Metadaten für das Buch 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)

Coverfoto hinzufügen[Bearbeiten | Quelltext bearbeiten]

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 "File:" ein, also nur den Namen und die Erweiterung des Bildes.

Bücher

Anschließend wird das Bild auf der Vorschauseite des Buches angezeigt.

Ein Buch exportieren[Bearbeiten | Quelltext bearbeiten]

Bookshelf7.png

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

  • Öffnen Sie das Buch im Bucheditor.
  • Wählen Sie alle zu exportierenden Seiten oder Kapitel aus, indem Sie auf die entsprechenden Kontrollkästchen vor ihnen 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
Arbeitstipps
  • .

Buch als PDF exportieren
Buch als PDF exportieren

Konfiguration[Bearbeiten | Quelltext bearbeiten]

  • Verwenden Sie ein kompetentes Team, um zu entscheiden, welche Inhalte in ein Online-Buch übertragen werden sollen.
  • Entscheiden Sie, wie mit vorhandenen Zahlen oder Referenzen verfahren werden soll.
  • Nutzen Sie die Gelegenheit: Beseitigen Sie unnötigen Inhalt (oder fügen Sie ihn nicht in Ihr Wiki ein)
  • Festlegen von Standards für Dokumente: Wann ist es sinnvoll, Dokumente im Wiki zu verknüpfen? Wann ist es sinnvoll, den Inhalt des Dokuments in einen Wiki-Artikel aufzunehmen?
  • Entscheiden Sie sich für eine geeignete Vorgehensweise: Möchten Sie die Artikel zuerst im Wiki erstellen und anschließend in einer Buchstruktur zusammenstellen, oder möchten Sie zuerst die Buchstruktur erstellen und die enthaltenen Artikel schrittweise erstellen und bearbeiten? Vor allem, wenn Sie sich für Letzteres entscheiden, werden Vorlagen sehr wichtig, da Sie die bereits erforderliche Buchnavigationsmarke zur Vorlage hinzufügen können. Das spart später viel Zeit.
Verwaltung

Anzeigeoptionen[Bearbeiten | Quelltext bearbeiten]

  • Eine Blätterfunktion für Bücher nach dem Inhalt anzeigen: Zeigt vorwärts/zurück-Schaltflächen am Ende jeder Buchseite an.
  • Eine Blätterfunktion für Bücher vor dem Inhalt anzeigen: Zeigt vorwärts/zurück-Schaltflächen am Beginn jeder Buchseite an.
    Umblättern von Buchseiten
    Umblättern von Buchseiten

  • Den angezeigten Titel aus der Buchquelle für den Artikel verwenden: Zeigt den Titel aus der Buchnavigation als Seitentitel anstelle des Seitennamens an.
Buchtitel anzeigen
Buchtitel anzeigen

Hinweis: Wenn die Seite zusätzlich ein "Displaytitle"-Etikett enthält, wird anstelle des Buchtitels der Anzeigetitel der Seite angezeigt.


  • Stellen Sie dem Inhaltsverzeichnis und den Überschriften des Artikels die Buchnummer voran
  • Unterdrückt das Namespace-Präfix von Buchartikeln in der Ausgabe


Buchexport[Bearbeiten | Quelltext bearbeiten]

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

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
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
    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
    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
    FlaggedRevs-Info unter der Überschrift


Größenbegrenzung des Buchexports konfigurieren (Server)[Bearbeiten | Quelltext bearbeiten]

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[Bearbeiten | Quelltext bearbeiten]

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.
Removing a page from a book
Buch löschen
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[Bearbeiten | Quelltext bearbeiten]

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.
Duplicating a book
Duplicating a book
Ü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.

Berechtigungen[Bearbeiten | Quelltext bearbeiten]

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.

Siehe auch[Bearbeiten | Quelltext bearbeiten]

Unsere Referenz-Seite. Wenn ein Benutzer ein Buch exportieren will, das Seiten enthält, auf die dieser Benutzer keinen Zugriff hat, wird eine Fehlermeldung angezeigt.

Verwandte Themen



Anhänge

Diskussionen