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

(Difference between pages)
No edit summary
Tag: 2017 source edit
 
No edit summary
Tag: 2017 source edit
 
Line 1: Line 1:
{{DISPLAYTITLE:Blog}}
{{DISPLAYTITLE:Content Droplets}}
{{BSVersion|bsvFrom=4.3.2|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.


The extension ''BlueSpiceSocialBlog'' is part of ''BlueSpiceSocial'', the communications module of BlueSpice. In addition to the type blog, there are other types of so-called social entities, such as ''comment'', ''discussion topic'', ''attachment'', or ''microblog''.
== Adding a droplet to a page ==
To add a droplet to a page:


==About the blog==
# '''Click''' the Content droplets icon in the editor toolbar or type <code><nowiki><<</nowiki></code>.
Basically, a blog is a list of comments, questions, or feedback from different users. The blog is often sorted chronologically.  Lively communication can arise when blog entries are further commented, recommended, linked with related articles, or placed on a personal watchlist.  
#'''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]]
The blog is ready to use on the special page ''Special:Blog''. This page is linked directly from the main navigation in every new wiki installation. So you can start using the blog right away.  
#'''Select''' a droplet
[[File:nav-blog.png|alt=Navigation link to the blog page|center|thumb|202x202px|Navigation link to the blog page]]
#'''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.


== Characteristics and features ==
==List of droplets==
{{Icon|bi bi-arrow-right-circle|||}} [[Manual:Extension/ContentDroplets/Examples|View examples of droplets outputs.]]


* A blog entry consists of a title and content.


* '''Comments:''' Users can leave comments to each blog entry.
<containerfilter selector=".wikitable tr">


* '''Actions:'''
</containerfilter>
** '''Delete:''' Editors can delete their own posts. Administrators can delete all posts. Deleted posts are no longer displayed. Exception: Administrators see deleted items with a red background and can restore them.
{| class="wikitable" style="width: 100%;"
** '''Recommend:''' Blog posts can be recommended. It is possible to generate a list of posts with the most recommendations via the timeline filter. (See: Embedding the blog on a page)
! style="background-color:rgb(234, 236, 240);text-align:center;box-sizing:border-box;border:1px solid rgb(162, 169, 177);padding:8px;" class="" |'''Droplet'''
** '''Linked page:''' Every blog entry is connected to a wiki page by the system. By default, this is the main page of the wiki. However, other pages can be added as "Linked page". Blog entries can then be filtered for linked pages via the ''Special:Timeline'' page.
! style="background-color:rgb(234, 236, 240);text-align:center;box-sizing:border-box;border:1px solid rgb(162, 169, 177);padding:8px;" class="" |'''Description'''
** '''Watch:''' Own blog posts and comments are automatically added to the watch list.
!Inserts the following in the page source:
* '''Permissions:''' It is possible to allow users with read permissions on the wiki to comment on blog entries. See: [[Manual:Extension/BlueSpiceSocial#Permissions|BlueSpiceSocial Permissions]].
|-
| style="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="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>


==Adding the blog to a page==
<code>* <nowiki>[[Media:Financial_Sample.xlsx]]</nowiki></code>
It is also possible to include the blog functionality on any wiki page. Social contributions of many types can be consolidated and displayed chronologically in a timeline and filtered and sorted as needed.


=== All blog entries ===
<code><nowiki></attachments></nowiki></code>
If you want to include a view of your blog on another page of your wiki, for example your homepage, you need to insert the necessary codeblock in the source code of your page.
|-
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Booklist
| style="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 value in the book settings
|<code><nowiki><bs:booklist filter="Author:WikiSysop" /></nowiki></code>
|-
|Book PDF link{{Bsvs|bsvFrom=4.4}}
|PDF-download link to a book
|<code><nowiki>{{BookPDFLink|book=Testbook|template=BlueSpice%20Book|label=Book PDF Link}}</nowiki></code>
|-
|Book table of contents{{PopImg|file=droplet-BookTOC.png|alt=First chapter of the book "Admin manual"|caption=Book table of contents|width=600}}{{Bsvs|bsvFrom=4.4}}
|Inserts the ToC of any book in a wiki page
|<code><nowiki><booknav book="Admin_manual" chapter="1" /></nowiki></code>
|-
| style="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="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="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="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="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[mediawikiwiki:Extension:CategoryTree|Categorytree]]
| style="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="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceChecklist#Creating a checkbox|Checkbox]]{{Bsvs|bsvTo=4.3}}
| style="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="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceChecklist|Checklist]]
| style="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="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="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="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Circled number
| style="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="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="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>


'''To include a blog view:'''
<code>.hi {background:blue;}</code>


#'''Go to''' the page where you want to insert the blog or create a new page.
<code><nowiki></syntaxhighlight></nowiki></code>
#'''Open the page''' in ''Source editing'' mode.
|-
#'''Copy the following code block''' to the section in your page where you want to show the blog.<syntaxhighlight lang="html">
| 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="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="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><dataquery modified="+" format="ul" count="6" namespaces="Main" /></nowiki></code>
|-
|Date{{Bsvs|bsvFrom=4.4}}{{PopImg|file=ContentDroplets date.png|alt=Screenshot of a date|caption=Date display}}
|Inserts a date. This can be used in combination with the content droplet ''Task list''
|<code><datetime>2023-11-23</datetime></code>
|-
| style="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="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>
|-
|Decision  overview{{PopImg|file=ContentDroplets Decision report.png|alt=Decision report table|caption=Decision report output|width=600}}{{Bsvs|bsvTo=|bsvFrom=4.4}}
|Table with a list of decisions that were created by the ''Decision'' content droplet<br />
|<code><nowiki><decisionoverview namespaces=""></decisionoverview></nowiki></code>
|-
| style="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="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="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="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>


<bs:timeline>
<code>File:test1.png</code>
{
    "showentitylistmenu": true,
    "preloadtitles": {
        "blog": "Template:Blog"
    },
    "preloadedentities": [{
        "type": "blog"
    }],
    "headlinemessagekey": "Community-Blog",
      "showheadline": true,
    "usemorescroll": false,
    "morelink": "Special:Blog",
    "limit": 5,
    "sort": [ {
        "property": "timestampcreated",
        "direction": "DESC"
    }],
    "lockedfilternames": [
        "type"
    ],
    "filter": [ {
        "type": "list",
        "property": "type",
        "value": [ "blog" ],
        "comparison": "ct"
    }]
}
</bs:timeline>
</syntaxhighlight>After saving the page, you will see a list of existing blog entries based on the filter and sorting criteria you provided.


=== Blog entries of a linked page ===
<code>File:test.pdf</code>
If you want to create a blog that only displays the posts of the blog posts created on this page, copy the following timeline tag. Here, under the preloadedentities, new blog entries are already linked to the page and filtered. Replace Blog1 under preloadedentities and in the filter section with the appropriate page name:<syntaxhighlight lang="json">
<bs:timeline>
{
    "showentitylistmenu": true,
    "preloadtitles": {
        "blog": "Vorlage:Blog"
    },
    "preloadedentities": [{
        "type": "blog",
        "tags": "Blog1"
    }],
    "headlinemessagekey": "Community-Blog",
      "showheadline": true,
    "usemorescroll": false,
    "morelink": "Special:Blog",
    "limit": 5,
    "sort": [ {
        "property": "timestampcreated",
        "direction": "DESC"
    }],
    "lockedfilternames": [
        "type"
    ],
"filter": [ {
      "property": "type",
      "value": ["blog"],
      "comparison": "ct",
      "type": "list"},
      {
      "property": "tags",
      "value": ["Blog1"],
      "comparison": "ct",
      "type": "list" },
      {
      "property":"archived",
      "value":false,
      "type":"boolean",
      "comparison":"eq"}
  ]


}
<code><nowiki></gallery></nowiki></code>
</bs:timeline>        
|-
</syntaxhighlight>
| style="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="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Inserts an icon
==Blog parameters==
|<code><nowiki>{{Icon|bi bi-arrow-left-circle}}</nowiki></code>
 
|-
===Output format===
| style="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"}}
The following table shows the blog elements and the necessary paramaters to create the output.
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Adds colored panel for a important note
[[File:blog-layout-en.png|alt=Blog output|center|thumb|750x750px|Blog output]]
|<code><nowiki>{{Textbox|boxtype=important|header=OMG|text=Important|icon=yes}}</nowiki></code>
{| class="wikitable" style=""
|-
|+
| style="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:90px;" |Element
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |List of pages that link to this page
! style="width:150px;" |Parameters
|<code><nowiki>{{Whatlinkshere|count=5|sort=time|order=DESC}}</nowiki></code>
!Parameter and element description
|-
! style="width:80px;" |Type
| style="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:80px;" |Default value
| style="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>
|-
|-
| rowspan="2" style="width:90px;" |1 - header
| style="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:150px;" |headlinemessagekey
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Locations can be marked on the map
|Header text
|<code><nowiki>{{Map|Munich ~ Hello there!|Munich, Germany}}</nowiki></code>
| style="width:80px;" |string
| style="width:80px;" |''Timeline''
|-
|-
| style="width:150px;" |showheadline
| style="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}}
|Show the header text
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Display of mathematical formulas
| style="width:80px;" |boolean
|<code><nowiki><math>\tfrac{2}{4}</math></nowiki></code>
| style="width:80px;" |''true''
|-
|-
| rowspan="7" style="width:90px;" |2 - blog menu
| style="width:190px;" |Member list
| style="width:150px;" |showentitylistmenu
|List of members of a wiki group
|Show or hide the blog menu
|<code><nowiki><bs:userlist groups="sysop" count="6" /></nowiki></code>
| style="width:80px;" |boolean
| style="width:80px;" |''true''
|-
|-
| style="width:150px;" |showentityspawner
| style="background-color:rgb(248, 249, 250);text-align:start;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}}
|Show the  menu item for creating a blog entry
| style="background-color:rgb(248, 249, 250);text-align:start;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
| style="width:80px;" |boolean
|<code><nowiki>{{Textbox|boxtype=neutral|header=|text=SDadad|icon=no}}</nowiki></code>
| style="width:80px;" |''true''
|-
|-
| style="width:150px;" |availablesorterfields
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/ContentDroplets#Modal button|Modal button]]
|Determines which data fields are included as sorting options in the sort menu. Example: allow sorting only by date created or by the user who created a blog entry:
| style="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>"availablesorterfields":["timestampcreated","ownerid"]</code>
|<code><nowiki>{{ModalDialog|title=I am a dialog|btnLabel=click me!|body=This is the text|footer=hello world}}</nowiki></code>
 
[[File:Manual:blog-filter-timestampcreated.png|350x350px]]
 
[[Manual:Extension/BlueSpiceSocialBlog#Sor|List of typical sort fields]]
| style="width:80px;" |array
| style="width:80px;" |all
|-
|-
| style="width:150px;" |lockedoptionnames
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceSmartList#Toplist|Most visited pages]]
|Determines which settings for sorting the user cannot change.
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |List of the most visited wiki pages
| style="width:80px;" |array
|<code><nowiki><bs:toplist count="3" period="-" /></nowiki></code>
| style="width:80px;" |[]
|-
|-
| style="width:150px;" |availablefilterfields
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceSmartList|New users]]
|Determines which data fields are included as filter options in the filter menu. Example: allow filtering based on Creation date and Linked pages:
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" | List of new users in the wiki
<code>"availablefilterfields":["timestampcreated","tags"]</code>
|<code><nowiki><bs:newbies count="4" /></nowiki></code>
 
[[File:Manual:blog-filter-availablefilterfields.PNG|350x350px|]]
| style="width:80px;" |array
| style="width:80px;" |all
|-
|-
| style="width:150px;" |lockedfilternames
| style="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"}}
|Determines which settings for filtering the user cannot change.
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" | Adds colored panel for a note
Example: a user cannot change the filter values for ''Linked pages.'' The text field is greyed out:
|<code><nowiki>{{Textbox|boxtype=note|header=|text=sfsadfasfdsdaf|icon=yes}}</nowiki></code>
 
