Last edited one year ago
by Margit Link-Rodrigue

Manual:Extension/BlueSpiceWikiFarm and Reference:BlueSpiceExtendedStatistics: Difference between pages

(Difference between pages)
VisualWikitext
No edit summary
Tag: 2017 source edit
 
No edit summary
Tag: 2017 source edit
 
Line 1: Line 1:
{{Messagebox|boxtype=note|Note text=WikiFarm is not a standard feature of BlueSpice pro and needs to be acquired separately.}}
{{BSExtensionInfo
'''WikiFarm''' is an architecture for BlueSpice wikis that can be used to centrally manage multiple wikis. Wikis can be created, cloned, deleted, and suspended. An administrative interface is provided for this purpose. The architecture also facilitates the maintenance of the wikis, since all wikis in the farm can be updated simultaneously.
|status=stable
|developer=HalloWelt
|type=BlueSpice
|edition=BlueSpice pro, BlueSpice free (deactivated), BlueSpice Farm, BlueSpice Cloud
|compatible=BlueSpice
|category=Reporting
|license=GPL v3 only
|features='''ExtendedStatistics''' provides an analytic view of many relevant parameters on the wiki, providing wiki administrators better insight into the usage of the wiki.


==Farm administration==
ExtendedStatistics can be accessed from the pages ''Special:ExtendedStatistics'' and ''Special:AggregatedStatistic''.


===Terminology===


*'''WikiFarm:''' Central administration of all existing wikis.
For the Snapshot statistics (=AggregatedStatistic) to return any data, the following cronjob needs to run:
*'''Root wiki:''' The wiki that is used as administration interface for all wiki instances.
*'''Wiki instance:''' A single wiki in the farm.
*'''Master wiki:''' A wiki that provides the content for pre-filling a new wiki. This wiki can be copied by cloning.<br /><br />


==Access==
In <code>crontab -e</code>:
The WikiFarm is implemented like a standalone and complete BlueSpice wiki and can be accessed at a certain URL. On the special page <code>Special:SimpleFarmer</code> you can access the farm management functions. In the list of all special pages (<code>Special:SpecialPages</code>) you can find the farm management in the section ''BlueSpice''.
<code>0 1 * * * php <path-to-wiki>/extensions/BlueSpiceExtendedStatistics/maintenance/generateSnapshot.php --interval=day --skip-timecheck</code>
<br />
[[File:farm-mainpage-EN.png|alt=Farm management|center|thumb|650x650px|Farm management]]


It offers analysis of many aspects of wiki, like:


The farm management displays a complete list of all existing wiki instances with information about:
*Number of users.
*Number of pages.
*Edits per user.
*Search queries and more.


*Site name (links to the wiki)
This data can be filtered:
*Globally searchable: Makes the wiki available to interwiki search between all wiki instances.
*Date of creation
*Keywords (meta information)
*Description (meta information)


The list is filterable and sortable.
*By defining the period (from and to date).
*Granulation (interval to show on diagram - day, week, month, year).
*Type (absolute, aggregate and list modes).
*Additional filters depending of the data being represented.


==Features==
Some aspects of this extension can be configured with the [[Special:BlueSpiceConfigManager{{!}}Config manager]], under ''ExtendedStatistics''. Here, wiki administrators can configure:
In the administrative interface you can:


*Create a wiki
*the users to exclude from statistical analysis
*Clone a wiki
*the maximum number of interval steps
*Remove a wiki
|desc=Provides an analytic view of many relevant parameters on the wiki.
*Suspend a wiki (archive)
}}
*Exclude a wiki from interwiki search
{{wcagCheck
*Add meta information for each wiki
|wcagStatus=2-testing complete
 
|wcagCheckedfor=Web
===Create a wiki===
|wcagTestdate=2022-08-08
Using the button ''Create Wiki'', you create a new wiki instance:
|wcagLevel=AA
 
|wcagSupport=does not support
#'''Enter''' a site name
|wcagWorkaround=no
#Click ''OK''. <br />[[File:farm-createwiki-EN.png|alt=Creating a wiki instance|center|thumb|450x450px|Creating a wiki instance]]
|wcagComments=most output formats only available and exportable as svg and not in text-based format.
 
|extensionType=extended
The individual wiki instances need a unique URL to make it accessible in the browser. This is automatically generated from the entered site name.
|extensionFocus=admin
 
}}
'''An example:'''
 
The WikiFarm is accessible at the URL <code><nowiki>https://wiki.bluespice.com</nowiki></code>.
 
While creating the wiki instance, the site name "hallo welt" has been chosen. Due to this, the following path - and therefore also the URL - of the new wiki instance will be generated:
 
<code><nowiki>https://wiki.bluespice.com/hallo-welt</nowiki></code>
 
{{Messagebox|boxtype=note|Note text=The website title and path cannot be changed after creating the wiki.}}
 
===Clone a wiki===
To clone a wiki, you select an already created wiki as a source. Clicking on the list entry marks the selected wiki and activates the ''Clone Wiki'' button. In the dialog window, you can enter a site name and change the path (optional).
 
In contrast to creating a new wiki, content and data will already be transferred during the cloning process. All articles, users, settings, namespaces, etc. are copied to the new wiki. This is, therefore, a one-to-one copy of the source wiki. This makes it possible to create master wikis, pre-fill and easily duplicate them as needed.
 
