Difference between revisions of "Manual:Extension/BlueSpiceExpiry"

__HIDETITLE__
            
            
            
            
            <bs:bookshelf src="Book:User manual" />
            
            
            
            __TOC__
            
            
            
            ==What is Expiry?==
            
            
            
            '''Expiry''' marks after a certain period of time a chosen article as "obsolete". The article{{DISPLAYTITLE:Expiry}}
            
            
            
            '''Expiry''' marks  a wiki page as "obsolete". The page can be updated by editing or by confirming that the articlepage is still up-to-date. 
            
            
        Expiry is the ideal basis for an archiving system. Outdated articles can be moved to an archive automatically or after being queried. 
            
            ==Functionality==
            
            
            
            *Add an expiration date to the article,
            
            :*An author can add an expiration date to an article. There is a menu item "Set expiration date",
            
            :*This is done via a dialogue,
            
            :*There is a date deposited.
            
            :*It is possible to specify if you want to be notified (one week) before expiration -> comes from Functional_Design / Reminder.
            
            
            
            *Memory
            
            
            
            **One week before expiration, the user will be notified by e-mail,
            
            **The article will be marked as "obsolete" in the status bar,
            
            **A button appears in the status bar, with which the author can confirm the topicality of the article,
            
            **The expiry date can then automatically be postponed to the future for a specific period of time.
            
            
            
            
            
            *Delete expiration date
            
            
            
            **If an expiration date is stored for an article, then this can be removed via a menu entry "delete expiration date",
            
            **This also removes any possible labeling as "obsolete".
            
            
            
            
            
            *Logging
            
            
            
            **Setting up / changing an expiry date is stored in the MW logbook. USER has set an expiration date of X for ARTIKEL.
            
            **The update of an article is stored in the MW logbook. USER has confirmed that ARTIKEL is up to date.
            
            
            
            
            
            *Overview: SpecialExpiry
            
            **There is an overview of all obsolete articles
            
            **This can also be filtered by users.
            
            
            
            ==Visibility== 
            
            (modes, namespaces, views, required rights)
            
            
            
            *The function is available to any user with the appropriate authorization
            
            *The function is available for every article (All NRs)
            
            
            
            ==Sorting==
            
            
            
            Special: Expired_Articles
            
            
            
            *Sort by expiration date (default).
            
            *In addition, it should be possible to sort by article, user and status.
            
            
            
            ==Screenshots==
            
            
            
            [[File:expiry_en.PNG|thumb|center|850x550px|Set an expiry date for an article]]
            
            
            
            
            
            [[File:expiry2_en.PNG|thumb|center|450x128px|Set an expiry date for an articleExpiry can be set on any content page of the wiki.  
            
            
            
            ==Expiring a page==
            
            [[File:Expiry1.png|thumb|alt=Page tools|center|650x650px|Page tools]]
            
            Expiry for a page can be set from the ''Quality management tab'' in the page tools. After clicking on "Expiry", a form opens in a fly-out layer.
            
            
            
            If the page has already been expired, the expiration date is shown. In this case, a user can remove the expiration from the page by clicking on ''Unexpire the page''.
            
            
            
            If no expiration date is set, users can set an expiration date and enter  a short comment: In addition, the user can create a [[Manual:Extension/BlueSpiceReminder|reminder]] for the page.
            
            After saving the form, the page is reloaded and updated information is displayed.
            
            
            
            
            <br />[[File:Expiry2.png|thumb|alt=Expiring a page|center|650x650px|Expiring a page]]
            
            ==Overview of expired wiki pages==
            
            Users can see all of the pages set to expire, along with expiry information for those pages on ''Special:Expiry'' page.
            
            This page can be accessed from the Expiry flyout described above, by clicking on Expiry manager at the bottom of the flyout.
            
            All expiration dates can be deleted or edited from this page.
            
            
            
            
            <br />
            
            [[File:Expiry3.png|thumb|Expiry manager|alt=Expiry manager|center|650x650px]]
            
            
            
            ==Configuration==
            
            
            
            In the [[Manual:Extension/BlueSpiceConfigManager|Config manager]], you can change the following settings:
            
            
            
            {{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceExpiry}}
            
            
            
            {{Box Links-en|Topic2=[[Reference:BlueSpiceExpiry]]|Topic1=[[Quality assurance]]}}
            
            [[en:{{FULLPAGENAME}}]]
            
            [[de:Handbuch:Erweiterung/BlueSpiceExpiry]]
            
            __FORCETOC__
            
            [[Category:Quality]]