Last edited 2 months ago
by Margit Link-Rodrigue

Manual:Extension/BlueSpiceBookshelf and Manual:Extension/ContentDroplets: Difference between pages

(Difference between pages)
VisualWikitext
No edit summary
 
No edit summary
 
Line 1: Line 1:
<bookshelf src="Book:User manual" />
{{DISPLAYTITLE:Content Droplets}}
{{DISPLAYTITLE:Books}}
<!--{{BSVersion|bsvFrom=4.3|bsvFeature=ContentDroplets}}-->
{{TOClimit|limit=1}}
To insert additional functionality in a wiki page, you can use Content droplets. Content droplets include tags that were previously accessed from ''Insert > Magic word'' in the editor toolbar.  They also provide access to some templates that are preconfigured in the wiki, such as message boxes.


In BlueSpice pro, several wiki pages can be displayed for a structured book with chapter navigation. The book can also be printed as a PDF file with a cover sheet.
== Adding a droplet to a page ==
To add a droplet to a page:


==Characteristics of books==
# '''Click''' the Content droplets icon in the editor toolbar or type <code><nowiki><<</nowiki></code>.
By default, books are created as a "general book". General books have the following characteristics:
#'''Search''' for a droplet name in the search bar of the droplets menu or browse the droplets by category.[[File:droplet menu.png|none|thumb|550x550px]]
#'''Select''' a droplet
#'''Click''' ''Insert''.
{{Messagebox|boxtype=note|icon=|Note text=Some droplets open an inspector menu which contains another ''Insert'' button. Be sure to confirm that button as well.|bgcolor=}}
Based on the type of droplet, you can continue with configuring the droplet as needed.


*They povide a chapter navigation.
==List of droplets==
*On book pages, the book navigation is displayed instead of the main navigation.
<containerfilter selector=".wikitable tr">
*A wiki page that belongs to a general book is identified by a <code><nowiki><bookshelf /></nowiki></code> tag in the source code.
*Each page can only be included '''in one''' general book.
*Books can be printed completely or partially as a PDF with a cover sheet.
*They are listed alphabetically on the bookshelf. It is not possible to hide individual books.
*The bookshelf can be reached via the main navigation.


