Documentation for ucomment

Hide comments
next

ucomment is a Django application that allows for web-based commenting on a document that has been written in reStructuredText.

ucomment relies heavily on Sphinx to typeset the document. A distributed version control system is used to track document revisions and comments made by web users. And it requires Django as the glue to hold it all together.

This entire site uses ucomment, so please visit the pages below to see it in action. You are welcome to contribute your comments, questions and feedback, by clicking on the blue sidebar at left on any of these links below.

Search entire document

next
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:      http://ucomment.org shows up as http://ucomment.org
  • 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.