Opened 4 years ago
Last modified 4 years ago
#31006 closed Cleanup/optimization
Document how to escape a date/time format character for the |date and |time filters — at Initial Version
| Reported by: | Baptiste Mispelon | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| 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 current documentation for the date and time filters doesn't explain how to escape a format character.
It's only documented as part of the now template tag:
Note that you can backslash-escape a format string if you want to use the “raw” value. In this example, both “o” and “f” are backslash-escaped, because otherwise each is a format string that displays the year and the time, respectively:
It is the {% now "jS \o\f F" %}
This would display as “It is the 4th of September”.
Historically, the big table with all the available format characters used to be next to the documentation for {% now %} but it was moved at some point (to be with the documentation for |date.
I would suggest moving the paragraph about backslash escape under the table of all formats instead (or least duplicating it there too).