Browse history interactively

Meryam Sahin (talk | contribs)

12 user groups
4,159 edits
VisualWikitext
Meryam Sahin (talk | contribs)
Interface administrators, Administrators, wiki_FIN_reader, wiki_HR_editor, wiki_HR_reader, wiki_IIT_reader, wiki_IMS_editor, wiki_IMS_reader, wiki_MnS_reader, wiki_RnD_editor, wiki_RnD_reader, wiki__global_admin
4,159 edits
Created page with "{{DISPLAYTITLE:Books}} 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== <span class="youtubelink">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 h..."
 
Meryam Sahin (talk | contribs)
Interface administrators, Administrators, wiki_FIN_reader, wiki_HR_editor, wiki_HR_reader, wiki_IIT_reader, wiki_IMS_editor, wiki_IMS_reader, wiki_MnS_reader, wiki_RnD_editor, wiki_RnD_reader, wiki__global_admin
4,159 edits
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
<status color="green" light="true">done</status> <br>
{{DISPLAYTITLE:Books}}
{{DISPLAYTITLE:Books}}
 
Wiki pages can be organized as structured books with chapter navigation. Books can also be exported as PDF files with a cover page. Books can be grouped into bookshelves, and a wiki page can be included in multiple books.
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.
<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|22px]][https://youtu.be/koPjB2KSZow YouTube: Books (5:22 min.)]|link=https://youtu.be/koPjB2KSZow]]</span>
 
== Create a book ==
==Characteristics==
Create books from the '''Books''' page.
<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>
[[File:bookshelf-create-new-book.png|alt=Books page with the Create new book action|center|thumb|650x650px|Create new book]]
 
To create a book:
Books have the following characteristics:
# Select '''+ Create new book''' from the page actions.
 
# Enter a book title.
*On book pages, the book navigation is displayed instead of the main navigation.
# Enter a subtitle (optional).
* 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.
# Select a bookshelf (optional). If no bookshelf is selected, the book is listed under '''Various books'''.
*Books can be printed completely or partially as a PDF with a cover sheet.
# Upload or select a cover image (optional). If no cover image is selected, a random cover image is applied.
*Books can be grouped into individual bookshelves.
# Select '''Save'''.
 
# Select '''Done'''. The book editor opens.
== Differences to previous versions ==
[[File:bookshelf-create-book-dialog.png|alt=Create book dialog with completed fields for a user manual|center|thumb|400x400px|Create book dialog]]
*A page can now be in multiple books.
An alternative way to create a book is to select '''New book''' from the '''New content''' button in the header. The remaining steps are the same.
*The books are displayed as thumbnails and can be organized on different "shelves".
== Edit a book ==
*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>).
To edit a book:
* There is no option to duplicate a book since this was also an edge use case.
# Select '''Edit''' in the book preview on the '''Books''' page.
*There is no more separate book manager. All books can now be managed directly from the Books page.
# The book editor opens.
 
=== Add pages ===
==Creating a book==
Pages can be added as wiki page chapters or text chapter headings. <br>
Books are created from the page  ''Special:Books''.  
To add a wiki page chapter:
[[File:Bookshelf create book action.png|alt=Page Special:Books with actions menu|center|thumb|650x650px|"Create new book" ]]  
# Select '''+ Add element'''.
 
# Select '''Edit element'''.
'''To create a book:'''
# For '''Node type''', select '''Wiki page chapter'''.
#'''Click''' ''Create new book'' in the actions menu of the page tools. This opens a dialog box.
# Enter the name of the wiki page in '''Target'''.
#'''Enter''' a book title.
# Enter the label displayed for the chapter in '''Text'''.
#'''Enter''' a subtitle (optional).
# Select '''Done'''.
#'''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''.
# Drag and drop the chapter to the required position.
#'''Upload or select''' a cover image (optional)'''.''' If you do not upload or select a cover image, a random cover image will be applied.
# Select '''Save'''. <br>
#'''Click''' ''Save''.  The book is now shown in its bookshelf group and can be edited.
To add a text chapter heading:
#'''Click''' ''Done''. The book editor loads next.
# Select '''+ Add element'''.
[[File:book dialog box.png|alt=Create book dialog box with completed fields for a user manual|center|thumb|400x400px|Dialog box]]
# Select '''Edit element'''.
 
# For '''Node type''', select '''Text chapter heading'''.
==="New" button===
# Enter the chapter heading in '''Text'''.
Alternatively, you can create a book via the "+" button. The next steps to save the book are as described above.
# Select '''Done'''.
==Editing a book==
# Drag and drop the chapter heading to the required position.
To switch to the book edit mode, '''click''' ''Edit'' in the book preview on the Books page.  
# Select '''Save'''.
 
