This is an old revision of the document!

Revamping user comments at

Possible mentor: Philip Olson

This task involves rethinking how we handle user comments at This is mainly (only, currently) done within the PHP manual but it could leak into other areas like at

The first task involves defining what a user note is (or should be). Is an example that happens to use strlen() a fine user note for the strlen() documentation? Are examples even appropriate user notes? Is the current moderation system working? Many other questions will arise.


There has been some discussion.



Baby steps: step A, moderation flags

This involves a simple user notes moderation flag option. Users can flag notes as “bad”, which prompts a moderator to look into it. Users do not need to login, but if not logged in, must answer a recaptcha or similar.

How it will probably work
  1. User clicks on “flag” button near individual note
  2. Popup
    1. Checks if logged in
    2. If not logged in, prompts reCaptcha or similar (human?)
  3. Window now has several options, including:
    1. A button to submit the flag, with no details (quick flag)
    2. Or optionally allow entering details such as name, email, textarea and/or select reason for flag (e.g., Spam)
  4. Flagged notes generate email to a list, and are also listed within our web admin panel. (only email for now is fine)
    1. People can subscribe to receive these emails? (future)
  5. Moderator takes action, which includes current options (delete/reject/modify) and perhaps a new unflag option.
  6. If note flag is accepted (e.g., deleted), should we notify the user via email? Or list via email?

Notes about the current system

The current system was written in the 90's, and contains files spread out in several places throughout the PHP project. Also, various note moderation statistics are listed here.


ideas/usercomments.1304358986.txt.gz · Last modified: 2017/09/22 13:28 (external edit)