Changes between Version 3 and Version 4 of PeerReviewPlugin/Reports


Ignore:
Timestamp:
Aug 14, 2016, 6:15:48 PM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • PeerReviewPlugin/Reports

    v3 v4  
    11[[PageOutline(2-3, Categories, pullout)]]
     2
    23= Reports
    3 Instead of shipping it's own report module PeerReviewPlugin relies on Tracs reporting features by leveraging custom TracReports using data from PeerReviewPlugin. These custom reports can be accessed from the regular Trac report page but they are also shown on the report page for reviews.
     4
     5Instead of shipping its own report module, PeerReviewPlugin relies on Trac's reporting features by utilising custom TracReports using data from the PeerReviewPlugin. These custom reports can be accessed from the regular Trac report page but they are also shown on the report page for reviews.
    46
    57Note that when opening a report you are automatically redirected to the Trac report module.
    68
    79There are no reports created during installation. You may use the ones shown below.
     10
    811== Creating Reports
     12
    913=== Displaying a report on the review report page
     14
    1015For reports to show up on the review page you must add the following wiki comment to the reports description.
    1116{{{
     
    2732
    2833}}}
     34
    2935=== Provide links from report results
     36
    3037It is possible to directly link from report results to a referenced review or file. You need to set the {{{realm}}} column in the report as explained in [TracReports#Automaticallyformattedcolumns TracReports: Automatically formatted columns].
    3138
     
    4047       f.revision AS revision, f.status AS status,
    4148       'peerreviewfile' AS _realm,
    42        (SELECT COUNT(*) FROM peerreviewcomment AS c
    43         WHERE f.file_id = c.file_id) AS comments
     49       (SELECT COUNT(*) FROM peerreviewcomment AS c WHERE f.file_id = c.file_id) AS comments
    4450FROM peerreviewfile f
    4551WHERE f.status = 'approved'
     
    4753ORDER BY f.path, f.revision
    4854}}}
     55
    4956== Example Reports
     57
    5058=== All reviews grouped by author
     59
    5160Description:
    5261{{{
     
    7685
    7786=== Approved files
     87
    7888Description:
    7989{{{
     
    102112
    103113=== All files with comments
     114
    104115Description:
    105116{{{
     
    128139
    129140=== Files with comments - My reviews
     141
    130142Description:
    131143{{{
     
    140152 * '''disapproved'''
    141153* Mark files with unread comments
    142   [[BR]][[BR]]Note: the status ''read/unread'' is set for each user.
     154  '''Note''': the status ''read/unread'' is set for each user.
    143155
    144156Back to [/peerreviewreport Codereview reports].
     
    168180INNER JOIN peerreview AS rev ON f.review_id = rev.review_id
    169181WHERE (f.status IS NULL OR f.status NOT IN ('approved', 'disapproved'))
    170 AND f.review_id in
    171 (SELECT a.review_id FROM peerreviewer a JOIN peerreview r
    172 ON a.review_id = r.review_id
    173 WHERE a.reviewer = $USER
    174 AND r.status IS NOT 'closed')
    175 
     182   AND f.review_id in
     183   (SELECT a.review_id FROM peerreviewer a JOIN peerreview r
     184   ON a.review_id = r.review_id
     185   WHERE a.reviewer = $USER
     186   AND r.status IS NOT 'closed')
    176187GROUP BY f.file_id
    177188ORDER BY f.file_id, f.status, f.path, f.revision