Custom comment form is incomplete and wrong.

[ddshore@…]

When viewing the documentation for the django comment framework (​http://docs.djangoproject.com/en/dev/ref/contrib/comments/) this is the example form that is shown:

{% get_comment_form for event as form %}
<form action="{% comment_form_target %}" method="post">
  {{ form }}
  <tr>
    <td></td>
    <td><input type="submit" name="preview" class="submit-post" value="Preview"></td>
  </tr>
</form>

However, the post button is missing, only the preview button appears, and it's class is shown as a post button. Not sure what the original intention was, but it would probably be better to have both buttons in the documentation:

	<input type = "submit" name = "post" class = "submit-post" value = "post">
	<input type = "submit" name = "preview" class = "submit-preview" value = "preview">

or at least correct the class for the preview button to submit-preview instead of submit-post.

[Gabriel Hurley]

Agreed. There are definitely some mixed signals in that example. Might as well include both buttons for completeness.

Speaking of "preview" buttons, you might want to use Trac's preview to check your code formatting before submitting your ticket next time. ;-)

[Julien Phalip]

The patch introduces a third column, which is not correct since the form only has two columns. It would be more correct to have a single <td colspan="2">.

For completeness it'd also be good to wrap the form with <table></table> tags, and also to clean up a similar example in ​https://docs.djangoproject.com/en/dev/ref/contrib/comments/example/

[Daniel Quinn]

Two inputs, one td, no csrf

[Daniel Quinn]

I've attached a patch that should solve the problem, however it doesn't include a {% csrf_token %} even though it needs to be there if the form is to work at all. Should I include that as well, or leave it as is?

[Daniel Quinn]

Added {% csrf_token %}

[Daniel Quinn]

After talking to one of the Elder Nerds here at DjangoCon, we agreed that the {% csrf_token %} should be in there, so I've added a new patch.

[Aymeric Augustin]

Could you make your patch relative to the trunk directory of the svn repo? Like this: cd trunk; svn di > your_patch.diff.

We expect to be able to apply it with cd trunk; patch -p0 < your_patch.diff (or -p1 if you're using git).

Also, when you upload a new patch that take into account the reviewers' remarks, you can uncheck "patch needs improvement".

Thanks!

[Daniel Quinn]

Fixed the patch so that it can be applied from the root.

[Julien Phalip]

The code snippet just above the "Flagging" section in ​https://docs.djangoproject.com/en/dev/ref/contrib/comments/example/ should also be fixed as part of this ticket.

[Daniel Quinn]

Includes fix for example.txt as well.

[Julien Phalip]

This looks good. Just one more change to remove any confusion: let's completely remove all instances of class="submit-post"

[teraom]

Changed to one tr tag with colspan 2. Removed all class attributes. Wrapped form in table tag

[Julien Phalip]

That's great, thanks.

[Jannis Leidel]

In [16412]:

Fixed #16031 -- Corrected comments template examples. Thanks, teraom.

[Jannis Leidel]

In [16421]:

[1.3.X] Fixed #16031 -- Corrected comments template examples. Thanks, teraom.

Backport from trunk (r16412).