Difference between revisions of "Manual:Extension/BlueSpiceSmartList"
[unchecked revision] | [quality revision] |
(Tag: 2017 source edit) |
m (Tag: Visual edit) |
Contents
- 1 What is BlueSpiceSmartList? 2
- Available tags
- 3 Where to find the function BlueSpiceSmartList? 4 Tag <bs:smartlist> 4
- 2 Smartlist
- 4.2 Example in wikicode 5 Tag <bs:newbies> 5
- 3 Newbies 5
- 6 Tag <bs:toplist> 6
- 4 Toplist 6
- 7 5 Related info
BlueSpiceSmartList introduces a number of tags that can be placed on any page to show a list of most relevant pages based on different criteriaThe 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[edit | edit source]
BlueSpiceSmartList
The extension SmartList offers three different tags:
-
<bs:smartlist />
- main tag used to display a list of pages based on various different criteria -
<bs:newbies />
- displays display a list of recentrly registered users -
<bs:toplist />
- displays display a list of most visited pages
All of the tags listed above can be added through "Insert magic" menu of the menu Insert > Magic word in VisualEditor. For more information on how to insert magic words, see BlueSpiceInsertMagic InsertMagic.
Tag <bs:smartlist>Smartlist[edit | edit source]
Once- 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. |
<bs:smartlist
mode="recentchanges"
new="true"
count="7"
ns="104"
trim="false"
/>
Tag <bs:newbies>Newbies[edit | edit source]
The
tag <bs:newbies />
shows
therecently registered
members on thewiki users.
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>Toplist[edit | edit source]
This tag shows a list of the 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" />
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{{DISPLAYTITLE:Generating lists of pages}} __TOC__ 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|Available tags in "Insert magic" dialog|alt=Available tags in "Insert magic" dialog|border|center|603x603px]] BlueSpiceSmartList 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> - main tag used to display display a list of pages based on variousdifferent criteria *<code><nowiki><bs:newbies /></nowiki></code> - displays display a list of recentrly registered users *<code><nowiki><bs:toplist /></nowiki></code> - displays display a 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 the menu ''Insert > Magic word'' in [[Manual:Extension/VisualEditor|VisualEditor]]. For more information on how to insert magic words, see [[Manual:Extension/BlueSpiceInsertMagic|BlueSpiceInsertMagic]]. ==Tag <bs:smartlist>InsertMagic]]. ==Smartlist== [[File:Smartlist3.png|Options of bs:the ''smartlist'' tag|alt=Options of bs:the 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|thumb]] === 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. '''Example output in source code:''' <nowiki><bs:smartlist mode="recentchanges" 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: 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|Options of bs:smartlist tag<br />|alt=Options of bs:smartlist tag|border|center|603x603px]] This tag shows list of == Toplist == This tag shows a list of the 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> {{Box Links-en|Topic1=[[Reference:BlueSpiceSmartList]]}} {{Translation}}|Topic2=[[Reference:BlueSpiceInsertMagic]]}} {{Translation}} __FORCETOC__
Line 1: | Line 1: | ||
− | + | {{DISPLAYTITLE:Generating lists of pages}} | |
__TOC__ | __TOC__ | ||
− | + | 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== | ==Available tags== | ||
− | [[File:Smartlist2.png| | + | [[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=== | + | === Parameters === |
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: 531px | + | {| class="contenttable" style="width:531px;" cellspacing="0" cellpadding="5" border="0" |
|- | |- | ||
− | | style=" | + | | style="" | |
Count -'''count''' | Count -'''count''' | ||
− | | style=" | + | | style="" | |
The number of articles to be shown. Default value: 5 | The number of articles to be shown. Default value: 5 | ||
|- | |- | ||
− | | style=" | + | | style="" | |
Namespaces - '''ns''' | Namespaces - '''ns''' | ||
− | | 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. | ||
|- | |- | ||
− | | style=" | + | | style="" | |
Exclude NS - '''excludens''' | Exclude NS - '''excludens''' | ||
− | | style=" | + | | 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. | 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=" | + | | style="" | |
Category - '''cat''' | Category - '''cat''' | ||
− | | style=" | + | | style="" | |
Only articles from given category will be listed. Selecting several categories is not possible. Default: All categories. | Only articles from given category will be listed. Selecting several categories is not possible. Default: All categories. | ||
|- | |- | ||
− | | style=" | + | | style="" | |
Show minor - '''nominor''' | Show minor - '''nominor''' | ||
− | | 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. | ||
|- | |- | ||
− | | style=" | + | | style="" | |
Period - '''period''' | Period - '''period''' | ||
− | | style=" | + | | style="" | |
Only changes within given period are shown. Possible values: 'month', 'week', 'day'. Default: No limit. | Only changes within given period are shown. Possible values: 'month', 'week', 'day'. Default: No limit. | ||
|- | |- | ||
− | | style=" | + | | style="" | |
Show only new articles - '''new''' | Show only new articles - '''new''' | ||
− | | style=" | + | | style="" | |
Only new pages will be listed. Default: All pages are shown | Only new pages will be listed. Default: All pages are shown | ||
|- | |- | ||
− | | style=" | + | | style="" | |
Trim - '''trim''' | Trim - '''trim''' | ||
− | | 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. | ||
|- | |- | ||
− | | style=" | + | | style="" | |
Show text '''showtext''' | Show text '''showtext''' | ||
− | | 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. | ||
|- | |- | ||
− | | style=" | + | | style="" | |
Trim text - '''trimtext''' | Trim text - '''trimtext''' | ||
− | | 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. | ||
− | |} | + | |}'''Example output in source code:''' |
− | + | <nowiki><bs:smartlist mode="recentchanges" new="true" count="7" ns="104" trim="false" /></nowiki> | |
− | + | ==Newbies== | |
− | + | The tag <code><nowiki><bs:newbies /></nowiki></code> shows recently registered wiki users. | |
− | < | ||
− | |||
− | |||
− | == | ||
− | The< | ||
− | |||
===Parameters=== | ===Parameters=== | ||
− | {| class="contenttable" style="width: 531px | + | {| class="contenttable" style="width:531px;" cellspacing="0" cellpadding="5" border="0" |
|- | |- | ||
− | | 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 125: | Line 112: | ||
<pre><bs:newbies count="7"/></pre> | <pre><bs:newbies count="7"/></pre> | ||
− | + | == Toplist == | |
− | == | + | This tag shows a list of the most visited pages. |
− | |||
− | This tag shows list of most visited pages. | ||
===Parameters=== | ===Parameters=== | ||
− | {| class="contenttable" style="width: 531px | + | {| class="contenttable" style="width:531px;" cellspacing="0" cellpadding="5" border="0" |
|- | |- | ||
− | | style=" | + | | style="" | |
Count - '''count''' | Count - '''count''' | ||
− | | 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. | ||
|- | |- | ||
− | | style=" | + | | style="" | |
Namespaces - '''ns''' | Namespaces - '''ns''' | ||
− | | 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. | ||
|- | |- | ||
− | | style=" | + | | style="" | |
Category - '''cat''' | Category - '''cat''' | ||
− | | 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. | ||
|- | |- | ||
− | | style=" | + | | style="" | |
Period - '''period''' | Period - '''period''' | ||
− | | style=" | + | | style="" | |
The period that should be used (alltime or month). The default is alltime. | The period that should be used (alltime or month). The default is alltime. | ||
Line 167: | Line 152: | ||
− | {{Box Links-en|Topic1=[[Reference:BlueSpiceSmartList]]}} | + | {{Box Links-en|Topic1=[[Reference:BlueSpiceSmartList]]|Topic2=[[Reference:BlueSpiceInsertMagic]]}} |
{{Translation}} | {{Translation}} | ||
+ | __FORCETOC__ |