<code>"lockedfilternames": ["tags"]</code>
 
[[File:Manual:blog-filter-lockedfilternames.png|350x350pxg|alt=|350x350px]]
<span /><span /><span /><span /><br />
| style="width:80px;" |array
| style="width:80px;" |[]
|-
|-
| style="width:150px;" |persistsettings
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceCountThings|Number of characters]]
|Initial settings and custom sort and filter settings are included in the page url. The url can then be used to create a link to the page with the same filter and sort settings.
| style="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>"persistsettings":true</code>
|<code><nowiki><bs:countcharacters /></nowiki></code>
 
[[File:Manual:blog-filter-persistsettings.png|alt=|300x300px]]
| style="width:80px;" |boolean
| style="width:80px;" |''false''
|-
|-
| style="width:90px;" |3 -  new blog entry
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceCountThings|Number of files]]
| style="width:150px;" |preloadentities<span /><span /><span /><span /><br />
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Shows the number of all uploaded files
|Shows the text field for creating a new blog entry. If it is not set, the text field is not available.
|<code><nowiki><bs:countfiles /></nowiki></code>
To show the text field:
 
<code>"preloadedentities": [{"type":"blog"}]</code>
 
<span><span /><span /><br /></span>
If the wiki page that has a <code><nowiki><bs:timeline></nowiki></code> tag should only show its own blog entries, then all blog entries need to be automatically tagged with the current page name:
 