==Creating a book==
</containerfilter>
Books are created from the page  ''Special:BookshelfBookManager''. This page can be reached from the ''[[Manual:Extension/BlueSpiceDiscovery|Global actions]]'' menu under  ''Management > Books''.
{| class="wikitable" style="width: 100%;"
[[File:Manual:book-manager.png|alt=Book manager|center|thumb|650x650px|Book manager]]
! style="background-color:rgb(234, 236, 240);text-align:center;width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);padding:8px;" class="" |'''Droplet'''
! style="background-color:rgb(234, 236, 240);text-align:center;width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);padding:8px;" class="" |'''Description'''
!Inserts the following in the page source:
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Attachments]] {{PopImg|file=attachments.png|alt=Screenshot of the attachments area|caption=Attachments output|width=600}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Area for organising attachments
|<code><nowiki><attachments title="Attachments area"></nowiki></code>


'''To create a book:'''
<code>* <nowiki>[[Media:Financial_Sample.xlsx]]</nowiki></code>
#'''Click''' the <code>+</code>-button.
#'''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===
<code><nowiki></attachments></nowiki></code>
You are now in the book editing mode.
|-
[[File:Manual:bookshelf-schaltflächen.png|alt=Book edit buttons|center|thumb|220x220px|Book edit buttons]]
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Booklist
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |List of books based on a filter value. The value needs to be defined as a metadata in the book settings.
|<code><nowiki><bs:booklist filter="Author:WikiSysop" /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[mediawikiwiki:Extension:Cognitive_Process_Designer#Usage|BPMN diagram]] {{PopImg|file=Manual:bpmn-UserFeedback.svg|alt=Screenshot of a BPMN diagram|caption=BPMN diagram|width=600}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Editable BPMN diagram
|<code><nowiki><bpmn name="Test:Erm31642" /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Templates download/ButtonLink|Button]]{{PopImg|file=HW-ButtonLink.png|alt=Screenshot of three colored button links|caption=Links styled as buttons|width=400}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Link that is styled as a button
|<code><nowiki>{{ButtonLink|target=Main Page|label=click me!|format=blue}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[mediawikiwiki:Extension:CategoryTree|Categorytree]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Selected categories are shown in a tree structure
|<code><nowiki><categorytree>TestCat</categorytree></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceChecklist#Creating a checkbox|Checkbox]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Checkbox that can be checked in view mode
|<code><nowiki><bs:checkbox checked="true" /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceChecklist#Creating a checkbox|Checklist]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |List that allows to set a value in view mode
|<code><nowiki><bs:checklist type="list" checked="true" list="Template:Status" value="Select status" /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[wikipedia:Help:Displaying_a_formula#Chemistry|Chemical formula]]  {{PopImg|file=chem.png|alt=screenshot of the chemical formula|caption=Chemical formula|width=300}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Display of chemical formulas
|<code><nowiki><chem>H2O</chem></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Circled number
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Number in a circle with customizable color
|<code><nowiki>{{CircledNumber|bgColor=black|fgColor=yellow|number=180}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Reference:SyntaxHighlight|Code]]{{PopImg|file=syntaxhighlight.png|alt=Screenshot of a code area with css syntax|caption=Code area for a css example}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Highlighted section for code examples
|<code><nowiki><syntaxhighlight lang="css"></nowiki></code>


#'''Click''' the  ''Plus'' button (1).  A dialog window opens.
<code>.hi {background:blue;}</code>
#'''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).
#'''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]]
<code><nowiki></syntaxhighlight></nowiki></code>
{{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=}}
|-
The book is now displayed on the wiki bookshelf. The bookshelf can be reached via the entry links in the main navigation.
| style="width:190px;" |[[Manual:Extension/InputBox|Create page]]
| style="width:380px;" |Form field for predefined page creation
|<code><nowiki>{{CreateInput|alignment=left|buttonlabel=Create}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[SMW queries#Content droplet .22Data query.22 v4.3.2B|Data query]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Enables queries on content in the wiki
|<code><nowiki>{{SMWReport|count=10}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/ContentDroplets#Decision|Decision]] {{PopImg|file=droplet decision.png|alt=Example of a decision|caption=Decision output|width=600}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Highlights a decision as a page property
|<code><nowiki>{{Decision|decision=Eat more veggies}}{{Decision|decision=Buy new car}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/DrawioEditor|Diagram]] {{PopImg|file=BlueSpice_system_architecture_high_level.drawio.png|alt=Example of a server structure diagram|caption=Drawio diagram|width=600}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Editable draw.io diagram
|<code><nowiki><drawio filename="Mydiagram"></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" | [[mediawikiwiki:Help:Images#Gallery_syntax|Gallery]] {{PopImg|file=droplet gallery.png|alt=Example of a gallery with three fish|caption=Gallery|width=}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Displays an image gallery
|<code><nowiki><gallery></nowiki></code>


{{Messagebox|boxtype=note|icon=|Note text=There is no option to go directly from the bookshelf to the book manager.|bgcolor=}}
<code>File:test1.png</code>


===Mass-adding of pages===
<code>File:test.pdf</code>
After clicking "Mass add", a dialog is opened. It contains different criteria for page selection:


* All pages of a category
<code><nowiki></gallery></nowiki></code>
* All subpages of a certain page
|-
* 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].
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/ContentDroplets/Icon|Icon]]{{PopImg|file=icon.png|alt=Example of a bootstrap icon|caption=Icons template}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Inserts an icon
|<code><nowiki>{{Icon|bi bi-arrow-left-circle}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Templates download/Messagebox|Important Message]]{{PopImg|file=message-important.png|alt=Screenshot of important message|caption=Message of type "important"}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Adds colored panel for a important note
|<code><nowiki>{{Textbox|boxtype=important|header=OMG|text=Important|icon=yes}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceSmartList|Links to this page]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |List of pages that link to this page
|<code><nowiki>{{Whatlinkshere|count=5|sort=time|order=DESC}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Reference:BlueSpiceWhoIsOnline|List of users logged in]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Pop-up with a list of all users that are currently logged in
|<code><nowiki><bs:whoisonlinepopup /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[https://maps.extension.wiki/wiki/Displaying_Leaflet_maps Map]{{PopImg|file=map.png|alt=Screenshot of the map output|caption=Map output with text marker}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Locations can be marked on the map
|<code><nowiki>{{Map|Munich ~ Hello there!|Munich, Germany}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[mediawikiwiki:Help:VisualEditor/User_guide#Editing_mathematical_formulae|Mathematical formula]]{{PopImg|file=math.png|alt=Math formula|caption=Screenshot of a math formula}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Display of mathematical formulas
|<code><nowiki><math>\tfrac{2}{4}</math></nowiki></code>
|-
| style="width:190px;" |Member list
|List of members of a wiki group
|<code><nowiki><bs:userlist groups="sysop" count="6" /></nowiki></code>
|-
| style="background-color:rgb(248, 249, 250);text-align:start;width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;color:rgb(32, 33, 34);font-family:Lato, &quot;sans-serif&quot;;font-size:13.9995px;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;orphans:2;text-indent:0px;text-transform:none;white-space:normal;widows:2;word-spacing:0px;-webkit-text-stroke-width:0px;text-decoration-thickness:initial;text-decoration-style:initial;text-decoration-color:initial;" class="" |[[Templates download/Messagebox|Message]]{{PopImg|file=message.png|alt=Screenshot of a plain message|caption=A plain message}}
| style="background-color:rgb(248, 249, 250);text-align:start;width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;color:rgb(32, 33, 34);font-family:Lato, &quot;sans-serif&quot;;font-size:13.9995px;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;orphans:2;text-indent:0px;text-transform:none;white-space:normal;widows:2;word-spacing:0px;-webkit-text-stroke-width:0px;text-decoration-thickness:initial;text-decoration-style:initial;text-decoration-color:initial;" class="" |Adds text panel
|<code><nowiki>{{Textbox|boxtype=neutral|header=|text=SDadad|icon=no}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/ContentDroplets#Modal button|Modal button]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Configurable button which opens a customizable modal dialogue
|<code><nowiki>{{ModalDialog|title=I am a dialog|btnLabel=click me!|body=This is the text|footer=hello world}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceSmartList#Toplist|Most visited pages]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |List of the most visited wiki pages
|<code><nowiki><bs:toplist count="3" period="-" /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceSmartList|New users]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |List of new users in the wiki
|<code><nowiki><bs:newbies count="4" /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Templates download/Messagebox|Note Message]]{{PopImg|file=message-note.png|alt=Screenshot of a note message|caption=Message of type "Note"}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Adds colored panel for a note
|<code><nowiki>{{Textbox|boxtype=note|header=|text=sfsadfasfdsdaf|icon=yes}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceCountThings|Number of characters]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Shows the number of characters or words in a wiki page
|<code><nowiki><bs:countcharacters /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceCountThings|Number of files]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Shows the number of all uploaded files
|<code><nowiki><bs:countfiles /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceCountThings|Number of  pages]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Shows the number of  pages
|<code><nowiki><bs:countarticles /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceCountThings|Number of users]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Shows the number of all users
|<code><nowiki><bs:countusers /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" | [[Reference:BlueSpiceWhoIsOnline|Number of users logged in]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Number of currently logged in users
|<code><nowiki><bs:whoisonlinecount /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Reference:BlueSpicePageAccess|Page access]]{{PopImg|file=pageaccess.png|alt=Screenshot of the page access notification banner|caption=Page access notification banner}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Restricts access to the page to the specified groups
|<code><nowiki><bs:pageaccess groups="sysop" /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |PDF link
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Link that downloads another wiki page as PDF
|<code><nowiki>{{PDFLink|page=Main Page|template=BlueSpice|label=PDF Link}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |PDF page break
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Forces a page break at the set position during PDF export
|<code><nowiki><bs:uepagebreak /></nowiki></code>
|-
|[[Manual:Extension/ContentDroplets#PDF preview|PDF preview]]
|Embed preview of a PDF file
|<code><nowiki><pdf height="800">File:Raspberry_pi.pdf</pdf></code></nowiki>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceUniversalExport#Exclude content from PDF export|PDF no export]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Content within this section is excluded from the  PDF export
|<code><nowiki><bs:uenoexport>Don't export this text</bs:uenoexport></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" | [[Manual:Extension/ContentDroplets#Progress|Progress]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Visualizes progress against given measurement variables
|<code><nowiki><bs:statistics:progress basecount="2" progressitem="OK" width="150" baseitem="Status:" /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/ContentDroplets#Pros and cons|Pros and cons]]{{PopImg|file=pros and cons.png|alt=Screenshot of the pros and cons template|caption=Pros and cons}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Table for comparing pros and cons
|<code><nowiki>{{ProConList|title-advantages=Advantages|title-disadvantages=Disadvantages|advantages=* It is cheap|disadvantages=* It is sold out}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" | [[Manual:Extension/BlueSpiceSmartList|Recent changes]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |List of recently changed pages
|<code><nowiki>{{RecentChanges|count=5}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceSignHere|Signature]]{{PopImg|file=signatures.png|alt=Screenshot of the signatures button with a signature already added|caption=Signatures button}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |A button to add signatures in view mode
|<code><nowiki><bs:signhere /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceTagSearch|Search field]] {{PopImg|file=Suchfeld standard.png|alt=Screenshot of a search field with suggested results|caption=Search field|width=}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Adds a search field to the page content
|<code><nowiki><bs:tagsearch type="wikipage"  namespace="QM" /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Reference:SubPageList|Subpages]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |List of the subpages of a wiki page
|<code><nowiki>{{Subpages|parentpage=Mypage}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Templates download/Messagebox|Success Message]]{{PopImg|file=message-success.png|alt=Screenshot of a success message|caption=Message of type "success"}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Adds colored panel for a success note
|<code><nowiki>{{Textbox|boxtype=success|header=OMG|text=It works|icon=yes}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceTagCloud|Tag cloud]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Tag cloud based on categories or search queries
|<code><nowiki><bs:tagcloud renderer="list" store="category" /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Templates download/Messagebox|Tip Message]]{{PopImg|file=message-tip.png|alt=Screenshot of a tip message|caption=Message of type "tip"}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Adds colored panel for a tip
|<code><nowiki>{{Textbox|boxtype=tip|header=Tip|text=sfsadf|icon=yes}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceAvatars#Using the .3Cprofileimage.3E tag|User profile]] {{PopImg|file=userprofile.png|alt=Screenshot of the user profile|caption=User profile of type "Short"|width=300}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |A user profile will be included on this page
|<code><nowiki><bs:socialentityprofile username="WikiSysop" rendertype="Short" /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/EmbedVideo|Video]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Embeds video from different external platforms (YouTube)
|<code><nowiki><embedvideo service="youtube">JILEkPu61Ao</embedvideo></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpicePagesVisited|Visited pages]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |List with visited pages
|<code><nowiki><bs:pagesvisited count="7" maxtitlelength="40" order="time" /></nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Templates download/Messagebox|Warning Message]]{{PopImg|file=message-warning.png|alt=Screenshot of a warning message|caption=Message of type "warning"}}
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Adds a colored box for a warning note
|<code><nowiki>{{Textbox|boxtype=warning|header=Hello|text=|icon=yes}}</nowiki></code>
|-
| style="width:190px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/ContentDroplets#Watchlist|Watchlist]]
| style="width:380px;box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Latest changes to pages included in your watch list
|<code><nowiki><bs:watchlist count="5" maxtitlelength="20" order="time" /></nowiki></code>
|}


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.
== Example outputs==
===Button===
{{ButtonLink|external=no|target=Main Page|label=My page|format=blue}}


