Config manager

    • This page is accepted
< Manual:Extension

About Config manager

With the Config manager, a wiki user with sysop rights can manage all BlueSpice wiki-wide settings in one place. In the navigation, it is located under Global navigations > Management > Config manager.This link loads the page Special:ConfigManager.

config manager in navigation item
Config manager navigation item

Layout

Filter options

All settings can be accessed through the following filter options:

  • Feature: group by type of functionality the setting belongs to (search, administration...)
  • Extension: group by extension name
  • Package: group by BlueSpice edition and services (BlueSpice free, BlueSpice pro, Matomo)
config manager filter
config manager filter


All settings are available in any type of grouping. Changing the grouping type does not add or remove setting options. It just groups them differently.

After settings are adjusted, they can be saved by clicking Save, or reset to the default settings by clicking Reset.

Searching for settings

A search bar is located above the list of settings. Type in a keyword such as "logo" to find the corresponding setting. The search returns settings regardless of the currently selected group.

Note: The search field has to be empty if you want to see the filter menu instead of the search.


Config manager search box
Config manager search box

Settings by extension

BlueSpiceFoundation

  • Logo path: The logo image should be stored in the /images folder of your installation. If you store it in the /skins folder of your BlueSpice installation, it could be overwritten with an upgrade.

To upload the logo directly in the wiki:

  1. Upload the logo on the page Extended file list (Special:ExtendedFilelist). This is a link under the Global actions navigation.
  2. Search for the logo name in the extended file list.
  3. Click on the thumbnail image of the logo. This opens the logo on a separate page.
    logo thumbnail image
    logo thumbnail image
  4. Copy the relative logo path from the address bar.In a typical Wiki configuration, this path starts with /w/.... .
    relative image path
    relative image path
  5. Paste the logo path into the text field for the logo.
    logo path
    logo path
  6. Click Save.
  7. Refresh the page (Strg+F5).
  • Favicon path: The favicon image should be stored in the /images folder of your installation. If you store it in the /skins folder of your BlueSpice installation, it could be overwritten with an upgrade. Favicon images have the file extension .ico.
  • Allowed file extensions: For security reasons, the types of files that users can upload are restricted. Here, you can allow additional file formats. If a file format is blacklisted in the server configuration, adding this file extension here will not allow this file type to be uploaded. See mediawiki.org/wiki/Manual:Page_title for more info.

BlueSpiceAbout

  • Show link "About BlueSpice" in the main menu: Shows or hides the link to the page AboutBlueSpice in the main navigation.
main navigation
main navigation

BlueSpiceArticleInfo

BlueSpiceArticleInfo, together with BlueSpiceAuthors and BlueSpiceReaders is part of the Page information in the quality management tools.

  • Update interval in seconds: Sets the refresh rate for the "Last edit" value. By default, this date is updated every 10 seconds via JavaScript.
article info
article info

BlueSpiceAuthors

BlueSpiceAuthors, together with BlueSpiceArticleInfo and BlueSpiceReaders, is part of the Page information in the quality management tools.

  • Display authors: Show or hide authors on the page information page.
page authors in page information
page authors in page information

BlueSpiceAvatars

InstantAvatar
InstantAvatar

An avatar image is automatically generated if the user does not upload a profile picture or if the user decides to create an avatar image in the preferences.

  • Generator
    • InstantAvatar: Generates an avatar image based on using the initials of the Real name or the Username
    • Identicon: Generates an avatar image based on parts of the user's IP address.
      Identicon
      Identicon

BlueSpiceBookshelf

  • Use the display title from book source on article: Shows the title from the book navigation as page title instead of the page name.
book display title
book display title

Note: If the page additionally contains a {{DISPLAYTITLE}} tag, the display title of the page is shown instead of the book title.


  • Prepend article table of contents and headlines with book numberation
  • Supress namespace prefix of book articles in output

BlueSpiceChecklist

  • Mark checklist changes as minor edit: If this setting is active, changes to a checklist (for example, checking a checkbox) in view mode are logged as minor edits. If this setting is inactive, a change to the checklist is not recorded in the page history.
    minor edit
    minor edit

