Review Request 119991: Use Juvia to add comments on the API class pages

[Denis Steckelmacher]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/119991/
-----------------------------------------------------------

(Updated Sept. 12, 2014, 9:24 a.m.)


Status
------

This change has been marked as submitted.


Review request for KDE Frameworks and Aurélien Gâteau.


Repository: kapidox


Description
-------

Juvia is a Free Software commenting system that can easily be used on static websites like api.kde.org. An instance of Juvia has just been installed on commenting.kde.org (many thanks to Ben Cooksley!), and this patch adds support for it to api.kde.org.

The users can now comment class pages. The comments are disabled (no comment box nor anything else appears) on the main page of each framework, on the Frameworks 5 index page and on any other page that does not directly concern a class. I've done that in order to avoid cluttering important pages with comments, but if you think that having comments on all the pages (or a bigger subset of them) is desirable, it is very easy to change. Personally, I would avoid having comments on the main pages, so that any spam, if the automatic Akismet filter does not work, will not be too visible.

A screenshot is linked to this review request and shows how the comments have been integrated (I slightly modified the built-in Juvia style so that Doxygen and KDE colors are used).


Diffs
-----

  src/kapidox/data/htmlresource/kde.css e173dfe 
  src/kapidox/data/templates/comments.html PRE-CREATION 
  src/kapidox/data/templates/doxygen.html d00e14e 

Diff: https://git.reviewboard.kde.org/r/119991/diff/


Testing
-------

Posting a comment works, and comments can be viewed. They also appear in the admin interface of Juvia (I've now deleted these comments). I posted comments on different classes and in different frameworks in order to test that namespacing works correctly.


File Attachments
----------------

Comments on api.kde.org
  https://git.reviewboard.kde.org/media/uploaded/files/2014/08/29/278299d8-18a6-46a0-ada5-1b6452a3276f__apidox-comments-1.png


Thanks,

Denis Steckelmacher

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20140912/50223945/attachment.html>