<code>"preloadedentities": [{</code>
 
<code>         "type": "blog",</code>
 
<code>         "tags":["Blog1"]</code>
 
<code>     }]</code>
 
In the example above, <code>Blog1</code> is the associated page for all blog entries that are created on this page. The [[Manual:Extension/BlueSpiceSocialBlog#Filtering|blog filter]] <span>has to be adjusted accordingly to take the associated page into consideration.</span>
| style="width:80px;" |array of objects
| style="width:80px;" | -
|-
|-
| rowspan="2" style="width:90px;" |4 - existing blog entry
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceCountThings|Number of  pages]]
| style="width:150px;" |outputtypes
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Shows the number of  pages
|It defines the display format of the blog entry.
|<code><nowiki><bs:countarticles /></nowiki></code>
 
Standard types are: ''List, Short, Default, Page.'' ([[Manual:Extension/BlueSpiceSocialBlog#Output type examples|see examples]])
 
Each blog entry is a "social entity".
| style="width:80px;" |object
| style="width:80px;" |''Default''
|-
|-
| style="width:150px;" |limit
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceCountThings|Number of users]]
|Defines how many social entities are loaded initially.
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" | Shows the number of all users
| style="width:80px;" |object
|<code><nowiki><bs:countusers /></nowiki></code>
| style="width:80px;" |''Default''
|-
|-
| style="width:90px;" |4a - avatar
| style="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:150px;" |<nowiki>-</nowiki>
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Number of currently logged in users
|Shows the avatar of the user who created the blog entry or comment. It is displayed in all output types except ''List.''
|<code><nowiki><bs:whoisonlinecount /></nowiki></code>
| style="width:80px;" |<nowiki>-</nowiki>
| style="width:80px;" |<nowiki>-</nowiki>
|-
|-
| style="width:90px;" |4b - info area
| style="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:150px;" |<nowiki>-</nowiki>
| style="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
|Link to the comments and "last edit" info.
|<code><nowiki><bs:pageaccess groups="sysop" /></nowiki></code>
| style="width:80px;" |<nowiki>-</nowiki>
| style="width:80px;" |<nowiki>-</nowiki>
|-
|-
| style="width:90px;" |4c - blog entry content
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |PDF link
| style="width:150px;" |<nowiki>-</nowiki>
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Link that downloads another wiki page as PDF
|Shows the text body of a blog entry. The output type ''Default'' collapses the blog entry content after the first paragraph with a "More" link.
|<code><nowiki>{{PDFLink|page=Main Page|template=BlueSpice|label=PDF Link}}</nowiki></code>
| style="width:80px;" |<nowiki>-</nowiki>
| style="width:80px;" |<nowiki>-</nowiki>
|-
|-
| style="width:90px;" |4d - actiion menu
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |PDF page break
| style="width:150px;" |<nowiki>-</nowiki>
| style="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
|Actions: ''edit, delete, recommend, Linked page, watch''
|<code><nowiki><bs:uepagebreak /></nowiki></code>
[[File:Manual:blog-editmenu.png|200x200px]]
| style="width:80px;" |<nowiki>-</nowiki>
| style="width:80px;" |<nowiki>-</nowiki>
|-
|-
| style="width:90px;" | 5 - new comment
|[[Manual:Extension/ContentDroplets#PDF preview|PDF preview]]
| style="width:150px;" |<nowiki>-</nowiki>
|Embed preview of a PDF file
|Text field for creating a new comment.
|<code><nowiki><pdf height="800">File:Raspberry_pi.pdf</pdf></code></nowiki>
| style="width:80px;" |<nowiki>-</nowiki>
| style="width:80px;" |<nowiki>-</nowiki>
|-
|-
| style="width:90px;" |6 - existing comment
| style="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:150px;" |<nowiki>-</nowiki>
| style="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
|Comments include the social tag ''Recommend.''
|<code><nowiki><bs:uenoexport>Don't export this text</bs:uenoexport></nowiki></code>
 
Each comment is a "social entity".
| style="width:80px;" |<nowiki>-</nowiki>
| style="width:80px;" |<nowiki>-</nowiki>
|-
|-
| rowspan="3" style="width:90px;" |7 - "more" button
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/ContentDroplets#Progress|Progress]]
| style="width:150px;" |morelink
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Visualizes progress against given measurement variables
|Link target of the "more" button. For blogs, it makes sense to link to the page ''Special:Blog''.
|<code><nowiki><bs:statistics:progress basecount="2" progressitem="OK" width="150" baseitem="Status:" /></nowiki></code>
| style="width:80px;" |str
| style="width:80px;" |''Special:Timeline''
|-
|-
| style="width:150px;" |useendlessscroll
| style="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}}
|More blog entries are automatically loaded after the user scrolls to the end of the blog.
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Table for comparing pros and cons
| style="width:80px;" |boolean
|<code><nowiki>{{ProConList|title-advantages=Advantages|title-disadvantages=Disadvantages|advantages=* It is cheap|disadvantages=* It is sold out}}</nowiki></code>
| style="width:80px;" |''true''
|-
|-
| style="width:150px;" |showentitylistmore
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceSmartList|Recent changes]]
| Shows a "more" button below the blog which loads more blog entries on click. This is only possible if ''useendlessscroll'' is set to ''false''.
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |List of recently changed pages
| style="width:80px;" |boolean
|<code><nowiki><recentchanges count="6" period="-" sort="time" showns="0" /></nowiki></code>
| style="width:80px;" |''false''
|}
 
