You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "Reference:BlueSpiceWatchList"
m (Tag: 2017 source edit) |
(Tag: 2017 source edit) |
Extension: BlueSpiceWatchList
| Overview | |||
|---|---|---|---|
| Description: | Adds a watchlist widget and tag | ||
| State: | stable | Dependency: | BlueSpice |
| Developer: | HalloWelt | License: |
GPL v3 only-3.0-onlyProperty "BSExtensionInfoLicense" (as page type) with input value "</br>GPL-3.0-only" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process. |
| Type: | BlueSpice | Category: | Reporting |
| Edition: | BlueSpice free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud | ||
Features
WatchList improves on standard MediaWiki watchlist functionality and adapts it to the BlueSpice environment.
The watchlist can be viewed in:
- UserSidebar (keyword WATCHLIST) shows entries from a user's own watchlist.
-
Page content (tag-based, added by user). Example:
<bs:watchlist count="10" maxtitlelength="50"/> - Discussion pages are implicitly watched by MW. These implicit entries do not appear in the list. But a discussion page can be added explicitly.
- Long titles are truncated.
Technical Information[edit source]
This information
applies to BlueSpice 3 . Technical details for BlueSpice cloud can differ in some cases.
Configuration[edit | edit source]
Widget
- The number of watchlist entries is limited to 10 if the user does not provide a different value.
- The titles displayed are limited to 20 characters in the personal navigation.
Widget
| Name | Description | Type | Default value | Scope |
|---|---|---|---|---|
| WidgetLimit | number of returned pages | int | 10 | user |
| WidgetSortOdr | page order | time, pagename | time | user |
Tag parameters
| Name | Description | Type | Default value |
|---|---|---|---|
| count | number of returned pages | num | 5 |
| maxtitlelength | number of strings | num | 20 |
| order | sort order | time, pagename | pagename |
All users can view watchlist entries and change the settings. Only pages are included for which a user has read permissions.
Requirements[edit | edit source]
WatchList requires BlueSpiceFoundation.
More info[edit | edit source]
For a detailed description and usage, visit our help page.
Demo[edit | edit source]
Test the watchlist tag or the watchlist function in the personal navigation (sidebar) in our BlueSpiceDemo.
{{BSExtensionInfobox
|desc=Adds a watchlist widget and tag
|BSExtensionInfo
|status=stable
|developer=HalloWelt
|type=BlueSpice
|edition=BlueSpice free
|active=Yes
, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud
|compatible=BlueSpice
|category=Reporting
|license=GPL v3 only
|docu=https://www.mediawiki.org/wiki/Extension:WatchList
}}features='''WatchList''' improves on standard MediaWiki watchlist functionality and adapts it to the BlueSpice environment.
==Usage / features==
The watchlist can be viewed in:
*UserSidebar (keyword WATCHLIST) shows entries from a user's own watchlist.
*Page content (tag-based, added by user). Example: <code><nowiki><bs:watchlist count="10" maxtitlelength="50"/></nowiki></code>
*Discussion pages are implicitly watched by MW. These implicit entries do not appear in the list. But a discussion page can be added explicitly.
*Long titles are truncated.
==Technical information==
===Configuration===
'''Widget'''
* }}
===Configuration===
*The number of watchlist entries is limited to 10 if the user does not provide a different value.
* The titles displayed are limited to 20 characters in the personal navigation.
{| class="contenttable sortable jquery-tablesorter"
! class="headerSort" tabindex="0" role="columnheader button" title="Aufsteigend sortieren" |Name
! class="headerSort" tabindex="0" role="columnheader button" title="Aufsteigend sortieren" |Description
! class="headerSort" tabindex="0" role="columnheader button" title="Aufsteigend sortieren" |Type
! class="headerSort" tabindex="0" role="columnheader button" title="Aufsteigend sortieren" |Default value
! class="headerSort" tabindex="0" role="columnheader button" title="Aufsteigend sortieren" |'''Widget'''
{| class="reference wikitable"
!Name
!Description
!Type
!Default value
!Scope
|-
|''WidgetLimit''
|number of returned pages
|int
|10
|user
|-
|''WidgetSortOdr''
|page order
|time, pagename
|time
|user
|}
'''Tag parameters'''
{| class="reference wikitable"
style="border-collapse: collapse;" cellpadding="5" border="1"
!Name
!Description
!Type
!Default value
|-
|''count''
|number of returned pages
|num
|5
|-
|''maxtitlelength''
|number of strings
|num
|20
|-
|''order''
|sort order
|time, pagename
|pagename
|}
===Rights (permissions)===
All users can view watchlist entries and change the settings. Only pages are included for which a user has ''read'' permissions.
===Requirements===
WatchList requires [[Reference:BlueSpiceFoundation|BlueSpiceFoundation]].
==More info==
For a detailed description and usage, visit our [[Manual:Extension/WatchList|help page]].
==Demo==
Test the watchlist tag or the watchlist function in the personal navigation (sidebar) in our [https://en.demo.bluespice.com/wiki/Main_Page BlueSpiceDemo.]
{{Translation}}
[[Category:Extension]]
[[Category:BlueSpice free]]| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{BSExtensionInfo |
| − | |||
|status=stable | |status=stable | ||
|developer=HalloWelt | |developer=HalloWelt | ||
|type=BlueSpice | |type=BlueSpice | ||
| − | |edition=BlueSpice free | + | |edition=BlueSpice free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud |
| − | |||
|compatible=BlueSpice | |compatible=BlueSpice | ||
|category=Reporting | |category=Reporting | ||
| − | | | + | |features='''WatchList''' improves on standard MediaWiki watchlist functionality and adapts it to the BlueSpice environment. |
| − | |||
| − | |||
| − | |||
| − | |||
The watchlist can be viewed in: | The watchlist can be viewed in: | ||
| Line 19: | Line 13: | ||
*Page content (tag-based, added by user). Example: <code><nowiki><bs:watchlist count="10" maxtitlelength="50"/></nowiki></code> | *Page content (tag-based, added by user). Example: <code><nowiki><bs:watchlist count="10" maxtitlelength="50"/></nowiki></code> | ||
*Discussion pages are implicitly watched by MW. These implicit entries do not appear in the list. But a discussion page can be added explicitly. | *Discussion pages are implicitly watched by MW. These implicit entries do not appear in the list. But a discussion page can be added explicitly. | ||
| − | *Long titles are truncated. | + | *Long titles are truncated.}} |
| − | |||
| − | |||
| − | |||
===Configuration=== | ===Configuration=== | ||
| − | |||
| − | * The number of watchlist entries is limited to 10 if the user does not provide a different value. | + | *The number of watchlist entries is limited to 10 if the user does not provide a different value. |
| − | * The titles displayed are limited to 20 characters in the personal navigation. | + | *The titles displayed are limited to 20 characters in the personal navigation. |
| − | {| class=" | + | '''Widget''' |
| − | ! | + | {| class="reference wikitable" |
| − | ! | + | !Name |
| − | ! | + | !Description |
| − | ! | + | !Type |
| − | ! | + | !Default value |
| + | !Scope | ||
|- | |- | ||
|''WidgetLimit'' | |''WidgetLimit'' | ||
| Line 49: | Line 40: | ||
|} | |} | ||
'''Tag parameters''' | '''Tag parameters''' | ||
| − | {| class="wikitable | + | {| class="reference wikitable" |
!Name | !Name | ||
!Description | !Description | ||
| Line 70: | Line 61: | ||
|pagename | |pagename | ||
|} | |} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||