Summary

Render new RRs, Reviews and Comments as markdown.

Review Request #3892 — Created Feb. 19, 2013 and discarded Aug. 28, 2013, 5:23 p.m.

Information

Owner

gregwym

Repository

Review Board

Branch

master

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

What has been done, 
- Add rich_text db evolution script. 
  - All old ReviewRequests, Reviews and Comments are marked as `rich_text = False`
  - All later ReviewRequests, Reviews and Comments will be marked as `rich_text = True`
- Enable markdown rendering with code highlight for all pre-text blocks
  - Use `marked` js lib render text
  - Use `google code prettify` for syntax highlighting
  - Rendered text are inserted along the page loading process using `document.write()`
- Use single template file to generate text blocks
- Always place text inside <pre> tag
- Adjust the css style for markdown text

Testing Done

Execute `./reviewboard/manage.py evolve --execute` on RB 1.7.6 database. 
- All reviews and comments are marked as `rich_text = False`

Then post a new review. 
- The new review is marked as `rich_text = True`
- The new review is rendered as Markdown with `.rich-text` class attribute
- The old reviews stays as they used to be

Files

Issues

Description	From	Last Updated
Col: 21 E128 continuation line under-indented for visual indent	reviewbot	Feb. 19, 2013, 9:06 p.m.
So, Django Evolution has some design problems that we're trying to work around, and one of the necessary workarounds is …	chipx86	March 8, 2013, 12:22 a.m.
The jquery-ui bit is because Djblets owns a copy of jquery-ui and we want to make sure that both Djblets …	chipx86	March 8, 2013, midnight
Col: 7 E702 multiple statements on one line (semicolon)	reviewbot	March 20, 2013, 10:31 p.m.
Can this not be combined with rich_text.py?	mike_conley	April 4, 2013, 5:50 p.m.
indent this one more space	mike_conley	April 4, 2013, 5:52 p.m.
typo: nad -> and	mike_conley	April 4, 2013, 5:52 p.m.
If this isn't needed, please remove it.	mike_conley	April 4, 2013, 5:54 p.m.
What node is this trying to remove?	mike_conley	April 4, 2013, 5:55 p.m.

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/reviews/views.py
    reviewboard/reviews/evolutions/__init__.py
    reviewboard/reviews/evolutions/rich_text.py
    reviewboard/reviews/models.py
  Ignored Files:
    reviewboard/templates/reviews/review_detail.html

reviewboard/reviews/views.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 21
 E128 continuation line under-indented for visual indent