===Sorting===
Most commonly, a blog shows the latest blog entries first. However, there are many different options for sorting the list of blog entries.
 
====Syntax====
<syntaxhighlight lang="json">
[{
 
"property": "timestamptouched",
 
"direction": "DESC"
 
}]
</syntaxhighlight>
 
====Properties====
There are some common properties of a blog entry that are useful for sorting:
{| class="wikitable" style=""
|+
!Property
!Description
|-
|-
|timestampcreated
| style="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}}
|creation date
| style="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>
|-
|-
|timestamptouched
| style="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=}}
|last edit date
| style="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>
|-
|-
|commentcount
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Reference:SubPageList|Subpages]]
|number of comments
| style="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>
|-
|-
|ratingcount
| style="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"}}
|number of ratings
| style="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=Example|text=Message text|icon=yes}}</nowiki></code>
|-
|-
|ownerid
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpiceTagCloud|Tag cloud]]
| username of the creator of a blog entry
| style="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>
|-
|-
|ownerrealname
|Task list{{PopImg|file=droplet-task-item.png|alt=Checkbox with label|caption=Task list output}}{{Bsvs|bsvFrom=4.4}}
|real name of the user
|Adds a checklist item
|}
|[]
 
====Direction====
[] [] Checkbox text
Blog entries can be sorted in descending and ascending order. Descending is the default order.
{| class="wikitable" style=""
|+
!Property
! Description
|-
|-
|DESC
|Task report {{PopImg|file=Content_Droplets_Task_report.png|alt=Filterable task report with 4 entries|caption=Task report}}{{Bsvs|bsvFrom=4.4}}
|sorts the blog entries in descending order
|Filterable list of existing tasks
|<code><nowiki><taskreport user="" namespaces="" status=""></taskreport></nowiki></code>
|-
|-
|ASC
| style="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"}}
|sorts the blog entries in ascending order
| style="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>
 
