You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "Manual:Extension/BlueSpiceSmartList"
| [unchecked revision] | [unchecked 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...") |
/tmp/bshtmldiff/helpdesk_en-hw_/5850.html (Datei oder Verzeichnis nicht gefunden)
__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.
==Where to find the function SmartList?==
You can integrate SmartList into an article, the widget bar or the user sidebar.
::: [[File:SmartList1.jpg|500x286px]]
::: [[File:SmartList2.jpg|500x301px]]
::: [[File:SmartList3.jpg|500x288px]]
::: [[File:SmartList4.jpg|500x289px]]
::: [[File:SmartList5.png|500x214px]]
==The functionality of SmartList==
Add the tag where you want. <nowiki><smartlist/> </nowiki> Add the parameters you want, for example:
<pre><bs:smartlist new="true" count="7" ns="104" trim="false" /></pre>
==Recentchanges or Changesofweek==
There are two basic options which you can choose using the parameter "mode":
* '''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".
'''Example''':
<pre><smartlist mode="changesofweek" /></pre>
'''Note''': The relevant Hallo Welt extension must be activated to use 'changesofweek'.
===Parameters for 'recentchanges'===
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'''
| style="border: 1px solid #ebecec;"|
The number of articles to be shown. Default value: 5
|-
| style="border: 1px solid #ebecec;"|
'''ns'''
| style="border: 1px solid #ebecec;"|
Only articles from these namespace will be listed. The namespaces can be entered numerically or by names. Several namespaces can be named with commas: ns="0,2,5". Default: No limit.
|-
| style="border: 1px solid #ebecec;"|
'''excludens'''
| style="border: 1px solid #ebecec;"|
Articles from these namespaces will not be shown. At the moment, the namespaces can be entered numerically or by names. Several namespaces can be named with commas: excludens="0,2,5". Default: No limit.
|-
| style="border: 1px solid #ebecec;"|
'''cat'''
| style="border: 1px solid #ebecec;"|
Only articles from this category will be listed. Selecting several categories is not possible. Default: No limit.
|-
| style="border: 1px solid #ebecec;"|
'''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'''
| style="border: 1px solid #ebecec;"|
Only changes within this period are shown. Possible values: 'month', 'week', 'day'. Default: No limit.
|-
| style="border: 1px solid #ebecec;"|
'''new'''
| style="border: 1px solid #ebecec;"|
Only new pages will be listed. Default: All pages are shown
|-
| style="border: 1px solid #ebecec;"|
'''trim'''
| style="border: 1px solid #ebecec;"|
Long article names are not cropped. Default: The title is cut off at 30 characters.
|-
| style="border: 1px solid #ebecec;"|
'''showtext'''
| style="border: 1px solid #ebecec;"|
With this option, a line of the article contents will be shown alongside the title: showtext="true".
|-
| style="border: 1px solid #ebecec;"|
'''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.
|}
The parameters are added to the tag.<br />'''Example''':
<pre><smartlist new="true" count="7" ns="104" trim="false" /></pre>
<br /> This SmartList lists the seven newest articles from a particular namespace without shortening their titles.
===Parameters for 'changesofweek'===
{| class="contenttable" style="width: 531px; height: 65px;" cellspacing="0" cellpadding="5" border="0"
|-
| style="border: 1px solid #ebecec;"|
'''count'''
| style="border: 1px solid #ebecec;"|
The number of articles to be shown. Default value: 5
|-
| style="border: 1px solid #ebecec;"|
'''period'''
| style="border: 1px solid #ebecec;"|
Only changes within this period are shown. Possible values: 'month', 'week', 'day'. Default: No limit.
|}
'''Example''':
<pre><smartlist mode="changesofweek" count="10" /></pre>
===What links here===
A smartlist with the mode <code>mode="whatlinkshere"</code> shows all sites that link to this site - if you don't define a special site through "target" then smartlist will show all links to the page the smartlist-tag is used at. You can use all parameters of the mode 'recentchanges'.
===Additional parameters for 'whatlinkshere'===
{| class="contenttable-black"
|-
| style="border: 1px solid #ebecec;"|'''target'''
| style="border: 1px solid #ebecec;"|page title - default: site on which the tag is used.
|}
'''Beispiel''':
<pre><nowiki><bs:smartlist mode="whatlinkshere" target="Portal:Test" count="7" ns="0" trim="false"/></nowiki></pre>
===SmartList in the widgets===
The SmartList in the widgets can only changed by an admin under [[Preferences]].
===Ratings===
If the extension [[Rating|Ratings]] integrated into the wiki, an overview of the most commonly evaluated pages can be inserted in the wiki code where you want (e.g. the start page) using SmartList. This happens via the wiki tag <nowiki><smartlist mode="ratings" /></nowiki>. This will show the pages which have been evaluated most often. It does not matter whether they have had positive or negative evaluations. Only the amount of evaluations made is important.
The SmartList of the pages evaluated also has some parameters for customisation:
{| class="contenttable" style="width: 531px; height: 65px;" cellspacing="0" cellpadding="5" border="0"
|-
| style="border: 1px solid #ebecec;"|
'''count'''
| style="border: 1px solid #ebecec;"|
The number of articles to be shown; the default value is 5.
|-
| style="border: 1px solid #ebecec;"|
'''ns'''
| style="border: 1px solid #ebecec;"|
Only articles from these namespace which have been evaluated will be listed.
|-
| style="border: 1px solid #ebecec;"|
'''excludens'''
| style="border: 1px solid #ebecec;"|
No articles from this namespace will be listed.
|-
| style="border: 1px solid #ebecec;"|
'''showtext'''
| style="border: 1px solid #ebecec;"|
With this option, a line of the article contents will be shown alongside the title. (showtext="true")
|-
| style="border: 1px solid #ebecec;"|
'''trimtext'''
| style="border: 1px solid #ebecec;"|
Limits the number of characters shown of the article's contents. (trimtext="50")
|-
| style="border: 1px solid #ebecec;"|
'''showvotes'''
| style="border: 1px solid #ebecec;"|
The number of evaluations made is given alongside the title. (showvotes="true")
|}
'''Example:'''
<pre><smartlist mode="ratings" count="9" showtext="true" /> </pre>
<br /> In this example, 9 articles will be listed which have been evaluated most often. At the same time, a line of each article will be shown.
===Approval===
An example for displaying approvals (the right extension is needed):
<pre><smartlist mode="flaggedrevisions" ns="502" count="7"/> </pre>
==Further functions==
===Most clicked article===
The <nowiki><bs:toplist /></nowiki> tag creates a list of the most clicked articles in the wiki.
The following are possible parameters:
{| class="contenttable" style="width: 531px; height: 65px;" cellspacing="0" cellpadding="5" border="0"
|-
| style="border: 1px solid #ebecec;"|
'''count'''
| style="border: 1px solid #ebecec;"|
The number of articles to be shown; the default value is 10.
|-
| style="border: 1px solid #ebecec;"|
'''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;"|
'''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'''
| style="border: 1px solid #ebecec;"|
The period that should be used (alltime or month). The default is alltime.
|}
===New members===
The<nowiki><bs:newbies/></nowiki> tag shows the newest members of the wiki.
The following are possible parameters:
{| class="contenttable" style="width: 531px; height: 65px;" cellspacing="0" cellpadding="5" border="0"
|-
| style="border: 1px solid #ebecec;"|
'''count'''
| style="border: 1px solid #ebecec;"|
The number of members to be shown; the default value is 10.
|}
==See also==
Our [[SmartList|reference page.]]| Line 7: | Line 7: | ||
'''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. | '''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. | ||
| + | |||
| + | ==Where to find the function SmartList?== | ||
| + | You can integrate SmartList into an article, the widget bar or the user sidebar. | ||
| + | |||
| + | ::: [[File:SmartList1.jpg|500x286px]] | ||
| + | ::: [[File:SmartList2.jpg|500x301px]] | ||
| + | ::: [[File:SmartList3.jpg|500x288px]] | ||
| + | ::: [[File:SmartList4.jpg|500x289px]] | ||
| + | ::: [[File:SmartList5.png|500x214px]] | ||
| + | |||
| + | ==The functionality of SmartList== | ||
| + | Add the tag where you want. <nowiki><smartlist/> </nowiki> Add the parameters you want, for example: | ||
| + | |||
| + | <pre><bs:smartlist new="true" count="7" ns="104" trim="false" /></pre> | ||
| + | |||
| + | ==Recentchanges or Changesofweek== | ||
| + | There are two basic options which you can choose using the parameter "mode": | ||
| + | |||
| + | * '''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". | ||
| + | |||
| + | '''Example''': | ||
| + | |||
| + | <pre><smartlist mode="changesofweek" /></pre> | ||
| + | |||
| + | '''Note''': The relevant Hallo Welt extension must be activated to use 'changesofweek'. | ||
| + | |||
| + | ===Parameters for 'recentchanges'=== | ||
| + | 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''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | The number of articles to be shown. Default value: 5 | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''ns''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | Only articles from these namespace will be listed. The namespaces can be entered numerically or by names. Several namespaces can be named with commas: ns="0,2,5". Default: No limit. | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''excludens''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | Articles from these namespaces will not be shown. At the moment, the namespaces can be entered numerically or by names. Several namespaces can be named with commas: excludens="0,2,5". Default: No limit. | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''cat''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | Only articles from this category will be listed. Selecting several categories is not possible. Default: No limit. | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''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''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | Only changes within this period are shown. Possible values: 'month', 'week', 'day'. Default: No limit. | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''new''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | Only new pages will be listed. Default: All pages are shown | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''trim''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | Long article names are not cropped. Default: The title is cut off at 30 characters. | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''showtext''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | With this option, a line of the article contents will be shown alongside the title: showtext="true". | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''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. | ||
| + | |||
| + | |} | ||
| + | The parameters are added to the tag.<br />'''Example''': | ||
| + | |||
| + | <pre><smartlist new="true" count="7" ns="104" trim="false" /></pre> | ||
| + | <br /> This SmartList lists the seven newest articles from a particular namespace without shortening their titles. | ||
| + | |||
| + | ===Parameters for 'changesofweek'=== | ||
| + | {| class="contenttable" style="width: 531px; height: 65px;" cellspacing="0" cellpadding="5" border="0" | ||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''count''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | The number of articles to be shown. Default value: 5 | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''period''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | Only changes within this period are shown. Possible values: 'month', 'week', 'day'. Default: No limit. | ||
| + | |||
| + | |} | ||
| + | |||
| + | '''Example''': | ||
| + | |||
| + | <pre><smartlist mode="changesofweek" count="10" /></pre> | ||
| + | |||
| + | ===What links here=== | ||
| + | A smartlist with the mode <code>mode="whatlinkshere"</code> shows all sites that link to this site - if you don't define a special site through "target" then smartlist will show all links to the page the smartlist-tag is used at. You can use all parameters of the mode 'recentchanges'. | ||
| + | |||
| + | ===Additional parameters for 'whatlinkshere'=== | ||
| + | {| class="contenttable-black" | ||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"|'''target''' | ||
| + | | style="border: 1px solid #ebecec;"|page title - default: site on which the tag is used. | ||
| + | |} | ||
| + | '''Beispiel''': | ||
| + | |||
| + | <pre><nowiki><bs:smartlist mode="whatlinkshere" target="Portal:Test" count="7" ns="0" trim="false"/></nowiki></pre> | ||
| + | |||
| + | ===SmartList in the widgets=== | ||
| + | The SmartList in the widgets can only changed by an admin under [[Preferences]]. | ||
| + | |||
| + | ===Ratings=== | ||
| + | If the extension [[Rating|Ratings]] integrated into the wiki, an overview of the most commonly evaluated pages can be inserted in the wiki code where you want (e.g. the start page) using SmartList. This happens via the wiki tag <nowiki><smartlist mode="ratings" /></nowiki>. This will show the pages which have been evaluated most often. It does not matter whether they have had positive or negative evaluations. Only the amount of evaluations made is important. | ||
| + | |||
| + | The SmartList of the pages evaluated also has some parameters for customisation: | ||
| + | |||
| + | {| class="contenttable" style="width: 531px; height: 65px;" cellspacing="0" cellpadding="5" border="0" | ||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''count''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | The number of articles to be shown; the default value is 5. | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''ns''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | Only articles from these namespace which have been evaluated will be listed. | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''excludens''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | No articles from this namespace will be listed. | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''showtext''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | With this option, a line of the article contents will be shown alongside the title. (showtext="true") | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''trimtext''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | Limits the number of characters shown of the article's contents. (trimtext="50") | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''showvotes''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | The number of evaluations made is given alongside the title. (showvotes="true") | ||
| + | |||
| + | |} | ||
| + | |||
| + | '''Example:''' | ||
| + | |||
| + | <pre><smartlist mode="ratings" count="9" showtext="true" /> </pre> | ||
| + | <br /> In this example, 9 articles will be listed which have been evaluated most often. At the same time, a line of each article will be shown. | ||
| + | |||
| + | ===Approval=== | ||
| + | An example for displaying approvals (the right extension is needed): | ||
| + | |||
| + | <pre><smartlist mode="flaggedrevisions" ns="502" count="7"/> </pre> | ||
| + | |||
| + | ==Further functions== | ||
| + | ===Most clicked article=== | ||
| + | The <nowiki><bs:toplist /></nowiki> tag creates a list of the most clicked articles in the wiki. | ||
| + | |||
| + | The following are possible parameters: | ||
| + | |||
| + | {| class="contenttable" style="width: 531px; height: 65px;" cellspacing="0" cellpadding="5" border="0" | ||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''count''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | The number of articles to be shown; the default value is 10. | ||
| + | |||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''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;"| | ||
| + | '''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''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | The period that should be used (alltime or month). The default is alltime. | ||
| + | |||
| + | |} | ||
| + | |||
| + | ===New members=== | ||
| + | The<nowiki><bs:newbies/></nowiki> tag shows the newest members of the wiki. | ||
| + | |||
| + | The following are possible parameters: | ||
| + | |||
| + | {| class="contenttable" style="width: 531px; height: 65px;" cellspacing="0" cellpadding="5" border="0" | ||
| + | |- | ||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | '''count''' | ||
| + | |||
| + | | style="border: 1px solid #ebecec;"| | ||
| + | The number of members to be shown; the default value is 10. | ||
| + | |||
| + | |} | ||
==See also== | ==See also== | ||
Our [[SmartList|reference page.]] | Our [[SmartList|reference page.]] | ||