```

Change Summary:

- Add rich_text field for `BaseReviewRequestDetails` in the models.py and the evolution script. 
- Add `marked` and `google-code-prettify` to static/lib/js
- Add `richtext.html` as js template which import richtext rendering required js libs
- Add rich-text render process into $(document).ready() of the `review_detail.html` template

Description:

		What has been done,
		- Add rich_text db evolution script.
~		- All old reviews and comments are marked as `rich_text = False`
~		- All reviews and comments post after this will be marked as `rich_text = True`
~		- Enable markdown rendering with code highlight for `review.body_top` (for testing and style demo purpose only)
~		- Use pre block and escaped text for non-rich_text reviews
~		- Use div block and safe text for rich_text reviews
	~	- All old ReviewRequests, Reviews and Comments are marked as `rich_text = False`
	~	- All later ReviewRequests, Reviews and Comments will be marked as `rich_text = True`
	~	- Enable markdown rendering with code highlight for `review.body_top`
	~	- Use `pre` block and escaped text for non-rich_text reviews
	~	- Use `div` block and safe text for rich_text reviews
	+	- Use `marked` js lib render text onReady
	+	- Use `google code prettify` for syntax highlighting

		What's next,
~		- Try JS/Python markdown libraries and collect info...
~		- How the text been formated/styled
~		- How is the performance
	~	- Try more JS/Python markdown libraries and collect info...
	~	- Try solve the anchor related issue with `marked`
	~	- Adjust the css style for markdown text
-		- Whether effecting the anchor or scrolling
-		- Considering add rich_text field into `BaseReviewRequestDetails`, so `Description` and `Testing Done` will be have the Markdown capability as well.

Testing Done:

~		Execute `./reviewboard/manage.py evolve --execute` on RB 1.7.5 database.
	~	Execute `./reviewboard/manage.py evolve --execute` on RB 1.7.6 database.
		- All reviews and comments are marked as `rich_text = False`

		Then post a new review.
		- The new review is marked as `rich_text = True`
~		- The new review is rendered as Markdown in a div block
	~	- The new review is rendered as Markdown in a div block with `.rich-text` class attribute
		- The old reviews stays as they used to be

Diff:

Revision 2 (+1257 -1)

Show changes

	reviewboard/reviews/models.py
	reviewboard/reviews/evolutions/__init__.py
	reviewboard/reviews/evolutions/rich_text.py
	reviewboard/static/lib/js/marked.js
	reviewboard/static/lib/js/google-code-prettify/lang-apollo.js
	reviewboard/static/lib/js/google-code-prettify/lang-basic.js
	reviewboard/static/lib/js/google-code-prettify/lang-clj.js
	reviewboard/static/lib/js/google-code-prettify/lang-css.js
	29 more

Added Files:

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/reviews/evolutions/__init__.py
    reviewboard/reviews/evolutions/rich_text.py
    reviewboard/reviews/models.py
  Ignored Files:
    reviewboard/static/lib/js/google-code-prettify/lang-proto.js
    reviewboard/static/lib/js/google-code-prettify/lang-lua.js
    reviewboard/static/lib/js/google-code-prettify/lang-ml.js
    reviewboard/static/lib/js/google-code-prettify/lang-yaml.js
    reviewboard/static/lib/js/google-code-prettify/lang-n.js
    reviewboard/static/lib/js/google-code-prettify/lang-tex.js
    reviewboard/static/lib/js/google-code-prettify/lang-lisp.js
    reviewboard/static/lib/js/google-code-prettify/lang-vhdl.js
    reviewboard/static/lib/js/google-code-prettify/lang-dart.js
    reviewboard/static/lib/js/marked.js
    reviewboard/static/lib/js/google-code-prettify/lang-scala.js
    reviewboard/static/lib/js/google-code-prettify/lang-apollo.js
    reviewboard/static/lib/js/google-code-prettify/lang-vb.js
    reviewboard/static/lib/js/google-code-prettify/lang-tcl.js
    reviewboard/static/lib/js/google-code-prettify/run_prettify.js
    reviewboard/static/lib/js/google-code-prettify/lang-xq.js
    reviewboard/static/lib/js/google-code-prettify/prettify.css
    reviewboard/static/lib/js/google-code-prettify/lang-r.js
    reviewboard/static/lib/js/google-code-prettify/lang-clj.js
    reviewboard/templates/reviews/review_detail.html
    reviewboard/static/lib/js/google-code-prettify/lang-sql.js
    reviewboard/static/lib/js/google-code-prettify/lang-erlang.js
    reviewboard/static/lib/js/google-code-prettify/prettify.js
    reviewboard/static/lib/js/google-code-prettify/lang-wiki.js
    reviewboard/static/lib/js/google-code-prettify/lang-css.js
    reviewboard/templates/base.html
    reviewboard/static/lib/js/google-code-prettify/lang-rd.js
    reviewboard/static/lib/js/google-code-prettify/lang-go.js
    reviewboard/static/lib/js/google-code-prettify/lang-basic.js
    reviewboard/static/lib/js/google-code-prettify/lang-mumps.js
    reviewboard/static/lib/js/google-code-prettify/lang-hs.js
    reviewboard/templates/js/richtext.html
    reviewboard/static/lib/js/google-code-prettify/lang-llvm.js
    reviewboard/static/lib/js/google-code-prettify/lang-pascal.js

So far this looks really good, Greg! Keep it up!

reviewboard/reviews/evolutions/rich_text.py (Diff revision 2)

The issue has been resolved. Show all issues

So, Django Evolution has some design problems that we're trying to work around, and one of the necessary workarounds is that we don't introduce evolutions for tables that haven't been around since the first release. FileAttachmentComment is newer than that.

I'm hoping to find a way to change that so that it's not a problem, but for now, I want to make sure we're more bullet-proof.

Can you make a second evolution that does just this particular AddField? Make sure to test that it works against a database made prior to these evolutions.

reviewboard/templates/base.html (Diff revision 2)

The issue has been resolved. Show all issues

The jquery-ui bit is because Djblets owns a copy of jquery-ui and we want to make sure that both Djblets and Review Board share the same definitions, which Review Board can override.

In your case, there should not be a separate file. Instead, all the scripts we need for this feature should be defined as a "markdown" Pipeline JavaScript bundle in settings.py (PIPELINE_JS dictionary). Then you should just use {% compressed_js "markdown" %} on it.

Same thing for CSS.

Change Summary:

- Use document.write() to write rendered text directly during loading
- Move evolution of FileAttachmentComment to separate evolution script

Description:

		What has been done,
		- Add rich_text db evolution script.
		- All old ReviewRequests, Reviews and Comments are marked as `rich_text = False`
		- All later ReviewRequests, Reviews and Comments will be marked as `rich_text = True`
	+	- Evolution for FileAttachmentComment locates in separated evolution script
		- Enable markdown rendering with code highlight for `review.body_top`
		- Use `pre` block and escaped text for non-rich_text reviews
		- Use `div` block and safe text for rich_text reviews
~		- Use `marked` js lib render text onReady
~		- Use `google code prettify` for syntax highlighting
	~	- Use `marked` js lib render text
	~	- Use `google code prettify` for syntax highlighting
	+	- Rendered text are inserted along the page loading process using document.write()

		What's next,
~		- Try more JS/Python markdown libraries and collect info...
~		- Try solve the anchor related issue with `marked`
	~	- Adjust the css style for markdown text
	~	- Apply Markdown to more text fields
-		- Adjust the css style for markdown text

Diff:

Revision 3 (+1280 -1)

Show changes

	reviewboard/settings.py
	reviewboard/reviews/models.py
	reviewboard/reviews/evolutions/__init__.py
	reviewboard/reviews/evolutions/rich_text.py
	reviewboard/reviews/evolutions/rich_text_file_attach_comment.py
	reviewboard/static/lib/css/prettify.css
	reviewboard/static/lib/js/marked.js
	reviewboard/static/lib/js/google-code-prettify/lang-apollo.js
	30 more

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/reviews/evolutions/__init__.py
    reviewboard/reviews/models.py
    reviewboard/settings.py
    reviewboard/reviews/evolutions/rich_text.py
    reviewboard/reviews/evolutions/rich_text_file_attach_comment.py
  Ignored Files:
    reviewboard/static/lib/js/google-code-prettify/lang-proto.js
    reviewboard/static/lib/js/google-code-prettify/lang-lua.js
    reviewboard/static/lib/js/google-code-prettify/lang-ml.js
    reviewboard/static/lib/js/google-code-prettify/lang-yaml.js
    reviewboard/static/lib/js/google-code-prettify/lang-lisp.js
    reviewboard/static/lib/js/google-code-prettify/lang-n.js
    reviewboard/static/lib/js/google-code-prettify/lang-tex.js
    reviewboard/static/lib/css/prettify.css
    reviewboard/templates/reviews/reviewable_base.html
    reviewboard/static/lib/js/google-code-prettify/lang-vhdl.js
    reviewboard/static/lib/js/google-code-prettify/lang-dart.js
    reviewboard/static/lib/js/marked.js
    reviewboard/static/lib/js/google-code-prettify/lang-scala.js
    reviewboard/static/lib/js/google-code-prettify/lang-apollo.js
    reviewboard/static/lib/js/google-code-prettify/lang-vb.js
    reviewboard/static/lib/js/google-code-prettify/lang-tcl.js
    reviewboard/static/lib/js/google-code-prettify/run_prettify.js
    reviewboard/static/lib/js/google-code-prettify/lang-xq.js
    reviewboard/static/lib/js/google-code-prettify/lang-r.js
    reviewboard/static/lib/js/google-code-prettify/lang-clj.js
    reviewboard/templates/reviews/review_detail.html
    reviewboard/static/lib/js/google-code-prettify/lang-sql.js
    reviewboard/static/lib/js/google-code-prettify/lang-erlang.js
    reviewboard/static/lib/js/google-code-prettify/prettify.js
    reviewboard/static/lib/js/google-code-prettify/lang-wiki.js
    reviewboard/static/lib/js/google-code-prettify/lang-css.js
    reviewboard/static/lib/js/google-code-prettify/lang-rd.js
    reviewboard/static/lib/js/google-code-prettify/lang-go.js
    reviewboard/static/lib/js/google-code-prettify/lang-basic.js
    reviewboard/static/lib/js/google-code-prettify/lang-mumps.js
    reviewboard/static/lib/js/google-code-prettify/lang-hs.js
    reviewboard/static/lib/js/google-code-prettify/lang-llvm.js
    reviewboard/static/lib/js/google-code-prettify/lang-pascal.js

Change Summary:

Add markdown to body_bottom and diff_comment. 
Adding markdown to other review comments in `review_reply.html` prevents banners from appearing.

Description:

		What has been done,
		- Add rich_text db evolution script.
		- All old ReviewRequests, Reviews and Comments are marked as `rich_text = False`
		- All later ReviewRequests, Reviews and Comments will be marked as `rich_text = True`
		- Evolution for FileAttachmentComment locates in separated evolution script
~		- Enable markdown rendering with code highlight for `review.body_top`
	~	- Enable markdown rendering with code highlight for `review.body_top\body_bottom` and `diff_comment`
		- Use `pre` block and escaped text for non-rich_text reviews
		- Use `div` block and safe text for rich_text reviews
		- Use `marked` js lib render text
		- Use `google code prettify` for syntax highlighting
~		- Rendered text are inserted along the page loading process using document.write()
	~	- Rendered text are inserted along the page loading process using document.write()
	+	- Adding markdown to other review comments in `review_reply.html` prevents banners from appearing.

		What's next,
		- Adjust the css style for markdown text
		- Apply Markdown to more text fields

Diff:

Revision 4 (+1321 -3)

Show changes

	reviewboard/settings.py
	reviewboard/reviews/models.py
	reviewboard/reviews/evolutions/__init__.py
	reviewboard/reviews/evolutions/rich_text.py
	reviewboard/reviews/evolutions/rich_text_file_attach_comment.py
	reviewboard/reviews/templatetags/reviewtags.py
	reviewboard/static/lib/css/prettify.css
	reviewboard/static/lib/js/marked.js
	32 more

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/settings.py
    reviewboard/reviews/models.py
    reviewboard/reviews/evolutions/__init__.py
    reviewboard/reviews/templatetags/reviewtags.py
    reviewboard/reviews/evolutions/rich_text_file_attach_comment.py
    reviewboard/reviews/evolutions/rich_text.py
  Ignored Files:
    reviewboard/static/lib/js/google-code-prettify/lang-proto.js
    reviewboard/static/lib/js/google-code-prettify/lang-lua.js
    reviewboard/static/lib/js/google-code-prettify/lang-ml.js
    reviewboard/static/lib/js/google-code-prettify/lang-yaml.js
    reviewboard/static/lib/js/google-code-prettify/lang-lisp.js
    reviewboard/static/lib/js/google-code-prettify/lang-n.js
    reviewboard/static/lib/js/google-code-prettify/lang-tex.js
    reviewboard/static/lib/css/prettify.css
    reviewboard/templates/reviews/reviewable_base.html
    reviewboard/static/lib/js/google-code-prettify/lang-vhdl.js
    reviewboard/static/lib/js/google-code-prettify/lang-dart.js
    reviewboard/templates/reviews/review_reply.html
    reviewboard/static/lib/js/marked.js
    reviewboard/static/lib/js/google-code-prettify/lang-scala.js
    reviewboard/static/lib/js/google-code-prettify/lang-apollo.js
    reviewboard/static/lib/js/google-code-prettify/lang-vb.js
    reviewboard/static/lib/js/google-code-prettify/lang-tcl.js
    reviewboard/static/lib/js/google-code-prettify/run_prettify.js
    reviewboard/static/lib/js/google-code-prettify/lang-xq.js
    reviewboard/static/lib/js/google-code-prettify/lang-r.js
    reviewboard/static/lib/js/google-code-prettify/lang-clj.js
    reviewboard/templates/reviews/review_detail.html
    reviewboard/static/lib/js/google-code-prettify/lang-sql.js
    reviewboard/static/lib/js/google-code-prettify/lang-erlang.js
    reviewboard/static/lib/js/google-code-prettify/prettify.js
    reviewboard/static/lib/js/google-code-prettify/lang-wiki.js
    reviewboard/static/lib/js/google-code-prettify/lang-css.js
    reviewboard/static/lib/js/google-code-prettify/lang-rd.js
    reviewboard/static/lib/js/google-code-prettify/lang-go.js
    reviewboard/static/lib/js/google-code-prettify/lang-basic.js
    reviewboard/static/lib/js/google-code-prettify/lang-mumps.js
    reviewboard/static/lib/js/google-code-prettify/lang-hs.js
    reviewboard/static/lib/js/google-code-prettify/lang-llvm.js
    reviewboard/static/lib/js/google-code-prettify/lang-pascal.js

Change Summary:

- Place all markdown text inside <pre>
- Use separate template file to generate rendering code

Description:

		What has been done,
		- Add rich_text db evolution script.
		- All old ReviewRequests, Reviews and Comments are marked as `rich_text = False`
		- All later ReviewRequests, Reviews and Comments will be marked as `rich_text = True`
		- Evolution for FileAttachmentComment locates in separated evolution script
		- Enable markdown rendering with code highlight for `review.body_top\body_bottom` and `diff_comment`
-		- Use `pre` block and escaped text for non-rich_text reviews
-		- Use `div` block and safe text for rich_text reviews
		- Use `marked` js lib render text
		- Use `google code prettify` for syntax highlighting
		- Rendered text are inserted along the page loading process using document.write()
~		- Adding markdown to other review comments in `review_reply.html` prevents banners from appearing.
	~	- Place all markdown text inside <pre>
	+	- Use separate template file to generate rendering code

		What's next,
		- Adjust the css style for markdown text
~		- Apply Markdown to more text fields
	~	- Fix `linkifyText`, so it won't mess up the url within markdown

Testing Done:

		Execute `./reviewboard/manage.py evolve --execute` on RB 1.7.6 database.
		- All reviews and comments are marked as `rich_text = False`

		Then post a new review.
		- The new review is marked as `rich_text = True`
~		- The new review is rendered as Markdown in a div block with `.rich-text` class attribute
	~	- The new review is rendered as Markdown with `.rich-text` class attribute
		- The old reviews stays as they used to be

Diff:

Revision 5 (+1338 -5)

Show changes

	reviewboard/settings.py
	reviewboard/reviews/models.py
	reviewboard/reviews/evolutions/__init__.py
	reviewboard/reviews/evolutions/rich_text.py
	reviewboard/reviews/evolutions/rich_text_file_attach_comment.py
	reviewboard/reviews/templatetags/reviewtags.py
	reviewboard/static/lib/css/prettify.css
	reviewboard/static/lib/js/marked.js
	35 more

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/settings.py
    reviewboard/reviews/models.py
    reviewboard/reviews/evolutions/__init__.py
    reviewboard/reviews/templatetags/reviewtags.py
    reviewboard/reviews/evolutions/rich_text_file_attach_comment.py
    reviewboard/reviews/evolutions/rich_text.py
  Ignored Files:
    reviewboard/static/lib/js/google-code-prettify/lang-proto.js
    reviewboard/static/lib/js/google-code-prettify/lang-lua.js
    reviewboard/static/lib/js/google-code-prettify/lang-ml.js
    reviewboard/static/lib/js/google-code-prettify/lang-yaml.js
    reviewboard/static/lib/js/google-code-prettify/lang-lisp.js
    reviewboard/static/lib/js/google-code-prettify/lang-n.js
    reviewboard/static/lib/js/google-code-prettify/lang-tex.js
    reviewboard/static/lib/css/prettify.css
    reviewboard/templates/reviews/reviewable_base.html
    reviewboard/static/lib/js/google-code-prettify/lang-vhdl.js
    reviewboard/static/lib/js/google-code-prettify/lang-dart.js
    reviewboard/templates/reviews/review_reply.html
    reviewboard/templates/reviews/review_rich_text_markdown.html
    reviewboard/static/lib/js/marked.js
    reviewboard/static/lib/js/google-code-prettify/lang-scala.js
    reviewboard/static/lib/js/google-code-prettify/lang-apollo.js
    reviewboard/static/lib/js/google-code-prettify/lang-vb.js
    reviewboard/static/lib/js/google-code-prettify/lang-tcl.js
    reviewboard/static/rb/js/reviews.js
    reviewboard/static/lib/js/google-code-prettify/run_prettify.js
    reviewboard/static/lib/js/google-code-prettify/lang-xq.js
    reviewboard/static/lib/js/google-code-prettify/lang-r.js
    reviewboard/static/lib/js/google-code-prettify/lang-clj.js
    reviewboard/templates/reviews/review_detail.html
    reviewboard/static/lib/js/google-code-prettify/lang-sql.js
    reviewboard/static/lib/js/google-code-prettify/lang-erlang.js
    reviewboard/static/lib/js/google-code-prettify/prettify.js
    reviewboard/static/lib/js/google-code-prettify/lang-wiki.js
    reviewboard/static/lib/js/google-code-prettify/lang-css.js
    reviewboard/static/lib/js/google-code-prettify/lang-rd.js
    reviewboard/static/lib/js/google-code-prettify/lang-go.js
    reviewboard/static/lib/js/google-code-prettify/lang-basic.js
    reviewboard/static/lib/js/google-code-prettify/lang-mumps.js
    reviewboard/templates/reviews/review_request_box.html
    reviewboard/static/lib/js/google-code-prettify/lang-hs.js
    reviewboard/static/lib/js/google-code-prettify/lang-llvm.js
    reviewboard/static/lib/js/google-code-prettify/lang-pascal.js

reviewboard/reviews/templatetags/reviewtags.py (Diff revision 5)
The issue has been resolved. Show all issues
```
Col: 7
 E702 multiple statements on one line (semicolon)
