Last edited 3 months ago
by Margit Link-Rodrigue

7 Books

VisualWikitext
No edit summary
No edit summary
Tag: 2017 source edit
 
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Textbox|boxtype=note|header=BlueSpice 4.5:|text=This help page applies to the book functionality for BlueSpice 4.5+. For earlier versions, go to the previous documentation.|icon=yes}}<bookshelf src="Book:User manual" />
{{Textbox|boxtype=note|header=BlueSpice 4.5:|text=This help page applies to the book functionality for BlueSpice 4.5+. For earlier versions, go to the [[Manual:Extension/BlueSpiceBookshelf/4-4|previous documentation.]]|icon=yes}}<bookshelf src="Book:User manual" />
{{DISPLAYTITLE:Books}}
{{DISPLAYTITLE:Books}}
In ''BlueSpice pro'', wiki pages can be displayed as a structured book with chapter navigation. A book can also be printed as a PDF file with a cover sheet.
In ''BlueSpice pro'', wiki pages can be displayed as a structured book with chapter navigation. A book can also be printed as a PDF file with a cover sheet.
 
{{TOClimit|limit=1}}
==Characteristics of books==
==Characteristics==
Books have the following characteristics:
<span class="youtubelink">[[File:book example.png|alt=introduction page of the user manual with chapter navigation|thumb|450x450px|[[File:youtube-icon.png|alt=YouTube icon|left|22x22px]][https://youtu.be/koPjB2KSZow YouTube: Books (5:22 min.)]|link=https://youtu.be/koPjB2KSZow]]</span>Books have the following characteristics:


*On book pages, the book navigation is displayed instead of the main navigation.
*On book pages, the book navigation is displayed instead of the main navigation.
*A wiki page can be in multiple books.
* A wiki page can be in multiple books. If a page is in multiple books, the book navigation shows a dropdown menu that allows to switch between these books.
*Books can be printed completely or partially as a PDF with a cover sheet.
*Books can be printed completely or partially as a PDF with a cover sheet.
*Books can be grouped into individual book shelves.
*Books can be grouped into individual bookshelves.
 
== Differences to previous versions ==
*A page can now be in multiple books.
*The books are displayed as thumbnails and can be organized on different "shelves".
*There are no more "own" or "temporary" books since these were edge use cases. Own books will not get lost after updating to BlueSpice 4.5, but rather be stored as a list of links  on subpages of the user profile page (e.g., <code>User:JaneDoe/...</code>).
* There is no option to duplicate a book since this was also an edge use case.
*There is no more separate book manager. All books can now be managed directly from the Books page.


==Creating a book==
==Creating a book==
Books are created from the page  ''Special:Books''.  
Books are created from the page  ''Special:Books''.  
[[File:Bookshelf create book action.png|alt=Page Special:Books with actions menu|center|thumb|650x650px|"Create new book" ]]
'''To create a book:'''
#'''Click''' ''Create new book'' in the actions menu of the page tools. This opens a dialog box.
#'''Enter''' a book title.
#'''Enter''' a subtitle (optional).
#'''Select''' a bookshelf (optional). This puts the book in a group of books. If you do not select a bookshelf, the book will be listed under the heading ''Various books''.
#'''Upload or select''' a cover image (optional)'''.''' If you do not upload or select a cover image, a random cover image will be applied.
#'''Click''' ''Save''.  The book is now shown in its bookshelf group and can be edited.
#'''Click''' ''Done''. The book editor loads next.
[[File:book dialog box.png|alt=Create book dialog box with completed fields for a user manual|center|thumb|400x400px|Dialog box]]


Click ''Create new book'' in the actions menu of the page tools.
==="New" button===
Alternatively, you can create a book via the "New" button. The next steps to save the book are as described above.
[[File:new button menu.png|alt=New button with open drop-down menu|center|thumb|229x229px|New book menu item]]


'''To create a book:'''
==Editing a book==
#'''Click''' the <code>+</code>-button.
To switch to the book edit mode, '''click''' ''Edit'' in the book preview on the Books page.  
#'''Enter''' a ''Book title.''
#'''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.
{{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=}}


===Adding pages===
This opens the book editor.
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.
==Adding elements==
#'''Search''' for a page in the wiki and select it. If a different name is to be displayed in the book navigation, you can enter a display title (optional).
To add a wikipage to a book:
#'''Click''' ''Done''.
#'''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]]
#'''Click''' ''Add element.''
{{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=}}
#'''Select''' the node type ''Wiki page chapter.''
The book is now displayed on the wiki bookshelf. The bookshelf can be reached via the entry links in the main navigation.
#'''Enter''' the name of the wikipage you want to add in the field ''Target''.
#'''Enter''' the label you want show for the page in the field ''Text''.
#'''Click''' ''Done''. The page is added to the end of the book.
#'''Drag-and-drop''' the page to the desired section.
#'''Repeat''' steps 1-6 if you want to add another page.
#'''Click''' ''Save'' when you are done.


{{Messagebox|boxtype=note|icon=|Note text=There is no option to go directly from the bookshelf to the book manager.|bgcolor=}}
==Editing meta data==
While editing a book (adding or removing pages), metadata for the book can be added. References to these metadata can be included in the PDF template.  The following table shows which of the Paramters are by default part of the PDF-Printout. All Paramters are part of the user-defined document properties of the printed PDF. 
{| class="wikitable" style="width: 100%;"
|+Meta data and their functionality
!Parameter
!Beschreibung
! style="width:100px;" |in Standard-Vorlagen
|-
|Author 1
|User-defined PDF-document property. Not included in PDF pages.
| style="width:100px;" |no
|-
|Author 2
|User-defined PDF-document property. Not included in PDF pages.
| style="width:100px;" |no
|-
|Bookshelf
|Lists the book on the Books page of the wiki under a particular bookshelf.  It has no relevance for the printed PDF.
| style="width:100px;" |no
|-
|Bookshelf Image
|Image that is shown as preview image. It can be used as [[Manual:Extension/BlueSpiceUniversalExport/Customization#Book cover|cover image of the printed PDF in the Cloud]].
| style="width:100px;" | yes (cloud only)
|-
|Department
|User-defined PDF-document property. Not included in PDF pages.
| style="width:100px;" |no
|-
|Document type
|User-defined PDF-document property. Not included in PDF pages.
| style="width:100px;" |no
|-
|Document-ID
|Manually assigned document ID.
| style="width:100px;" |no
|-
|Subtitle
|Printed on the cover page.
| style="width:100px;" |yes
|-
|Table of contents
|''Only article titles:''The PDF TOC does not include the individual page TOCs.
''Embed article TOCs:'' The PDF TOC includes the individual page TOCs.
| style="width:100px;" |yes
|-
|Template (PDF)
| By default, there is only one book PDF template (BlueSpice Book). If custom PDF templates exist (possible in on-premise hosting only), they are listed as options.
|no  
|-
|Title
|Printed on cover page. Overwrites the book title of the wiki for the PDF-printout. It will be used as PDF file name and title on the cover page.
| style="width:100px;" |yes
|-
|Version
|Manually assigned book version number.
| style="width:100px;" |no
|}


===Mass-adding of pages===
== Mass adding pages==
After clicking "Mass add", a dialog is opened. It contains different criteria for page selection:
After clicking "Mass add", a dialog is opened. It contains different criteria for page selection:


* All pages of a category
*All pages of a category: All pages of a category are added at the end of the book (regardless of whether some of the pages already exist in the book).
* All subpages of a certain page
*All subpages of a certain page: After selecting a page, all its subpages are added at the end of the book.
* From a page collection - page collections are lists of pages located in the MediaWiki namespace. They are usually created from a [[Manual:Extension/ImportOfficeFiles|Word import]] or from [https://en.wiki.bluespice.com/wiki/Manual:Extension/BlueSpiceExtendedSearch#Export search results].
* From a page collection: Page collections are lists of pages located in the MediaWiki namespace. They an be created from a [[Manual:Extension/ImportOfficeFiles|Word import]] or from [https://en.wiki.bluespice.com/wiki/Manual:Extension/BlueSpiceExtendedSearch#Export search results].
{{Textbox|boxtype=important|header=Moving chapters:|text=Currently, it is not possible to move multiple mass-added pages together to a different location in the book. To rearrange the chapters, you can open the book in source editing mode and copy-and-paste chapters to reorder the book pages.|icon=yes}}
 
== Exporting a book==
'''To download the book as PDF:'''
 
'''Click''' ''Export'' on the ''Books'' page. This immediately downloads the book.
 
'''To download individual chapters:'''


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.
#'''Go to''' the entrypoint ''Pages''. If your wiki does not show this link, go directly to the page ''Special:Pages''.
#'''Click''' on a book name.
#'''Select''' the chapters you want to export.
#'''Click''' E''xport'' above the chapter tree.


==Adding metadata==
The book is then downloaded.
While editing a book (adding or removing pages), metadata 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 with a drop-down selection of the following options is available:


* Title
==More actions==
* Subtitle
The ''More actions'' button allows to delete, assign, or edit the metadata of the book.
* Author 1
[[File:bookshelf more actions.png|alt=expanded "more actions"  menu of a book|center|thumb|287x287px|button "more actions"]]
* Author 2
* Document-ID
* Document type
* Department
* Version
* Bookshelf image
* 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'')
It is also possible to add your own met data for use in the <nowiki><booklist>-tag, for example.</nowiki>


=== Add graphic for gallery view ===
===Delete===
Add the  ''Bookshelf image'' metadata element to add a cover photo for a book in the bookshelf gallery view. Select this option from the drop-down list and click ''Add''. Then enter the name of the image (without the “File:” prefix) in the value field. Any image currently uploaded to the wiki can be used. The image will then be displayed in the book gallery. However, the image is not used as a cover image for the PDF export (exception: [[Manual:Extension/BlueSpiceUniversalExport/Customization|''BlueSpice cloud'']]).
When you delete a book, you only remove the book page of the book (that is, the table of contents) in the "Book" namespace. The wiki pages in the book are not deleted and they are no longer associated with the book.


==Types of books==
===Edit metadata===
{| class="wikitable"
This provides the same functionality as the button [[Manual:Extension/BlueSpiceBookshelf#Editing metadata|''Edit metadata'' in the menu editor]].
!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==
===Assign ===
Books, individual chapters or even individual book pages can be exported as PDF files:
A book page can be assigned to individual users or usergroups like any other wiki page. The book will then show up under the user's [[Manual:Extension/BlueSpicePageAssignments|assignments]] in the user menu.


# '''Open''' the book in the book manager.
== Including a book table of contents on a page {{Bsvs|bsvFrom=4.4}}==
# '''Select''' each of the pages or chapters to export by clicking the appropriate check boxes. Sub-chapters are selected automatically.
The [[Manual:Extension/ContentDroplets|Content droplet]] “Book table of contents” can be used to insert the an entire book TOC or an individual chapter navigation of a book on any wiki page.
# '''Click''' the Export Selections drop-down menu to open a list of the available formats.<br />
[[File:droplet-BookTOC.png|alt=Chapter from an admin manual|center|thumb|650x650px|Content droplet "Book table of contents"]]


==Actions in the book manager==
==Adding a PDF-download link to a page==
The link Administration > Books in the menu ''Global Actions'' loads the page ''Special:Book Administration''. Here you can edit your books.
The [[Manual:Extension/ContentDroplets|Content droplet]] “Book PDF link” can be used to insert a link on a page that will download a book directly as a PDF.
[[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.
==Permissions==
* '''Delete''' (2): Deletes the book page in the namespace ''Book'' '''without''' deleting the wiki pages.
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.
* '''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==
==Configuration==
Line 121: Line 175:
<max-request-size>262144000</max-request-size>
<max-request-size>262144000</max-request-size>
</syntaxhighlight>
</syntaxhighlight>
#The web app BShtml2PDF also has a setting that needs to be adjusted: <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>
Line 131: Line 185:
service tomcat restart
service tomcat restart
</syntaxhighlight>
</syntaxhighlight>
==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:'''
#'''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.
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.
{{Box Links-en|Topic1=[[Manual:Extension/BlueSpiceUniversalExport/Customization|PDF Customization (Cloud only)]]}}
*'''Wiki pages''': All pages contained in the original book are duplicated. The following scenarios are possible:
{{Translation}}
**'''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.
 
== Including a book table of contents on a page {{Bsvs|bsvFrom=4.4}} ==
The [[Manual:Extension/ContentDroplets|Content droplet]] “Book table of contents” can be used to insert the an entire book TOC or an individual chapter navigation of a book on any wiki page.
[[File:droplet-BookTOC.png|alt=Chapter from an admin manual|center|thumb|650x650px|Content droplet "Book table of contents"]]
 
== Adding a PDF-download link to a page ==
The [[Manual:Extension/ContentDroplets|Content droplet]] “Book PDF link” can be used to insert a link on a page that will download a book directly as a PDF.
 
==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.{{Translation}}


[[Category:Organization]]
[[Category:Organization]]

Latest revision as of 10:48, 24 July 2024

BlueSpice 4.5:This help page applies to the book functionality for BlueSpice 4.5+. For earlier versions, go to the previous documentation.

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

Characteristics

introduction page of the user manual with chapter navigation
YouTube icon
YouTube: Books (5:22 min.)

Books have the following characteristics:

  • On book pages, the book navigation is displayed instead of the main navigation.
  • A wiki page can be in multiple books. If a page is in multiple books, the book navigation shows a dropdown menu that allows to switch between these books.
  • Books can be printed completely or partially as a PDF with a cover sheet.
  • Books can be grouped into individual bookshelves.

Differences to previous versions

  • A page can now be in multiple books.
  • The books are displayed as thumbnails and can be organized on different "shelves".
  • There are no more "own" or "temporary" books since these were edge use cases. Own books will not get lost after updating to BlueSpice 4.5, but rather be stored as a list of links on subpages of the user profile page (e.g., User:JaneDoe/...).
  • There is no option to duplicate a book since this was also an edge use case.
  • There is no more separate book manager. All books can now be managed directly from the Books page.

Creating a book

Books are created from the page Special:Books.

Page Special:Books with actions menu
"Create new book"

To create a book:

  1. Click Create new book in the actions menu of the page tools. This opens a dialog box.
  2. Enter a book title.
  3. Enter a subtitle (optional).
  4. Select a bookshelf (optional). This puts the book in a group of books. If you do not select a bookshelf, the book will be listed under the heading Various books.
  5. Upload or select a cover image (optional). If you do not upload or select a cover image, a random cover image will be applied.
  6. Click Save. The book is now shown in its bookshelf group and can be edited.
  7. Click Done. The book editor loads next.
Create book dialog box with completed fields for a user manual
Dialog box

"New" button

Alternatively, you can create a book via the "New" button. The next steps to save the book are as described above.

New button with open drop-down menu
New book menu item

Editing a book

To switch to the book edit mode, click Edit in the book preview on the Books page.

This opens the book editor.

Adding elements

To add a wikipage to a book:

  1. Click Add element.
  2. Select the node type Wiki page chapter.
  3. Enter the name of the wikipage you want to add in the field Target.
  4. Enter the label you want show for the page in the field Text.
  5. Click Done. The page is added to the end of the book.
  6. Drag-and-drop the page to the desired section.
  7. Repeat steps 1-6 if you want to add another page.
  8. Click Save when you are done.

Editing meta data

While editing a book (adding or removing pages), metadata for the book can be added. References to these metadata can be included in the PDF template. The following table shows which of the Paramters are by default part of the PDF-Printout. All Paramters are part of the user-defined document properties of the printed PDF.

Meta data and their functionality
Parameter Beschreibung in Standard-Vorlagen
Author 1 User-defined PDF-document property. Not included in PDF pages. no
Author 2 User-defined PDF-document property. Not included in PDF pages. no
Bookshelf Lists the book on the Books page of the wiki under a particular bookshelf. It has no relevance for the printed PDF. no
Bookshelf Image Image that is shown as preview image. It can be used as cover image of the printed PDF in the Cloud. yes (cloud only)
Department User-defined PDF-document property. Not included in PDF pages. no
Document type User-defined PDF-document property. Not included in PDF pages. no
Document-ID Manually assigned document ID. no
Subtitle Printed on the cover page. yes
Table of contents Only article titles:The PDF TOC does not include the individual page TOCs.

Embed article TOCs: The PDF TOC includes the individual page TOCs.

yes
Template (PDF) By default, there is only one book PDF template (BlueSpice Book). If custom PDF templates exist (possible in on-premise hosting only), they are listed as options. no
Title Printed on cover page. Overwrites the book title of the wiki for the PDF-printout. It will be used as PDF file name and title on the cover page. yes
Version Manually assigned book version number. no

Mass adding pages

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

  • All pages of a category: All pages of a category are added at the end of the book (regardless of whether some of the pages already exist in the book).
  • All subpages of a certain page: After selecting a page, all its subpages are added at the end of the book.
  • From a page collection: Page collections are lists of pages located in the MediaWiki namespace. They an be created from a Word import or from search results.
Moving chapters:Currently, it is not possible to move multiple mass-added pages together to a different location in the book. To rearrange the chapters, you can open the book in source editing mode and copy-and-paste chapters to reorder the book pages.


Exporting a book

To download the book as PDF:

Click Export on the Books page. This immediately downloads the book.

To download individual chapters:

  1. Go to the entrypoint Pages. If your wiki does not show this link, go directly to the page Special:Pages.
  2. Click on a book name.
  3. Select the chapters you want to export.
  4. Click Export above the chapter tree.

The book is then downloaded.

More actions

The More actions button allows to delete, assign, or edit the metadata of the book.

expanded "more actions" menu of a book
button "more actions"

Delete

When you delete a book, you only remove the book page of the book (that is, the table of contents) in the "Book" namespace. The wiki pages in the book are not deleted and they are no longer associated with the book.

Edit metadata

This provides the same functionality as the button Edit metadata in the menu editor.

Assign

A book page can be assigned to individual users or usergroups like any other wiki page. The book will then show up under the user's assignments in the user menu.

Including a book table of contents on a page   v4.4+

The Content droplet “Book table of contents” can be used to insert the an entire book TOC or an individual chapter navigation of a book on any wiki page.

Chapter from an admin manual
Content droplet "Book table of contents"

Adding a PDF-download link to a page

The Content droplet “Book PDF link” can be used to insert a link on a page that will download a book directly as a PDF.

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.

Configuration

Display options

Book

  • 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 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 on the page and in the book navigation instead of the page label provided in the book page.


Content structuring

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

Export

  • Supress namespace prefix of book articles in output: The namespace prefix of an article is not shown in PDFs.

Skinning

  • Show entrypoint "Books": Adds a link to the page Special:Books to the main navigation entrypoints.


Export

Wiki administrators can make the following adjustments for the book export:

  • Show stabilization information in PDF export:
    Prints the timestamp for the last approved version below the page headings in the PDF (date of approval and date of last edit before approval).
    FlaggedRevs info under the heading


  • Supress namespace prefix of book articles in output: The namespace prefix of an article is not shown in PDFs.
  • Show watermark for expired pages in PDF: Shows the watermark for expired pages in PDFs.
  • Show watermark for expired pages in print version: Shows the watermark for expired pages when a page is printed.


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. Restart Apache Tomcat 
    service tomcat restart


Related info


Technical Reference: BlueSpiceBookshelf


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

Retrieved from "https://en.wiki.bluespice.com/w/index.php?title=Manual:Extension/BlueSpiceBookshelf&oldid=9924"