Code

Opened 7 years ago

Closed 7 years ago

#4232 closed (fixed)

Update to the newforms documentation

Reported by: heckj@… Owned by: jacob
Component: Documentation Version: master
Severity: Keywords: newforms documentation
Cc: heckj@… Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

In learning about how to use the newforms from within the templates, I thought I'd write it up from a template designer's point of view to make the newforms a little more accessible. I've submitted the update to the docs as a patch, attached to this bug.

Attachments (4)

newforms.diff (2.0 KB) - added by heckj@… 7 years ago.
documentation updates
newforms.2.diff (4.1 KB) - added by heckj@… 7 years ago.
documentation updates v2
4232.diff (4.2 KB) - added by heckj@… 7 years ago.
final update - cleaned up view per request and removed nasty tabs
4232.2.diff (4.2 KB) - added by heckj@… 7 years ago.
Update to the diff after checkins [5219], [5222], and [5237] (easier merge)

Download all attachments as: .zip

Change History (11)

Changed 7 years ago by heckj@…

documentation updates

comment:1 Changed 7 years ago by Simon G. <dev@…>

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Summary changed from [patch] update to the newforms documentation to Update to the newforms documentation
  • Triage Stage changed from Unreviewed to Accepted

Looks like a good start!

Changed 7 years ago by heckj@…

documentation updates v2

comment:2 Changed 7 years ago by heckj@…

I added some more documentation - putting in an example view just above "Outputting to HTML" to bring together all of the components above. I also put in a few more "template" references on rendering of the form using shortcuts as_p, as_ul, and as_table.

comment:3 follow-up: Changed 7 years ago by Gary Wilson <gary.wilson@…>

  • Patch needs improvement set

Thanks for the documentation. Is this complete now, or are you still working on this?

A few comments:

  • It appears that you have possibly mixed some tabs in there as the indention is nonuniform.
  • In the view code, I believe it is better practice to use "if request.method == 'POST'" instead of "if request.POST".

comment:4 in reply to: ↑ 3 Changed 7 years ago by anonymous

Replying to Gary Wilson <gary.wilson@gmail.com>:

Thanks for the documentation. Is this complete now, or are you still working on this?

A few comments:

  • It appears that you have possibly mixed some tabs in there as the indention is nonuniform.
  • In the view code, I believe it is better practice to use "if request.method == 'POST'" instead of "if request.POST".

I'll clean up the tabs and change the view code per your suggestions, then I'll call it done for this set. I need to learn more about Widgets and the variety of ways of using them before I attack more docs.

Changed 7 years ago by heckj@…

final update - cleaned up view per request and removed nasty tabs

comment:5 Changed 7 years ago by heckj@…

Added that final cleanup update. The previous diff can be deleted.

comment:6 Changed 7 years ago by Gary Wilson <gary.wilson@…>

  • Patch needs improvement unset
  • Triage Stage changed from Accepted to Ready for checkin

Changed 7 years ago by heckj@…

Update to the diff after checkins [5219], [5222], and [5237] (easier merge)

comment:7 Changed 7 years ago by mtredinnick

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

(In [5294]) Fixed #4232 -- Added example usages to the newforms documentation. Thanks, Joe
Heck.

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.