Last edited one month ago
by Margit Link-Rodrigue

7 Books

(Difference between pages)
VisualWikitext
No edit summary
Tag: 2017 source edit
 
No edit summary
Tag: 2017 source edit
 
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 [[Manual:Extension/BlueSpiceBookshelf/4-4|previous documentation.]]|icon=yes}}<bookshelf src="Book:User manual" />
{{DISPLAYTITLE:Notifications}}
{{DISPLAYTITLE:Books}}
{{Textbox|boxtype=note|header=BlueSpice 4.5:|text=This help page applies to the notifications functionality for BlueSpice 4.5+. For earlier versions, go to the [[Manual:Extension/BlueSpiceEchoConnector|previous documentation]].|icon=yes}}
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==
<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 Watch on 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.
Registered wiki users receive notifications for a variety of changes to the wiki. Users can subscribe to different types of notifications.
* 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 ==  
== Automatically generated notifications ==
*A page can now be in multiple books.
<span class="youtubelink">[[File:notif subscr default excerpt.png|alt=default subscriptions set in the user preferences|thumb|[[File:youtube-icon.png|alt=YouTube icon|left|22x22px]][https://youtu.be/UojRGLmDTwM YouTube: Notifications subscriptions (4:55 min.)] |450x450px]]</span>Some notifications are not dependent on a subscription and are always automatically sent to users. These include:
*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==
* [[Manual:Extension/BlueSpiceReminder|Reminders]]: Your reminders are due in one week or today
Books are created from the page ''Special:Books''.  
* [[Manual:Extension/BlueSpiceReadConfirmation|Read confirmation]] requests: You have a new read confirmation request
[[File:Bookshelf create book action.png|alt=Page Special:Books with actions menu|center|thumb|650x650px|"Create new book" ]]  
* [[Manual:Extension/Workflows|Mentions and tasks]]: Another user mentioned you or a new task was assigned to you
* [[Manual:Extension/Workflows|Workflow]] notifications: A workflow you initiated has finished or you have a new workflow task
* [[Manual:Extension/BlueSpicePageAssignments|Page assignment]] changes: Someone assigned you to a page or removed your page assignment.  <br />'''Note:''' Users are not automatically notified about changes on pages to which they are assigned. Assigned users have to subscribe to be notified.
* Changes to your user page by other users
* Reverted changes via the page history by other users
* Changes to your wiki permissions and other administrative events
{{Icon|bi bi-arrow-right-circle|||}} [[Manual:Extension/Notifications/standard|List of events that trigger automatic notifications]]


'''To create a book:'''
== Events without notifications ==
#'''Click''' ''Create new book'' in the actions menu of the page tools. This opens a dialog box.
The following events do not trigger notifications:
#'''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]]


==="New" button===
* own edits
Alternatively, you can create a book via the "New" button. The next steps to save the book are as described above.
* page revisions that are marked as "minor edit"
[[File:new button menu.png|alt=New button with open drop-down menu|center|thumb|229x229px|New book menu item]]


==Editing a book==
== Subscribing to notifications ==
To switch to the book edit mode, '''click''' ''Edit'' in the book preview on the Books page.  
In addition to automatic notifications, you can subscribe to additional notifications. These custom notification sets are meant to inform you about very specific events in a single context (for example: page approvals in a particular namespace).
[[File:notification preferences.png|alt=Notifications tab with three subscriptions|center|thumb|750x750px|Notifications tab in user preferences]]


This opens the book editor.
'''To subscribe to a notification set:'''
# '''Click''' on ''Preferences'' in your user menu.
# '''Switch''' to the tab ''Notifications''.
# '''Click''' the ''Add'' button.
#'''Create''' your notification subscription. See below for [[Manual:Extension/Notifications#Options|selecting the options]].
#'''Click''' ''Done'' to save your new notification set.[[File:notification edit subscription set.png|center|thumb|550x550px|alt=Dialog box for adding a subscription|Subscription settings]]
{{Textbox|boxtype=note|header=A note for wiki administrators:|text=If you are an administrator and need to monitor the entire wiki, it is more efficient to habitually check the overview pages that show all changes in the wiki (e.g., the pages for ''Recent changes'' or the ''Quality overview'' page for the approval status of all pages) That way, you can avoid beeing flooded with notifications.|icon=yes}}


==Adding elements==
=== Options ===
To add a wikipage to a book:
{| class="wikitable"
 
!Setting
#'''Click''' ''Add element.''
!Description
#'''Select''' the node type ''Wiki page chapter.''
#'''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.
 
==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
|Receive notifications for
|''Only article titles:''The PDF TOC does not include the individual page TOCs.
|
''Embed article TOCs:'' The PDF TOC includes the individual page TOCs.
* '''Book:'''  if pages change in a  book. To get notifiied about multiple namespaces, you need to create separate subscriptions.
| style="width:100px;" |yes
* '''Namespace:'''  if pages change in a  namespace. To get notifiied about multiple namespaces, you need to create separate subscriptions.'''Namespace:'''  if pages change in a  namespace. To get notifiied about multiple namespaces, you need to create separate subscriptions.
* '''Category:'''  if pages change in a  category. To get notifiied about multiple categories, you need to create separate subscriptions. Subcategories are also not included in a category subscriptions. They each require their own notification.
* '''Watchlist:''' if pages change that are on your watchlist.
* '''Assigned pages:''' if pages change that are on your [[Manual:Extension/BlueSpicePageAssignments|assignments]] list.
|-
|-
|Template (PDF)
|Type of notifications
| 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
* '''Low-frequency:'''
** create / move / delete page
** edit / delete discussion or blog topic / comment
* '''High-frequency:'''
** edit page
** create blog post or discussion topic
** create blog or discussion comment
* '''Quality monitoring:'''
** approval of assigned page
** page expiry
|-
|-
|Title
|Delivery method
|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.
|By default, notifications appear in the wiki itself. If you want to get email notifications as well, you need to activate the email checkbox.
| style="width:100px;" |yes
|-
|Version
|Manually assigned book version number.
| style="width:100px;" |no
|}
|}


== Mass adding pages==
==Viewing notifications==
After clicking "Mass add", a dialog is opened. It contains different criteria for page selection:
If a user has unread notifications, the bell symbol in the top toolbar shows the number of new notifications. Clicking the notification symbols opens a mega menu with the 10 most recent notifications.
 
[[File:Notifications symbol.png|alt=Buttons in the top toolbar with active notifications symbol|center|thumb|300x300px|New notifications]]
*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 [[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:'''
 
#'''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.
 
The book is then downloaded.
 
==More actions==
The ''More actions'' button allows to delete, assign, or edit the metadata of the book.
[[File:bookshelf more actions.png|alt=expanded "more actions"  menu of a book|center|thumb|287x287px|button "more actions"]]


===Delete===
At the end of the notifications is a link to view all notifications. This link opens the ''Notification center''.
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.
[[File:Notifications center.png|alt=layout of the notification center with 4 marked areas|center|thumb|750x750px|Notifications center]]


===Edit metadata===
This provides the same functionality as the button [[Manual:Extension/BlueSpiceBookshelf#Editing metadata|''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 [[Manual:Extension/BlueSpicePageAssignments|assignments]] in the user menu.


== Including a book table of contents on a page {{Bsvs|bsvFrom=4.4}}==
'''The following features are available in the Notification center:'''
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==
'''1 - Notifications filter:''' The filter  lists notifications by category or namespace.  
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==
'''2 - Status tab:''' You can view unread notifications as well as read notifications or all notifications.
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==
'''3 - Preferences:''' Here you can clear the unread notifications list or go to your user preferences to update your notification subscriptions.
===Display options===
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceBookShelf}}


===Export===
'''4 - Notification:''' Clicking on the filled-in blue notification marker will mark a notification as read.
Wiki administrators can make the following adjustments for the book export:
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#Export}}


===Configuring the file size limits  (server)===
== Customizing the notification emails ==
By default, the book export is limited to 50MB in file size. To adjust this value, complete the following steps:
By default, the emails use the settings from the page ''Special:FlexiSkin''. If your wiki does not have active FlexiSkin settings, the standard template uses the BlueSpice Logo and default colors.


#In Apache Tomcat, open the file ''web.xml'': <syntaxhighlight lang="c">
[[File:Standard notification email layout.png|alt=Screenshot of the default layout with example content|center|thumb|550x550px|Notification email layout]]
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>


You can customize the content and design of the default email layout directly in the wiki. This requires changes to the following three pages:


{{Box Links-en|Topic1=[[Manual:Extension/BlueSpiceUniversalExport/Customization|PDF Customization (Cloud only)]]}}
* MediaWiki:Wrapper.mail
{{Translation}}
* MediaWiki:SingleNotification.mail
* MediaWiki:DigestNotification.mail
{{Icon|bi bi-arrow-right-circle|||}} [[Manual:Extension/Notifications/Email layout|How to customize the notification email layout]]


[[Category:Organization]]
{{translation}}
[[Category:Personalization]]
__FORCETOC__

Revision as of 11:48, 24 July 2024

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


Registered wiki users receive notifications for a variety of changes to the wiki. Users can subscribe to different types of notifications.

Automatically generated notifications

default subscriptions set in the user preferences
YouTube icon
YouTube: Notifications subscriptions (4:55 min.)

Some notifications are not dependent on a subscription and are always automatically sent to users. These include:

  • Reminders: Your reminders are due in one week or today
  • Read confirmation requests: You have a new read confirmation request
  • Mentions and tasks: Another user mentioned you or a new task was assigned to you
  • Workflow notifications: A workflow you initiated has finished or you have a new workflow task
  • Page assignment changes: Someone assigned you to a page or removed your page assignment.
    Note: Users are not automatically notified about changes on pages to which they are assigned. Assigned users have to subscribe to be notified.
  • Changes to your user page by other users
  • Reverted changes via the page history by other users
  • Changes to your wiki permissions and other administrative events

List of events that trigger automatic notifications

Events without notifications

The following events do not trigger notifications:

  • own edits
  • page revisions that are marked as "minor edit"

Subscribing to notifications

In addition to automatic notifications, you can subscribe to additional notifications. These custom notification sets are meant to inform you about very specific events in a single context (for example: page approvals in a particular namespace).

Notifications tab with three subscriptions
Notifications tab in user preferences

To subscribe to a notification set:

  1. Click on Preferences in your user menu.
  2. Switch to the tab Notifications.
  3. Click the Add button.
  4. Create your notification subscription. See below for selecting the options.
  5. Click Done to save your new notification set.
    Dialog box for adding a subscription
    Subscription settings
A note for wiki administrators:If you are an administrator and need to monitor the entire wiki, it is more efficient to habitually check the overview pages that show all changes in the wiki (e.g., the pages for Recent changes or the Quality overview page for the approval status of all pages) That way, you can avoid beeing flooded with notifications.


Options

Setting Description
Receive notifications for
  • Book: if pages change in a book. To get notifiied about multiple namespaces, you need to create separate subscriptions.
  • Namespace: if pages change in a namespace. To get notifiied about multiple namespaces, you need to create separate subscriptions.Namespace: if pages change in a namespace. To get notifiied about multiple namespaces, you need to create separate subscriptions.
  • Category: if pages change in a category. To get notifiied about multiple categories, you need to create separate subscriptions. Subcategories are also not included in a category subscriptions. They each require their own notification.
  • Watchlist: if pages change that are on your watchlist.
  • Assigned pages: if pages change that are on your assignments list.
Type of notifications
  • Low-frequency:
    • create / move / delete page
    • edit / delete discussion or blog topic / comment
  • High-frequency:
    • edit page
    • create blog post or discussion topic
    • create blog or discussion comment
  • Quality monitoring:
    • approval of assigned page
    • page expiry
Delivery method By default, notifications appear in the wiki itself. If you want to get email notifications as well, you need to activate the email checkbox.

Viewing notifications

If a user has unread notifications, the bell symbol in the top toolbar shows the number of new notifications. Clicking the notification symbols opens a mega menu with the 10 most recent notifications.

Buttons in the top toolbar with active notifications symbol
New notifications

At the end of the notifications is a link to view all notifications. This link opens the Notification center.

layout of the notification center with 4 marked areas
Notifications center


The following features are available in the Notification center:

1 - Notifications filter: The filter lists notifications by category or namespace.

2 - Status tab: You can view unread notifications as well as read notifications or all notifications.

3 - Preferences: Here you can clear the unread notifications list or go to your user preferences to update your notification subscriptions.

4 - Notification: Clicking on the filled-in blue notification marker will mark a notification as read.

Customizing the notification emails

By default, the emails use the settings from the page Special:FlexiSkin. If your wiki does not have active FlexiSkin settings, the standard template uses the BlueSpice Logo and default colors.

Screenshot of the default layout with example content
Notification email layout

You can customize the content and design of the default email layout directly in the wiki. This requires changes to the following three pages:

  • MediaWiki:Wrapper.mail
  • MediaWiki:SingleNotification.mail
  • MediaWiki:DigestNotification.mail

How to customize the notification email layout

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=9925"