BlueSpiceExtendedSearch

  • External file paths: External locations to scan for and index files from. These locations are entered in key/value pairs of Physical path and URL prefix.
    • Physical path: Storage path. For mounted drives, for example: X:\Documents
    • URL prefix: All files indexed from the indexed physical location are prefixed in the search results. It should be used if files are available from a web server. By default, the URL prefix is set to the same value as Physical path.
  • Use simple autocomplete: forces a more compact autocomplete (1-column layout, no thumbnail preview).
    compact autocomplete
    compact autocomplete
    regular autocomplete
    regular autocomplete

  • Automatically set language filter: This setting applies to multi-language wikis. It returns search results for a user only in the user's language. Users can set their language in their preferences.
  • Exclude patterns: Files at external file locations can be exluded from search based on regular expression patterns.

BlueSpiceExtendedStatistics

  • Exclude these users: Some user groups, like WikiSysop can skew the statistics, for example the statistics for search queries or because they complete automated maintenance tasks. These types of user groups can be excluded from the statistical results.
  • Maximum number of interval steps:

BlueSpiceInsertCategory

  • Insert category with its parents
  • Set page categories as default in upload dialog

BlueSpicensertLink

  • Allow unmapped links
  • Allowed locations for external files
    • Filesystem prefix
    • Web accessible prefix:

BlueSpicePageTemplates

  • Force target namespace: The page template is always created in the target namespace, no matter what namespace is provided during page creation.
  • Hide default templates: Hides the default Empty page template.

BlueSpicePermissionManager

  • Backup limit: Sets the number of backups for the permissions manager. Each time the page Special:PermissionManager is saved, a backup is created. If the backup limit is set to 5, the last five versions of the permissions configuration are saved as backups.

BlueSpiceReaders

  • Number of readers to display: Sets the number of readers that are displayed on the Page information in the Quality management tools.
    page readers
    page readers


BlueSpiceSaferEdit

  • Interval for lookup for concurrent editings: Sets the time in seconds for checking if another person is editing the page.
  • Show name of current editor: Shows or hides the name of the user who is currently editing the page.

BlueSpiceUEModuleBookPDF

  • Table of Contents
    • Only article titles (indent by grade): Only shows the article titles in the main contents table of the PDF.
      PDF table of contents without article TOCs
      PDF table of contents without article TOCs

    • Embed article TOCs (No indent of article titles): Shows the table of contents for each article in the main contents table of the PDF.
      Embed article TOCs
      Embed article TOCs

BlueSpiceUEModuleHTML

  • Hide namespace prefix in PDF: If activated, the namespace is shown in the HTML main heading.

Note: If the page contains a "displaytitle" tag in the page source, the page display title is shown and this setting has no effect.


BlueSpiceUEModulePDF

  • Hide namespace prefix in PDF: If activated, the namespace is shown in the PDF main heading for a page.
namespace in heading
namespace in heading

Note: If the page contains a "displaytitle" tag in the page source, the page display title is shown and this setting has no effect.


BlueSpiceUniversalExport

  • Metadata (standard, JSON): Additional data to be passed to the rendering template in JSON format. This data can be used in the export template. The template itself is maintened server-side.
  • Metadata (override, JSON): Allows overriding standard data sent to the rendering template in JSON format. Values that are set by default can be overriden with this option.

BlueSpiceVisualEditorConnector

  • Enable VisualEditor for BlueSpice extensions
  • Configuration variable to use a simplified save process
  • Upload type
    • Original (Here a confirmation of the rights of use/upload is obtained, file name and namespace of the file can be changed, a category can be assigned and a description of the file MUST be given).
    • Simple (No confirmation of required rights is obtained here, the name and namespace of the file can be changed, a description and a category can be assigned, but does not have to be specified)
    • One click (No confirmation about required rights is obtained here, the image cannot be renamed and no category can be assigned. Only the namespace can, but does not have to be adjusted before uploading)

