Cutlery/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-11-03 19:17:13 -05:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: fix filters docs (#10600)

Browse Source
This commit is contained in:
shamoon 2025-08-17 09:25:42 -07:00 committed by GitHub
parent f00a565130
commit ca9b5d9586
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/advanced_usage.md
View File

@ -469,12 +469,12 @@ The `get_cf_value` filter retrieves a value from custom field data with optional
##### Datetime Formatting ##### Datetime Formatting
The `format_datetime`filter formats a datetime string or datetime object using Python's strftime formatting. The `datetime` filter formats a datetime string or datetime object using Python's strftime formatting.
###### Syntax ###### Syntax
```jinja2 ```jinja2
{{ datetime_value | format_datetime('%Y-%m-%d %H:%M:%S') }} {{ datetime_value | datetime('%Y-%m-%d %H:%M:%S') }}
``` ```
###### Parameters ###### Parameters
@ -490,15 +490,11 @@ The `format_datetime`filter formats a datetime string or datetime object using P
```jinja2 ```jinja2
<!-- Format datetime object --> <!-- Format datetime object -->
{{ created_at | format_datetime('%B %d, %Y at %I:%M %p') }} {{ created | datetime('%B %d, %Y at %I:%M %p') }}
<!-- Output: "January 15, 2024 at 02:30 PM" --> <!-- Output: "January 15, 2024 at 02:30 PM" -->
<!-- Format datetime string -->
{{ "2024-01-15T14:30:00" | format_datetime('%m/%d/%Y') }}
<!-- Output: "01/15/2024" -->
<!-- Custom formatting --> <!-- Custom formatting -->
{{ timestamp | format_datetime('%A, %B %d, %Y') }} {{ custom_fields | get_cf_value('Date Field') | datetime('%A, %B %d, %Y') }}
<!-- Output: "Monday, January 15, 2024" --> <!-- Output: "Monday, January 15, 2024" -->
``` ```
@ -508,7 +504,8 @@ for the possible codes and their meanings.
##### Date Localization ##### Date Localization
The `localize_date` filter formats a date or datetime object into a localized string using Babel internationalization. The `localize_date` filter formats a date or datetime object into a localized string using Babel internationalization.
This takes into account the provided locale for translation. This takes into account the provided locale for translation. Since this must be used on a date or datetime object,
you must access the field directly, i.e. `document.created`.
###### Syntax ###### Syntax
@ -531,27 +528,27 @@ This takes into account the provided locale for translation.
```jinja2 ```jinja2
<!-- Preset formats --> <!-- Preset formats -->
{{ created_date | localize_date('short', 'en_US') }} {{ document.created | localize_date('short', 'en_US') }}
<!-- Output: "1/15/24" --> <!-- Output: "1/15/24" -->
{{ created_date | localize_date('medium', 'en_US') }} {{ document.created | localize_date('medium', 'en_US') }}
<!-- Output: "Jan 15, 2024" --> <!-- Output: "Jan 15, 2024" -->
{{ created_date | localize_date('long', 'en_US') }} {{ document.created | localize_date('long', 'en_US') }}
<!-- Output: "January 15, 2024" --> <!-- Output: "January 15, 2024" -->
{{ created_date | localize_date('full', 'en_US') }} {{ document.created | localize_date('full', 'en_US') }}
<!-- Output: "Monday, January 15, 2024" --> <!-- Output: "Monday, January 15, 2024" -->
<!-- Different locales --> <!-- Different locales -->
{{ created_date | localize_date('medium', 'fr_FR') }} {{ document.created | localize_date('medium', 'fr_FR') }}
<!-- Output: "15 janv. 2024" --> <!-- Output: "15 janv. 2024" -->
{{ created_date | localize_date('medium', 'de_DE') }} {{ document.created | localize_date('medium', 'de_DE') }}
<!-- Output: "15.01.2024" --> <!-- Output: "15.01.2024" -->
<!-- Custom patterns --> <!-- Custom patterns -->
{{ created_date | localize_date('dd/MM/yyyy', 'en_GB') }} {{ document.created | localize_date('dd/MM/yyyy', 'en_GB') }}
<!-- Output: "15/01/2024" --> <!-- Output: "15/01/2024" -->
``` ```