```

Change Summary:

- Prevent `linkifyText` from applying to `.rich-text`
- Change JS and CSS Pipeline name from `markdown` to `text`
- Rename `rich_text_markdown` function and template to `review_text_block`, which generate all pre-text blocks. 
- Add textUtils.js and inserted `marked` options initialization
- Extract `linkifyText` from reviews.js into three different functions in textUtils.js

Description:

		What has been done,
		- Add rich_text db evolution script.
		- All old ReviewRequests, Reviews and Comments are marked as `rich_text = False`
		- All later ReviewRequests, Reviews and Comments will be marked as `rich_text = True`
		- Evolution for FileAttachmentComment locates in separated evolution script
~		- Enable markdown rendering with code highlight for `review.body_top\body_bottom` and `diff_comment`
	~	- Enable markdown rendering with code highlight for all pre-text blocks
		- Use `marked` js lib render text
		- Use `google code prettify` for syntax highlighting
		- Rendered text are inserted along the page loading process using document.write()
~		- Place all markdown text inside <pre>
~		- Use separate template file to generate rendering code
	~	- Use single template file to generate text blocks
	~	- Always place text inside <pre> tag

		What's next,
~		- Adjust the css style for markdown text
	~	- Adjust the css style for markdown text
-		- Fix `linkifyText`, so it won't mess up the url within markdown

Diff:

Revision 6 (+1406 -10)

Show changes

	reviewboard/settings.py
	reviewboard/reviews/models.py
	reviewboard/reviews/evolutions/__init__.py
	reviewboard/reviews/evolutions/rich_text.py
	reviewboard/reviews/evolutions/rich_text_file_attach_comment.py
	reviewboard/reviews/templatetags/reviewtags.py
	reviewboard/static/lib/css/prettify.css
	reviewboard/static/lib/js/marked.js
	36 more

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/settings.py
    reviewboard/reviews/models.py
    reviewboard/reviews/evolutions/__init__.py
    reviewboard/reviews/templatetags/reviewtags.py
    reviewboard/reviews/evolutions/rich_text_file_attach_comment.py
    reviewboard/reviews/evolutions/rich_text.py
  Ignored Files:
    reviewboard/static/lib/js/google-code-prettify/lang-proto.js
    reviewboard/static/lib/js/google-code-prettify/lang-lua.js
    reviewboard/static/lib/js/google-code-prettify/lang-ml.js
    reviewboard/static/lib/js/google-code-prettify/lang-yaml.js
    reviewboard/static/lib/css/prettify.css
    reviewboard/static/lib/js/google-code-prettify/lang-n.js
    reviewboard/static/lib/js/google-code-prettify/lang-tex.js
    reviewboard/static/lib/js/google-code-prettify/lang-lisp.js
    reviewboard/templates/reviews/reviewable_base.html
    reviewboard/static/lib/js/google-code-prettify/lang-vhdl.js
    reviewboard/static/lib/js/google-code-prettify/lang-dart.js
    reviewboard/templates/reviews/review_reply.html
    reviewboard/static/lib/js/marked.js
    reviewboard/static/lib/js/google-code-prettify/lang-r.js
    reviewboard/static/lib/js/google-code-prettify/lang-apollo.js
    reviewboard/static/lib/js/google-code-prettify/lang-vb.js
    reviewboard/static/lib/js/google-code-prettify/lang-tcl.js
    reviewboard/static/rb/js/reviews.js
    reviewboard/static/lib/js/google-code-prettify/run_prettify.js
    reviewboard/static/lib/js/google-code-prettify/lang-xq.js
    reviewboard/static/lib/js/google-code-prettify/lang-scala.js
    reviewboard/static/lib/js/google-code-prettify/lang-clj.js
    reviewboard/templates/reviews/review_detail.html
    reviewboard/static/lib/js/google-code-prettify/lang-sql.js
    reviewboard/static/lib/js/google-code-prettify/lang-erlang.js
    reviewboard/static/lib/js/google-code-prettify/prettify.js
    reviewboard/static/rb/js/utils/textUtils.js
    reviewboard/templates/reviews/review_text_block.html
    reviewboard/static/lib/js/google-code-prettify/lang-wiki.js
    reviewboard/static/lib/js/google-code-prettify/lang-css.js
    reviewboard/static/lib/js/google-code-prettify/lang-rd.js
    reviewboard/static/lib/js/google-code-prettify/lang-go.js
    reviewboard/static/lib/js/google-code-prettify/lang-basic.js
    reviewboard/static/lib/js/google-code-prettify/lang-mumps.js
    reviewboard/templates/reviews/review_request_box.html
    reviewboard/static/lib/js/google-code-prettify/lang-hs.js
    reviewboard/static/lib/js/google-code-prettify/lang-llvm.js
    reviewboard/static/lib/js/google-code-prettify/lang-pascal.js

Greg, is this ready to come out of WIP yet?

gregwym April 2, 2013, 3:30 p.m.

Here we go. Tweaked all the styles. That was the only thing missing.

Change Summary:

- Adjust the css style for markdown text
- Add latest screenshot

Summary:

[WIP]Add rich_text db evolution script for reviews.models. Render markdown if is rich_text.

Render new RRs, Reviews and Comments as markdown.

Description:

		What has been done,
		- Add rich_text db evolution script.
		- All old ReviewRequests, Reviews and Comments are marked as `rich_text = False`
		- All later ReviewRequests, Reviews and Comments will be marked as `rich_text = True`
		- Evolution for FileAttachmentComment locates in separated evolution script
		- Enable markdown rendering with code highlight for all pre-text blocks
		- Use `marked` js lib render text
		- Use `google code prettify` for syntax highlighting
		- Rendered text are inserted along the page loading process using document.write()
		- Use single template file to generate text blocks
~		- Always place text inside <pre> tag
	~	- Always place text inside <pre> tag
-
-		What's next,
		- Adjust the css style for markdown text

Diff:

Revision 7 (+1502 -10)

Show changes

	reviewboard/settings.py
	reviewboard/reviews/models.py
	reviewboard/reviews/evolutions/__init__.py
	reviewboard/reviews/evolutions/rich_text.py
	reviewboard/reviews/evolutions/rich_text_file_attach_comment.py
	reviewboard/reviews/templatetags/reviewtags.py
	reviewboard/static/lib/css/prettify.css
	reviewboard/static/lib/js/marked.js
	37 more

Added Files:

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/settings.py
    reviewboard/reviews/models.py
    reviewboard/reviews/evolutions/__init__.py
    reviewboard/reviews/templatetags/reviewtags.py
    reviewboard/reviews/evolutions/rich_text_file_attach_comment.py
    reviewboard/reviews/evolutions/rich_text.py
  Ignored Files:
    reviewboard/static/lib/js/google-code-prettify/lang-proto.js
    reviewboard/static/rb/css/richtext.css
    reviewboard/static/lib/js/google-code-prettify/lang-lua.js
    reviewboard/static/lib/js/google-code-prettify/lang-ml.js
    reviewboard/static/lib/js/google-code-prettify/lang-yaml.js
    reviewboard/static/lib/js/google-code-prettify/lang-lisp.js
    reviewboard/static/lib/js/google-code-prettify/lang-n.js
    reviewboard/static/lib/js/google-code-prettify/lang-tex.js
    reviewboard/static/lib/css/prettify.css
    reviewboard/templates/reviews/reviewable_base.html
    reviewboard/static/lib/js/google-code-prettify/lang-vhdl.js
    reviewboard/static/lib/js/google-code-prettify/lang-dart.js
    reviewboard/templates/reviews/review_reply.html
    reviewboard/static/lib/js/marked.js
    reviewboard/static/lib/js/google-code-prettify/lang-scala.js
    reviewboard/static/lib/js/google-code-prettify/lang-apollo.js
    reviewboard/static/lib/js/google-code-prettify/lang-vb.js
    reviewboard/static/lib/js/google-code-prettify/lang-tcl.js
    reviewboard/static/rb/js/reviews.js
    reviewboard/static/lib/js/google-code-prettify/run_prettify.js
    reviewboard/static/lib/js/google-code-prettify/lang-xq.js
    reviewboard/static/lib/js/google-code-prettify/lang-r.js
    reviewboard/static/lib/js/google-code-prettify/lang-clj.js
    reviewboard/templates/reviews/review_detail.html
    reviewboard/static/lib/js/google-code-prettify/lang-sql.js
    reviewboard/static/lib/js/google-code-prettify/lang-erlang.js
    reviewboard/static/lib/js/google-code-prettify/prettify.js
    reviewboard/static/rb/js/utils/textUtils.js
    reviewboard/templates/reviews/review_text_block.html
    reviewboard/static/lib/js/google-code-prettify/lang-wiki.js
    reviewboard/static/lib/js/google-code-prettify/lang-css.js
    reviewboard/static/lib/js/google-code-prettify/lang-rd.js
    reviewboard/static/lib/js/google-code-prettify/lang-go.js
    reviewboard/static/lib/js/google-code-prettify/lang-basic.js
    reviewboard/static/lib/js/google-code-prettify/lang-mumps.js
    reviewboard/templates/reviews/review_request_box.html
    reviewboard/static/lib/js/google-code-prettify/lang-hs.js
    reviewboard/static/lib/js/google-code-prettify/lang-llvm.js
    reviewboard/static/lib/js/google-code-prettify/lang-pascal.js

Greg:

This is a really sexy, exciting change! I just played with this patch, and I really dug it. :)

Just a few notes below,

-Mike

reviewboard/reviews/evolutions/rich_text_file_attach_comment.py (Diff revision 7)

The issue has been resolved. Show all issues

Can this not be combined with rich_text.py?

gregwym April 3, 2013, 8:06 p.m.

Chip mentioned, combined in rich_text.py will cause some problem with Django Evolution. Please refer to http://reviews.reviewboard.org/r/3892/#comment9237

chipx86 April 3, 2013, 10:43 p.m.

Oh yeah, I fixed the bug! It can be one file now.

gregwym April 4, 2013, 5:56 p.m.

Here we go, reverted that commit. Love Git.

reviewboard/static/rb/js/reviews.js (Diff revision 7)
The issue has been resolved. Show all issues
```
indent this one more space
```
reviewboard/static/rb/js/utils/textUtils.js (Diff revision 7)
The issue has been resolved. Show all issues
```
typo: nad -> and
```
reviewboard/static/rb/js/utils/textUtils.js (Diff revision 7)
The issue has been resolved. Show all issues
```
If this isn't needed, please remove it.
```

reviewboard/templates/reviews/review_text_block.html (Diff revision 7)

The issue has been resolved. Show all issues

What node is this trying to remove?

gregwym April 3, 2013, 8:06 p.m.

The content of `#{{dom_id}}-markdown` is used as input for markdown rendering. This block is hidden, but not necessary to be removed. 

