Opened 5 years ago

Closed 3 years ago

#12871 closed New feature (fixed)

Document creation of a comment form for authenticated users

Reported by: shacker 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 shacker 5 years ago.
Docs for authenticated comment form
comments2.diff (2.6 KB) - added by shacker 5 years ago.
Changes as suggested
12871.diff (2.5 KB) - added by timo 3 years ago.
Updated the patch a bit

Download all attachments as: .zip

Change History (14)

Changed 5 years ago by shacker

Docs for authenticated comment form

comment:1 Changed 5 years ago by shacker

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

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 Changed 5 years ago by russellm

  • Triage Stage changed from Unreviewed to Accepted

comment:3 Changed 5 years ago by russellm

  • 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 Changed 5 years ago by shacker

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.

Changed 5 years ago by shacker

Changes as suggested

comment:5 Changed 5 years ago by ubernostrum

  • milestone 1.2 deleted

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 Changed 4 years ago by lukeplant

  • Type set to New feature

comment:7 Changed 4 years ago by lukeplant

  • Severity set to Normal

comment:8 Changed 3 years ago by aaugustin

  • UI/UX unset

Change UI/UX from NULL to False.

comment:9 Changed 3 years ago by aaugustin

  • Easy pickings unset

Change Easy pickings from NULL to False.

Changed 3 years ago by timo

Updated the patch a bit

comment:10 Changed 3 years ago by timo

  • Cc timograham@… added
  • Patch needs improvement unset

Updated the patch a bit

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

  • Resolution set to fixed
  • Status changed from new to closed

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