Reference:BlueSpiceBookshelf: Difference between revisions

Latest revision as of 13:41, 11 July 2025


Overview
Description:	Enables BlueSpice to manage and export hierarchical collections of articles.
State:	stable	Dependency:	BlueSpice
Developer:	HalloWelt	License:	GPL-3.0-only
Type:	BlueSpice	Category:	Book
Edition:	BlueSpice pro, BlueSpice farm, BlueSpice cloud	Version:
View user help page

Bookshelf combines wiki pages to create books and also to export those pages as a PDF document.

Some aspects of this extension can be configured on Special:BlueSpiceConfigManager. Here, wiki administrators can:

prepend the article table of contents and headlines of a page with book numeration.
supress the namespace prefix of book articles in the PDF output.
apply the display title from the book source to a wiki page.

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

In Apache Tomcat, open the file web.xml:

sudo -s
nano /opt/tomcat/webapps/manager/WEB-INF/web.xml

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>

The web app BShtml2PDF also has a setting that needs to be adjusted:
```
nano /opt/tomcat/webapps/BShtml2PDF/WEB-INF
```

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>

Technical details for BlueSpice cloud can differ in some cases.

Name	Description	Role
bookshelf-viewspecialpage	Access the special page Special:Bookshelf	reader
bookshelfbookmanager-viewspecialpage	Access the special page Special:BookshelfBookManager	reader

Name	Value
BookShelfDefaultCoverImage	'resources/images/assets/coverimage/dummy.png'
BookShelfShowChapterNavigationPagerAfterContent	false
BookShelfShowChapterNavigationPagerBeforeContent	false
BookshelfDefaultBookTemplate	'StandardBookPDF'
BookshelfMainLinksBookshelf	true
BookshelfPrependPageTOCNumbers	true
BookshelfTitleDisplayText	true
BookshelfToolbarOffset	153

Name	Value
bs-bookshelf-defaultview	'gridviewpanel'

PDF exclude - start

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

PDF exclude - end

@@ Line 22: / Line 22: @@
 *supress the namespace prefix of book articles in the PDF output.
 *apply the display title from the book source to a wiki page.
+===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:
+#In Apache Tomcat, open the file ''web.xml'': <syntaxhighlight lang="c">
+sudo -s
+nano /opt/tomcat/webapps/manager/WEB-INF/web.xml
+</syntaxhighlight>
+#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-request-size>262144000</max-request-size>
+</syntaxhighlight>
+# The web app BShtml2PDF also has a setting that needs to be adjusted: <syntaxhighlight lang="c">
+nano /opt/tomcat/webapps/BShtml2PDF/WEB-INF
+</syntaxhighlight>
+#Enter your values in the following lines: <syntaxhighlight lang="c">
+<param-name>maxMemSize</param-name> <param-value>26214400</param-value>
+<param-name>maxFileize</param-name> <param-value>26214400</param-value>
+</syntaxhighlight>
+#Restart Apache Tomcat  <syntaxhighlight lang="c">
+service tomcat restart
+</syntaxhighlight>
 }}