=== Add multiple pages ===
This opens the book editor.
'''Add multiple pages''' adds several pages to a book based on a selected source. <br>
 
To add multiple pages:
==Adding elements==
# Select '''Add multiple pages'''.
To add a wikipage to a book:
# For '''Source''', select one of the following options:
 
#* '''All pages of a category''': adds all pages from a selected category to the end of the book.
#'''Click''' ''Add element.''
#* '''All subpages of a page''': adds all subpages of a selected page to the end of the book.
#'''Select''' the node type ''Wiki page chapter.''
#* '''Page collection''': adds the pages from a page collection to the end of the book.
#'''Enter''' the name of the wikipage you want to add in the field ''Target''.
# Configure the selected source.
#'''Enter''' the label you want show for the page in the field ''Text''.
# Confirm the selection.
#'''Click''' ''Done''. The page is added to the end of the book.
{{Textbox|boxtype=important|header=Reordering multiple pages|text=Pages added with '''Add multiple pages''' cannot currently be moved together to another location in the book. To rearrange the chapters, open the book in source editing mode and copy and paste the chapters into the required order.|icon=yes}}
#'''Drag-and-drop''' the page to the desired section.
=== Edit book metadata ===
#'''Repeat''' steps 1-6 if you want to add another page.
Book metadata can be edited while editing a book. Some metadata is used when the book is exported as a PDF. All metadata is also available as user-defined document properties in the exported PDF. <br>
#'''Click''' ''Save'' when you are done.
The following metadata is available:
 
==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%;"
{| class="wikitable" style="width: 100%;"
|+Meta data and their functionality
|+Book metadata
! style="" |Parameter
! Parameter
! style="" |Beschreibung
! Description
! style="width:100px;" |in Standard-Vorlagen
! Included in standard PDF templates
|-
|-
| style="" |Author 1
| Author 1
| style="" |User-defined PDF-document property. Not included in PDF pages.
| User-defined PDF document property; not included on PDF pages.
| style="width:100px;" |no
| no
|-
|-
| style="" |Author 2
| Author 2
| style="" |User-defined PDF-document property. Not included in PDF pages.
| User-defined PDF document property; not included on PDF pages.
| style="width:100px;" |no
| no
|-
|-
| style="" |Bookshelf
| Bookshelf
| style="" |Lists the book on the Books page of the wiki under a particular bookshelf. It has no relevance for the printed PDF.
| Determines the bookshelf under which the book is listed on the '''Books''' page. It has no relevance for the exported PDF.
| style="width:100px;" |no
| no
|-
|-
| style="" |Bookshelf Image
| Bookshelf Image
| style="" |Image that is shown as preview image and as the cover image on the actual PDF.
| Image displayed as the book preview image and used as the cover image in the exported PDF.
| style="width:100px;" | yes
| yes
|-
|-
| style="" |Department
| Department
| style="" |User-defined PDF-document property. Not included in PDF pages.
| User-defined PDF document property; not included on PDF pages.
| style="width:100px;" |no
| no
|-
|-
| style="" |Document type
| Document type
| style="" |User-defined PDF-document property. Not included in PDF pages.
| User-defined PDF document property; not included on PDF pages.
| style="width:100px;" |no
| no
|-
|-
| style="" |Document-ID  
| Document-ID
| style="" |Manually assigned document ID.
| Manually assigned document ID.
| style="width:100px;" |no
| no
|-
|-
| style="" |PDF export template
| PDF export template
| style="" | Template that is applied to create the PDF. Templates can be defined in the wiki. [[Manual:Extension/PDFCreator|See PDFCreator]].
| Template used to create the PDF. Templates can be defined in the wiki. See [[Manual:Extension/PDFCreator|PDFCreator]].
| style="" |no  
| no
|-
|-
| style="" |Subtitle
| Subtitle
| style="" |Printed on the cover page.
| Printed on the cover page.
| style="width:100px;" |yes  
| yes
|-
|-
| style="" |Title
| Title
| style="" |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.
| Printed on the cover page. The title replaces the book title in the PDF output and is used as the PDF file name.
| style="width:100px;" |yes
| yes
|-
|-
| style="" |Version  
| Version
| style="" |Manually assigned book version number.
| Manually assigned book version number.
| style="width:100px;" |no
| no
|}
|}
 
== Export a book ==
== Mass adding pages==
=== Export the complete book ===
After clicking "Mass add", a dialog is opened. It contains different criteria for page selection:
To export the complete book as a PDF:
 
