User manual
Extensions
4 Extensions
Authors
Avatars
Blog
Export: 24.03.2018
This document was created with BlueSpice
Page 1 of 130
User manual
Extensions
4.1. AboutBlueSpice
Contents
1 What is AboutBlueSpice? ..................................................................................................................................... 2
2 Where to find? ..................................................................................................................................................... 2
3 See also ............................................................................................................................................................... 2
What is AboutBlueSpice?
About BlueSpice offers an information page, which is delivered with every edition of an BlueSpice
MediaWiki distribution.
This extension is very helpfull to provide users with additional information from an external source, e.g. a
page from a content management system. It was developed for marketing reasons, so that people come via
a link to a page in the "backend" of the wiki. The content is embedded via an Iframe.
Where to find?
It can be found in the main menu:
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 2 of 130
User manual
Extensions
Extensions/AboutBluseSpice
Redirect to:
Extensions/AboutBlueSpice
Export: 24.03.2018
This document was created with BlueSpice
Page 3 of 130
User manual
Extensions
4.2. ArticleInfo
Contents
1 What is ArticleInfo? .............................................................................................................................................. 4
2 Where to find? ..................................................................................................................................................... 4
3 Information provided by ArticleInfo ..................................................................................................................... 5
4 See also ............................................................................................................................................................... 7
What is ArticleInfo?
ArticleInfo displays additional information about an article. This extension displays data in the StateBar.
Where to find?
Export: 24.03.2018
This document was created with BlueSpice
Page 4 of 130
User manual
Extensions
Information provided by ArticleInfo
When was the article last edited:
Author of the latest edit: Export: 24.03.2018
This document was created with BlueSpice
Page 5 of 130
User manual
Extensions
Categories assigned to the article (the first three categories will be visible, if there are more "[...]" will
appear, clicking on it will show all the categories.
Export: 24.03.2018
This document was created with BlueSpice
Page 6 of 130
User manual
Extensions
Subpages(if there are any):
Templates used on the page and similar pages:
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 7 of 130
User manual
Extensions
4.3. Authors
Contents
1 What is Authors? .................................................................................................................................................. 8
2 Where to find Authors .......................................................................................................................................... 8
3 See also ............................................................................................................................................................... 8
What is Authors?
Authors extension displays all users who have contributed to the article. They are displayed at the bottom
of the article in the form of their user images/avatars.
Where to find Authors
The main author (the one who created the article) and other contributors are shown at the bottom of each
article. The main author appears first and is slightly separated from other users who have contributed to the
page. If a user has been deleted there is a dummy photo with a yellow question mark instead of his or her
profile picture. When the mouse hoovers over the photo, the username is be shown. Clicking on the picture
takes you to that authors user page.
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 8 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 9 of 130
User manual
Extensions
4.4. Avatars
Contents
1 What is Avatars? ................................................................................................................................................ 10
2 Where can you see Avatars? ............................................................................................................................. 10
3 Changing your profile image .............................................................................................................................. 10
4 See also ............................................................................................................................................................. 12
What is Avatars?
Avatars handles profile images of wiki users. Every user has an automatically generated avatar created or
can upload his personal image.
Where can you see Avatars?
Your profile image will appear throughout the wiki on the pages you have contributed to or have been
otherwise involved with. If you have not changed your image so far, the system will show an automatically
generated avatar for you. Clicking on your avatar will lead you to your wiki-userpage.
Changing your profile image
If you are already registered and logged in, expand your user menu in the upper right corner of the wiki and
open your user page, by clicking on your username. At the bottom of the page you will find the option
"Change profile picture".
Export: 24.03.2018
This document was created with BlueSpice
Page 10 of 130
User manual
Extensions
Upon clicking on this link, a dialog window will pop up, offering several options for setting the profile picture.
Following options are available:
Upload your own profile picture:
You can select an image from your computer, upload it and set it to your profile. To do this, first click on
"Browse" to select the image and then on "Upload" to upload it.
Choose an image already existing on the wiki or from the internet:
Export: 24.03.2018
This document was created with BlueSpice
Page 11 of 130
User manual
Extensions
Enter the name of the image already uploaded to the wiki or the URL of any publicly accessible image and
click "Save".
Generate an avatar:
Click "Generate new avatar" to generate and assign an automatic avatar to your profile. The type of avatar
generated depends on the generator selected in the global wiki settings by the administrator.
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 12 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 13 of 130
User manual
Extensions
4.5. Blog
Contents
1 What is Blog? ..................................................................................................................................................... 14
2 Blog by default ................................................................................................................................................... 14
2.1 Display Blog on any wiki page .................................................................................................................. 15
3 Blog tags ............................................................................................................................................................ 17
3.1 Write an entry or create a new entry ....................................................................................................... 17
3.2 Creating a second blog ............................................................................................................................. 17
3.3 <bs:blog /> attributes .............................................................................................................................. 17
4 Tips for working with blogs ................................................................................................................................ 18
5 See also ............................................................................................................................................................. 18
What is Blog?
Blog extension allows creating news feeds on the wiki. These news feeds can be shown on any page, and
users can be allowed to add their own news.
Blog by default
By default, there is a link to the Blog page in the TopMenuBar, which then opens the blog, a page containing
a form for writing a new blog entry and a list of previous entries.
Export: 24.03.2018
This document was created with BlueSpice
Page 14 of 130
User manual
Extensions
Display Blog on any wiki page
This blog news feed can be displayed on any wiki page by adding the blog tag to the page.
Export: 24.03.2018
This document was created with BlueSpice
Page 15 of 130
User manual
Extensions
This also displays a "Create new blog entry"-form on the page, unless it is disabled to use blog tag attributes
.
A blog entry consists of a title, revision information (date and author of first revision), the entry itself and
possibly links for comments and a permalink.
If a blog entry is too long, the link "continue reading" is displayed.
Export: 24.03.2018
This document was created with BlueSpice
Page 16 of 130
User manual
Extensions
Blog tags
Blog extension offers several tags. These tags can be added to a page using InsertMagic functionality, or
writing tag syntax directly to wiki code editor.
Wiki tag
<bs:blog />
Description
Displays blog news feed on the page. It can be extended with multiple attributes. For
more on attubutes read section "Blog tag attibutes" below.
This tag should be placed inside the content of a blog entry (pages in Blog
<bs:blog:more />
namespace) to define at which point in text "continue reading" link should be placed.
This will override default cut-off length of an entry.
<bs:blog:time
This tag also should be placed inside the content of a blog entry. It allows manually
defining timestamp for that particular blog entry. Timestamp is used in sorting and
YYYYMMDDHHmm" displaying blog entries.
/>
time="
Write an entry or create a new entry
New blog entries can be created through the form on the page containing a blog tag, on Blog special page
(Special:Blog), or by directly creating new pages in the Blog namespace.
Creating a second blog
As described the default blog feed consists of "normal" wiki pages stored in the Blog namespace. Other blog
feeds can exist in addition to this feed, and they can be defined by category.
For example, the category "Company news" can be designated for a second blog. In that case all pages in
this category will be considered entries of this blog and will be displayed on page as blog entries. By
adding <bs:blog /> tag to the page, attribute "cat" must be set to "Company news" like <bs:blog cat="
Company news" />
Another option is to designate a namespace for this purpose. Using example from above, namespace
"Company news" must be created and all pages inside this namespace (Company news:News1, Company
news:News2) will be considered blog entries. The syntax that should be used for the blog tag in this case
is: <bs:blog ns="Company news" />
Keep in mind that when blog tags with "cat" or "ns" are used, all pages from that category/namespace will
be shown, so those categories/namespaces should be used for that purpose only.
<bs:blog /> attributes
The following tag arguments can be used with the tag <bs:blog />:
Attribute
Description
Value
count
Number of blog entries to be displayed.
number
cat
Category from which to show pages as blog entries
category name
Export: 24.03.2018
This document was created with BlueSpice
Page 17 of 130
User manual
Extensions
ns
Namespace from which to show pages as blog entries
newentryfield
Should "Create new blog entry" be shown?
newentryfieldposition Position of the "Create new blog entry" form.
renderimages
maxchars
Should images be displayed
Number of characters that should be shown before the "Continue
reading" link is shown.
namespace
name or ID
0 or 1
"bottom" or
"top"
0 or 1
number
Default values for these attributes for the whole wiki can be set in the global BlueSpice preferences. See
Reference page.
Tips for working with blogs
Put a link to the blog in the left hand navigation menu. Then your colleagues will be able to find the blog
whenever they want.
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 18 of 130
User manual
Extensions
Extensions/BlueSpiceCategoryManager
Contents
1 What is CategoryManager? ................................................................................................................................ 19
2 Where to find CategoryManager ........................................................................................................................ 19
2.1 Create a new category ............................................................................................................................. 20
2.2 Move Category ......................................................................................................................................... 21
2.3 Delete category ........................................................................................................................................ 22
3 See also ............................................................................................................................................................. 22
What is CategoryManager?
CategoryManager is a special page. You will find the category management administration interface
in the main menu under "Global Actions" in the "Administration" area (visible only to admins).
Where to find CategoryManager
Global actions, Category manager:
Export: 24.03.2018
This document was created with BlueSpice
Page 19 of 130
User manual
Extensions
Create a new category
To create a new category, click the green "Add" button above the list. You can enter the name of the new
category using an input field. This is then sorted into the alphabetical folder of the list. Export: 24.03.2018
This document was created with BlueSpice
Page 20 of 130
User manual
Extensions
Move Category
Moving a category works in category management using the drag-and-drop principle. Drag the category to
the destination folder with the mouse.
Export: 24.03.2018
This document was created with BlueSpice
Page 21 of 130
User manual
Extensions
Delete category
To remove a category, select it and click the red "remove" button above the list.
This action deletes both the corresponding category page and removes the category's assignments to the
wiki articles.
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 22 of 130
User manual
Extensions
4.7. BlueSpiceExtendedFileList
Contents
1 What is ExtendedFileList? .................................................................................................................................. 23
2 Where to find ExtendedFileList .......................................................................................................................... 23
3 See also ............................................................................................................................................................. 24
What is ExtendedFileList?
ExtendedFileList is special page listing the files in the Wiki. Simplifies the display and search of images
and files.
Where to find ExtendedFileList
Global actions, Extended file list:
Export: 24.03.2018
This document was created with BlueSpice
Page 23 of 130
User manual
Extensions
Page listing the files in the Wiki:
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 24 of 130
User manual
Extensions
4.8. BlueSpiceReadConfirmation
Contents
1 What is ReadConfirmation? ............................................................................................................................... 25
2 Where to find Assignments that you are responsible for? ................................................................................. 25
3 Accept ReadConfirmation .................................................................................................................................. 27
4 Check reading confirmation ............................................................................................................................... 27
5 Delete assignments ........................................................................................................................................... 28
6 The logbooks of ReadConfirmation .................................................................................................................... 28
7 See also ............................................................................................................................................................. 28
What is ReadConfirmation?
Read Confirmation ask for confirmation that an article was read by certain users.
Where to find Assignments that you are responsible for?
Or go to upper right corner, click on your name and in combo box you will find:"assignments". When you
click on "assignments" you will get an article or articles which you are assigned to.
Export: 24.03.2018
This document was created with BlueSpice
Page 25 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 26 of 130
User manual
Extensions
Accept ReadConfirmation
For the user who has been assigned to a specific page, a prominent message block appears at the beginning
of the page for read verification. This will appear every time the page is accessed until the confirmation has
actually been made.
Check reading confirmation
When all prompted users have confirmed the current version of the article, the circle in Access Management
changes from red to green in the "Read" column. More details about the confirmation, e.g. The date of the
confirmation, you will be found in the read confirmation logbook (see below).
Export: 24.03.2018
This document was created with BlueSpice
Page 27 of 130
User manual
Extensions
Delete assignments
The assignments are removed either via the delete button above the list in the access management or in
the "Actions" column. First, activate the corresponding article.
The assignments for an article can only be deleted completely
The logbooks of ReadConfirmation
In the assignment manager you will find two icons in the "Actions" column, which lead to two logbooks
The assignment logbook is a special page that lists all assignments and their deletions with date and
actor.
The read-only confirmation log shows all confirmations of the assigned users..
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 28 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 29 of 130
User manual
Extensions
4.9. BlueSpiceSignHere
Contents
1 What is Signhere? .............................................................................................................................................. 30
2 How to add Signhere? ........................................................................................................................................ 30
3 Visibility ............................................................................................................................................................. 31
4 Sorting ............................................................................................................................................................... 31
5 Scaling ............................................................................................................................................................... 32
6 Restrictions ........................................................................................................................................................ 32
7 See also ............................................................................................................................................................. 32
What is Signhere?
SignHere allows you to quickly sign off a wiki article.
How to add Signhere?
In edit mode, in article add: <bs:signhere/> as on the screenshot below, and save
Export: 24.03.2018
This document was created with BlueSpice
Page 30 of 130
User manual
Extensions
When this tag is added to a page, a field to add a signature appears:
When clicked, this field will generate a signature above itself
Visibility
Will be shown in view mode of an Article. Everyone with edit right will be able to sign.
Sorting
Signatures appear in the order they were added.
Export: 24.03.2018
This document was created with BlueSpice
Page 31 of 130
User manual
Extensions
Scaling
All signatures will always be shown.
Restrictions
Question of forgery was discussed. Reason is that signatures will be added as text, and therefore could be
edited by other users. This is not obvious at first glance (while reading). However, every change will be
visible in the log. So it can be known for sure, if the signatures have been changed after the fact.
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 32 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 33 of 130
User manual
Extensions
4.10. Bookshelf
Contents
1 What is Bookshelf? ............................................................................................................................................. 34
2 Where do I find the features of Bookshelf? ........................................................................................................ 34
3 Preferences ........................................................................................................................................................ 34
4 Manage books .................................................................................................................................................... 35
5 See also ............................................................................................................................................................. 37
What is Bookshelf?
Bookshelf is an extension of the package BlueSpice BookMaker. Bookshelf enables you to combine different
wiki articles to create books and also to export those as a pdf document.
Where do I find the features of Bookshelf?
You can call up the page with the bookshelf in different ways. One method is to open the Widgetbar. The
menu item 'Manage books' leads you to the appropriate page, where you can organize your books. In the
Book Manager, you can edit, delete or add books.
Due to the fact that the WidgetBar can be customized by for every user, it is possible that the Bookshelf
feature is not listed there. You can add it to the WidgetBar by adding BOOKSHELF in the list of your WidgetBar
tools. Another way is to go to the special pages. You can find the link under "BlueSpice" -> "Book Manager".
All available export features are also listed in the WidgetBar under the menu item "Export". You can
choose between exporting PDF single page or PDF single page with attachments. If you want to convert
books, or parts of a book, into the PDF format, you can find this feature right at the appropriate book in the
Book Manager. Call up the book you want to export and you can see the export button in the right upper
corner.
Preferences
If you have the correct permissions, you will be able to see the link "Preferences" in the "Admin" section in
the left hand navigation bar. There you will find preferences for "Bookshelf" which you can activate or
deactivate:
enable navigation popups
Prepend article table of contents and headlines with book numberation
Supress namespace prefix of book articles in output
Use display title from book source on article
Export: 24.03.2018
This document was created with BlueSpice
Page 34 of 130
User manual
Extensions
Manage books
Click on "Manage books" in your WidgetBar and it leas you to the special page Special:BookManager, which
provides an overview of all available books.
The following actions can be performed:
Export: 24.03.2018
This document was created with BlueSpice
Page 35 of 130
User manual
Extensions
Button
Action
Add book: opens a dialogue for inserting the title of the new book.
Copy book: Copy an existing book and edit it afterwards.
Edit book: leads you to the book editor, where you can add articles to the book, delete them or
change the position in the book structure with drag & drop.
Delete book: completely deletes the article collection (but not the articles).
Export: 24.03.2018
This document was created with BlueSpice
Page 36 of 130
User manual
Extensions
Screenshot: Chapter navigation in the sidebar
See also
Our reference page.
RELATED TOPICS
Export: 24.03.2018
This document was created with BlueSpice
Page 37 of 130
User manual
Extensions
Universal Export
Wiki Tags
Page Templates
Export: 24.03.2018
This document was created with BlueSpice
Page 38 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 39 of 130
User manual
Extensions
4.11. BookshelfUI
Contents
1 What is BookshelfUI? ......................................................................................................................................... 40
2 Where to find BookshelfUI? ................................................................................................................................ 40
3 Create Article/Page in the book ......................................................................................................................... 42
4 Add next Article/Page ........................................................................................................................................ 44
5 Books management ........................................................................................................................................... 45
6 Book Editor ........................................................................................................................................................ 45
7 Integrated navigation ........................................................................................................................................ 46
8 See also ............................................................................................................................................................. 46
What is BookshelfUI?
BookshelfUI provides a graphical interface for creating, editing and managing books. It consists of a book
editor, a book management and an integrated navigation.
Where to find BookshelfUI?
Global actions, BookManager:
Export: 24.03.2018
This document was created with BlueSpice
Page 40 of 130
User manual
Extensions
Add:
Add title of the book:
Export: 24.03.2018
This document was created with BlueSpice
Page 41 of 130
User manual
Extensions
Book is created:
Create Article/Page in the book
Too create article in the book, click Add and specified the title:
Export: 24.03.2018
This document was created with BlueSpice
Page 42 of 130
User manual
Extensions
All changes will only become active after clicking on the "Save" button.
Right click to manage:
Export: 24.03.2018
This document was created with BlueSpice
Page 43 of 130
User manual
Extensions
Add next Article/Page
To add next page, mark book and then Add button.
To add next page in the already existing page mark, that specific page where you want to add next one.
Export: 24.03.2018
This document was created with BlueSpice
Page 44 of 130
User manual
Extensions
Or add a page that already exists:
Books management
In the book management books can be created, copied and deleted.
When creating a title must be specified.
The already existing books are displayed in a list.
Book Editor
The book editor displays the contents of a book in a hierarchical folder structure.
Book chapters are added in the form of wiki articles. A selection dialog opens for this purpose.
Book chapters can be renamed.
Book chapters can be dragged into the desired order by Drag'n'Drop.
Book chapters can be deleted via an icon. It is not the article itself deleted, but only taken from the book.
Export: 24.03.2018
This document was created with BlueSpice
Page 45 of 130
User manual
Extensions
Book chapters can be deleted via an icon. It is not the article itself deleted, but only taken from the book.
Metadata can be inserted via a dialog.
All changes will only become active after clicking on the "Save" button.
When saving, the bookshelf tags in the articles are copied (if desired).
It is possible to mark individual chapters for export.
If the user clicks on "Export selection", he receives a document in the selected format. At least one
export extension must be activated for this.
Integrated navigation
The navigation is a separate tab in the sidebar.
It consists of two areas
Available Books shows a list of all the books stored in the system
Chapter shows the chapter navigation of the currently selected book.
The two areas are represented by an accordion grid. This also means that only one area is open at a time.
The ad will be preserved the same way the user selected it when the page was changed.
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 46 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 47 of 130
User manual
Extensions
4.12. BreadCrumbs
Contents
1 What is BreadCrumbs? ...................................................................................................................................... 48
2 Where do I find BreadCrumbs? .......................................................................................................................... 48
3 Tips for the usage BreadCrumbs ....................................................................................................................... 48
4 Preferences ........................................................................................................................................................ 48
5 See also ............................................................................................................................................................. 50
NOTE
The MediaWiki extension BreadCrumbs is compatible with MediaWiki and BlueSpice. The extension is
available for download in our BlueSpice Marketplace.
What is BreadCrumbs?
BreadCrumbs displays the path the user navigated to the article in sense of "How did I get here". In this
way, the extension helps you to keep orientation in the wiki and makes the navigation to formely visited
articles much easier.
Where do I find BreadCrumbs?
BreadCrumbs can be found at every article in the wiki, if the functionality is activated (also read "Preferences
"). The navigation path is shown on top of an article right under the article title. The formerly visited pages
will be listed there, so the user see the way he went to get to the current article.
Tips for the usage BreadCrumbs
The pages in the navigation path are not only displayed, they are also linked to the appropriate article. Due
to the wiki principle, empty pages are shown as redlinks (red font and linked to the article to create the
content).
Preferences
Every user decides for himself the behaviour of the BreadCrumb extension. Therefore, the preferences for
BreadCrumbs can be found in the user preferences. The configurations are in tab "Appearance" in
paragraph "Bread Crumbs".
Export: 24.03.2018
This document was created with BlueSpice
Page 48 of 130
User manual
Extensions
The following can be configured here:
If bread crumbs should be displayed or not
If the namespaces should be included in the bread crumbs or not
If already visited pages should be filtered out
The number of bread crumbs which should be displayed
The text to appear before the bread crumbs
The kind of separator between the bread crumbs
Standard preferences:
Configuration
Display bread
crumbs
Definition
activated
Include
Namespaces in
activated
bread crumbs
Filter out
repeatedly-visited
deactivated
pages
Number of bread
crumbs
5
Text to appear
before bread
-no text-
crumbs
Bread crumb
separator
Export: 24.03.2018
>
This document was created with BlueSpice
Page 49 of 130
User manual
Extensions
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 50 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 51 of 130
User manual
Extensions
4.14. Checklist
Contents
1 What is Checklist? .............................................................................................................................................. 52
2 Background ........................................................................................................................................................ 52
3 Where to find Checklist? .................................................................................................................................... 52
4 CheckList Functions ........................................................................................................................................... 52
5 Create Checkboxes ............................................................................................................................................ 53
6 Creating Lists ..................................................................................................................................................... 53
6.1 Assign colors ............................................................................................................................................ 54
7 Authorisation ..................................................................................................................................................... 55
8 CheckList-Tag Paramaters ................................................................................................................................. 55
9 Classic MediaWiki .............................................................................................................................................. 55
10 See also ........................................................................................................................................................... 56
What is Checklist?
Checklist gives you the ability to create checklists and checkboxes for to-do lists or task lists with
responsibilities and status queries.
Background
Checklist inserts wiki code elements which, depending on the mode chosen, appear as check or combo
boxes.
Where to find Checklist?
Checklist is a page editor menu item. Edit opens the page editor and opens the checklist dropdown.
CheckList Functions
The checklist dropdown inserts
Recently used lists
Single checkbox elements
Newly created lists
Multiple checkboxes and/or checklists can be inserted into an article.
Export: 24.03.2018
This document was created with BlueSpice
Page 52 of 130
User manual
Extensions
Create Checkboxes
Insert Checkbox : A checkbox is a single checkbox element. You insert a
checkbox by clicking the Menu Icon
or the 'Checklist elements'
dropdown item. Ticking the checkbox in view mode alternates the checkbox
hook between false and checked and updates the article's version history, edit
mode doesn't update the history.
Wikicode: The Code Editor (i.e. not the WYSIWYG Editor) edits checklist tags. i.
e. the value="" unchecked states table below or the color hex codes further
With checkboxes you can
create simple to-do lists
below. Clicking the
inserts
only. You need to add the Prepare Mail
identifier.
<bs:checklist value="checked" /> Prepare Mail
<bs:checklist value="false" /> Book Hotel
Creating Lists
Prepare Checklist : In order to insert a checklist in an article, you
must first create a checklist template that contains the necessary
check list elements. This is done by creating a new article in the
Template namespace. For example create a new article named
'Template:Status'. Then in the Code Editor (i.e. not the WYSIWYG
Editor) ad the check list items as exampled above, as a list. Save
the Template and remember the Template's name as you need to
add this name to Insert list dialogue below.
Screenshot : Prepare article list in
seperate template
Assign colors : To facilitate visibility, you can assign list element
colors. This is done by entering the pipe symbol ( straight line )
after the item identifier followed by a HEX color code.
* Prepare Mail| #FF9900
* Book Hotel| #00FF00
Export: 24.03.2018
This document was created with BlueSpice
Page 53 of 130
User manual
Extensions
Assign colors
To support element status visibility color codes can be linked to the list elements. This is done by adding the
pipe symbol (straight line) after the list element name followed by the HEX color Code.
Typical colors;
Colour
Name
HEX-Code
black
#000000
grey
#888888
red
#FF0000
orange
#FF8800
green
#00FF00
blue
#0000FF
magenta
#FF00FF
Insert checklist : The WYSIWYG Editor checklist dropdown
arrow
enables you to insert checklists into your articles. You simply
click a previously used template or as in this case add a new
checklist.
Screenshot Checklist WYSIWYG
To insert a new checklist, select the Insert list item in the
dropdown. Then in the popup click on the + sign to add a new
template. You must now enter the exact template title
created above. Clicking " Ok " inserts the template's checklist
items into your current article.
As and example, you can add in multiple table
Export: 24.03.2018
This document was created with BlueSpice
Page 54 of 130
User manual
Extensions
row lists to show a tasks status of tasks , this
might look like this.
Example of Checklist being used for employee and status
allocations.
Authorisation
Anyone who has write permissions can use the Checklist tag.
Anyone who has the checklistmodify permission can modify a checklist.
Designation
Description
Standard group
checklistmodify
Allows you to change a checklist item
user
CheckList-Tag Paramaters
You can off course also use Wikicode to insert check boxes and checklists. A Checklist-Tag
creates a
single form field, which depending on the mode is a checkbox or select box. It has the following parameters:
Type /
Name Description
Default
Value range value
type
Modus: If the checklist item as a list or as
check, list
check
value
Current value
str
-
str
-
str
-
list
id
Contains the name of the page in the MediaWiki namespace of the list
entries. Mandatory when type is 'list'
Optional indication of ID that can be used to identify the items
Classic MediaWiki
Classic MediaWiki does not provide checklist functionality.
Export: 24.03.2018
This document was created with BlueSpice
Page 55 of 130
User manual
Extensions
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 56 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 57 of 130
User manual
Extensions
4.15. ContextMenu
Contents
1 What is ContextMenu? ....................................................................................................................................... 58
2 Where do I find ContextMenu? ........................................................................................................................... 58
3 Settings for ContextMenu .................................................................................................................................. 58
4 Administration ................................................................................................................................................... 61
5 See also ............................................................................................................................................................. 61
What is ContextMenu?
ContextMenu replaces the default browser context menu with wiki functions - depending on the context
and user permissions.
Context dialogues will open by clicking on the right mouse button at an internal link. You will see article
tools like “delete“. Intermediate steps are obsolete. This is just an example – the developer Hallo Welt! can
now integrate different functionalities for different links – just let us know your idea – we will customize it for
you.
Where do I find ContextMenu?
Click on the right mouse button at an internal link. In this case related actions like "edit" this page will be
offered.
Settings for ContextMenu
You can also decide if you want those context dialogues to pop up by clicking on the right mouse button or
“CTRL and right-click”. With the last named combination your browser functionalities will open.
Go to user menu, click on Preferences:
Export: 24.03.2018
This document was created with BlueSpice
Page 58 of 130
User manual
Extensions
Go to user menu, click on Preferences:
you will find BlueSpice:
Export: 24.03.2018
This document was created with BlueSpice
Page 59 of 130
User manual
Extensions
There you can choose will you use: Click on right mouse button and pressing CTRL (Normal right mouse
button will show default browser menu)
or: Click on right mouse button (Pressing CTRL will show default browser context menu)
Export: 24.03.2018
This document was created with BlueSpice
Page 60 of 130
User manual
Extensions
And Save it:
Administration
If you want to use context dialogues they have to be activated by an administrator first (deactivated by
default).
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 61 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 62 of 130
User manual
Extensions
4.16. CountThings
Contents
1 What is CountThings? ........................................................................................................................................ 63
2 Where do I find CountThings? ............................................................................................................................ 63
2.1 Number of articles on the wiki .................................................................................................................. 66
2.2 Number of characters, words and pages (2000 characters = 1 Page) of an article ................................. 66
2.3 Number of users in a system (users who are signed-in) ........................................................................... 67
3 See also ............................................................................................................................................................. 67
What is CountThings?
CountThings introduces a set of tags that allow for counting various metadata in the wiki. These
information will be displayed on page in the configurable table.
Where do I find CountThings?
You only see the function when you or another author integrated the special tag into an article. Everybody
with writing permissions can use the tag, everyone with reading permissions can see the infobox as a result.
"Edit" and "Insert magic word or tag":
You can choose what you want count on your Page / Article:
countusers - shows number of users currently logged in the wiki.
countarticles - shows number of pages currently existing on the wiki.
countcharacters - shows information on the particular article. It can show different information depending on
Export: 24.03.2018
This document was created with BlueSpice
Page 63 of 130
User manual
Extensions
countcharacters - shows information on the particular article. It can show different information depending on
the mode:
chars – number of characters on the page
words – number of words on the page
pages – number of pages this article would have if printed/exported
all – default mode – shows all the information above.
For Example we will count characters:
You will get wiki code: "<bs:countcharacters>ARTICLENAME</bs:countcharacters>"
Export: 24.03.2018
This document was created with BlueSpice
Page 64 of 130
User manual
Extensions
Instead ARTICLENAME you must type Name of your Article. In this case name of my Article is: TestPage.
So, wiki code will look like this: "<bs:countcharacters>TestPage</bs:countcharacters>"
Export: 24.03.2018
This document was created with BlueSpice
Page 65 of 130
User manual
Extensions
Save and you should get:
Number of articles on the wiki
This number is based on the database table page. <bs:countarticles />
Number of characters, words and pages (2000 characters = 1 Page) of an
article
If you want to show all information (characters, words and pages) of an article, please use this code:
<bs:countcharacters>ARTICLENAME</bs:countcharacters>
ARTICLENAME is: Name of your page.
If you just want to show part of the information, please choose between these different modes:
chars: Only number of characters.
words: Only number of words.
pages: Only number of pages.
all (Standard): All informations.
The mode is defined with "mode" Atribute:
<bs:countcharacters mode="chars">Name of the article</bs:countcharacters><br>
Export: 24.03.2018
This document was created with BlueSpice
Page 66 of 130
User manual
Extensions
Number of users in a system (users who are signed-in)
<bs:countusers />
The code has to be integrated directly into the article.
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 67 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 68 of 130
User manual
Extensions
4.17. Dashboards
Contents
1 What is Dashboards? ......................................................................................................................................... 69
2 Where to find Dashboards? ................................................................................................................................ 69
2.1 Where to find the user dashboard? .......................................................................................................... 69
2.2 Where to find the admin dashboard? ....................................................................................................... 70
3 Add Portlets ....................................................................................................................................................... 70
3.1 Available portlets for the user dashboard ................................................................................................ 70
3.2 Available portlets for the admin dashboard ............................................................................................. 70
4 Edit dashboards ................................................................................................................................................. 71
5 Example ............................................................................................................................................................. 72
6 See also ............................................................................................................................................................. 72
What is Dashboards?
Dashboards consists of an admin and a user dashboard. It provides several portlets a user/admin can
choose.
Get an overview of important information on the wiki.
In BlueSpice there are two Dashboards: the User-Dashboard and the Admin-Dashboard. Every user can
adapt his dashboard according to his needs.
Where to find Dashboards?
Where to find the user dashboard?
Screenshots:Access to the user
dashboard via the user area.
Export: 24.03.2018
This document was created with BlueSpice
Page 69 of 130
User manual
Extensions
Where to find the admin dashboard?
Screenshots:Access to the Admin
dashboard via the user area.
Add Portlets
Adjust you dashboard by clicking on the green plus symbol
. Choose from the list of portlets the
ones you want to use.
Available portlets for the user dashboard
RSS feed
Calendar
My edits
Most edited pages
Most viewed pages
Most active users (by edits)
Your responsibilities
Number of users
Number of edits
Number of pages
Available portlets for the admin dashboard
RSS feed
My edits
Most edited pages
Most viewed pages
Number of users
Number of edits
Number of pages
Export: 24.03.2018
This document was created with BlueSpice
Page 70 of 130
User manual
Extensions
Number of pages
Recent search terms
Edit dashboards
Add, adjust, edit or delete portlets:
Symbol
Meaning
Fold out portlets
Fold in portlets
Edit a portlet (settings vary from portlet to portlet)
Delete a portlet (stop displaying this information - the portlet can be reactivated at any time)
Use drag and drop to change the order of the portlets.
Export: 24.03.2018
This document was created with BlueSpice
Page 71 of 130
User manual
Extensions
Example
Screenshot:Example of an admin dashboard
See also
Our reference page.
RELATED TOPICS
Visited pages
Who is online?
Export: 24.03.2018
This document was created with BlueSpice
Page 72 of 130
User manual
Extensions
Who is online?
Personal navigation
Export: 24.03.2018
This document was created with BlueSpice
Page 73 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 74 of 130
User manual
Extensions
4.18. Emoticons
Contents
1 What is Emoticons? ............................................................................................................................................ 75
2 Where to find Emoticons? .................................................................................................................................. 75
3 Tips for using emoticons .................................................................................................................................... 75
4 See also ............................................................................................................................................................. 76
5 Classic emoticons with MediaWiki ..................................................................................................................... 76
What is Emoticons?
Emoticons are converted to small smiley images in the Reading View.
Enable forum-style emoticon (smiley) replacement within MediaWiki.
BlueSpice has a list of emoticons, or smilies, coming from chat jargon. These can enhance communication
by expressing things like irony, for example. If a user adds a smiley to an article, this is transformed into an
image.
Where to find Emoticons?
The following sequences of symbols are transformed into emoticons. Here is the list of BlueSpice smilies
where you see the sequence of symbols, then the name of the image, then the image and a short
description:
:-) smile.png smiling
:-( sad.png sad
:-| neutral.png neutral, sceptical
:-@ angry.png angry, annoyed
;-) wink.png winking, ironic
:-D smile-big.png laughing
:-/ thinking.png thinking
:-X shut-mouth.png sealed lips
:'( crying.png crying
:-O shock.png shocked, surprised
:-S confused.png undecided, confused
8-)
:lol: glasses-cool.png cool, sunglasses
(:| yawn.png yawning
:good:good.png good, thumbs up
:bad: bad.png bad, thumbs down
:-[ embarrassed.png embarrassed, blushing
[-X shame.png ashamed
Tips for using emoticons
If a user adds an emoticon to an article, this is transformed into a small image. The emoticons used can be
changed at the page Template: emoticons.
Export: 24.03.2018
This document was created with BlueSpice
Page 75 of 130
User manual
Extensions
NOTE
Emoticons cannot be used directly at the start of a line! This could otherwise lead to conflicts with other
wiki markup e.g. indents or lists which start with : or ;. One always has to leave a space before an
emoticon too.
See also
Our reference page.
Classic emoticons with MediaWiki
MediaWiki does not have smilies installed by default.
Export: 24.03.2018
This document was created with BlueSpice
Page 76 of 130
User manual
Extensions
4.19. Expiry
Contents
1 What is Expiry? .................................................................................................................................................. 77
2 Functionality ...................................................................................................................................................... 77
3 Visibility ............................................................................................................................................................. 78
4 Sorting ............................................................................................................................................................... 78
5 Screenshots ....................................................................................................................................................... 79
6 See also ............................................................................................................................................................. 79
What is Expiry?
Expiry marks after a certain period of time a chosen article as "obsolete". The article can be updated by
editing or by confirming that the article is still up-to-date.
Expiry is the ideal basis for an archiving system. Outdated articles can be moved to an archive automatically
or after being queried.
Functionality
Add an expiration date to the article,
An author can add an expiration date to an article. There is a menu item "Set expiration date",
This is done via a dialogue,
There is a date deposited.
It is possible to specify if you want to be notified (one week) before expiration -> comes from
Functional_Design / Reminder.
Memory
One week before expiration, the user will be notified by e-mail,
The article will be marked as "obsolete" in the status bar,
A button appears in the status bar, with which the author can confirm the topicality of the article,
The expiry date can then automatically be postponed to the future for a specific period of time.
Delete expiration date
If an expiration date is stored for an article, then this can be removed via a menu entry "delete
expiration date",
This also removes any possible labeling as "obsolete".
Export: 24.03.2018
This document was created with BlueSpice
Page 77 of 130
User manual
Extensions
Logging
Setting up / changing an expiry date is stored in the MW logbook. USER has set an expiration date of
X for ARTIKEL.
The update of an article is stored in the MW logbook. USER has confirmed that ARTIKEL is up to date.
Overview: SpecialExpiry
There is an overview of all obsolete articles
This can also be filtered by users.
Visibility
(modes, namespaces, views, required rights)
The function is available to any user with the appropriate authorization
The function is available for every article (All NRs)
Sorting
Special: Expired_Articles
Sort by expiration date (default).
In addition, it should be possible to sort by article, user and status.
Export: 24.03.2018
This document was created with BlueSpice
Page 78 of 130
User manual
Extensions
Screenshots
Set an expiry date for an article
Set an expiry date for an article
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 79 of 130
User manual
Extensions
4.20. ExportTables
Contents
1 What is ExportTables? ....................................................................................................................................... 80
2 How does ExportTables work? ........................................................................................................................... 80
3 Where to find ExportTables? .............................................................................................................................. 80
3.1 Perform ExportTables ............................................................................................................................... 80
3.2 Remove export tables from table ............................................................................................................. 81
4 See also ............................................................................................................................................................. 81
What is ExportTables?
ExportTables supplements tables with the option to save them with one click into other formats, eg. MS
Excel, to export.
How does ExportTables work?
If the Extension ExportTables is installed, you can assign tables the additional property "Exportable". This
allows you to open the table in read-only mode with a mouse click in other formats.
Where to find ExportTables?
1. About the WYSIWYG editor
In Edit mode, click on a table and expand the Formats button in the WYSIWYG editor. The entry "Table"
opens another menu in which you select the last entry "Exportable". The selected points are indicated by a
gray bar on the left margin. After saving, the table has the additional property that you can export it to other
formats.
Screenshot
2. In the wiki code
You can also quickly and easily export a table in the wiki code. Add the bs-exportable attribute to the table
tag:
Screenshot
Perform ExportTables
In the read mode of the article in which the exportable table is located, right-click on the table and the
following selection window opens:
Screenshot
Here you can choose the desired format and save or open the table in this format.
Export: 24.03.2018
This document was created with BlueSpice
Page 80 of 130
User manual
Extensions
Here you can choose the desired format and save or open the table in this format.
Remove export tables from table
To remove the function from a table, you must go to the wiki code and delete the "bs-exportable" attribute
from the start of the table.
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 81 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 82 of 130
User manual
Extensions
4.21. ExtendedEditbar
Contents
1 What is ExtendedEditbar? .................................................................................................................................. 83
2 Where to find ExtendedEditbar? ........................................................................................................................ 83
3 Simple edit bar .................................................................................................................................................. 83
3.1 Functions .................................................................................................................................................. 83
4 Uses ................................................................................................................................................................... 84
5 See also ............................................................................................................................................................. 84
What is ExtendedEditbar?
ExtendedEditbar provides important, helpful functions. In the wikicode view can be insert the wiki code for
links and much more very quick. Can be open one of the BlueSpice dialogues to upload and insert images
for example.
Where to find ExtendedEditbar?
Screenshot: Extended edit bar of BlueSpice wikicode
Simple edit bar
Functions
Change to WYSIWYG mode
Information on wikicode formatting
Insert categories with the (InsertCategory tool)
Upload and insert images with the (InsertImage tool)
Upload and insert files (InsertFile tool)
Insert intern, extern, e-mail links, interwiki links and links on files (InsertLink tool)
Insert MagicWords with the (InsertMagic tool)
Insert checkboxes and checklists (more at Checklist)
Insert table (more at Insert Tables)
Export: 24.03.2018
This document was created with BlueSpice
Page 83 of 130
User manual
Extensions
bold
italics
crossed out text
Heading (second level)
line break
Add an image gallery
Add signature with time stamp
Set up a redirect
add a (hidden) comment in the wikicode
Uses
Clicking on the icon you want adds some standard code to the source text. For formatting, mark the right
parts of the text and then click on the icon for the formatting you want.
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 84 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 85 of 130
User manual
Extensions
4.22. ExtendedSearch
Contents
1 What is ExtendedSearch? .................................................................................................................................. 86
2 Where to find ExtendedSearch? ........................................................................................................................ 86
3 What can ExtendedSearch do? .......................................................................................................................... 87
4 What can I do with the search results? .............................................................................................................. 88
4.1 Sorting results .......................................................................................................................................... 88
4.2 Limit the search with facets ..................................................................................................................... 89
5 Tips for using the extended search .................................................................................................................... 89
6 Search administration ........................................................................................................................................ 90
7 Troubleshooting ................................................................................................................................................. 90
8 See also ............................................................................................................................................................. 90
What is ExtendedSearch?
ExtendedSearch is able to search for articles and attachments according to both title and content. The first
hits are shown as you are typing the search term into the box. If you do not get a suitable hit straight away,
the search results can be refined by using facets.
Where to find ExtendedSearch?
ExtendedSearch is a special page. You will be redirected here when you do not find a suitable hit using the
auto complete function.
You can find the search box above any article to the right. You can search for titles (use the arrow) or the full
content (magnifying glass).
Screenshot: The first results start to appear as soon as you start to type
Export: 24.03.2018
This document was created with BlueSpice
Page 86 of 130
User manual
Extensions
Screenshot: The first results start to appear as soon as you start to type
in the query
As you can see in the screenshot, search results are suggested to you as you type, and you can select these
too. If none of these results is suitable, you are automatically taken to the search form for the
ExtendedSearch. Here you can sort the search results and use facets to filter them further.
You can also reach this search form by going to Special pages -> BlueSpice -> Extended Search. The "auto
complete" function is deactivated here, otherwise it works just like the search box above the article.
What can ExtendedSearch do?
With the improved search function from BlueSpice you can:
Search titles: Search in a selection of areas only according to title. If the search term fully matches an
existing article, you will be forwarded to it (this can be activated and deactivated). Search by title by
using the arrow button to the right of the search box.
Search the full content: Search the complete content in a selection of areas. This is done by using the
magnifying glass button to the right of the search box.
Search uploaded or linked files (Office documents and PDFs).
Search image data
Search-as-you-type and auto-complete: As soon as you start typing a search term into the box at the
top right, the system starts searching and giving you relevant suggestions. These suggestions are shown
in a drop-down menu below the entry box and you can choose individual suggestions by clicking on
them. This forwards you to the article named. This function is particularly good for locating articles with
long titles or subpages.
If the search term is not found automatically, the menu immediately gives you the possibilities "Suggest
article" and "Create article".
Ignore upper and lower case (case-insensitive).
Example: Searching for "keyboard" gives the same results as for "Keyboard".
Search with the operators AND, OR, NOT.
Example: Searching for "keyboard OR keypad" gives results which contain at least one of these two
terms.
Search with wildcards:
*(the star replaces an arbitrary number of characters). This allows you to truncate your search terms
to the left or to the right. This means you can search for "User*" (trunkated to the right) or
"*preferences" (truncated to the left).
? (the question mark replaces a single letter)
Search for phrases (filter according to author, category and namespace).
Fuzzy search: this means that imprecise search entries (for example typing mistakes) suck as keyboard
will be found and a corrected version will be suggested to you.
Sentence components which belong together will be found, like "computer keyboard"
Export: 24.03.2018
This document was created with BlueSpice
Page 87 of 130
User manual
Extensions
What can I do with the search results?
Sorting results
Screenshot: The display of the search results showing the possibile sorting criteria.
The search results are initially sorted according to relevance. You can, however, sort them by title or type or
chronologically. The criteria for sorting are shown in a block next to the results and can be chosen by
clicking on them.
The current choice/sorting is highlighted in bold. The current sorting direction is shown with an arrow symbol
behind the sort criterion and can be changed by clicking on it.
You can find links to further search results right at the bottom. These are shown in the following way: < 1 2
3 4 5 .. 66 > : the arrow to the right takes you to the next page. The current page is highlighted in bold.
Export: 24.03.2018
This document was created with BlueSpice
Page 88 of 130
User manual
Extensions
Limit the search with facets
You can further restrict the search results by using facets (filters)
which you can find on the left hand side. The following facets are
available:
Namespace filter: You can restrict your search to one
namespace or a selection of several. You can also select particular
namespaces which should be searched or blanked our in advance
in the search settings (under "Preferences").
Category filter: The extended search lets you search within one
category or a selection of them. You can also select particular
categories which should be searched or blanked our in advance in
the search settings (under "Preferences").
Type filter: This lets you filter whether you will search for or in
wiki articles (shown as a W on a white background before the hit),
for or in PDF, Word, EXCEL or other documents.
Author filter: You can give the author who, for example, you
think may have written the article.
Screenshot: Filter (facet) selection in
ExtendedSerach
Tips for using the extended search
Configure search: A wiki administrator can set up which filters can be chosen in the Preferences, and
also which search function comes as default when a user presses enter.
Personal search preferences: If you want to change the number of hits shown in a search, you can do
Export: 24.03.2018
This document was created with BlueSpice
Page 89 of 130
User manual
Extensions
Personal search preferences: If you want to change the number of hits shown in a search, you can do
this in your MediaWiki personal preferences. You can also change the lines per hit and the characters per
line. But you can also change the standard namespaces for your searches here.
So that your search delivers the appropriate results, the content must be regularly indexes (see
below under Search administration). This normally occurs "on the fly", i.e. whenever there are new
articles/files, changes to the content of articles, or an article is deleted or restored. In the indexing has
not been done, searching will give no results. If the indexing is not up to date, new articles and files will
not be able to be found.
Anyone can search if they have read permission in the wiki. This means that results are only shown
from namespaces in which the user has read permission. If you cannot find an article even though you
know it exists, it may be that you do not have the relevant access permission. Permissions are set up via
the PermissionManager.
Even though the namespace "book" is marked as not searchable, content will be found from within it. "
Not searchable" means, here, that the namespace is not searched by default. These standard settings
can be overwritten in the user preferences. Whether a page is displayed as a hit depends on the
readability of the page and not on the namespace's search settings.
Search administration
The following functions are available in the wiki admin area.
The number of hits shown per page can be set up at WikiAdmin->Preference->Search>LimitResultsDefault
Weighting of search results: Administrators can prioritize namespaces for the search results. Just go to
the namespace manager and mark the checkbox at “content namespace” for the namespace you want
to prioritize. Contents of this namespace will be preferred in the search results
Troubleshooting
Problems with the Extended Search
Extended Search will shut down without notice
See also
Our reference page.
WikiExplorer. Sorting articles
Export: 24.03.2018
This document was created with BlueSpice
Page 90 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 91 of 130
User manual
Extensions
4.23. ExtendedStatistics
Contents
1 What is ExtendedStatistics? ............................................................................................................................... 92
2 Where to find ExtendedStatistics? ..................................................................................................................... 92
2.1 Choose the database ................................................................................................................................ 92
2.2 Choose a filter .......................................................................................................................................... 93
3 Tips for working with ExtendedStatistics ........................................................................................................... 94
4 Classical statistics with MediaWiki ..................................................................................................................... 95
5 See also ............................................................................................................................................................. 95
What is ExtendedStatistics?
ExtendedStatistics provides an analytic view of many relevant parameters on the wiki, providing wiki
administrators better insight into functioning of the wiki.
Where to find ExtendedStatistics?
"Global actions", "Extended statistics":
Choose the database
Next, choose the database you want to use:
Number of users: All the users that registered in the period chosen.
Number of pages: All pages created in the period chosen. Namespace, linking and so on play no role here.
Number of articles: All articles which were created in the period chosen, lie in a content namespace and
Export: 24.03.2018
This document was created with BlueSpice
Page 92 of 130
User manual
Extensions
Number of articles: All articles which were created in the period chosen, lie in a content namespace and
have at least one internal link. The numbers should conform with the article's MediaWiki statistics. Note:
MediaWiki has changes the way it counts a little in Version 1.18. This can lead to slight discrepancies.
Number of edits: All edits carried out in the period chosen.
Edits per user: The quotient of "number of edits" and "number of users" in each interval is shown.
Choose a filter
Enter the settings you want:
Date range:
Both data fields empty: No time restriction
From date empty: Starting from the earliest creation / edit / registration / search query
To date empty: Up to the present day.
Display:
Resolution (Year, month (default), week, day)
Mode
Absolute: The actual numbers involved
Aggregate: The running total. This graph will always either rise or stay at the same level.
As a list: The individual results will be shown as a sortable list.
Filter:
Namespace: To choose several namespaces, hold down the CTRL key while clicking. No choice means
that all namespaces will be considered.
Category: No choice means the results will not be filtered according to category, and pages not assigned
to a category will be included.
Search space: Only for search query statistics. Enter which pages you want to be included in the
statistics: Title, text, files, all
Excluded users: Select all users that shall not be included in the statistics.
Export: 24.03.2018
This document was created with BlueSpice
Page 93 of 130
User manual
Extensions
I will choose, for example, number of edits:
And "Create diagram":
A graph is created matching the settings for the statistics you have made.
Note: Only valid data will be taken into account.
The time will be shown on the X axis, and the values on the Y axis.
Below the diagram, you will find a summary of your query.
Tips for working with ExtendedStatistics
Carry out queries in small steps. If the server load is expected to be too high, you will be asked to minimise
the steps. At the moment, a maximum of 366 steps (e.g. 366 weeks) can be entered. The maximum number
will be set by the administrators in the preferences.
Export: 24.03.2018
This document was created with BlueSpice
Page 94 of 130
User manual
Extensions
The list of search queries can be sorted according to the "number of results". Queries which do not yield any
information are especially interesting. There is clearly some information missing in the wiki.
Classical statistics with MediaWiki
The statistics special page in MediaWiki has developed its own counting system. For example, an article or a
content page will only be counted if:
it is in the main namespace or a different separately determined namespace
it is not a redirect
it contains at least one internal link.
See also
Our reference page.
Further helpful information:
mediawiki.org: Magic words
RELATED TOPICS
Search options
Recent changes
Export: 24.03.2018
This document was created with BlueSpice
Page 95 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 96 of 130
User manual
Extensions
4.24. ExtensionInfo
Contents
1 What is ExtensionInfo? ....................................................................................................................................... 97
2 Where to find ExtensionInfo? ............................................................................................................................. 97
3 Functionality ...................................................................................................................................................... 97
4 Administration ................................................................................................................................................... 98
5 See also ............................................................................................................................................................. 98
What is ExtensionInfo?
ExtensionInfo creates a special page with basic information about loaded extensions of a wiki: extension
name, description, version or status.
Where to find ExtensionInfo?
The list of all extension in the admin area. Only visible for users with administration rights.
Functionality
Next to a list of extension names you will find the following information:
Description: a short description of the extension's functionality,
Version: here you can see the version,
Export: 24.03.2018
This document was created with BlueSpice
Page 97 of 130
User manual
Extensions
Version: here you can see the version,
Status: information about the level of development (alpha / beta / stable).
Administration
If you install a new extension it will be listed in the ExtensionInfo automatically. Further administration is
only possible right now in the script path: (/bluespice-mw/config/extension-settings.php)
NOTE
In the special page Spezial:Version there is an overview as well.
See also
Our reference page.
RELATED TOPICS
Preferences for Administrators
Installation manual
Export: 24.03.2018
This document was created with BlueSpice
Page 98 of 130
User manual
Extensions
4.25. FilterSpecialPages
Contents
1 What is FilterSpecialPages? ............................................................................................................................... 99
2 Where to find FilterSpecialPages? ...................................................................................................................... 99
3 See also ............................................................................................................................................................. 99
What is FilterSpecialPages?
Inserts a field in Special:Specialpages to provide a search function.
Where to find FilterSpecialPages?
Quick access and less searching for special pages: The extension offers a search field at the special page
"Specialpages". While typing a search string (e.g. "pages") only special pages with this search string in the
title will be shown.
Special_keys:
Enter: open page link if only one entry left,
Esc: toggle input selection
This is an extension for MediaWiki. BlueSpice is not required. FilterSpecialPages can be used e. g. with
vector skin, too.
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 99 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 100 of 130
User manual
Extensions
4.26. FlexiSkin
Contents
1 What is FlexiSkin? ............................................................................................................................................ 101
2 Where to find Flexiskin? ................................................................................................................................... 101
2.1 Adapting the skin ................................................................................................................................... 103
2.2 Skin changes .......................................................................................................................................... 104
3 Activating a skin .............................................................................................................................................. 105
4 Delete a skin .................................................................................................................................................... 106
5 See also ........................................................................................................................................................... 106
What is FlexiSkin?
FlexiSkin allows you to customize the skin of your wiki. Change the design of your wiki via the backend and
with a preview function. Choose between different colours, insert your own logo and decide if you want to
have the navigation at the left or right side.
Where to find Flexiskin?
Flexiskin is a special page. The most common way to open the Flexiskin is by clicking on "Skin" at the admin
navigation.
Export: 24.03.2018
This document was created with BlueSpice
Page 101 of 130
User manual
Extensions
By clicking on "Skin" you will be taken to dialogue where you can add a new skin:
Enter title and description of the new skin. You can also choose a related template at the dropdown and click
on "Ok" to create the new skin. Export: 24.03.2018
This document was created with BlueSpice
Page 102 of 130
User manual
Extensions
Adapting the skin
On the left hand side you will find the edit functionalities on the right hand side there is a preview. Don't
forget to click the "Save" button at the top of the editor area.
General
Save
Attention: The Reset button only resets the last set value.
To close the skin editor click on "close". Please confirm to the pop-up to really close the editor.
Export: 24.03.2018
This document was created with BlueSpice
Page 103 of 130
User manual
Extensions
Skin changes
You can also insert an image as background image.
Upload new image
Upload
Upload the image you want to have in the background and specify if you want to have repeats (no repeat,
horizontal, vertical repeat).
Background Image No
Repeat
Background Image
Horizontal Repeat
After you uploaded the image please click on "save" at the top of the skin editor.
Header/Logo: At the bottom of the editor on the left you will find "Header". Here you can upload an
individual logo. To see changes in the preview please click on "save" at the top.
No Logo
Export: 24.03.2018
Logo
This document was created with BlueSpice
Page 104 of 130
User manual
Extensions
Attention: The logo area in BlueSpice is defined with 276 x 60px. You can also change the logo in the admin
settings (click on "settings" in the admin navigation) and enter the logo path in the submenu "Flexiskin".
Position and size: Choose wether the navigation shall appear left or right next to the content. Position
means that you can display the content left, center or right in the browser. You can also change the
complete width.
Default for the skin is navigation on the left, content in the middle and width 1000px.
Left
Right
Activating a skin
To finally activate a new skin please select the skin at the overview of skins on the special page by clicking
on it.
Export: 24.03.2018
This document was created with BlueSpice
Page 105 of 130
User manual
Extensions
Delete a skin
You want to delete a skin completely? Mark the skin in the overview and click on the "remove" symbol.
Please confirm that you want to remove the skin. Or you can use "delete" symbol. Please confirm that you want
to delete the skin. See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 106 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 107 of 130
User manual
Extensions
4.27. FormatingHelp
Contents
1 What is FormatingHelp? ................................................................................................................................... 108
2 Where to find FormattingHelp? ........................................................................................................................ 108
3 Customising ..................................................................................................................................................... 109
4 See also ........................................................................................................................................................... 109
What is FormatingHelp?
FormattingHelp gives the most important information on formatting as you type. It is, however,
significantly shorter than the wiki quick reference. FormattingHelp is a MediaWiki extension.
Where to find FormattingHelp?
When you go to the edit mode, you will either see the wiki code view or will be able to change to it by
clicking the symbol. In the wiki code view, you will find the button FormattingHelp on the far right. Clicking
on it gives you a short overview of the most common formatting options.
Export: 24.03.2018
This document was created with BlueSpice
Page 108 of 130
User manual
Extensions
Screenshot: BueSpice formatting help
Customising
FormattingHelp can be customised using the page MediaWiki:Formatting. However, you should only do
this after agreeing the changes with the other wiki admins.
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 109 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 110 of 130
User manual
Extensions
4.28. GroupManager
Contents
1 What is GroupManager? ................................................................................................................................... 111
2 Where to find the function Group Manager? .................................................................................................... 111
3 The functionality of Group manager ................................................................................................................ 112
3.1 Create group .......................................................................................................................................... 112
3.2 Editing the group's permissions ............................................................................................................. 113
3.3 Assigning users to a group ..................................................................................................................... 113
3.4 Deleting groups ...................................................................................................................................... 113
4 See also ........................................................................................................................................................... 113
What is GroupManager?
Group Manager creates new groups, edit existing groups, and delete existing groups.
Where to find the function Group Manager?
To manage groups, open the Admin tab in the left navigation bar (sidebar), then click on Group manager.
Export: 24.03.2018
This document was created with BlueSpice
Page 111 of 130
User manual
Extensions
The functionality of Group manager
Overview of all user groups:
Create group
To create a group, move to the administration page via the link "WikiAdmin" (this is only available for
sysops). Then choose Group manager. The link "New"
takes you to a form where you can enter the
name of the group.
The new group will now be visible in the list. It is only given "Read" permission as standard. In order to
change this, you must edit the group.
Export: 24.03.2018
This document was created with BlueSpice
Page 112 of 130
User manual
Extensions
Editing the group's permissions
The permissions of individual groups can be changes in PermissionManager.
Assigning users to a group
This is not done via group management, but via user management, which you can find in the administration
area. You can see which groups a user is a member of in the column "Groups".
Deleting groups
Next to the edit button in the list, you will also see a buttons which allows you to delete group a group. If
you want to delete more than one group at once please mark all groups and use the "minus" button at the
top
or "Delete" button.
The only groups you cannot delete are "All" and "Users", as they are basic wiki groups. The users that were
members of the groups you delete are not deleted. They will still exist.
See also
Our reference page.
RELATED TOPICS
User Manager
Permission Manager
BlueSpice free Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 113 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 114 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 115 of 130
User manual
Extensions
4.29. HideTitle
Contents
1 What is HideTitle? ............................................................................................................................................ 116
2 How to ............................................................................................................................................................. 117
3 Tips for working ............................................................................................................................................... 118
4 See also ........................................................................................................................................................... 118
What is HideTitle?
HideTitle enables hiding of the title on the page, if it's necessary.
Export: 24.03.2018
This document was created with BlueSpice
Page 116 of 130
User manual
Extensions
How to
Export: 24.03.2018
This document was created with BlueSpice
Page 117 of 130
User manual
Extensions
Save and:
Tips for working
This extension is very useful on the main page. There you won't see "Main page", but nothing or maybe a
"Welcome".
See also
Our reference page.
RELATED TOPICS
Using redirects
Moving articles
Export: 24.03.2018
This document was created with BlueSpice
Page 118 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 119 of 130
User manual
Extensions
4.30. InsertCategory
Contents
1 What is InsertCategory? ................................................................................................................................... 120
2 Where to find InsertCategory? ......................................................................................................................... 120
3 InsertCategory's functions ............................................................................................................................... 121
4 Tips for working with InsertCategory ............................................................................................................... 121
5 Classical categories in MediaWiki .................................................................................................................... 122
6 See also ........................................................................................................................................................... 122
What is InsertCategory?
InsertCategory displays all existing categories, helping to keep the terminology uniform. You can then
assign the page you are on to one or more of these existing categories. On top of this, you can create new
categories here too. The dialogue can be called up from both the "Edit" mode and the "View" mode.
Where to find InsertCategory?
Inserting categories in the "edit" mode: In the edit view (wiki code and WYSIWYG), click the button
to assign keywords.
Inserting categories in the "Read" mode:
Click on the button "more"
on the right
hand side.
You will find several orders, one of which is "Insert Category". Here
you can add new and insert categories or you can delete categories
that don't fit the article.
Screenshot: Inserting categories in
the "Read" mode
Export: 24.03.2018
It does not matter if you start from the "Read" or "Edit" mode, when
you choose to assign categories, a dialogue opens that looks
something like this:
This document was created with BlueSpice
Page 120 of 130
User manual
Extensions
As you can see on the screenshot on
the left side, in the left column all
available categories, in the right
column there are all chosen
categories for the article and you can
add new categories in the same field.
Dialogue of InsertCategory
InsertCategory's functions
The caregories are listed hierarchically in the left column. The column on the right shows the categories
which are already assigned to the article.
Assigning categories: Click on one of the categories listed, it will appear on the right in the column
"Chosen categories" and is then assigned to the article. Is a category is chosen which lies in a deeper
level of the category hierarchy, all the categories above it will be transferred into the right hand column
too.
Deleting categories: To remove a category from the site you are on, click on the delete symbol (a red
cross).
Adding new categories: A category can be created and assigned by typing the category's name in the
text box and clicking on "Enter". New categories only show up in the dialogue after the page has been
saved and the dialogue has been reloaded.
Ok button: In order to assign the chosen categories to the page, click the "Ok" button. The categories
you have chosen will only be added to the page when you do this. Then they are added at the end, in the
form .
Abort: If you do not want to make the change, you can cancel the action with the button "Abort".
Tips for working with InsertCategory
By the way: One can set whether categories should be inserted with or without their parent categories in
the preferences.
There is no limit on the number of categories to which an article can be assigned.
Export: 24.03.2018
This document was created with BlueSpice
Page 121 of 130
User manual
Extensions
Classical categories in MediaWiki
Here is information about how to add Categories the classical way in MediaWiki.
See also
Our user manual.
Export: 24.03.2018
This document was created with BlueSpice
Page 122 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 123 of 130
User manual
Extensions
4.31. InsertFile
Contents
1 What is InsertFile? ........................................................................................................................................... 124
2 Where to find InsertFile? .................................................................................................................................. 124
3 InsertFile's functions ........................................................................................................................................ 125
3.1 Inserting files .......................................................................................................................................... 125
3.2 Uploading data ....................................................................................................................................... 125
3.3 Searching for files ................................................................................................................................... 125
4 What can and should be uploaded? ................................................................................................................. 126
5 Umlauts ........................................................................................................................................................... 126
6 For Wiki-Administrators ................................................................................................................................... 126
7 case study ....................................................................................................................................................... 126
8 See also ........................................................................................................................................................... 126
What is InsertFile?
InsertFile is a tool developed by Hallo Welt GmbH for uploading and inserting files in the wiki.
Where to find InsertFile?
Go to the edit mode of the article by clicking on the tab "edit". You can find an extra button for InsertFile in
the edit bar of the WYSIWYG editor and the wikicode editor:
Export: 24.03.2018
This document was created with BlueSpice
Page 124 of 130
User manual
Extensions
InsertFile's functions
Screenshot: Inserting and uploading files with InsertFile
Inserting files
To insert files into your page, use InsertFile to choose a file from the preview list and accept the change with
Ok. Then the data is inserted using the wiki code.
Uploading data
If you want to upload a file yourself, click on Upload. You can choose the file you want with Browse. Then
you need to copy the file into the wiki using Upload file.
Searching for files
You can also choose which files are shown by, for example, typing the first few letters into the field f ilter.
You can sort the files by Name, Recent changes or File size if you click on the small arrow next to the
heading.
Export: 24.03.2018
This document was created with BlueSpice
Page 125 of 130
User manual
Extensions
If the preview is not automatically updated when you have uploaded a file, please leave the dialogue and
open it again.
What can and should be uploaded?
You should only upload files that aren't available in other systems, which means files you can't link to.
Because of security reasons it's only possible to upload the following file formats:
Size limitation is 32 MB a file
There is no limitation for the number of files
The following file extensions (file formats) are enabled by default:
png, gif, jpg, jpeg, doc, dot, ppt, pdf.
If you need to upload other file formats please contact your administrator.
Umlauts
In the new MediaWiki versions it is not possible to upload files that containing umlauts. This has been
disabled generally for security reasons (August 2013)
For Wiki-Administrators
The permitted file formats can be managed at the special page Wiki-Admin.
Click on the "Admin" tab in your main navigation and choose the preferences there. Go to:
BlueSpice - MediaWiki settings -> BlueSpice -> Allowed file extensions
There are some file extensions, which are not allowed in general, because of security issues (.exe, .php,
etc.). If you want to use these document files anyway, please contact the Hallo Welt! - Medienwerkstatt
GmbH.
There are problems when uploading files? Have a look at this MediaWiki tutorial: Manual:Configuring file
uploads
case study
Cant upload file from an edit page
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 126 of 130
User manual
Extensions
Export: 24.03.2018
This document was created with BlueSpice
Page 127 of 130
User manual
Extensions
4.13. TagCloud
Contents
1 What is TagCloud? ........................................................................................................................................... 128
2 Embed TagCloud .............................................................................................................................................. 128
3 Parameters ...................................................................................................................................................... 128
4 Examples ......................................................................................................................................................... 129
5 See also ........................................................................................................................................................... 130
What is TagCloud?
TagCloud can visualize a category overview graphically.
Embed TagCloud
A tag is provided to integrate the configurable TagCloud into an article. The tag must be inserted in an
article of the wiki to make the function visible and usable. You can place it manually in the diting mode of
the article. The tag can only be inserted in the Wikicode, not in the Visual Editor.
Tag: <bs:tagcloud></bs:tagcloud>
Parameters
The TagCloud can be configured using various parameters:
Parameter Description
width
showcount
Value
Default
determines the width of TagCloud
number
300
Shows the number how often the category is used in
true
false
false
the wiki
left
float
determines the orientation in the article
left
right
40
count
defines the number of displayed categories
number
viewtype=list
Export: 24.03.2018
This document was created with BlueSpice
(all categories
= -1)
simple
Page 128 of 130
User manual
Extensions
viewtype
changes the visualization of the list
viewtype=canvas3d TagCloud
Examples
<bs:tagcloud/>
Screenshot: Example for TagCloud with default settings, unconfigured
<bs:tagcloud width=800 float=right count=15/>
Screenshot: Example for TagCloud, right-aligned, 15 hits
Export: 24.03.2018
This document was created with BlueSpice
Page 129 of 130
User manual
Extensions
<bs:tagcloud viewtype=canvas3d width=600 count=10/>
Screenshot: Example for TagCloud, View 3D, 10 hits, Rotating standard view
<bs:tagcloud viewtype=list showcount=true count=10/>
Screenshot: Example for TagCloud, view Liste
See also
Our reference page.
Export: 24.03.2018
This document was created with BlueSpice
Page 130 of 130