Reference:BlueSpiceSmartList

Extension: BlueSpiceSmartList

Overview
Description:	introduces a tag that can be placed on any page to show a list of most relevant pages. Displays the last five changes of the wiki in a list
State:	stable	Dependency:	BlueSpice
Developer:	HalloWelt	License:	GPL-3.0-onlyProperty "BSExtensionInfoLicense" (as page type) with input value "</br>GPL-3.0-only" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process.
Type:	BlueSpice	Category:	Reporting
Edition:	BlueSpice free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud
View help page

Features

SmartList introduces a tag

BlueSpiceSmartList introduces various tags that can be placed on any page to show a list of the most relevant pages

. Type of content it will display, as well as number of entries can be configured using different options in the tag. Usage / Features

• Using SmartList tag on a page, displays configurable list of pages.
• It can show different lists of pages, depending of configuration, like:
  • top last modified pages,
  • pages that link to this page,
  • pages that need approving (when using FlaggedRevs extensions)
  • and more...
• Length of the list (number of entries) can be configured
• Can show only pages in a particular namespace

Technical background

The SmartList is a tag which can be customised via various parameters. Up to BlueSpice Version 1.0.1 it was called "Infobox". Please note that in BlueSpice versions older than 1.20, the tag name "infobox" and not "smartlist" must be used. The function is similar to PagesVisited.

Where can I find the function SmartList?

You can integrate SmartList into an article, the widget bar or the user sidebar.

The functionality of SmartList

Add the tag where you want. <smartlist/> Add the parameters you want, for example:

                <bs:smartlist new="true" count="7" ns="104" trim="false" />
            

Recentchanges or Changesofweek

There are two basic options which you can choose using the parameter "mode":

• recentchanges shows the most recent changes. This is the default option.
• changesofweek shows the articles which have been chosen as a "Change of the week".

Example:

                <smartlist mode="changesofweek" />
            

Note: The relevant Hallo Welt extension must be activated to use 'changesofweek'.

Parameters for 'recentchanges'

The SmartList can be limited or extended with the following parameters:

count	The number of articles to be shown. Default value: 5
ns	Only articles from these namespace will be listed. The namespaces can be entered numerically or by names. Several namespaces can be named with commas: ns="0,2,5". Default: No limit.
excludens	Articles from these namespaces will not be shown. At the moment, the namespaces can be entered numerically or by names. Several namespaces can be named with commas: excludens="0,2,5". Default: No limit.
cat	Only articles from this category will be listed. Selecting several categories is not possible. Default: No limit.
nominor	Minor changes (changes marked with an "m" in the recent changes) will not be listed. Default: Minor changes are listed.
period	Only changes within this period are shown. Possible values: 'month', 'week', 'day'. Default: No limit.
new	Only new pages will be listed. Default: All pages are shown
trim	Long article names are not cropped. Default: The title is cut off at 30 characters.
showtext	With this option, a line of the article contents will be shown alongside the title: showtext="true".
trimtext	"trimtext" sets the number of characters of an article's content shown. This is only relevant when showtext="true"). Note: trimtext="0" is not possible.

The parameters are added to the tag.
Example:

                <smartlist new="true" count="7" ns="104" trim="false" />
            

This SmartList lists the seven newest articles from a particular namespace without shortening their titles. Parameters for 'changesofweek'

count	The number of articles to be shown. Default value: 5
period	Only changes within this period are shown. Possible values: 'month', 'week', 'day'. Default: No limit.

Example:

                <smartlist mode="changesofweek" count="10" />
            

What links here

A smartlist with the mode mode="whatlinkshere" shows all sites that link to this site - if you don't define a special site through "target" then smartlist will show all links to the page the smartlist-tag is used at. You can use all parameters of the mode 'recentchanges'.

Additional parameters for 'whatlinkshere'

target

page title - default: site on which the tag is used.

Beispiel:

                <bs:smartlist mode="whatlinkshere" target="Portal:Test" count="7" ns="0" trim="false"/>
            

SmartList in the widgets

The SmartList in the widgets can only changed by an admin under Preferences.

Ratings

If the extension Ratings integrated into the wiki, an overview of the most commonly evaluated pages can be inserted in the wiki code where you want (e.g. the start page) using SmartList. This happens via the wiki tag <smartlist mode="ratings" />. This will show the pages which have been evaluated most often. It does not matter whether they have had positive or negative evaluations. Only the amount of evaluations made is important.

The SmartList of the pages evaluated also has some parameters for customisation:

count	The number of articles to be shown; the default value is 5.
ns	Only articles from these namespace which have been evaluated will be listed.
excludens	No articles from this namespace will be listed.
showtext	With this option, a line of the article contents will be shown alongside the title. (showtext="true")
trimtext	Limits the number of characters shown of the article's contents. (trimtext="50")
showvotes	The number of evaluations made is given alongside the title. (showvotes="true")

Example:

                <smartlist mode="ratings" count="9" showtext="true" /> 
            

In this example, 9 articles will be listed which have been evaluated most often. At the same time, a line of each article will be shown.

Approval

An example for displaying approvals (the right extension is needed):

                <smartlist mode="flaggedrevisions" ns="502" count="7"/> 
            

Further functions

Most clicked article

The <bs:toplist /> tag creates a list of the most clicked articles in the wiki.

The following are possible parameters:

count	The number of articles to be shown; the default value is 10.
ns	Only articles from these namespace will be shown. You can put several namespaces here, separated by commas.
cat	Only articles from this category will be shown. You can put several categories here, separated by commas.
period	The period that should be used (alltime or month). The default is alltime.

New members

The<bs:newbies/> tag shows the newest members of the wiki.

The following are possible parameters:

count

The number of members to be shown; the default value is 10.

based on different criteria.

The tag newbies shows the latest added user accounts. The toplist tag shows the most popular content pages.

The tag smartlist accepts the following parameters:

• categories to show
• whether to show comments
• number of results
• namespace
• sort order
• time period
• show minor changes
• show page title with namespace
• only show new pages
• show page content
• maximum length of the title (in characters).
• maximum length of the page content (in characters).

Technical Information

This information applies to BlueSpice 3 . Technical details for BlueSpice cloud can differ in some cases.

Requirements

• MediaWiki: 1.31

• BlueSpiceFoundation: 3.2

Integrates into

• BlueSpiceUserSidebar
• VisualEditor

Special pages

API Modules

• bs-smartlist-tasks

Hooks

• BSInsertMagicAjaxGetData
• BSUsageTrackerRegisterCollectors