===Filtering ===
Without setting the filter parameter, there will be no output on the page.
 
To show the blog entries of your wiki, include the following codeblock like shown in the code example above:<syntaxhighlight lang="json-object">
"filter": [ {
        "type": "list",
        "property": "type",
        "value": [ "blog" ],
        "comparison": "ct"
    }]
</syntaxhighlight>This filter includes all social entities which match the type ''blog''. Since we only want to show social entities of type ''blog'', we only include ''blog'' entries in our filter.
If you want to create a social timeline rather than a blog view, you can also add other types of social entities. The following example shows a timeline view that includes blog entries, discussion entries from wiki pages, and user profile information:<syntaxhighlight lang="json-object">
"filter": [ {
        "type": "list",
        "property": "type",
        "value": ["blog","topic","profile"],
        "comparison": "ct"
    }]
</syntaxhighlight>
 
=== <span class="mw-headline">Filtering associated pages</span> ===
Wenn ein eingebundenes Blog nur Beiträge zeigen soll, die mit dem Seitennamen (z.B. ''Blog1'') verknüpft sind, muss dieses in den [[:de:Handbuch:Erweiterung/BlueSpiceSocialBlog#Blog-Parameter|Blog-Parametern (siehe preloadedentities)]] definiert werden und anschließend im Filter angegeben werden:
 
If an embedded blog should only show posts that are associated with a paritcular page name (e.g., Blog1), this must be defined in the [[Manual:Extension/BlueSpiceSocialBlog#Blog parameters|blog parameters]] (see ''preloadedentities'') and then specified in the filter:<syntaxhighlight lang="json">
"filter": [ {  
      "property": "type",
      "value": ["blog"],
      "comparison": "ct",
      "type": "list"},
      {  
      "property": "tags",
      "value": ["Blog1"],
      "comparison": "ct",
      "type": "list" },
      {
      "property":"archived",
      "value":false,
      "type":"boolean",
      "comparison":"eq"}
  ]
 
</syntaxhighlight>
 
==Output type examples==
The output type for a blog is added using the ''outputtypes'' parameter. Don't forget to include a comma before and after this parameter (unless this is the last parameter in your code):<syntaxhighlight lang="json-object">
"outputtypes": {
        "blog": "Default"
    }
</syntaxhighlight>
 
===Default===
The output type ''Default'' shows the content of a blog entry truncated after the first paragraph. To view the full text, users can click on the ''More'' link.
[[File:Manual:blog-output-default.png|center|650x650px|alt="Default" output|thumb|"Default" output]]
<span /><span /><span /><span /><br />
 
===Short===
The output type ''Short'' does not show the content of the blog entry. To view the content, a user has to click on the title of a blog entry. This loads the actual page for the selected blog entity.
<span /><span /><span /><span /><br />
[[File:Manual:blog-output-short.png|center|650x650px|alt="Short" output|thumb|"Short" output]]
<span /><span /><span /><span /><br />
 
===Page ===
The output type ''Page'' shows all blog elements, including the comments, in an expanded view.
<span /><span /><span /><span /><br />
[[File:Manual:blog-output-page.png|center|650x650px|alt="Page" output|thumb|"Page" output]]
 
===List===
The output type ''List'' only shows the title and the timestamp.
<span /><span /><span /><span /><br />
[[File:Manual:blog-output-list.png|center|alt="List" output|thumb|450x450px|"List" output]]
 
<span><span /><span /><span /><br /></span>
==Setting blog permissions==
 
===Using the  "commenter" role===
In general, all users with edit rights can create blog entries and comments. However, the ''commenter'' role in the [[Manual:Extension/BlueSpicePermissionManager|Permission manager]] does not allow you to create blog entries. This role only assigns the right to create comments on existing blog entries. See also [[Manual:Extension/BlueSpiceSocial#Permissions|BlueSpiceSocial permissions]].
 
===Using groups===
{{BSVersion|bsvFrom=4.2|bsvTo=|bsvFeature=}}
If a blog is integrated into a page, the creation and editing of discussion posts and comments can be restricted to certain user groups. This option does not exist on the ''Special:Blog'' page itself.
 
Add the blog to a wiki page as follows. Then, modify the ''editgroups'', c''ommentgroups, deletegroups,'' and r''eadgroups'' as needed.
{{Messagebox|boxtype=important|icon=|Note text=Only set the groups that you really need, since individual rights are not inherited. Therefore, please read the following explanations carefully!|bgcolor=}}
<syntaxhighlight lang="json">
<bs:timeline>
{
    "showentitylistmenu": true,
      "preloadedentities": [{
      "type": "groupblog",
      "editgroups": ["blog_GF"],
      "commentgroups": ["blog_commenter"],
      "deletegroups": ["blog_delete"],
      "readgroups": ["blog_reader","blog_GF","blog_commenter","blog_delete"]
    }],
    "headlinemessagekey": "My Blog",
    "showheadline": true,
    "usemorescroll": true, 
    "limit": 5,
    "sort": [ {
        "property": "timestampcreated",
        "direction": "DESC"
    }],
    "lockedfilternames": [
        "type"
    ],
    "filter": [ {
        "type": "list",
        "property": "type",
        "value": [ "groupblog" ],
        "comparison": "ct"
    }]
}
</bs:timeline>
</syntaxhighlight>Im Objekt ''preloadedentities'' werden die unterschiedlichen Berechtigungen definiert:
{| class="wikitable" style=""
|+
!Name
!Value (examples)
!Description
|-
|-
|type
| style="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}}
|groupblog
| style="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
|The type ''groupblog'' allows setting group-based permissions on a blog.
|<code><nowiki><bs:socialentityprofile username="WikiSysop" rendertype="Short" /></nowiki></code>
|-
|-
|editgroups
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/EmbedVideo|Video]]
|["blog_GF"]
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Embeds video from different external platforms (YouTube)
|Permission to create blog entries
|<code><nowiki><embedvideo service="youtube">JILEkPu61Ao</embedvideo></nowiki></code>
|-
|-
|commentgroups
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/BlueSpicePagesVisited|Visited pages]]
|["blog_commenter"]
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |List with visited pages
|Permission to create comments
|<code><nowiki><bs:pagesvisited count="7" maxtitlelength="40" order="time" /></nowiki></code>
|-
|-
|deletegroups
| style="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"}}
|["blog_delete"]
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |Adds a colored box for a warning note
|Permission to delete blog entries and comments
|<code><nowiki>{{Textbox|boxtype=warning|header=Hello|text=|icon=yes}}</nowiki></code>
|-
|-
|readgroups
| style="box-sizing:border-box;border:1px solid rgb(162, 169, 177);break-inside:avoid;padding:8px;" |[[Manual:Extension/ContentDroplets#Watchlist|Watchlist]]
|["blog_reader","blog_GF","blog_commenter","blog_delete"]
| style="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
|Read permission:
|<code><nowiki><bs:watchlist count="5" maxtitlelength="20" order="time" /></nowiki></code>
All groups listed in editgroups, commentgroups and deletegroups must also be listed here explicitly if this group is defined.
|}<br />
|}
'''Important notes:'''
 
# If the blog already exists on a page and the group assignments are created later, the permissions will not be applied to existing blog entries.
#<span /><span /><span /><span /><br />There is no inheritance if a group definition is given explicitly. E.g., a user group that is in editgroups but not in commentgroups (if exists) cannot add comments.
 
'''“editgroups”''' exists:
 
*Only users in these groups see the button to start a new blog entry.
 
'''“commentgroups”''' exists:
 
*Only users in these groups see the “answer here” button and can add comments.
 
'''“deletegroups”''' exists:
 
*Only users in these groups see the delete link and can delete o'''ther users'''' posts. Note: “sysop” users can always delete or restore a post. See below for sysop user read permissions.
 
'''“readgroups”''' exists:
 
* Only set if necessary, as there is no inheritance. If present, all user groups of the other blog groups must be added here.
 
Examples:
 
*If the ''blog_GF'' user group is in ''editgroups'' but not in ''readgroups'', the create button is not displayed despite explicit editing rights. If the ''blog_commenter'' user group is in ''commentgroups'' but not in ''readgroups'', the new blog entries that have this setting applied will not be visible.  If the user group ''blog_delete'' is in ''deletegroups'' but not in ''readgroups'', the new blog entries are not visible and therefore cannot be deleted.
 
'''user group “sysop”:'''
 
*If ''readgroups'' is not defined, group sysop can delete all blog entries
*If ''readgroups'' is defined and sysop is not part of this group, sysop cannot see blog posts and therefore cannot delete them from the page. But with a direct link to the actual blog page, the sysop user can delete/restore the entry from there.
{{Messagebox|boxtype=important|icon=|Note text=The default user group "sysop" cannot be added as a user group to a definition. For example, to assign read rights to an admin user (if "readgroups" exists), the user must be added to a user group defined in "readgroups" ( e.g. blog_reader)|bgcolor=}}
 
'''more”-button:'''
 
To avoid switching to the default ''Special:Blog'' page at the end of the blog, the m''ore-''button must be set as a scroll button instead of linking to the special page. To do this, set (as already indicated in the example):<syntaxhighlight lang="json">
"usemorescroll": true
</syntaxhighlight>
 
==Configuration==
 
<span><span /><span /><span /><br /></span>
In the [[Manual:Extension/BlueSpiceConfigManager|Config manager]], you can change the following settings:
 
<span><span /><span /><span /><br /></span>
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceSocialBlog}}
 