==Adding metadata==
===Data query===
While editing a book (adding or removing pages), meta-data 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 will be opened where various meta-data can be added or removed:
'''Inspector settings'''
 
* Title
* Subtitle
* Author 1 and 2
* Document-ID
* Document type
* Department
* Version
* 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 metadata for use in the <nowiki><booklist>-tag, for example.</nowiki>
 
==Adding a cover image==
<span>To add a cover photo for the book, add a metadata item</span> ''Bookshelf image''<span>. Select this option from the dropdown and click</span> ''Add''<span>. Once the meta data is added enter the name of the image in the value field. Any image currently uploaded to the wiki can be used. Type the name without the "File:" prefix (enter the image name and file extension).</span>
 
==Types of books==
{| class="wikitable"
{| class="wikitable"
!Type
!setting
!Description
!value
!Chapter navigation
!description
|-
|Category
|Administration, Customization
|the returned pages need to be in one of these categories (optional)
|-
|-
|'''General books'''
|Namespace
|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".
|Main, Manual
|Yes
|the returned pages need to be in one of these namespaces (optional)
|-
|-
|'''Own books'''
| Modified
|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.
|All, Since, Before
|No
|sets a date filter
|-
|-
|'''Temporary books'''
|Printout statements
|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.
|<nowiki>Last editor is|Modification date</nowiki>
|No
|adds page properties in parentheses
|-
|Format
|Bulleted list, numbered list
|the output is in one of two lists formats
|-
|Number
|6
|Number of pages that are returned
|}
|}
'''Output'''
<dataquery namespaces="Manual" modified="+" printouts="Last editor is|Modification date" format="ul" count="6" />


