Difference between revisions of "Manual:Extension/BlueSpiceConfigManager"

{{DISPLAYTITLE:Config manager}}
        
        __TOC__
        
        
        
        ==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 [[BlueSpice Layout|navigation]], it is located under ''Global navigations > Management > Config manager''.This link loads the page ''Special:ConfigManager.''<br />[[File:ConfigManager1a.png|alt=config manager in navigation item|center|550x550px|thumb|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)<br />
        
        
        
        [[File:ConfigManager2a.png|alt=config manager filter|center|550x550px|thumb|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. {{Box Note|boxtype=note|Note text=The search field has to be empty if you want to see the filter menu instead of the search.}}<br />
        
        [[File:Manual:configmanager-search.png|alt=Config manager search box|center|thumb|400x400px|Config manager search box]]
        
        
        <br />
            
            
            
            ==
            
            == 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:'''
        
        
        
        #'''Upload''' the logo on the page ''Extended file list'' (''Special:ExtendedFilelist''). This is a link under the ''Global actions'' navigation.
        
        #'''Search''' for the logo name in the extended file list.
        
        #'''Click''' on the thumbnail image of the logo. This opens the logo on a separate page.<br />[[File:Manual:config-logo1.png|link=https://en.wiki.bluespice.com/wiki/File:Manual:config-logo1.png|alt=logo thumbnail image|center|thumb|280x280px|logo thumbnail image]]
        
        #'''Copy''' the relative logo path from the address bar.In a typical Wiki configuration, this path starts with ''/w/....'' .<br />[[File:Manual:config-logo2.png|alt=relative image path|center|thumb|450x450px|relative image path]]<br />
        
        #'''Paste''' the logo path into the text field for the logo.<br />[[File:Manual:config-logo3.png|link=https://en.wiki.bluespice.com/wiki/File:Manual:config-logo3.png|alt=logo path|center|thumb|450x450px|logo path]]
        
        #'''Click''' ''Save''.
        
        #'''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. [https://de.wikipedia.org/wiki/Favicon 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 [[mediawikiwiki:Manual:Configuring_file_uploads|https://mediawiki.org/wiki/Manual:Page_title mediawiki.org/wiki/Manual:Configuring_file_uploads]]Page_title] for more info.
        
        
        
        *'''Allowed image extensions:''' The standard web image types are listed here. In general, you want to restrict image uploads to web images. See [https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types] for more on browser-supported image types.
        
        
        
        ===BlueSpiceAbout===
        
        
        
        *'''Show link "About BlueSpice" in the main menu:''' Shows or hides the link to the page [[Extension/AboutBlueSpice|AboutBlueSpice]] in the main navigation.<br />
        
        
        
        [[File:Manual:config-aboutbluespice.png|alt=main navigation|center|thumb|215x215px|main navigation]]
        
        
        
        ===BlueSpiceArticleInfo===
        
        ''BlueSpiceArticleInfo'', together with ''BlueSpiceAuthors'', 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.
        
        
        
        [[File:ArticleInfo3.jpg|alt=article info|center|thumb|450x450px|article info]]
        
        
        
        ===BlueSpiceAuthors===
        
        ''BlueSpiceAuthors'' together with ''BlueSpiceArticleInfo'', is part of the ''Page Information'' in the quality management tools.
        
        
        
        *'''Display authors:''' Show or hide authors on the page information page.
        
        
        
        [[File:Authors3.jpg|alt=page authors in page information|center|thumb|450x450px|page authors in page information]]
        
        
        
        ===BlueSpiceAvatars===
        
        [[File:Manual:configmanager-instantavatar.png|alt=InstantAvatar|thumb|101x101px|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
        
        **'''[[wikipedia:Identicon|Identicon:]]''' Generates an avatar image based on parts of the user's IP address.<br />[[File:Manual:configmanager-identicon.png|alt=Identicon|center|thumb|500x500px|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. <br />
        
        
        
        [[File:Manual:configmanager-bookdisplaytitle.png|alt=book display title|center|thumb|450x450px|book display title]]
        
        {{Box Note|boxtype=note|Note text=If the page additionally contains a <nowiki>{{DISPLAYTITLE}}</nowiki> tag, the display title of the page is shown instead of the book title.}}
        
        
        
        *<span class="col-red">Prepend article table of contents and headlines with book numberation</span>
        
        *<span class="col-red">Supress namespace prefix of book articles in output</span>
        
        
        
        ===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.<br />[[File:Manual:configmanager-checklistminoredit.png|alt=minor edit|center|thumb|550x550px|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: S''torage 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).<br />[[File:Manual:configuration-autocomplete-simple.1575886540740.png|alt=compact autocomplete|center|thumb|450x450px|compact autocomplete]][[File:Manual:configuration-autocomplete-regular.1575886496796.png|alt=regular autocomplete|center|thumb|450x450px|regular autocomplete]]<br />
        
        *'''Automatically set language filter''': Returns search results for a user only in the user's language. Users can set their language in their [[Manual:Preferences|preferences]].
        
        *'''Exclude patterns:''' Files at external file locations can be exluded from search based on regular expression patterns. <br />
        
        
        
        ===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.
        
        *'''<span class="col-red">Maximum number of interval steps:</span>'''
        
        
        
        ===BlueSpiceInsertCategory===
        
        
        
        *<span class="col-red">Insert category with its parents</span>
        
        *<span class="col-red">Set page categories as default in upload dialog</span>
        
        
        
        ===BlueSpicensertLink===
        
        
        
        *'''<span class="col-red">Allow unmapped links</span>'''
        
        *'''<span class="col-red">Allowed locations for external files</span>'''
        
        **<span class="col-red">Filesystem prefix</span>
        
        **<span class="col-red">Web accessible prefix:</span>
        
        
        
        ===BlueSpicePageTemplates===
        
        
        
        *'''<span class="col-red">Force target namespace:</span>''' 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. <br />[[File:Manual:configmanager-readers.png|alt=page readers|center|thumb|450x450px|page readers]]<br />
        
        
        
        
        <br />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.
        
        
        
        ===<span class="col-red">BlueSpiceUEModuleBookPDF</span>===
        
        
        
        *Table of Contents
        
        **''Only article titles (indent by grade)'':
        
        **Embed article TOCs (No indent of article titles)
        
        
        
        ===BlueSpiceUEModuleHTML===
        
        
        
        *'''Hide namespace prefix in PDF:''' If activated, the namespace is shown in the HTML main heading.
        
        {{Box Note|boxtype=note|Note text=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.
        
        
        
        [[File:Manual:configmanager-pdfhidenamespace.png|alt=namespace in heading|center|thumb|450x450px|namespace in heading]]
        
        {{Box Note|boxtype=note|Note text=If the page contains a "displaytitle" tag in the page source, the page display title is shown and this setting has no effect.}}
        
        
        
        ===<span class="col-red">BlueSpiceUniversalExport</span>===
        
        
        
        *<span class="oo-ui-fieldLayout-header">'''Metadata (standard, JSON):'''</span>  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.
        
        
        
        ===<span class="col-red">BlueSpiceVisualEditorConnector</span>===
        
        
        
        *<span class="oo-ui-fieldLayout-header">'''Enable VisualEditor for BlueSpice extensions'''</span>
        
        *'''<span class="oo-ui-fieldLayout-header">Configuration variable to use a simplified save process</span>'''
        
        *'''Upload type'''
        
        **''Original''
        
        **''Simple''
        
        **''One click''
        
        
        
        ===BlueSpiceWhoIsOnline===
        
        
        
        *<span class="oo-ui-fieldLayout-header">'''Time in seconds until a user is marked as offline:'''</span> 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.
        
        *<span class="oo-ui-fieldLayout-header">'''Update interval in seconds:'''</span> The system checks every ''x'' seconds for users.
        
        
        
        ===BlueSpiceExpiry===
        
        
        
        *'''<span class="oo-ui-fieldLayout-header">Show watermark for expired pages in PDF</span>:'''  Shows the watermark for expired pages in PDFs.
        
        *<span class="oo-ui-fieldLayout-header">'''Show watermark for expired pages in print version:''' Shows the watermark for expired pages when a page is printed.</span>
        
        *<span class="oo-ui-fieldLayout-header">'''Show watermark for expired pages'''</span>: Shows a watermark on the page itself.<br />[[File:Manual:configmanager-watermark.png|alt=watermark|center|thumb|250x250px|watermark]]
        
        
        
        ===BlueSpiceReview===
        
        
        
        *'''<span class="col-red">Only the owner of a review can change it</span>:''' 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.
        
        
        
        
        <br />
        
        [[File:Manual:configuration-addworkflowtohistory.png|alt=workflow log entries in page history|center|thumb|650x650px|workflow log entries in page history]]
        
        
        
        ===BlueSpiceFlaggedRevsConnector===
        
        
        
        *'''Export:''' The export settings affect how the pages of a book are generated in the PDF export.
        
        **'''<span class="oo-ui-fieldLayout-header">Bookshelf: List accepted revisions log</span>:''' Shows a log of stable page versions 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. <br />[[File:Manual:configmanager-bookshelf-revisionslog.png|alt=accepted revisions log|center|thumb|450x450px|accepted revisions log]]<br />
        
        **<span class="col-red">Bookshelf: List pages without stable revision</span>
        
        **<span class="col-red">Bookshelf: List pages without FlaggedRevs</span>
        
        **<span class="oo-ui-fieldLayout-header">'''UEModulePDF: Show FlaggedRevs info below main heading'''</span>: Prints the latest revision dates below the heading. <br />[[File:Manual:configmanager-bookshelf-flaggedrevsinfo.png|alt=FlaggedRevs info below heading|center|thumb|350x350px|FlaggedRevs info below heading]]<br />
        
        **<span class="oo-ui-fieldLayout-header">'''Automatically set the page to stable, when the workflow was finished successfully:''' The workflow ends with setting the page status to stable.</span>
        
        **<span class="oo-ui-fieldLayout-header">'''Automatically delete the workflow, when a page was marked as stable:''' The workflow is deleted.</span><br />
        
        
        
        *<span class="oo-ui-fieldLayout-header">'''Show unstable pages for following groups:'''</span> 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.
        
        
        
        *<span class="oo-ui-fieldLayout-header">'''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.</span><span class="oo-ui-fieldLayout-field"><span id="bsgFlaggedRevsConnectorUEModulePDFShowFRTag" class="oo-ui-widget oo-ui-widget-enabled oo-ui-inputWidget oo-ui-checkboxInputWidget" aria-disabled="false" data-ooui><span class="oo-ui-checkboxInputWidget-checkIcon oo-ui-widget oo-ui-widget-enabled oo-ui-iconElement oo-ui-iconElement-icon oo-ui-icon-check oo-ui-iconWidget oo-ui-image-invert" aria-disabled="false"></span></span></span><span class="oo-ui-fieldLayout-field"><span id="bsgFlaggedRevsConnectorUEModulePDFShowFRTag" class="oo-ui-widget oo-ui-widget-enabled oo-ui-inputWidget oo-ui-checkboxInputWidget" aria-disabled="false" data-ooui><span class="oo-ui-checkboxInputWidget-checkIcon oo-ui-widget oo-ui-widget-enabled oo-ui-iconElement oo-ui-iconElement-icon oo-ui-icon-check oo-ui-iconWidget oo-ui-image-invert" aria-disabled="false"></span></span></span>
        
        
        
        === 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. 
            
            
            
            
        <br />[[File:Manual:configmanager-blogteaser.png|alt=blog teaser text|center|thumb|380x380px|blog teaser text]]<br />
        
        
        
        ===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.  <br />[[File:Manual:configmanager-socialtopics-create.png|alt=create discussion topic|center|thumb|350x350px|create discussion topic]]<br />A message "This discussion page was created automatically" is inserted on the discussion page.  <br />[[File:Manual:configmanager-socialtopics.png|alt=automatically created discussion page|center|thumb|350x350px|automatically created discussion page]]<br />
        
        
        
        If this setting is deactivated, the user is directed to the "Create page" default page first
        
        
        <br />
        
        ===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.
        
        
        
        [[File:Manual:configmanager-matomo-idSite.png|alt=matomo site ID|center|thumb|250x250px|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''.<br />[[File:Manual:configmanager-matomo-optout-footer.png|alt=footer links|center|thumb|450x450px|footer links]]<br />On the Analysis service page, there is a checkbox that allows a user to opt-out from being tracked for analysis purposes.[[File:Manual:configmanager-matomo-optout-checkbox.png|alt=Matomo opt-out checkbox|center|thumb|500x500px|Matomo opt-out checkbox]]<br />
        
        
        
        {{Box Links-en|Topic1=[[Reference:ConfigManager]]}}
        
        
        
        
        
        [[de:Handbuch:Erweiterung/{{SUBPAGENAME}}]]
        
        [[en:Manual:Extension/{{SUBPAGENAME}}]]