Difference between revisions of "Manual:Archive:Extension/RatedComments"

<bs:bookshelf src="Book:User manual" />
        
        
        
        __TOC__
        
        
        
        ==What is RatedComments?==
        
        
        
        With '''RatedComments''' users can rate articles and comment their own ratings.
        
        
        
        ===Rights (permissions)===
            
            
            
            Users must have "ratedcommentsedit" permission to change ratings of a comment, as well as permissions for [[Shoutbox]] extension to view/edit comments, and permissions for [[Rating]] extension.
            
            
            
            ==Where to find RatedComments?==
        
        
        
        If RatedComments is installed in the wiki, you will find it under every article by clicking on ''Shoutbox''. There you have the possibility to rate the article with starts. Furthermore, you can justify your rating in a comment. Other users can then mark your comment as ''Helpful'' or ''Not helpful''.
        
        
        
        ::: [[File:RatedComments_Bewertungen-en.png|Screenshot: Ratings under an article]]
        
        
        
        ==How to use RatedComments? (Step-by-step)==
        
        
        
        '''Step 1:''' Click on ''Shoutbox'' at the end of the article you want to rate. This will also show you any other ratings for this article by other users.
        
        
        
        '''Step 2:''' Click on ''Rate this article''.
        
        
        
        ::: [[File:RatedComments_footer-en.png|Screenshot: Here you can rate the article]]
        
        
        
        
        
        '''Step 3:''' Move your mouse over the stars shown, and choose the amount you want to give. More stars stand for ''good'', less stars for ''not quite that good''. Click when you have marked the desired amount of stars to fix your rating.
        
        
        
        
        
        '''Step 4:''' write a short comment, so that other users understand the reasons for your rating. Choose a fitting title that summarizes your comment in one sentence (e.g. "Good structure, but missing sources"), and complete your rating with the comment itself.
        
        
        
        ::: [[File:RatedComments_BewertungmitInhalt-en.png|Screenshot: Rate with stars and comment]]
        
        
        
        
        
        '''Step 5:''' Click on ''Submit comment'' to finalize your rating.
        
        
        
        Please note: every user can rate every article only once, to prevent the falsification of the rating results.
        
        
        
        ==Average rating of an article==
        
        
        
        Beside the article title, you can see at a glance how many users have rated the article, and what the average star-rating was.
        
        ::: [[File:RatedComments_header-en.png|Screenshot: The number and average rating of all ratings for an article]]
        
        
        
        ==Edit own comments==
        
        
        
        If you have the necessary rights, you can always edit or delete your own comments. Just click on the respective button to the right of your comment.
        
        
        
        ::: [[File:rtdcomm1.jpg|500x89px|Screenshot: Here you can edit or delete your comment]]
        
        
        
        ==Rate other comments==
        
        
        
        You can also rate the comments of other users and mark them as helpful. Click on the respective button (''Yes'' or ''No'') below the comment you want to mark.
        
        
        
        ::: [[File:rtdcomm2_copy.jpg|500x107px|Screenshot: Was a rating helpful? Tell the commentator!]]
        
        
        
        ==Overview of all ratings==
        
        
        
        On the special page <code>Special:Ratings</code> you find an overview of all ratings given in the wiki. The list can be sorted upwards or downwards in every column.
        
        
        
        ::: [[File:RatedComments_spezialseite-en.png|Screenshot: All ratings in the wiki at a glance]]
        
        
        
        ==How to adapt RatedComments?==
        
        
        
        RatedComments works as is, so no further adaptations by the user are necessary. Administrators can adapt RatedComments to the needs of their wiki. You can find out more in the section ''Necessary settings'' below:
        
        
        
        ''Necessary settings'':
        
        
        
        '''Activate star-rating'''
        
        As administrator you can activate the star-rating for individual namespaces in the ''Rating'' tab of the admin settings. There you can also decide where the stars will be shown: beside the article title or in the status bar.
        
        
        
        '''Activate comment function'''
        
        In the admin settings, you can find the tab ''Rated comments''. There you can activate the comment function for individual namespaces, and decide on:
        
        
        
        * '''Maximum length of a message'''.
        
        * '''Maximum length of a message title'''.
        
        * '''Number of comments''' shown.
        
        
        
        ==See also==
        
        
        
        Our [[RatedComments|reference page.]]
        
        
        
        {| style="border: 1px solid #98A7C4; background-color: #ffffff; border-left: 20px solid #98A7C4; margin-bottom: 0.4em; margin-left: auto; margin-right: auto; width: 100%;" cellspacing="2" cellpadding="5" border="0"
        
        |-
        
        ||
        
        The BlueSpice extension '''RatedComments''' is part of [[BlueSpice pro]]. It can also be purchased as a single extension in the [https://shop.bluespice.com/ Shop].
        
        
        
        |}