Difference between revisions of "Manual:Extension/BlueSpiceSmartList"
| [unchecked revision] | [unchecked revision] |
(Tag: 2017 source edit) |
(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
User:Ptechnik, User:PraktiED, User:PraktiEG, User:Mkirsch, User:Fspinar
<bs:newbies />
- displays list of recentrly registered users
- Main Page (3431044)
- Setup:Installation Guide (190712)
- Reference:FlexiSkin (110669)
- Reference:BlueSpiceCountThings (102288)
- Archive:PasteImage (98889)
- Wiki (93315)
- Reference:BlueSpiceAuthors (92604)
- Archive:Preferences (79338)
- Reference:NamespaceManager (77441)
- Blog (75527)
<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.
If offers configuring: mode - criteria by which to retrieve pages displayedTwo 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:
Tag bs:newbies[edit | edit source]
TheUser:Ptechnik, User:PraktiED, User:PraktiEG, User:Mkirsch, User:Fspinar 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]
User:Ptechnik, User:PraktiED, User:PraktiEG, User:Mkirsch, User:Fspinar, User:Mmeixner, User:Rvogel
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]
See also[edit | edit source]
Our reference page.
<bs:bookshelf src="Book:User manual" /> __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]] BlueSpiceSmartList offers three different tags: * <code><pre><bs:smartlist /></code></pre> - main tag used to display list of pages based on various criteria * <code><pre><bs:newbies /></code></pre> - displays list of recentrly registered users * <code><pre><bs:toplist /></code></pre> - displays list of most visited pages ==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]] Once the tag is added to the page, configuration dialog (inspector) is shown. If offers configuring: * mode - criteria by which to retrieve pages displayed **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: <code><bs:smartlist mode="recentchanges" new="true" count="7" ns="104" trim="false" /></code> ==Tag bs:newbies== The<code><bs:newbies/></code> 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=== <code><bs:newbies count="7"/></code> ==Tag bs:toplist== [[File:Smartlist2.png|thumb|Options of bs:toplist tag]] 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=== <code><bs:toplist count="7" ns="Help|QM" /></code> ==See also== Our [[Reference:SmartList|reference page.]]
| Line 10: | Line 10: | ||
[[File:Smartlist2.png|thumb|Available tags in "Insert magic" dialog]] | [[File:Smartlist2.png|thumb|Available tags in "Insert magic" dialog]] | ||
BlueSpiceSmartList offers three different tags: | BlueSpiceSmartList offers three different tags: | ||
| − | * < | + | * <pre><bs:smartlist /></pre> - main tag used to display list of pages based on various criteria |
| − | * < | + | * <pre><bs:newbies /></pre> - displays list of recentrly registered users |
| − | * < | + | * <pre><bs:toplist /></pre> - displays list of most visited pages |
==Where to find the function BlueSpiceSmartList?== | ==Where to find the function BlueSpiceSmartList?== | ||
| Line 20: | Line 20: | ||
==Tag bs:smartlist== | ==Tag bs:smartlist== | ||
[[File:Smartlist3.png|thumb|Options of bs:smartlist tag]] | [[File:Smartlist3.png|thumb|Options of bs:smartlist tag]] | ||
| − | Once the tag is added to the page, configuration dialog (inspector) is shown. | + | 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=== | ===Parameters=== | ||