==Exporting a book==
===Modal button===
Books, individual chapters or even individual book pages can be exported as PDF files:
{{ModalDialog|title=Legal notice|btnLabel=Google.com|body=You are leaving this website. We are not responsible for any content beyond this point.


# '''Open''' the book in the book manager.
[https://google.com Visit google.com]|bgcolor=blue|footer=}}
# '''Select''' each of the pages or chapters to export by clicking the appropriate check boxes. Sub-chapters are selected automatically.
# '''Click''' the Export Selections drop-down menu to open a list of the available formats.<br />


==Actions in the book manager==
The link Administration > Books in the menu ''Global Actions'' loads the page ''Special:Book Administration''. Here you can edit your books.
[[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.
* '''Delete''' (2): Deletes the book page in the namespace ''Book'' '''without''' deleting the wiki pages.
* '''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==
===PDF preview===
===Display options===
<pdf height="800">File:Raspberry_pi.pdf</pdf>
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceBookShelf}}


===Export===
=== Progress===
Wiki administrators can make the following adjustments for the book export:
Inspector
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#Export}}
{| class="wikitable"
 
!setting
===Configuring the file size limits  (server)===
!value  
By default, the book export is limited to 50MB in file size. To adjust this value, complete the following steps:
!description
 
|-
#In Apache Tomcat, open the file ''web.xml'': <syntaxhighlight lang="c">
| Base count
sudo -s
|5
nano /opt/tomcat/webapps/manager/WEB-INF/web.xml
| number of items that are counted to reach 100%
</syntaxhighlight>
|-
#Look for the following lines and adjust the value (e.g. for 250MB=26214400) <syntaxhighlight lang="c">
|Base item
<max-file-size>262144000</max-file-size>
|Is:  
<max-request-size>262144000</max-request-size>
|prefix that specifies the progress item. If you do not provide a base item, the progress item could be to unspecific
</syntaxhighlight>
|-
#The web app BShtml2PDF also has a setting that needs to be adjusted: <syntaxhighlight lang="c">
|Progress item
nano /opt/tomcat/webapps/BShtml2PDF/WEB-INF
|closed
</syntaxhighlight>
|item that will be counted towards the base count
#Enter your values in the following lines: <syntaxhighlight lang="c">
|-
<param-name>maxMemSize</param-name> <param-value>26214400</param-value>
|Width
<param-name>maxFileize</param-name> <param-value>26214400</param-value>
|300
</syntaxhighlight>
|width in pixels
#Apache Tomcat neu starten <syntaxhighlight lang="c">
|}
service tomcat restart
'''Output'''<div><bs:statistics:progress basecount="5" progressitem="closed" width="300" baseitem="Statecheck:" /></div><br />
</syntaxhighlight>
*This is my topic 1 (Statecheck:open)
==Deleting a book==
*This is my topic 2 (Statecheck:closed)
 
*This is my topic 3 (Statecheck:closed)
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.
*This is my topic 4 (Statecheck:closed)
 
*This is my topic 5 (Statecheck:closed)
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.
*'''Wiki pages''': All pages contained in the original book are duplicated. The following scenarios are possible:
**'''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.
==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.
 
== Available tags ==


* [[Manual:Extension/ContentDroplets|booklist]]
===Pros and cons===
* bookshelf
{{ProConList|title-advantages=Advantages|title-disadvantages=Disadvantages|advantages=* affordable
* well-known
* easily accessible|disadvantages=* somewhat dated look and feel
* not customizable
* GDPR compliance unclear}}


==Tips for working with books ==
=== Tip Message===
{{Textbox|boxtype=tip|header=|text=This is a tip message.|icon=yes}}


*Use a competent team to decide on the content that should be transferred into an online book.
===Watchlist===
*Decide on how to handle existing numerations or references.
Shows the current user the most recently changed pages that are on their watchlist:<bs:watchlist count="5" maxtitlelength="100" order="time" />
*Seize the opportunity: Get rid of unnecessary content (or don't include it in your book).
*Decide on standards for documents: When does it make sense to link documents in the wiki? When is is sensible to include the document's content into a wiki article?
*Decide on a fitting course of action: Do you want to create the articles in the wiki first, and compile them in a book structure afterwards, or do you want to create the book structure first, and create and edit the articles contained gradually?
{{Box Links-en
|Topic1=[[Reference:BlueSpiceBookshelf]]
|Topic2=
|Topic3=}}
{{Translation}}


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

Revision as of 09:46, 14 August 2023

To insert additional functionality in a wiki page, you can use Content droplets. Content droplets include tags that were previously accessed from Insert > Magic word in the editor toolbar. They also provide access to some templates that are preconfigured in the wiki, such as message boxes.

Adding a droplet to a page

To add a droplet to a page:

  1. Click the Content droplets icon in the editor toolbar or type <<.
  2. Search for a droplet name in the search bar of the droplets menu or browse the droplets by category.
    droplet menu.png
  3. Select a droplet
  4. Click Insert.
Note:Some droplets open an inspector menu which contains another Insert button. Be sure to confirm that button as well.

Based on the type of droplet, you can continue with configuring the droplet as needed.

List of droplets

Droplet Description Inserts the following in the page source:
Attachments
Attachments output
 		Area for organising attachments <attachments title="Attachments area">

* [[Media:Financial_Sample.xlsx]]

</attachments>

Booklist List of books based on a filter value. The value needs to be defined as a metadata in the book settings. <bs:booklist filter="Author:WikiSysop" />
BPMN diagram
BPMN diagram
 		Editable BPMN diagram <bpmn name="Test:Erm31642" />
Button
Links styled as buttons
 		Link that is styled as a button {{ButtonLink|target=Main Page|label=click me!|format=blue}}
Categorytree Selected categories are shown in a tree structure <categorytree>TestCat</categorytree>
Checkbox Checkbox that can be checked in view mode <bs:checkbox checked="true" />
Checklist List that allows to set a value in view mode <bs:checklist type="list" checked="true" list="Template:Status" value="Select status" />
Chemical formula
Chemical formula
 		Display of chemical formulas <chem>H2O</chem>
Circled number Number in a circle with customizable color {{CircledNumber|bgColor=black|fgColor=yellow|number=180}}
Code
Code area for a css example
 		Highlighted section for code examples <syntaxhighlight lang="css">

.hi {background:blue;}

</syntaxhighlight>

Create page Form field for predefined page creation {{CreateInput|alignment=left|buttonlabel=Create}}
Data query Enables queries on content in the wiki {{SMWReport|count=10}}
Decision
Decision output
 		Highlights a decision as a page property {{Decision|decision=Eat more veggies}}{{Decision|decision=Buy new car}}
Diagram
Drawio diagram
 		Editable draw.io diagram <drawio filename="Mydiagram">
Gallery
Gallery
 		Displays an image gallery <gallery>

File:test1.png

File:test.pdf

</gallery>

Icon
Icons template
 		Inserts an icon {{Icon|bi bi-arrow-left-circle}}
Important Message
Message of type "important"
 		Adds colored panel for a important note {{Textbox|boxtype=important|header=OMG|text=Important|icon=yes}}
Links to this page List of pages that link to this page {{Whatlinkshere|count=5|sort=time|order=DESC}}
List of users logged in Pop-up with a list of all users that are currently logged in <bs:whoisonlinepopup />
Map
Map output with text marker
 		Locations can be marked on the map {{Map|Munich ~ Hello there!|Munich, Germany}}
Mathematical formula
Screenshot of a math formula
 		Display of mathematical formulas <math>\tfrac{2}{4}</math>
Member list List of members of a wiki group <bs:userlist groups="sysop" count="6" />
Message
A plain message
 		Adds text panel {{Textbox|boxtype=neutral|header=|text=SDadad|icon=no}}
Modal button Configurable button which opens a customizable modal dialogue {{ModalDialog|title=I am a dialog|btnLabel=click me!|body=This is the text|footer=hello world}}
Most visited pages List of the most visited wiki pages <bs:toplist count="3" period="-" />
New users List of new users in the wiki <bs:newbies count="4" />
Note Message
Message of type "Note"
 		Adds colored panel for a note {{Textbox|boxtype=note|header=|text=sfsadfasfdsdaf|icon=yes}}
Number of characters Shows the number of characters or words in a wiki page <bs:countcharacters />
Number of files Shows the number of all uploaded files <bs:countfiles />
Number of pages Shows the number of pages <bs:countarticles />
Number of users Shows the number of all users <bs:countusers />
Number of users logged in Number of currently logged in users <bs:whoisonlinecount />
Page access
Page access notification banner
 		Restricts access to the page to the specified groups <bs:pageaccess groups="sysop" />
PDF link Link that downloads another wiki page as PDF {{PDFLink|page=Main Page|template=BlueSpice|label=PDF Link}}
PDF page break Forces a page break at the set position during PDF export <bs:uepagebreak />
PDF preview Embed preview of a PDF file <pdf height="800">File:Raspberry_pi.pdf</pdf></code>
PDF no export Content within this section is excluded from the PDF export <bs:uenoexport>Don't export this text</bs:uenoexport>
Progress Visualizes progress against given measurement variables <bs:statistics:progress basecount="2" progressitem="OK" width="150" baseitem="Status:" />
Pros and cons
Pros and cons
 		Table for comparing pros and cons {{ProConList|title-advantages=Advantages|title-disadvantages=Disadvantages|advantages=* It is cheap|disadvantages=* It is sold out}}
Recent changes List of recently changed pages {{RecentChanges|count=5}}
Signature
Signatures button
 		A button to add signatures in view mode <bs:signhere />
Search field
Search field
 		Adds a search field to the page content <bs:tagsearch type="wikipage" namespace="QM" />
Subpages List of the subpages of a wiki page {{Subpages|parentpage=Mypage}}
Success Message
Message of type "success"
 		Adds colored panel for a success note {{Textbox|boxtype=success|header=OMG|text=It works|icon=yes}}
Tag cloud Tag cloud based on categories or search queries <bs:tagcloud renderer="list" store="category" />
Tip Message
Message of type "tip"
 		Adds colored panel for a tip {{Textbox|boxtype=tip|header=Tip|text=sfsadf|icon=yes}}
User profile
User profile of type "Short"
 		A user profile will be included on this page <bs:socialentityprofile username="WikiSysop" rendertype="Short" />
Video Embeds video from different external platforms (YouTube) <embedvideo service="youtube">JILEkPu61Ao</embedvideo>
Visited pages List with visited pages <bs:pagesvisited count="7" maxtitlelength="40" order="time" />
Warning Message
Message of type "warning"
 		Adds a colored box for a warning note {{Textbox|boxtype=warning|header=Hello|text=|icon=yes}}
Watchlist Latest changes to pages included in your watch list <bs:watchlist count="5" maxtitlelength="20" order="time" />

Example outputs

Button

My page


Data query

Inspector settings

setting value description
Category Administration, Customization the returned pages need to be in one of these categories (optional)
Namespace Main, Manual the returned pages need to be in one of these namespaces (optional)
Modified All, Since, Before sets a date filter
Printout statements Last editor is|Modification date adds page properties in parentheses
Format Bulleted list, numbered list the output is in one of two lists formats
Number 6 Number of pages that are returned

Output

Modal button

Google.com


PDF preview

Progress

Inspector

setting value description
Base count 5 number of items that are counted to reach 100%
Base item Is: prefix that specifies the progress item. If you do not provide a base item, the progress item could be to unspecific
Progress item closed item that will be counted towards the base count
Width 300 width in pixels

Output

100.0%


  • This is my topic 1 (Statecheck:open)
  • This is my topic 2 (Statecheck:closed)
  • This is my topic 3 (Statecheck:closed)
  • This is my topic 4 (Statecheck:closed)
  • This is my topic 5 (Statecheck:closed)

Pros and cons

Advantages Disadvantages
  • affordable
  • well-known
  • easily accessible
  • somewhat dated look and feel
  • not customizable
  • GDPR compliance unclear

Tip Message

This is a tip message.


Watchlist

Shows the current user the most recently changed pages that are on their watchlist:

Watchlist cannot be displayed because no user is logged in


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=7153"
No categories assignedEdit

Discussions