Difference between revisions of "Manual:Extension/BlueSpiceSmartList"
| [unchecked revision] | [unchecked revision] |
m (Text replacement - "<bs:bookshelf src="Book:User manual" />" to "") |
(Tag: 2017 source edit) |
Contents
What is BlueSpiceSmartList?[edit | edit source]
BlueSpiceSmartList introduces a number of tags that can be placed on any page to show a list of most relevant pages based on different criteria.
Available tags[edit | edit source]
BlueSpiceSmartList offers three different tags:
-
<bs:smartlist />- main tag used to display list of pages based on various criteria -
<bs:newbies />- displays list of recentrly registered users -
<bs:toplist />- displays list of most visited pages
Where to find the function BlueSpiceSmartList?[edit | edit source]
All of the tags listed above can be added through "Insert magic" menu of VisualEditor. For more information on how to insert magic words, see BlueSpiceInsertMagic.
Tag <bs:smartlist>[edit | edit source]
Once the tag is added to the page, configuration dialog (inspector) is shown. Two modes for showing pages are offered:
- 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".
Parameters[edit | edit source]
The SmartList can be limited or extended with the following parameters:
|
Count -count |
The number of articles to be shown. Default value: 5 |
|
Namespaces - ns |
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 |
Only articles from given category will be listed. Selecting several categories is not possible. Default: All categories. |
|
Show minor - nominor |
Minor changes (changes marked with an "m" in the recent changes) will not be listed. Default: Minor changes are listed. |
|
Period - period |
Only changes within given period are shown. Possible values: 'month', 'week', 'day'. Default: No limit. |
|
Show only new articles - new |
Only new pages will be listed. Default: All pages are shown |
|
Trim - trim |
Long article names are not cropped. Default: The title is cut off after 30 characters. |
|
Show text showtext |
With this option, a line of the article contents will be shown alongside the title. |
|
Trim text - 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. |
Example in wikicode[edit | edit source]
Of course, bs:smartlist tag can be added directly into wikitext:
<bs:smartlist mode="recentchanges" new="true" count="7" ns="104" trim="false" />
Tag <bs:newbies>[edit | edit source]
The<bs:newbies/>tag shows the recently registered members on the wiki.
Parameters[edit | edit source]
|
Count - count |
The number of users to be shown; the default value is 10. |
Example in wikicode[edit | edit source]
<bs:newbies count="7"/>
Tag <bs:toplist>[edit | edit source]
This tag shows list of most visited pages.
Parameters[edit | edit source]
|
Count - count |
The number of articles to be shown; the default value is 10. |
|
Namespaces - ns |
Only articles from these namespace will be shown. You can put several namespaces here, separated by commas. |
|
Category - cat |
Only articles from this category will be shown. You can put several categories here, separated by commas. |
|
Period - period |
The period that should be used (alltime or month). The default is alltime. |
Example in wikicode[edit | edit source]
<bs:toplist count="7" ns="Help|QM" />
See also[edit | edit source]
Reference page for this extension.
Related info
__TOC__
==What is BlueSpiceSmartList?==
'''BlueSpiceSmartList''' introduces a number of tags that can be placed on any page to show a list of most relevant pages based on different criteria.
==Available tags==
[[File:Smartlist2.png|thumb|Available tags in "Insert magic" dialog|alt=Available tags in "Insert magic" dialog|border|center|603x603px]]
BlueSpiceSmartList offers three different tags:
*<code><nowiki><bs:smartlist /></nowiki></code> - main tag used to display list of pages based on various criteria
*<code><nowiki><bs:newbies /></nowiki></code> - displays list of recentrly registered users
*<code><nowiki><bs:toplist /></nowiki></code> - displays list of most visited pages
{{Clear}}
==Where to find the function BlueSpiceSmartList?==
All of the tags listed above can be added through "Insert magic" menu of [[Manual:Extension/VisualEditor|VisualEditor]]. For more information on how to insert magic words, see [[Manual:Extension/BlueSpiceInsertMagic|BlueSpiceInsertMagic]].
==Tag <bs:smartlist>==
[[File:Smartlist3.png|thumb|Options of bs:smartlist tag|alt=Options of bs:smartlist tag|border|center|650x650px]]
Once the tag is added to the page, configuration dialog (inspector) is shown. Two modes for showing pages are offered:
*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".
===Parameters===
The SmartList can be limited or extended with the following parameters:
{| class="contenttable" style="width: 531px; height: 373px;" cellspacing="0" cellpadding="5" border="0"
|-
| style="border: 1px solid #ebecec;" |
Count -'''count'''
| style="border: 1px solid #ebecec;" |
The number of articles to be shown. Default value: 5
|-
| style="border: 1px solid #ebecec;" |
Namespaces - '''ns'''
| style="border: 1px solid #ebecec;" |
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="border: 1px solid #ebecec;" |
Exclude NS - '''excludens'''
| style="border: 1px solid #ebecec;" |
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="border: 1px solid #ebecec;" |
Category - '''cat'''
| style="border: 1px solid #ebecec;" |
Only articles from given category will be listed. Selecting several categories is not possible. Default: All categories.
|-
| style="border: 1px solid #ebecec;" |
Show minor - '''nominor'''
| style="border: 1px solid #ebecec;" |
Minor changes (changes marked with an "m" in the recent changes) will not be listed. Default: Minor changes are listed.
|-
| style="border: 1px solid #ebecec;" |
Period - '''period'''
| style="border: 1px solid #ebecec;" |
Only changes within given period are shown. Possible values: 'month', 'week', 'day'. Default: No limit.
|-
| style="border: 1px solid #ebecec;" |
Show only new articles - '''new'''
| style="border: 1px solid #ebecec;" |
Only new pages will be listed. Default: All pages are shown
|-
| style="border: 1px solid #ebecec;" |
Trim - '''trim'''
| style="border: 1px solid #ebecec;" |
Long article names are not cropped. Default: The title is cut off after 30 characters.
|-
| style="border: 1px solid #ebecec;" |
Show text '''showtext'''
| style="border: 1px solid #ebecec;" |
With this option, a line of the article contents will be shown alongside the title.
|-
| style="border: 1px solid #ebecec;" |
Trim text - '''trimtext'''
| style="border: 1px solid #ebecec;" |
"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.
|}
===Example in wikicode===
Of course, bs:smartlist tag can be added directly into wikitext:
<pre><bs:smartlist mode="recentchanges" new="true" count="7" ns="104" trim="false" /></pre>
==Tag <bs:newbies>==
The<pre><bs:newbies/></pre> tag shows the recently registered members on the wiki.
===Parameters===
{| class="contenttable" style="width: 531px; height: 65px;" cellspacing="0" cellpadding="5" border="0"
|-
| style="border: 1px solid #ebecec;" |
Count - '''count'''
| style="border: 1px solid #ebecec;" |
The number of users to be shown; the default value is 10.
|}
===Example in wikicode===
<pre><bs:newbies count="7"/></pre>
==Tag <bs:toplist>==
[[File:Smartlist2.png|thumb|Options of bs:toplist tagOptions of bs:smartlist tag<br />|alt=Options of bs:smartlist tag|border|center|603x603px]]
This tag shows list of most visited pages.
===Parameters===
{| class="contenttable" style="width: 531px; height: 65px;" cellspacing="0" cellpadding="5" border="0"
|-
| style="border: 1px solid #ebecec;" |
Count - '''count'''
| style="border: 1px solid #ebecec;" |
The number of articles to be shown; the default value is 10.
|-
| style="border: 1px solid #ebecec;" |
Namespaces - '''ns'''
| style="border: 1px solid #ebecec;" |
Only articles from these namespace will be shown. You can put several namespaces here, separated by commas.
|-
| style="border: 1px solid #ebecec;" |
Category - '''cat'''
| style="border: 1px solid #ebecec;" |
Only articles from this category will be shown. You can put several categories here, separated by commas.
|-
| style="border: 1px solid #ebecec;" |
Period - '''period'''
| style="border: 1px solid #ebecec;" |
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>
==See also==
[[Reference:SmartList|Reference page]] for this extension.
{{Box Links-en|Topic1=[[Reference:BlueSpiceSmartList]]}}
{{Translation}}| Line 1: | Line 1: | ||
| − | |||
__TOC__ | __TOC__ | ||
| Line 8: | Line 7: | ||
==Available tags== | ==Available tags== | ||
| − | [[File:Smartlist2.png| | + | [[File:Smartlist2.png|Available tags in "Insert magic" dialog|alt=Available tags in "Insert magic" dialog|border|center|603x603px]] |
BlueSpiceSmartList offers three different tags: | BlueSpiceSmartList offers three different tags: | ||
| Line 21: | Line 20: | ||
==Tag <bs:smartlist>== | ==Tag <bs:smartlist>== | ||
| − | [[File:Smartlist3.png| | + | [[File:Smartlist3.png|Options of bs:smartlist tag|alt=Options of bs:smartlist tag|border|center|650x650px]] |
Once the tag is added to the page, configuration dialog (inspector) is shown. Two modes for showing pages are offered: | Once the tag is added to the page, configuration dialog (inspector) is shown. Two modes for showing pages are offered: | ||
| Line 128: | Line 127: | ||
==Tag <bs:toplist>== | ==Tag <bs:toplist>== | ||
| − | [[File:Smartlist2.png| | + | [[File:Smartlist2.png|Options of bs:smartlist tag<br />|alt=Options of bs:smartlist tag|border|center|603x603px]] |
This tag shows list of most visited pages. | This tag shows list of most visited pages. | ||
| Line 168: | Line 167: | ||
| − | = | + | {{Box Links-en|Topic1=[[Reference:BlueSpiceSmartList]]}} |
| − | [[Reference: | ||
{{Translation}} | {{Translation}} | ||