# Select '''Export''' on the '''Books''' page.
*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).
# The book is downloaded as a PDF.
*All subpages of a certain page: After selecting a page, all its subpages are added at the end of the book.
=== Export individual chapters ===
* 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].
Individual chapters can be selected and exported from the book's chapter tree. <br>
{{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}}
To export individual chapters:
 
# Open '''Pages'''. If '''Pages''' is not available in the navigation, open '''Special:Pages''' directly.
== Exporting a book==
# Select the book.
'''To download the book as PDF:'''
# Select the chapters to export.
 
# Select '''Export''' above the chapter tree.
'''Click''' ''Export'' on the ''Books'' page. This immediately downloads the book.
# The selected chapters are downloaded as a PDF with a cover page and their original chapter numbering. <br>
 
For information about creating custom PDF export templates, see [[Extension/PDFCreator|PDFCreator]].
'''To download individual chapters:'''
== Manage a book ==
 
The '''More actions for this book''' menu provides additional actions for the current book.
#'''Go to''' the entrypoint ''Pages''. If your wiki does not show this link, go directly to the page ''Special:Pages''.
{| class="wikitable" style="width: 100%;"
#'''Click''' on a book name.
|+ More actions for this book menu
#'''Select''' the chapters you want to export.
!Parameter
#'''Click''' E''xport'' above the chapter tree.
!Description
 
|-
The book is then downloaded.
|Chapters
 
|'''Chapters''' opens the book's chapter tree. Individual chapters can be selected and exported from this view.
 
|-
If you  want to create export templates, follow the instructions for [[Manual:Extension/PDFCreator|PDFCreator]].
|Delete a book
 
|'''Delete''' removes the book, including its table of contents. The wiki pages included in the book are not deleted and are no longer associated with the book.
==More actions==
|-
The ''More actions'' button allows to delete, assign, or edit the metadata of the book.
|Edit metadata
=== Chapter ===
|'''Edit metadata''' opens the book metadata for editing. See [[#Edit book metadata|Edit book metadata]].
This takes you to the tree structure of the book where you can export individual chapters:
|-
 
|Watch a book
# '''Select''' the individual chapters using the selection boxes.
|'''Watch''' adds the book to the list of watched pages.
# '''Click''' <code>Export</code>.
|}
 
== Add book navigation to a page ==
The chapters are downloaded with a cover page and their original chapter numbering.  
The '''Book table of contents''' [[Extension/ContentDroplets|Content Droplet]] displays the table of contents of an entire book or the chapter navigation of an individual chapter on another wiki page.
 
[[File:bookshelf-book-table-of-contents.png|alt=Book table of contents Content Droplet showing chapter navigation|center|thumb|650x650px|Book table of contents]]
===Delete===
== Add a PDF download link to a page ==
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.
The '''Book PDF link''' [[Extension/ContentDroplets|Content Droplet]] adds a link to a wiki page that downloads a book directly as a PDF.
 
== Permissions ==
===Edit metadata===
Edit permissions in the relevant wiki are required to create and edit a book. <br>
This provides the same functionality as the button [[Manual:Extension/BlueSpiceBookshelf#Editing metadata|''Edit metadata'' in the menu editor]].
A book can only include pages that are readable in the relevant wiki. If a book contains pages that cannot be read with the current permissions, exporting the book as a PDF results in an error.
 
== Configuration ==
===Assign ===
* Display options: In the [[Extension/BlueSpiceConfigManager#BlueSpiceBookShelf|BlueSpiceConfigManager]], settings for '''BlueSpiceBookShelf''' are available.
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.
* Export: Wiki administrators can adjust the configuration for book export in the [[Extension/BlueSpiceConfigManager#Export|BlueSpiceConfigManager]] under '''Export'''.
 
== 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.
 
==Configuration==
===Display options===
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceBookShelf}}
 
===Export===
Wiki administrators can make the following adjustments for the book export:
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#Export}}
 
== Semantic Mediawiki ==
The books in which a page exists can be [[SMW queries|queried]] via the semantic property  ''Books'' (''Property:Books'').
[[File:property_books.png|alt=Display of values for property "book" of a wikipage|center|thumb|450x450px|Semantic property "Books"]]
 
 
{{Box Links-en|Topic1=[[Manual:Extension/PDFCreator|PDF export]]}}
{{Translation}}
 
[[Category:Organization]]

Latest revision as of 13:23, 31 August 2026

done
Wiki pages can be organized as structured books with chapter navigation. Books can also be exported as PDF files with a cover page. Books can be grouped into bookshelves, and a wiki page can be included in multiple books.

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

Create a book

Create books from the Books page.

Books page with the Create new book action
Create new book

To create a book:

  1. Select + Create new book from the page actions.
  2. Enter a book title.
  3. Enter a subtitle (optional).
  4. Select a bookshelf (optional). If no bookshelf is selected, the book is listed under Various books.
  5. Upload or select a cover image (optional). If no cover image is selected, a random cover image is applied.
  6. Select Save.
  7. Select Done. The book editor opens.
Create book dialog with completed fields for a user manual
Create book dialog

An alternative way to create a book is to select New book from the New content button in the header. The remaining steps are the same.

Edit a book

To edit a book:

  1. Select Edit in the book preview on the Books page.
  2. The book editor opens.

Add pages

Pages can be added as wiki page chapters or text chapter headings.
To add a wiki page chapter:

  1. Select + Add element.
  2. Select Edit element.
  3. For Node type, select Wiki page chapter.
  4. Enter the name of the wiki page in Target.
  5. Enter the label displayed for the chapter in Text.
  6. Select Done.
  7. Drag and drop the chapter to the required position.
  8. Select Save.

To add a text chapter heading:

  1. Select + Add element.
  2. Select Edit element.
  3. For Node type, select Text chapter heading.
  4. Enter the chapter heading in Text.
  5. Select Done.
  6. Drag and drop the chapter heading to the required position.
  7. Select Save.

Add multiple pages

Add multiple pages adds several pages to a book based on a selected source.
To add multiple pages:

  1. Select Add multiple pages.
  2. For Source, select one of the following options:
    • All pages of a category: adds all pages from a selected category to the end of the book.
    • All subpages of a page: adds all subpages of a selected page to the end of the book.
    • Page collection: adds the pages from a page collection to the end of the book.
  3. Configure the selected source.
  4. Confirm the selection.
Reordering multiple pagesPages added with Add multiple pages cannot currently be moved together to another location in the book. To rearrange the chapters, open the book in source editing mode and copy and paste the chapters into the required order.

Edit book metadata

Book metadata can be edited while editing a book. Some metadata is used when the book is exported as a PDF. All metadata is also available as user-defined document properties in the exported PDF.
The following metadata is available:

Book metadata
Parameter Description Included in standard PDF templates
Author 1 User-defined PDF document property; not included on PDF pages. no
Author 2 User-defined PDF document property; not included on PDF pages. no
Bookshelf Determines the bookshelf under which the book is listed on the Books page. It has no relevance for the exported PDF. no
Bookshelf Image Image displayed as the book preview image and used as the cover image in the exported PDF. yes
Department User-defined PDF document property; not included on PDF pages. no
Document type User-defined PDF document property; not included on PDF pages. no
Document-ID Manually assigned document ID. no
PDF export template Template used to create the PDF. Templates can be defined in the wiki. See PDFCreator. no
Subtitle Printed on the cover page. yes
Title Printed on the cover page. The title replaces the book title in the PDF output and is used as the PDF file name. yes
Version Manually assigned book version number. no

Export a book

Export the complete book

To export the complete book as a PDF:

  1. Select Export on the Books page.
  2. The book is downloaded as a PDF.

Export individual chapters

Individual chapters can be selected and exported from the book's chapter tree.
To export individual chapters:

  1. Open Pages. If Pages is not available in the navigation, open Special:Pages directly.
  2. Select the book.
  3. Select the chapters to export.
  4. Select Export above the chapter tree.
  5. The selected chapters are downloaded as a PDF with a cover page and their original chapter numbering.

For information about creating custom PDF export templates, see PDFCreator.

Manage a book

The More actions for this book menu provides additional actions for the current book.

More actions for this book menu
Parameter Description
Chapters Chapters opens the book's chapter tree. Individual chapters can be selected and exported from this view.
Delete a book Delete removes the book, including its table of contents. The wiki pages included in the book are not deleted and are no longer associated with the book.
Edit metadata Edit metadata opens the book metadata for editing. See Edit book metadata.
Watch a book Watch adds the book to the list of watched pages.

Add book navigation to a page

The Book table of contents Content Droplet displays the table of contents of an entire book or the chapter navigation of an individual chapter on another wiki page.

Book table of contents Content Droplet showing chapter navigation
Book table of contents

Add a PDF download link to a page

The Book PDF link Content Droplet adds a link to a wiki page that downloads a book directly as a PDF.

Permissions

Edit permissions in the relevant wiki are required to create and edit a book.
A book can only include pages that are readable in the relevant wiki. If a book contains pages that cannot be read with the current permissions, exporting the book as a PDF results in an error.

Configuration


Retrieved from "https://galaxy.demo.bluespice.com/Helpdesk/index.php?title=Extension/BlueSpiceBookshelf&oldid=12710"