== Notifications ==
If users want to receive notifications about blog posts in the wiki or by email, the setting "Entity actions on watched pages" must be activated in the user settings ("Notifications" tab).
[[File:BlueSpiceSocialBlog notifications.png|alt=Notification settings|center|thumb|650x650px|Notification settings]]
 
<span><span /><span /><span /><br /></span>
{{Box Links-en
|Topic1=[[Manual:Extension/BlueSpiceSocialMicroBlog|Micro-Blog]]
|Topic2=[[Reference:BlueSpiceSocial]]
}}


<span><span /><span /><span /><br /></span>
==More info==
{{Translation}}
{{#subpages:Manual:Extension/ContentDroplets}}
[[Category:Social]]
{{translation}}

Revision as of 14:49, 13 December 2023

ContentDroplets is available from BlueSpice 4.3.2.

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

View examples of droplets outputs.


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 value in the book settings <bs:booklist filter="Author:WikiSysop" />
Book PDF link  v4.4+ PDF-download link to a book {{BookPDFLink|book=Testbook|template=BlueSpice%20Book|label=Book PDF Link}}
Book table of contents
Book table of contents

  v4.4+

Inserts the ToC of any book in a wiki page <booknav book="Admin_manual" chapter="1" />
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  -v4.3 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 <dataquery modified="+" format="ul" count="6" namespaces="Main" />
Date  v4.4+
Date display
Inserts a date. This can be used in combination with the content droplet Task list 23 November 2023
Decision
Decision output
Highlights a decision as a page property {{Decision|decision=Eat more veggies}}{{Decision|decision=Buy new car}}
Decision overview
Decision report output

  v4.4+

Table with a list of decisions that were created by the Decision content droplet
<decisionoverview namespaces=""></decisionoverview>
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="6" period="-" sort="time" showns="0" />
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=Example|text=Message text|icon=yes}}
Tag cloud Tag cloud based on categories or search queries <bs:tagcloud renderer="list" store="category" />
Task list
Task list output

  v4.4+

Adds a checklist item []

[] [] Checkbox text

Task report
Task report

  v4.4+

Filterable list of existing tasks <taskreport user="" namespaces="" status=""></taskreport>
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" />


More info



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

No categories assignedEdit

Discussions