Manual:Extension/BlueSpiceSmartList

What is SmartList?

The extension SmartList allows to insert a list of pages in a wiki page using the tags smartlist, newbies, or toplist. The selection criteria can be set using a dialog box.

Available tags

SmartList introduces a tag that can be placed on any page to show a list of most relevant pages. Type of content it will display, as well as number of entries can be configured using different options in the tag.

Where to find the function SmartList?

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

The functionality of SmartList

Magic word smartlist in VisualEditor

The extension SmartList offers three different tags:

• <bs:smartlist /> - display a list of pages based on different criteria
• <bs:newbies /> - display a list of recentrly registered users
• <bs:toplist /> - display a list of most visited pages

All of the tags listed above can be added through the menu Insert > Magic word in VisualEditor. For more information on how to insert magic words, see InsertMagic.

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'

Options of the smartlist tag

Parameters

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

Label	Parameter	Values	Description
Count	count	number	The number of articles to be shown. Default value: 5
Namespace(s)	ns	number or name	Only articles from

these

given namespace will be listed. The namespaces can be entered

numerically

by IDs or by names. Several namespaces can be named with

commas

pipes: 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

or ns="Help|User|Test". Default:

No limit

All namespaces are included.
Category	cat	name	Only articles from

this

given category will be listed. Selecting several categories is not possible. Default:

No limit

All categories.

nominor

Category mode	catmode	AND, OR	Show pages if they are in at least one of the categories (OR) or show pages if they are tagged with all categories (AND).
Show minor	minor	true, false	Minor changes (changes marked with an "m" in the recent changes) will not be listed. Default: Minor changes are listed.
Period	period	-, month, week, day	Only changes within

this

given period are shown.

Possible values: 'month', 'week', 'day'.

Default: No limit.
Show only new articles	new	true, false	Only new pages will be listed. Default: All pages are shown
Heading	heading	text	Adds a heading above the list
Sort by	sort	Title, Time	Sort results by title or by latest edited.
Sort order	order	asc, desc	Ascending or descending sort order.
Trim	trim	number	Long article names are not cropped. Default: The title is cut off

at

after 30 characters.
Show text	showtext	true, false	With this option, a line of the article contents will be shown alongside the title

: showtext="true"

.
Trim text	trimtext	number	"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"

Show namespaces	showns	true, false	If true, the namespace prefix is shown with the page names.
Number with text	numwithtext	number	Anzahl der Artikel die mit Einführungstext angezeigt werden sollen. Nur effektiv wenn showtext=true
Meta	meta	true	The username and date for the last edit are shown.
Target	target	-	Obsolete
Exclude namespace(s)	excludens	number or name	Articles from given namespaces will not be shown. The namespaces can be entered by IDs or by names (comma-separated). Default: All namespaces are included.

Example output in source code:

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

SmartList in the widgets

Newbies

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

Ratings

tag <bs:newbies /> shows recently registered wiki users.

Parameters

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:

Label	Parameter	Values	Description
Count - count			The number of

articles

users 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

10.

Example in wikicode

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

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

Further functionsToplist

Most clicked article

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

The following are possible parameters:

count

visited pages.

Parameters

Label	Paramter	Values	Description
Count	count	number	The number of articles to be shown; the default value is 10.
Namespaces	ns	text, text	Only articles from these namespace will be shown. You can put several namespaces here, separated by commas.
Category	cat	text, text	Only articles from this category will be shown. You can put several categories here, separated by commas.
Period	period	month, alltime	The period that should be used

(alltime or month)

. The default is alltime.

New membersExample in wikicode

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.

See also

Our reference page.

                <bs:toplist count="7" ns="Help|QM" />
            

Related info

• Reference:BlueSpiceSmartList
• Reference:BlueSpiceInsertMagic