Documentation for ucomment

Hide comments

Future features

  • Mostly implemented already: Update a published document using the exiting pickle files (i.e. faster republishing). Still needs some testing.

  • Being able to specify a freshenv setting before compiling; to allow a full compile of the document.

  • Rejecting comments is still to be handled, coupled with a web-based tool to send a reason along with the rejection email to the comment submitter.

  • Ability for reader to add notes to the document and resume adding/editing the notes when returning.

  • Allow for 3rd party search tools to be used instead of the built-in simple search: e.g., or Whoosh.

  • Add support for other distributed revision control systems (currently only Mercurial is supported). DVCS wrappers for SVN, Bazaar and Git.

  • Real-time preview of comments while the user is typing (via AJAX). E.g. see the site.

  • Comment administration interface where the comment admin can approve/reject accumulated comments in one go.

  • Add a Sphinx extension to enable a directive that generates Beamer slides inline in the RST.

  • Add inline comments as an option (e.g. see Mercurial book website).

Contribute your comments (this window can be dragged out of the way)X

(Please read the help on commenting)

Want to add to the discussion? Please click here.

About this comment system

This pages uses a commenting system to obtain your feedback. Feel free to ask questions, provide your perspective, or leave a relevant comment on any block of text, bullet point, code, or chunck of content.

To get started, please click on the vertical sidebar, near the content you would like to comment on. It will highlight the section you are commenting on.

Shows how the comment system works

After being approved, your comment will appear on the website. Please provide your name and email address if you would like to receive credit for your contribution.

Please note that we reserve the right to edit or remove a comment, and that you give us permission to use your contribution.

How to comment

  • Italics:    *italic text*
  • Bold text:     **bold text**
  • monospaced text:     ``monospaced text`` (use backquotes)
  • Hyperlinks are automatically detected: shows up as
  • Unnumbered bullet points use * asterisks, while numbered points use a # hash mark.
    * This is a bulleted list.
    * It has two items, the second
      item uses two lines.
      #. Point one.
      #. Point two.
  • Mathematics: \(e^{i\pi} + 1 = 0\) will show as Euler's famous equation, \(e^{i\pi} + 1 = 0\), if the site administrator has allowed mathematics in the comments. Similarly, you can use \[ ... \] to write a stand-alone mathematical equation.

    See this page for help with writing math equations.

Tables, source code and other elements can also be added to your comment; please read more here.