Opened 14 years ago

Closed 11 years ago

#12871 closed New feature (fixed)

Document creation of a comment form for authenticated users

Reported by: Scot Hacker Owned by: nobody
Component: Documentation Version: 1.2-beta
Severity: Normal Keywords: comments
Cc: timograham@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

The documentation does not make clear how to use the Comments framework to create a form for authenticated users (eliding the name, email, and URL fields). Blogs out there are full of half-baked or convoluted solutions for what should be a no-brainer. This doc patch provides what I hope is a "best" approach to this problem.

Attachments (3)

auth_comments.diff (2.0 KB ) - added by Scot Hacker 14 years ago.
Docs for authenticated comment form
comments2.diff (2.6 KB ) - added by Scot Hacker 14 years ago.
Changes as suggested
12871.diff (2.5 KB ) - added by Tim Graham 11 years ago.
Updated the patch a bit

Download all attachments as: .zip

Change History (14)

by Scot Hacker, 14 years ago

Attachment: auth_comments.diff added

Docs for authenticated comment form

comment:1 by Scot Hacker, 14 years ago

I placed this at the end of the Notes section rather than higher on the page because it's based in part on information provided in Notes.

comment:2 by Russell Keith-Magee, 14 years ago

Triage Stage: UnreviewedAccepted

comment:3 by Russell Keith-Magee, 14 years ago

Patch needs improvement: set

The idea is good, but the text needs work. It isn't clear from this example how (or why) the comment will be associated with the authenticated user.

Also, placing this text after "Redirecting after the comment post" (i.e., just before the Notes, as the last section in the "Displaying the comment post form" section) makes more sense to me.

comment:4 by Scot Hacker, 14 years ago

Here is a second diff that explains why comments are associated with authenticated users. I've also explained the fields in use a bit, moved the block as suggested, and linked various sections to related docs.

by Scot Hacker, 14 years ago

Attachment: comments2.diff added

Changes as suggested

comment:5 by James Bennett, 14 years ago

milestone: 1.2

This isn't critical to 1.2; we can always go back and expand documentation as needed, so attention should focus on actual bugs.

comment:6 by Luke Plant, 13 years ago

Type: New feature

comment:7 by Luke Plant, 13 years ago

Severity: Normal

comment:8 by Aymeric Augustin, 12 years ago

UI/UX: unset

Change UI/UX from NULL to False.

comment:9 by Aymeric Augustin, 12 years ago

Easy pickings: unset

Change Easy pickings from NULL to False.

by Tim Graham, 11 years ago

Attachment: 12871.diff added

Updated the patch a bit

comment:10 by Tim Graham, 11 years ago

Cc: timograham@… added
Patch needs improvement: unset

Updated the patch a bit

comment:11 by Tim Graham <timograham@…>, 11 years ago

Resolution: fixed
Status: newclosed

In fea0ca4334b8c35100c0ca1048f81b9b3573bc26:

Fixed #12871 - Documented creation of a comment form for authenticated users; thanks shacker for patch.

Note: See TracTickets for help on using tickets.
Back to Top