Opened 13 years ago

Closed 13 years ago

Last modified 13 years ago

#16793 closed Cleanup/optimization (fixed)

consolidate and/or cross reference documentation on {% load %} template tag

Reported by: Tobias McNulty Owned by: Nick Meharry
Component: Documentation Version: 1.3
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

The {% load %} template tag is documented in at least 3 places, and 2 of them do not mention the {% load foo from bar %} syntax that was introduced in 1.3. This documentation can probably be consolidated (and/or spruced up with cross links) to make the from syntax easier to find.

The 3 locations are:

https://docs.djangoproject.com/en/dev/topics/templates/#custom-tag-and-filter-libraries

https://docs.djangoproject.com/en/dev/howto/custom-template-tags/#code-layout

https://docs.djangoproject.com/en/dev/ref/templates/builtins/#load

Attachments (1)

load_tag_linking.diff (1.5 KB ) - added by Nick Meharry 13 years ago.

Download all attachments as: .zip

Change History (5)

comment:1 by Gabriel Hurley, 13 years ago

Triage Stage: UnreviewedAccepted

Agreed on the linking. I don't think any de-duplication is necessary since they're all discussing different topics. For the three docs as listed:

  1. In the sentence "In the above, the load tag loads the comments tag library, which then makes the comment_form tag" all of those code bits should be cross-refs.
  1. The howto can include a cross-ref "for more information on load..." in the "behind the scenes" box below.
  1. This is the appropriate canonical place for a full reference and should be linked to from anywhere else.

That should take care of it.

comment:2 by Nick Meharry, 13 years ago

Owner: changed from nobody to Nick Meharry
Status: newassigned

by Nick Meharry, 13 years ago

Attachment: load_tag_linking.diff added

comment:3 by Nick Meharry, 13 years ago

Has patch: set

comment:4 by Alex Gaynor, 13 years ago

Resolution: fixed
Status: assignedclosed

In [16774]:

Fixed #16793. Added more cross referencing to the load tag's documentation. Thanks to bluejeansummer for the patch.

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