Difference between revisions of "Manual:Extension/BlueSpiceWatchList"

__HIDETITLE__
            
            
            <bs:bookshelf src="Book:User manual" />
            
            
            
            __TOC__
            
            
            
            ==What is BlueSpiceWatchList?==
            
            
            
            '''BlueSpiceWatchList''' improves on standard MediaWiki watchlist functionality and adapts it to BlueSpice environment.
            
            
            
            ==Using the watchlist==
            
            Every registered user has an ablity to mark pages that are important to them, and keep them in an easy-accessible place, called watchlist. It  is basically a quick-access list for the pages deemed most important to the user.
            
            
            
            ===Adding pages to watchlist===
            
            [[File:Watchlist1a.png|thumb|Button to watch/unwatch the page]]
            
            On every content article, registred users will have a button to add the page to their watchlist in the top right corner of the article, in page tools. This button is marked with an "star" icon.
            
            This button can be displayed in two ways:
            
            * hollow star - just outlined - means that the page is not currently being watched by the user, and clicking this button will add the page to the user's watchlist.
            
            * full star - means that the page is being watched by the user, and clicking on this button will remove the page from the watchlist (unwatch).
            
            
            
            ===Viewing the watchlist===
            
            [[File:Watchlist2a.png|thumb|Accessing the watchlist]]
            
            [[File:Watchlist3.png|thumb|Watchlist page]]
            
            Every user, in their personal menu (accessible by clicking on the user icon in the top right corner of the page), has the "Watchlist" entry. Clicking on this item leads to <code>Special:Watchlist</code> where the list containing all watched pages is located.
            
            
            
            Here, users can see the most relevant informations about the pages in their watchlist, as well as filter the list based on various criteria.
            
            
            
            Pages that have been changed since the last time user visited them will appear in bold. All pages can be marked as "read" by clicking the "Mark all pages visited" button that will appear if such pages exist.
            
            
            
            ===Other ways of getting pages into watchlist===
            
            In addition to manually marking page as "watched", there are several ways page can be added to the watchlist automatically. For example, whenever the user creates or edits the page, that page will be added to the watchlist (unless explicitly set not to).
            
            
            
            ===Notifications===
            
            All users watching certain page will {{DISPLAYTITLE:Watchlist}}
            
            
            
            With the '''watchlist''', you can monitor all wiki pages that are important to you. In your [[Manual:Preferences|preferences]], you can customize when and how to be notified about different types of changes related to the pages on your watchlist. Your watchlist is only visible to you. Administrators can see a report of which pages are not on any watchlist. 
            
            ==Watching and unwatching pages==
            
            In the title section of a page, you can add the page to your watchlist.  Click ''Watch'' to add the page to the watchlist. The link description switches to Unwatch. Click ''Unwatch'' to remove the list from your watchlist.
            
            
            
            
            <br />
            
            [[File:Manual:watchlist-link.png|alt=The watchlist switch link|center|650x650px|thumb|The watchlist switch link]]
            
            
            
            ===Automatic additions===
            
            In addition to manually marking a page watched, there are several ways a page can be added automatically. For example, whenever you create or edit a page, that page can be added to the watchlist. You can change the options for this in the ''Watchlist'' settings in your [[Manual:Preferences|Preferences]].{{Box Note|boxtype=important|Note text=If you have deactivated the setting ''Add pages and files I edit to my watchlist '' in the settings, the check box ''Watch this page'' in the save dialog is not automatically activated. If you do not manually activate this checkbox when saving a page, a page that was on your watch list will be removed from the watch list when you save. Conversely, each page is automatically added to your watch list if this check box is selected by default. When saving, always check whether the edited page should (still) be on your watchlist.
            
            
            
            [[File:Manual:watchlist-savepage-DE.png|alt=A page is removed from the watchlist|center|thumb|400x400px|A page is removed from the watchlist]]
            
            }}
            
            
            
            ==Settings==
            
            Go to your [[BlueSpice Layout|user menu]]. Click ''Preferences'' and select the tab ''Watchlist'' to access the following settings:
            
            
            
            *'''Edit watchlist''': Links to the maintenance pages for the watchlist.
            
            *'''Display options:''' Default settings for showing pages in your watchlist that have recently changed. 
            
            **You can set 3-90 days of page changes.
            
            **You can set 250-1000 watchlist results.
            
            *'''Advanced options:''' Settings for automatically adding pages to the watchlist or hiding page changes from the watchlist.
            
            *'''Watchlist token:''' The token can be used to create a public RSS feed to your watchlist. Anyone who knows this token can access the feed. The syntax for the feed URL is:  <code>https://[YourWikiDomain]/w/api.php?action=feedwatchlist&wlowner=[USERNAME]&wltoken=[TOKEN]</code>
            
            
            
            ==Watchlist quick view==
            
            You can open a quick view of your watchlist from the user profile menu. 
            
            
            
            
            <br />
            
            [[File:Manual:usermenu-watchlist.png|alt=Watchlist link in the user menu|center|180x180px|thumb|Watchlist link in the user menu]]
            
            
            
            
            
            This opens an overlay with a filterable and sortable view of your watchlist directly on the current page. The watchlist indicates what pages on your pages have changes that are unread by you. Clicking on the icon for unread changes leads to the version comparison page so that you can quickly review the changes you haven't seen yet.
            
            
            
            [[File:Manual:Mediawiki Extension WatchList.png|alt=Watchlist overlay|center|thumb|450x450px|Watchlist overlay]]
            
            
            
            ==Classic watchlist==
            
            From this overlay display, you can switch to the classic view of the watchlist. This loads the  page ''Special:Watchlist'':
            
            
            
            At the top of the Watchlist page are some important edit links and information about your watchlist settings:
            
            
            
            *'''View relevant changes:''' This is the default watchlist page. It displays the filter menu with the legend.
            
            *'''View and edit watchlist:''' Here you can delete entries from your watchlist.
            
            *'''Edit raw watchlist:''' Loads an editable list  of the page names on your watchlist.
            
            *'''Clear the watchlist:''' Loads a page that clears your watchlist in the next step. Clicking this link will not clear the watchlist yet.
            
            
            
            
            <br />
            
            [[File:Watchlist3.png|Classic view of the watchlist page|alt=Classic view of the watchlist page|center|650x650px|thumb]]{{Box Note|boxtype=note|Note text=Since many social entities are created automatically by the system, changes to pages in the namespace SocialEntity are filtered out by default. You can remove the filter to view changes to pages in this namespace.}}
            
            
            
            ==Notifications==
            
            You can get notifications about all changes on that page, if the page is edited, deleted, moved...
            
            In order to receive notifications, user must subscribe to relevant notifications in their UserPreferences, under Notifications tab.
            
            
            
            ==Watchlist widget==
            
            [[File:Watchlist4a.png|thumb|Preferences for Watchlist widget]]
            
            BlueSpiceWatchlist also provides a widget to display the list of pages in the watchlist in [[Manual:Extension/BlueSpiceUserSideBar| user sidebar]].
            
            This list can be configured from UserPreferences, under BlueSpice section:
            
            * Limit of entries - number of pages to show in the widget
            
            * Sort by - criteria by which to sort pages in the watchlist
            
            
            
            ==See also==
            
            [[Reference:WatchList|Reference page]] for this extension..
            
            
            
            To receive notifications, go to your ''[[Manual:Preferences|Preferences]]'' and open the ''Notifications'' tab. You can select to get notifications about the following changes:
            
            
            
            *'''Actions on pages in watchlist:''' A page was edited or deleted.
            
            *'''Entity actions on watched pages:''' A discussion topic or an attachment was added, edited, or deleted.
            
            
            
            ==Sidebar widget==
            
            
            
            The watchlist is, by default, is included in the[[Manual:Extension/BlueSpiceUserSidebar| user sidebar]]. It can be removed by deletiing the entry <code>*WATCHLIST</code>. 
            
            
            
            ==The watchlist tag==
            
            You can include the watchlist in the page content by adding the tag
            
            
            <code><nowiki><bs:watchlist /></nowiki></code>.
            
            '''Example:'''<syntaxhighlight lang="text">
            
            
            <bs:watchlist count="4" maxtitlelength="20" order="time" />
            
            
            </syntaxhighlight>Output:<br />
            
            
            
            
            <bs:watchlist count="4" maxtitlelength="20" order="time" />
            
            
            
            {{Box Links-en|Topic1=[[Reference:BlueSpiceWatchList]]}}
            
            {{Translation}}
            
            
            
            [[Category:Maintenance]]