BlueSpiceWhoIsOnline

  • Time in seconds until a user is marked as offline: The system checks every x seconds if a user logged out and no longer displayed as online. This can be less frequent than the update inteval for newly logged-in users.
  • Update interval in seconds: The system checks every x seconds for users.

BlueSpiceExpiry

  • Show watermark for expired pages in PDF: Shows the watermark for expired pages in PDFs.
  • Show watermark for expired pages in print version: Shows the watermark for expired pages when a page is printed.
  • Show watermark for expired pages: Shows a watermark on the page itself.
    watermark
    watermark

BlueSpiceReview

  • Only the owner of a review can change it: If this is unchecked, any user with edit rights can update a workflow.

BlueSpiceReviewExtended

  • Workflow will be added to page history: This enables that workflow votes are listed under the page history with the corresponding version.


workflow log entries in page history
workflow log entries in page history

BlueSpiceFlaggedRevsConnector

Export

The export settings affect how the pages of a book are generated in the PDF export.

  • Bookshelf: List accepted revisions log: Shows a log of stable page versions of pages in the PDF and when these pages were put into accepted status. If editors did not provide a comment when accepting the page, the Stable comment field for a revision is empty.
    accepted revisions log
    accepted revisions log

  • Bookshelf: List pages without stable revision: Displays a list of PDF pages at the beginning of the PDF that only exist as a first draft and have no released version.
    Pages without acceptance feature
    Pages without acceptance feature

  • Bookshelf: List pages without FlaggedRevs: Displays a list of PDF pages that do not have a release mechanism at the beginning of the PDF.


Pages with no FlaggedRevs feature.
Pages with no FlaggedRevs feature.


  • UEModulePDF: Show FlaggedRevs info below main heading: Prints the latest revision dates (last acceptance and last edit date) below the heading.
    FlaggedRevs info below heading
    FlaggedRevs info below heading

Quality assurance

  • Automatically set the page to stable, when the workflow was finished successfully: The workflow ends with setting the page status to stable.
  • Automatically delete the workflow, when a page was marked as stable: The workflow is deleted.
  • Show unstable pages for following groups: If the group user is removed from the BlueSpiceFlaggedRevs configuration, users in this group will not be able to see draft versions when they are added as reviewers in a review process. When the group user is removed, only sysop and reviewer users can access drafts. If you want other groups, for example editor, to see draft versions, you need to add them to the configuration. If no user groups are specified in the configuration field, not even reviewers and sysops users will see a visual status indication of a page. They will have access to drafts through the revision history for the page instead.

Searching and Navigation

  • Indexing only stable versions: Draft versions are excluded from the search results. If a page does not have a stable version, it is not shown as a search result.

BlueSpiceSocialBlog

  • Use teaser text for blog entries in the timeline: When you create a blog entry, you can create a teaser text for it by clicking the cogwheel symbol in the blog entry form. If this setting is active, the teaser text will be shown on the page Special:Timeline instead of the first part of the content.


blog teaser text
blog teaser text


BlueSpiceSocialTopics

  • Automatically create all discussion pages. If a user creates the first discussion topic for a page using the link in the page footer of a wiki page, the needed discussion page is automatically created first.
    create discussion topic
    create discussion topic

    A message "This discussion page was created automatically" is inserted on the discussion page.
    automatically created discussion page
    automatically created discussion page

If this setting is deactivated, the user is directed to the "Create page" default page first

BlueSpiceMatomoConnector

  • Site ID: Matomo ID of the wiki. You can find the site ID as a url parameter in the browser address bar when you are logged into Matomo.
matomo site ID
matomo site ID
  • Base url: The url to your Matomo installation.
  • Show opt-out link in footer: Displays a link in your wiki footer, usually named Analysis service.
    footer links
    footer links

    On the Analysis service page, there is a checkbox that allows a user to opt-out from being tracked for analysis purposes.
    Matomo opt-out checkbox
    Matomo opt-out checkbox


Related info

Attachments

Discussions