===Remove a wiki===
Deleting a Wiki is easy: just select a wiki in the list, click on the button "Remove Wiki" and the corresponding dialogue will open. Only the path to the wiki needs to be entered here. This corresponds to the name of the wiki instance as it is listed in the farm manager. Enter this in the correct notation (delimiter, uppercase and lowercase) in the field and confirm with OK. The wiki will be deleted completely.
===Suspend a wiki (archive)===
If you do not want to delete a wiki directly, but want to keep the contents for a while, you can also suspend and therefore archive it. The shutdown causes that the wiki becomes unavailable. When trying to access it via the URL, you will be redirected to the farm management.
 
Suspended wiki instances remain in the list of the farm management, but they are crossed out and the site name no longer links to the instance.
===Adding meta information===
The individual wikis can be described with additional metadata using the button ''Edit wiki meta''. The following meta information can be provided:
 
*Description
*Group
*Keywords
 
If there is any information from other wikis in ''group'' and ''keywords'', this information can be selected in a drop-down menu.
 
<br />
[[File:farm-metainformation-EN.png|alt=Editing meta information|center|thumb|450x450px|Editing meta information]]
 
 
The ''description'' and the ''keywords'' will be displayed as additional information in the list of the farm manager. This makes them filterable and sortable. The ''group'' is different to these information, because it is just a grouping of the wikis in the list. The groups can be expanded and collapsed.
 
===Creating new groups and keywords===
''Groups'' and ''keywords'' are created directly in the dialog window for entering meta information of a wiki instance.
 
*'''Group:''' If you need a new group for a wiki instance, enter the name in the text field and click ''Done''.
*'''Keyword:''' If you want to create a new keyword, enter the keyword in the text field and finish it with a comma. Then click done.
 
==Valid site names and paths==
When creating and cloning a wiki, you can also use spaces or umlauts when entering the site name. Spaces are automatically converted to hyphens and umlauts according the right notation, e.g. "Ü" to "ue". Also upper and lower case is possible and is taken into account.
 
When removing a wiki instance, the system is not as tolerant. The input must match one-to-one with the path specification so that the wiki can be deleted.
 
==Logs==
All actions are stored in a logfile so that they can be tracked.
<br />{{Box Links-en
|Topic1=[[Manual:Extension/ContentTransfer| Copying and publishing contents between wiki instances]]
|Topic2=[[Setup:Installation Guide/Installation BlueSpice WikiFarm|WikiFarm installation]]
}}<br />
 
[[en:{{FULLPAGENAME}}]]
[[de:WikiFarm]]

Revision as of 13:20, 30 November 2022

Extension: BlueSpiceExtendedStatistics

all extensions

Overview
Description:

Statistics module for BlueSpice

State: stable Dependency: BlueSpice
Developer: HalloWelt License: GPL-3.0-only
Type: BlueSpice Category: Reporting
Edition: BlueSpice pro, BlueSpice free (deactivated), BlueSpice Farm, BlueSpice Cloud Version: 4.1+
View user help page

Features

ExtendedStatistics provides an analytic view of many relevant parameters on the wiki, providing wiki administrators better insight into the usage of the wiki.

ExtendedStatistics can be accessed from the pages Special:ExtendedStatistics and Special:AggregatedStatistic.


For the Snapshot statistics (=AggregatedStatistic) to return any data, the following cronjob needs to run:

In crontab -e: 0 1 * * * php <path-to-wiki>/extensions/BlueSpiceExtendedStatistics/maintenance/generateSnapshot.php --interval=day --skip-timecheck

It offers analysis of many aspects of wiki, like:

  • Number of users.
  • Number of pages.
  • Edits per user.
  • Search queries and more.

This data can be filtered:

  • By defining the period (from and to date).
  • Granulation (interval to show on diagram - day, week, month, year).
  • Type (absolute, aggregate and list modes).
  • Additional filters depending of the data being represented.

Some aspects of this extension can be configured with the Config manager, under ExtendedStatistics. Here, wiki administrators can configure:

  • the users to exclude from statistical analysis
  • the maximum number of interval steps

Technical Information

This information applies to BlueSpice 4. Technical details for BlueSpice Cloud can differ in some cases.

Requirements

  • MediaWiki: 1.38.0
  • BlueSpiceFoundation: 4.1

Integrates into

  • BlueSpiceExtendedStatistics
  • BlueSpiceVisualEditorConnector
  • ContentDroplets

Special pages

  • AggregatedStatistic
  • ExtendedStatistics

Permissions

Name Description Role
extendedstatistics-viewspecialpage-aggregated Access the special page Special:AggregatedStatistic admin, maintenanceadmin
statistic-viewspecialpage Access to extended statistic admin, maintenanceadmin

Configuration

Name Value
StatisticsAvailableGrains array ( 'Y' => 'bs-statistics-year', 'm' => 'bs-statistics-month', 'W' => 'bs-statistics-week', 'd' => 'bs-statistics-day', )
StatisticsExcludeUsers array ( 0 => 'WikiSysop', )
StatisticsMaxNumberOfIntervals 366
StatisticsSnapshotStoreType 'database'

API Modules

  • bs-statistics-available-diagrams-store
  • bs-statistics-search-options-store
  • bs-statistics-tasks

Hooks

Accessibility

Test status: 2-testing complete
Checked for: Web
Last test date: 2022-08-08
WCAG level: AA
WCAG support: does not support (workaround: no)
Comments:

most output formats only available and exportable as svg and not in text-based format.

Extension type: extended
Extension focus: admin
Technical Reference: BlueSpiceWikiFarm


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

Retrieved from "https://en.wiki.bluespice.com/w/index.php?title=Manual:Extension/BlueSpiceWikiFarm&oldid=5320"

Discussions