We may want to keep this, and use as the input of text editor. (For now, inline text editor doesn't keep any markdown format tags.)

gregwym April 4, 2013, 5:56 p.m.

I see your point. I forgot to change the ID to `-raw`. But I guess I will get rid of this line.

Change Summary:

- Combine the evolution scripts together. 
- Name all text_block variables with `text_block` prefix

Description:

		What has been done,
		- Add rich_text db evolution script.
		- All old ReviewRequests, Reviews and Comments are marked as `rich_text = False`
		- All later ReviewRequests, Reviews and Comments will be marked as `rich_text = True`
-		- Evolution for FileAttachmentComment locates in separated evolution script
		- Enable markdown rendering with code highlight for all pre-text blocks
		- Use `marked` js lib render text
		- Use `google code prettify` for syntax highlighting
~		- Rendered text are inserted along the page loading process using document.write()
	~	- Rendered text are inserted along the page loading process using `document.write()`
		- Use single template file to generate text blocks
		- Always place text inside <pre> tag
		- Adjust the css style for markdown text

Diff:

Revision 8 (+1494 -11)

Show changes

	reviewboard/settings.py
	reviewboard/reviews/models.py
	reviewboard/reviews/evolutions/__init__.py
	reviewboard/reviews/evolutions/rich_text.py
	reviewboard/reviews/templatetags/reviewtags.py
	reviewboard/static/lib/css/prettify.css
	reviewboard/static/lib/js/marked.js
	reviewboard/static/lib/js/google-code-prettify/lang-apollo.js
	36 more

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/reviews/evolutions/__init__.py
    reviewboard/settings.py
    reviewboard/reviews/templatetags/reviewtags.py
    reviewboard/reviews/evolutions/rich_text.py
    reviewboard/reviews/models.py
  Ignored Files:
    reviewboard/static/lib/js/google-code-prettify/lang-proto.js
    reviewboard/static/rb/css/richtext.css
    reviewboard/static/lib/js/google-code-prettify/lang-lua.js
    reviewboard/static/lib/js/google-code-prettify/lang-ml.js
    reviewboard/static/lib/js/google-code-prettify/lang-yaml.js
    reviewboard/static/lib/css/prettify.css
    reviewboard/static/lib/js/google-code-prettify/lang-n.js
    reviewboard/static/lib/js/google-code-prettify/lang-tex.js
    reviewboard/static/lib/js/google-code-prettify/lang-lisp.js
    reviewboard/templates/reviews/reviewable_base.html
    reviewboard/static/lib/js/google-code-prettify/lang-vhdl.js
    reviewboard/static/lib/js/google-code-prettify/lang-dart.js
    reviewboard/templates/reviews/review_reply.html
    reviewboard/static/lib/js/marked.js
    reviewboard/static/lib/js/google-code-prettify/lang-r.js
    reviewboard/static/lib/js/google-code-prettify/lang-apollo.js
    reviewboard/static/lib/js/google-code-prettify/lang-vb.js
    reviewboard/static/lib/js/google-code-prettify/lang-tcl.js
    reviewboard/static/rb/js/reviews.js
    reviewboard/static/lib/js/google-code-prettify/run_prettify.js
    reviewboard/static/lib/js/google-code-prettify/lang-xq.js
    reviewboard/static/lib/js/google-code-prettify/lang-scala.js
    reviewboard/static/lib/js/google-code-prettify/lang-clj.js
    reviewboard/templates/reviews/review_detail.html
    reviewboard/static/lib/js/google-code-prettify/lang-sql.js
    reviewboard/static/lib/js/google-code-prettify/lang-erlang.js
    reviewboard/static/lib/js/google-code-prettify/prettify.js
    reviewboard/static/rb/js/utils/textUtils.js
    reviewboard/templates/reviews/review_text_block.html
    reviewboard/static/lib/js/google-code-prettify/lang-wiki.js
    reviewboard/static/lib/js/google-code-prettify/lang-css.js
    reviewboard/static/lib/js/google-code-prettify/lang-rd.js
    reviewboard/static/lib/js/google-code-prettify/lang-go.js
    reviewboard/static/lib/js/google-code-prettify/lang-basic.js
    reviewboard/static/lib/js/google-code-prettify/lang-mumps.js
    reviewboard/templates/reviews/review_request_box.html
    reviewboard/static/lib/js/google-code-prettify/lang-hs.js
    reviewboard/static/lib/js/google-code-prettify/lang-llvm.js
    reviewboard/static/lib/js/google-code-prettify/lang-pascal.js

Ship it!

This is awesome! I can't find anything wrong with it - it's got my ship-it. Great job!

gregwym April 4, 2013, 8:18 p.m.

Thanks! 

Well, one thing I have to mention is the inline editor. Triggering inline editor on a "markdowned" text block will loss all markdown format tags. That is a really bad UX. So might have to disable the rendering for the text block with inline editor for now (They are `description`, `testing-done` and `comments`). They can be re-enabled after the editor patch. 

I'm digging into the inline editor now. If I see any possible easy work around, I will update it.

Just like to mention that we've been working on fixing up the issues here (especially with the inline editor) and this will go in soon. I've got a new change at https://reviews.reviewboard.org/r/4506/ that obsoletes this one.

Status:: Discarded