Difference between revisions of "Manual:Extension/BlueSpiceSmartList"
| [quality revision] | [quality revision] |
(Changed categories.) |
(Tag: Visual edit) |
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.
Contents
Available tags[edit | edit source]
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[edit | edit source]
Parameters[edit | edit source]
The SmartList can be limited or extended with the following parameters:
Count -| 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 given namespace will be listed. The namespaces can be entered by IDs or by names. Several namespaces can be named with pipes: ns="0|2|5" or ns="Help|User|Test". Default: All namespaces are included. |
Exclude NS - excludens
Articles from given namespaces will not be shown. The namespaces can be entered by IDs or by names. Several namespaces can be named with pipes: ns="0|2|5" or ns="Help|User|Test". Default: All namespaces are included.
Category - cat
|
Category |
cat | name |
Only articles from given category will be listed. Selecting several categories is not possible. Default: All categories. |
|
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 given period are shown. |
|
Default: No limit. |
|
Show only new articles |
|
|
new | true, false |
Only new pages will be listed. Default: All pages are shown |
Trim - trim
| 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 after 30 characters. |
|
Show text |
showtext | true, false |
With this option, a line of the article contents will be shown alongside the title. |
|
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. |
| 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. |
<bs:smartlist modecategory="recentchangesISO9001" new="true" count="7" ns="104" trim="false" />
Newbies[edit | edit source]
The tag <bs:newbies /> shows recently registered wiki users.
Parameters[edit | edit source]
| Label | Parameter | Values | Description |
|
Count - count |
The number of users to be shown; the default value is 10. |
Example in wikicode[edit | edit source]
<bs:newbies count="7"/>
Toplist[edit | edit source]
This tag shows a list of the most visited pages.
Parameters[edit | edit source]
Count -| 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 |
|
. The default is alltime. |
Example in wikicode[edit | edit source]
<bs:toplist count="7" ns="Help|QM" />
Related info
{{DISPLAYTITLE:Generate page lists (smart lists)}}
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==
[[File:Smartlist2.png|Magic word ''smartlist'' in VisualEditor|alt=Magic word smartlist in VisualEditor|center|450x450px|thumb]]
The extension SmartList offers three different tags:
*<code><nowiki><bs:smartlist /></nowiki></code> - display a list of pages based on different criteria
*<code><nowiki><bs:newbies /></nowiki></code> - display a list of recentrly registered users
*<code><nowiki><bs:toplist /></nowiki></code> - display a list of most visited pages
All of the tags listed above can be added through the menu ''Insert > Magic word'' in [[Manual:Extension/VisualEditor|VisualEditor]]. For more information on how to insert magic words, see [[Manual:Extension/BlueSpiceInsertMagic|InsertMagic]].
==Smartlist==
[[File:Smartlist3.png|Options of the ''smartlist'' tag|alt=Options of the smartlist tag|center|650x650px|thumb]]
===Parameters===
The SmartList can be limited or extended with the following parameters:
{| class="contenttable" style="width:531px100%;" cellspacing="0" cellpadding="5" border="0"
|-
| style="" |
Count -'''count'''
Label
|Parameter
|Values
|Description
|-
| style="" |
Count
|'''count'''
|number
| style="" |
The number of articles to be shown. Default value: 5
|-
| style="" |
Namespaces - '''ns'''
Namespace(s)
|'''ns'''
|number or name
| style="" |
Only articles from given namespace will be listed. The namespaces can be entered by IDs or by names. Several namespaces can be named with pipes: ns="0|2|5" or ns="Help|User|Test". Default: All namespaces are included.
|-
| style="" |
Exclude NS - '''excludens'''
| style="" |
Articles from given namespaces will not be shown. The namespaces can be entered by IDs or by names. Several namespaces can be named with pipes: ns="0|2|5" or ns="Help|User|Test". Default: All namespaces are included.
|-
| style="" |
Category - '''cat'''
| style="" |
Only articles from given category will be listed. Selecting several categories is not possible. Default: All categories.
|-
| style="" |
Show minor - '''nominor'''
Category
|'''cat'''
|name
| style="" |
Only articles from given category will be listed. Selecting several categories is not possible. Default: All categories.
|-
| style="" |
Category mode
|'''catmode'''
|AND, OR
| style="" |
Show pages if they are in at least one of the categories (OR) or show pages if they are tagged with all categories (AND).
|-
| style="" |
Show minor
|'''minor'''
|true, false
| style="" |
Minor changes (changes marked with an "m" in the recent changes) will not be listed. Default: Minor changes are listed.
|-
| style="" |
Period
- |'''period'''
| -, month, week, day
| style="" |
Only changes within given period are shown. Possible values: 'month', 'week', 'day'. Default: No limit.
|-
| style="" |
Show only new articles
- |'''new'''
|true, false
| style="" |
Only new pages will be listed. Default: All pages are shown
|-
| style="" |
Trim - '''trim'''
|-
|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.
|-
| style="" |
Trim
|'''trim'''
|number
| style="" |
Long article names are not cropped. Default: The title is cut off after 30 characters.
|-
| style="" |
Show text
|'''showtext'''
|true, false
| style="" |
With this option, a line of the article contents will be shown alongside the title.
|-
| style="" |
Trim text
- |'''trimtext'''
|number
| style="" |
"trimtext" sets the number of characters of an article's content shown. This is only relevant when ''showtext="true"''). ''Note'': trimtext="0" is <u>not</u> possible.
||-
|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
|-
| style="" |
Exclude namespace(s)
|'''excludens'''
|number or name
| style="" |
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:'''
<nowiki><bs:smartlist mode="recentchangescategory="ISO9001" new="true" count="7" ns="104" trim="false" /></nowiki>
==Newbies==
The tag <code><nowiki><bs:newbies /></nowiki></code> shows recently registered wiki users.
===Parameters===
{| class="contenttable" style="width:531px100%;" cellspacing="0" cellpadding="5" border="0"
|-
| style="" |
Count - '''count'''
| Label
|Parameter
|Values
|Description
|-
| style="" |
Count - '''count'''
|
|
| style="" |
The number of users to be shown; the default value is 10.
|}
===Example in wikicode===
<pre><bs:newbies count="7"/></pre>
==Toplist==
This tag shows a list of the most visited pages.
===Parameters===
{| class="contenttable" style="width:531px100%;" cellspacing="0" cellpadding="5" border="0"
|-
| style="" |
Count - '''count'''
!Label
!Paramter
!Values
!Description
|-
| style="" |
Count
|'''count'''
|number
| style="" |
The number of articles to be shown; the default value is 10.
|-
| style="" |
Namespaces
- |'''ns'''
|text, text
| style="" |
Only articles from these namespace will be shown. You can put several namespaces here, separated by commas.
|-
| style="" |
Category
- |'''cat'''
|text, text
| style="" |
Only articles from this category will be shown. You can put several categories here, separated by commas.
|-
| style="" |
Period
- |'''period'''
|month, alltime
| style="" |
The period that should be used (alltime or month). The default is alltime.
|}
===Example in wikicode===
<pre><bs:toplist count="7" ns="Help|QM" /></pre>
{{Box Links-en|Topic1=[[Reference:BlueSpiceSmartList]]|Topic2=[[Reference:BlueSpiceInsertMagic]]}}
{{Translation}}
__FORCETOC__
[[Category:Organization]]| Line 21: | Line 21: | ||
The SmartList can be limited or extended with the following parameters: | The SmartList can be limited or extended with the following parameters: | ||
| − | {| class="contenttable" style="width: | + | {| class="contenttable" style="width:100%;" cellspacing="0" cellpadding="5" border="0" |
| + | |Label | ||
| + | |Parameter | ||
| + | |Values | ||
| + | |Description | ||
|- | |- | ||
| style="" | | | style="" | | ||
| − | Count | + | Count |
| − | + | |'''count''' | |
| + | |number | ||
| style="" | | | style="" | | ||
The number of articles to be shown. Default value: 5 | The number of articles to be shown. Default value: 5 | ||
| Line 31: | Line 36: | ||
|- | |- | ||
| style="" | | | style="" | | ||
| − | + | Namespace(s) | |
| − | + | |'''ns''' | |
| + | |number or name | ||
| style="" | | | style="" | | ||
Only articles from given namespace will be listed. The namespaces can be entered by IDs or by names. Several namespaces can be named with pipes: ns="0|2|5" or ns="Help|User|Test". Default: All namespaces are included. | Only articles from given namespace will be listed. The namespaces can be entered by IDs or by names. Several namespaces can be named with pipes: ns="0|2|5" or ns="Help|User|Test". Default: All namespaces are included. | ||
| Line 38: | Line 44: | ||
|- | |- | ||
| style="" | | | style="" | | ||
| − | + | Category | |
| − | + | |'''cat''' | |
| + | |name | ||
| style="" | | | style="" | | ||
| − | + | Only articles from given category will be listed. Selecting several categories is not possible. Default: All categories. | |
|- | |- | ||
| style="" | | | style="" | | ||
| − | Category | + | Category mode |
| − | + | |'''catmode''' | |
| + | |AND, OR | ||
| style="" | | | style="" | | ||
| − | + | Show pages if they are in at least one of the categories (OR) or show pages if they are tagged with all categories (AND). | |
|- | |- | ||
| style="" | | | style="" | | ||
| − | Show minor | + | Show minor |
| − | + | |'''minor''' | |
| + | |true, false | ||
| style="" | | | style="" | | ||
Minor changes (changes marked with an "m" in the recent changes) will not be listed. Default: Minor changes are listed. | Minor changes (changes marked with an "m" in the recent changes) will not be listed. Default: Minor changes are listed. | ||
| Line 59: | Line 68: | ||
|- | |- | ||
| style="" | | | style="" | | ||
| − | Period | + | Period |
| − | + | |'''period''' | |
| + | | -, month, week, day | ||
| style="" | | | style="" | | ||
| − | Only changes within given period are shown | + | Only changes within given period are shown. Default: No limit. |
|- | |- | ||
| style="" | | | style="" | | ||
| − | Show only new articles | + | Show only new articles |
| − | + | |'''new''' | |
| + | |true, false | ||
| style="" | | | style="" | | ||
Only new pages will be listed. Default: All pages are shown | 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. | ||
|- | |- | ||
| style="" | | | style="" | | ||
| − | Trim | + | Trim |
| − | + | |'''trim''' | |
| + | |number | ||
| style="" | | | style="" | | ||
Long article names are not cropped. Default: The title is cut off after 30 characters. | Long article names are not cropped. Default: The title is cut off after 30 characters. | ||
| Line 80: | Line 106: | ||
|- | |- | ||
| style="" | | | style="" | | ||
| − | Show text '''showtext''' | + | Show text |
| − | + | |'''showtext''' | |
| + | |true, false | ||
| style="" | | | style="" | | ||
With this option, a line of the article contents will be shown alongside the title. | With this option, a line of the article contents will be shown alongside the title. | ||
| Line 87: | Line 114: | ||
|- | |- | ||
| style="" | | | style="" | | ||
| − | Trim text | + | Trim text |
| − | + | |'''trimtext''' | |
| + | |number | ||
| style="" | | | style="" | | ||
"trimtext" sets the number of characters of an article's content shown. This is only relevant when ''showtext="true"''). ''Note'': trimtext="0" is <u>not</u> possible. | "trimtext" sets the number of characters of an article's content shown. This is only relevant when ''showtext="true"''). ''Note'': trimtext="0" is <u>not</u> possible. | ||
| + | |- | ||
| + | |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 | ||
| + | |- | ||
| + | | style="" | | ||
| + | Exclude namespace(s) | ||
| + | |'''excludens''' | ||
| + | |number or name | ||
| + | | style="" | | ||
| + | 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:''' | |}'''Example output in source code:''' | ||
| − | <nowiki><bs:smartlist | + | <nowiki><bs:smartlist category="ISO9001" new="true" count="7" ns="104" trim="false" /></nowiki> |
==Newbies== | ==Newbies== | ||
The tag <code><nowiki><bs:newbies /></nowiki></code> shows recently registered wiki users. | The tag <code><nowiki><bs:newbies /></nowiki></code> shows recently registered wiki users. | ||
===Parameters=== | ===Parameters=== | ||
| − | {| class="contenttable" style="width: | + | {| class="contenttable" style="width:100%;" cellspacing="0" cellpadding="5" border="0" |
| + | |Label | ||
| + | |Parameter | ||
| + | |Values | ||
| + | |Description | ||
|- | |- | ||
| style="" | | | style="" | | ||
Count - '''count''' | Count - '''count''' | ||
| − | + | | | |
| + | | | ||
| style="" | | | style="" | | ||
The number of users to be shown; the default value is 10. | The number of users to be shown; the default value is 10. | ||
| Line 116: | Line 176: | ||
===Parameters=== | ===Parameters=== | ||
| − | {| class="contenttable" style="width: | + | {| class="contenttable" style="width:100%;" cellspacing="0" cellpadding="5" border="0" |
| + | !Label | ||
| + | !Paramter | ||
| + | !Values | ||
| + | !Description | ||
|- | |- | ||
| style="" | | | style="" | | ||
| − | Count | + | Count |
| − | + | |'''count''' | |
| + | |number | ||
| style="" | | | style="" | | ||
The number of articles to be shown; the default value is 10. | The number of articles to be shown; the default value is 10. | ||
| Line 126: | Line 191: | ||
|- | |- | ||
| style="" | | | style="" | | ||
| − | Namespaces | + | Namespaces |
| − | + | |'''ns''' | |
| + | |text, text | ||
| style="" | | | style="" | | ||
Only articles from these namespace will be shown. You can put several namespaces here, separated by commas. | Only articles from these namespace will be shown. You can put several namespaces here, separated by commas. | ||
| Line 133: | Line 199: | ||
|- | |- | ||
| style="" | | | style="" | | ||
| − | Category | + | Category |
| − | + | |'''cat''' | |
| + | |text, text | ||
| style="" | | | style="" | | ||
Only articles from this category will be shown. You can put several categories here, separated by commas. | Only articles from this category will be shown. You can put several categories here, separated by commas. | ||
| Line 140: | Line 207: | ||
|- | |- | ||
| style="" | | | style="" | | ||
| − | Period | + | Period |
| − | + | |'''period''' | |
| + | |month, alltime | ||
| style="" | | | style="" | | ||
| − | The period that should be used | + | The period that should be used. The default is alltime. |
|} | |} | ||