Difference between revisions of "Manual:Extension/BlueSpiceSmartList"
[unchecked revision] | [quality revision] |
(Created page with "__HIDETITLE__ <bs:bookshelf src="Book:User manual" /> __TOC__ ==What is SmartList?== '''SmartList''' introduces a tag that can be placed on any page to show a list of most...") |
(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
- 1 What is SmartList? Available tags
- 2 See also
Available tags[edit | edit source]
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.
See also[edit | edit source]
Our reference page.
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:
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. |
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 |
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 category="ISO9001" 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]
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
__HIDETITLE__ <bs:bookshelf src="Book:User manual" /> __TOC__ ==What is SmartList?== '''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. ==See also== Our [[SmartList|reference page.{{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:100%;" cellspacing="0" cellpadding="5" border="0" |Label |Parameter |Values |Description |- | style="" | Count |'''count''' |number | style="" | The number of articles to be shown. Default value: 5 |- | style="" | 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="" | 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. Default: No limit. |- | style="" | Show only new articles |'''new''' |true, false | style="" | 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="" | 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 category="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:100%;" cellspacing="0" cellpadding="5" border="0" |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:100%;" cellspacing="0" cellpadding="5" border="0" !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. 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]]
(28 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
− | + | {{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:100%;" cellspacing="0" cellpadding="5" border="0" | ||
+ | |Label | ||
+ | |Parameter | ||
+ | |Values | ||
+ | |Description | ||
+ | |- | ||
+ | | style="" | | ||
+ | Count | ||
+ | |'''count''' | ||
+ | |number | ||
+ | | style="" | | ||
+ | The number of articles to be shown. Default value: 5 | ||
+ | |||
+ | |- | ||
+ | | style="" | | ||
+ | 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="" | | ||
+ | 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. Default: No limit. | ||
+ | |||
+ | |- | ||
+ | | style="" | | ||
+ | Show only new articles | ||
+ | |'''new''' | ||
+ | |true, false | ||
+ | | style="" | | ||
+ | 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="" | | ||
+ | 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 category="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:100%;" cellspacing="0" cellpadding="5" border="0" | ||
+ | |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:100%;" cellspacing="0" cellpadding="5" border="0" | ||
+ | !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. 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]] |