Wykres commitów

1022 Commity (main)

Autor SHA1 Wiadomość Data
Andy Chosak b376a7b65d
Don't duplicate snippets in "Snippets" menu
This change alters the behavior of the sidebar "Snippets" menu such that
the snippet index view doesn't include snippet models that have been
configured with their own menu item.

Currently, the "Snippets" menu doesn't appear if all snippet models have
their own menu items; however, if some models do and some don't, the
snippets index view lists all of them, causing some duplication in the
UI which could be confusing for editors.

This commit changes this behavior so that "Snippets" is only used to
edit those snippet models that aren't editable elsewhere.

A new setting (WAGTAILSNIPPETS_MENU_SHOW_ALL) has been added to always
show the snippets menu and all snippets models. This setting will allow
for continuation of the current behavior for those users that desire it.

Closes issue 11340.
2025-04-17 14:31:31 +01:00
Sage Abdullah aff18f634f
Remove 6.2 versionchanged note in frontend cache docs 2025-04-15 09:37:37 +01:00
Matt Westcott 9f9aecfd61
Document removal of deprecated features in 7.0 2025-04-15 09:33:59 +01:00
Matt Westcott 9c24705b88
Release note / documentation for validate on publish 2025-04-15 09:15:06 +01:00
Matt Westcott 26e65b5c01 Change references to version 6.5 to 7.0 2025-04-10 12:56:11 +01:00
Sage Abdullah f3e2084b3a Document snippets requirement for features provided by model mixins (#12999) 2025-04-09 15:50:49 +01:00
LB 5b429e24d6 Ensure `insert_editor_js` documentation reflects common usage (#13022)
Fixes #13021
Relates to #2936
2025-04-09 12:14:10 +01:00
Baptiste Mispelon c6c996b54c Make all formbuilder field types accept a custom widget + add docs
Prior to this change, it was inconsistent whether passing
a `widget` argument as an option to a create_<field>_field()
method would work or not (it might work, or might result in a
TypeError caused by the duplicate argument).
2025-04-06 17:03:14 +10:00
SebCorbin 5c30b4211a Support documented ability to override/extend icons in the userbar
Allow to override icons in userbar
2025-04-06 14:57:11 +10:00
LB c663911b9c Minor cleanup to documentation whitespace formatting 2025-04-06 14:32:00 +10:00
Matt Westcott edf7c66fac Mention third-party StreamField form builder packages in form builder docs
As per https://github.com/wagtail/wagtail/pull/12287#issuecomment-2769692508
2025-04-02 06:17:47 +10:00
Matt Westcott 103ea61702
Document that request_or_site is optional on BaseGenericSetting.load 2025-03-20 19:11:19 +07:00
Matt Westcott 1f210831dd Relax model validation when saving pages as draft 2025-03-19 14:22:45 +00:00
smark-1 322d7e1620 Add documentation for setting the default privacy option on pages 2025-03-15 15:23:54 +10:00
Thibaud Colas 801b1bb067
Add more details of legacy rich text behavior
This is to hopefully make it easier to look up with search.
2025-02-06 16:34:49 +00:00
Aayushman Singh 4f37b011f5
Add WAGTAIL_ prefix to non-taggit settings 2025-02-04 10:34:25 +00:00
Sage Abdullah 251d1d188c Expand docs for StreamField block previews 2025-02-03 16:43:29 +00:00
Sage Abdullah f309a44075 Add reference docs for Block.get_template and Block.get_context 2025-02-03 16:43:29 +00:00
Matt Westcott 695ff86c87 Remove versionchanged note for ImageChooserBlock to ImageBlock migration
Leave other versionadded/versionchanged notes intact, as they relate to deprecated features that are not yet removed and should thus be left in place until 7.0.
2025-01-27 18:54:25 +00:00
LB 1dd3dbea87 Fix spelling of `CloudFront` in docs & release notes 2025-01-22 10:31:35 +00:00
LB 0bf909414a Fix minor whitespace formatting issues in docs 2025-01-22 10:31:35 +00:00
Sage Abdullah ac4bd79e40
Add initial docs for StreamField block previews 2025-01-20 17:35:06 +00:00
Matt Westcott 82c42d1ecc Nest code snippets for string panel definitions inside the note 2025-01-06 19:29:44 +00:00
USER da818b562f “Update-FieldPanel-documentation-to-encourage-use-of-strings-in-panel-definitions” 2025-01-06 19:26:26 +00:00
Claude Meyer aa08e86cba Fixes #3847 by adding page as a third argument to construct_wagtail_userbar hooks along with a deprecation warning. 2024-12-17 22:10:09 +00:00
Jake Howard 076af8bec8 Automatically set CSP when serving images and documents (#12672)
Addresses #12617
2024-12-17 21:06:39 +00:00
jhrr 5402010d16 Allow hook override of user profile avatar url in admin tags (#12689)
Fixes #12661
2024-12-17 20:42:36 +00:00
Ayaan 3e75c018be Add support for query string params in WAGTAIL_GRAVATAR_PROVIDER_URL
- Enhance capabilities for WAGTAIL_GRAVATAR_PROVIDER_URL URL to support merging of URL params.
- Fixes #12659
- Rework of original PR #11077
2024-12-07 21:23:13 +10:00
Krystian Magdziarz 32417f9adc Fix Missing Cache-Control Headers for Password-Protected Pages (#12465)
Fixes #12455
2024-12-07 02:49:16 +00:00
Clifford Gama 7566fb84e0 Docs: Use sentence case for titles in pages/theory.md 2024-11-26 06:46:21 +10:00
Clifford Gama 8df6cae90c Docs: Break Scheduled Publishing into multiple subheadings 2024-11-26 06:38:26 +10:00
Andy Babic 66f1e817eb
Allow page types to easily restrict what type of requests they respond to (#12473)
* Allow page types to specify the request methods they support and block unsupported requests in serve()
* Use 'before_serve_page' hook to serve OPTIONS responses
* Add checks to RoutablePageMixin.serve() where the parent implementation is bypassed
* Rename check_http_method to check_request_method and actually use the return value
* Support Python 3.9 through to current approaches for `http` method strings
* Include documentation, docstrings & changelog entry
2024-11-20 10:15:36 +10:00
John-Scott Atlakson 9d31fd3fa5 Fix - Ensure `WagtailAdminFormPageForm.clean` returns `cleaned_data`
Return `cleaned_data` for more consistent subclassing.

Updated documentation with an example of adding custom page validation for form fields.

Add unit test to ensure that the documented usage of extending `WagtailAdminFormPageForm` works as expected.

Originally from #10375
2024-11-05 19:22:33 +00:00
minusf f600a356e6
Add missing apostrophe in settings documentation (#12542) 2024-11-05 16:09:55 +00:00
Sage Abdullah f54b03d595
Use intersphinx to link to treebeard docs 2024-11-05 10:44:41 +00:00
Sage Abdullah 503d1a743a
Replace hardcoded Python docs links with intersphinx 2024-11-05 10:44:40 +00:00
Sage Abdullah 5615deb5b1
Add Django's custom Sphinx roles and use them to link to settings
This is necessary for rST docs, i.e. in docstrings and in eval-rst
blocks. Without this, Sphinx cannot seem to understand the role. See:
https://stackoverflow.com/questions/13387125

MyST-Parser seems to be smarter, it can figure out these custom
roles without having to register the types ourselves. This is evident in
the previous commits where I already use the :setting: role in markdown
docs.
2024-11-05 10:44:40 +00:00
Sage Abdullah 9a5be8f180
Replace more hardcoded Django links with intersphinx in rST docs
Some link labels are changed to just the code part, because using Sphinx
roles for code objects (e.g. methods, attributes) would always format the
text as inline code.

It's currently impossible to customize the formatting of a link's text in
rST. See https://stackoverflow.com/questions/4743845
2024-11-05 10:44:39 +00:00
Sage Abdullah 857b26e5a0
Replace hardcoded Django docs links to intersphinx links 2024-11-05 10:44:39 +00:00
Aayushman Singh 7f6e7d4062 Docs - Improve hooks & extending pages with CSP compliant examples
- Avoid `mark_safe` and use `format_html` where possible
- Avoid inline scripts, instead ensure the example shows external script usage
2024-11-02 10:29:19 +10:00
Ayaan 0913118da4
Replaced Twitter references in the docs with more appropriate alternatives (#12516). Fix #12483
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2024-11-01 11:03:54 +00:00
Matt Westcott 593b95cad9
Document the ability to migrate from ImageChooserBlock to ImageBlock (#12518) 2024-11-01 09:58:42 +00:00
LB 3a5ae9c695 Docs - Ensure core models module level docstring does not appear in docs
Avoid the docstring being shared in the model reference documentation, this content is for core development only.
Update name of core modules.
2024-10-29 15:47:39 +00:00
Srishti-j18 fd9b1ca22b Docs - Update spelling to US customize variants
Fixes #12476
2024-10-29 18:47:43 +10:00
Srishti-j18 652de3fcb3 Documentation - Improve code highlighting & formatting for Python docstrings in core models 2024-10-28 08:34:38 +10:00
Andy Babic e451bbd96a Support application of select_related and prefetch_related lookups to subqueries made by SpecificIterable
- Add queryset methods to reference docs, and provide performance considerations for prefetch_related()
2024-10-28 08:06:03 +10:00
activus-d 97a1f5aabd Documentation - Improve project template (wagtail start) & add to management commands reference
Fixes #11938

* Add `wagtail start` to the management commands reference
* Add detail on how to creating templates with the need to escape template syntax by using the verbatim tag
2024-10-25 21:15:30 +10:00
LB fa81e2dbbe Docs - update spelling to US 'customizations' 2024-10-25 21:14:52 +10:00
Srishti-j18 2d644dd8e2 Documentation - Move tags out from pages model recipes to a standalone advanced topic 2024-10-25 20:30:12 +10:00
Srishti-j18 f588fcf249 Documentation - Reposition model & panel references
- Move model reference to directly under the references section, not the reference/pages section
- Move panel reference to directly under the references section, not the reference/pages section
- Merge panel API with panels reference pages
- Fix confusing heading levels in the page model recipes page
- Fix title in model reference to align with docs style guide
- Adopt US spelling for customize (panels) reference key
2024-10-25 20:30:12 +10:00
Matt Westcott bbb50459c9 Remove versionadded / versionchanged notes for 6.2
However, leave behind notes that mark settings/features that are deprecated but not yet removed, as this would be removing information that isn't in the main body of the text (and moving it out of a versionchanged note would make it harder to find when we come to remove it properly in 7.0).
2024-10-23 16:45:46 +10:00
Matt Westcott 93f8600c31
ImageBlock for StreamField (rebase of #11791) (#12416)
Co-authored-by: Chiemezuo <chiemezuoakujobi@gmail.com>
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2024-10-21 16:11:34 +01:00
Sage Abdullah 5909d3e822
Apply suggestions from code review 2024-10-18 18:19:18 +01:00
alexkiro b38141ad82
Allow customization of preview device sizes
Co-authored-by: Bartosz Cieliński <bart@fullfatthings.com>
2024-10-18 18:19:17 +01:00
Coen van der Kamp abcb2da372 Add translatable model copy for translation done signal (#12362) 2024-09-27 16:01:52 +01:00
Matt Westcott 5aa0673452 Update `WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT` docs to indicate that default is False (#12340)
Fixes #12329
2024-09-19 16:41:17 +01:00
Sage Abdullah 706b95f670 Deprecate the WAGTAIL_AUTO_UPDATE_PREVIEW setting 2024-09-19 08:22:54 +10:00
LB Johnston 4af8ab528b Documentation - formatting clean up 2024-08-29 18:32:20 +01:00
LB Johnston 1790bdd158 Align recent docs & release notes to US spelling 2024-08-29 18:28:07 +01:00
Vince Salvino 067ebc01ec Add example date/time formatting for the Wagtail admin settings. (#12083) 2024-08-02 13:54:13 +01:00
Sage Abdullah dfe9638e7d Replace pytz.common_timezones with zoneinfo.available_timezones
and remove pytz dependency
2024-07-29 18:31:30 +01:00
Matt Westcott f7fa20e600 Upgrade Sphinx to 7.3; use newer syntax for no-index directive and --fail-on-warning switch 2024-07-23 10:13:03 +01:00
Matt Westcott 0e60590676 Fix no-index directive for Sphinx 7.4.7 2024-07-22 14:21:16 +01:00
Matt Westcott e1f9d97238 Remove versionadded/versionchanged notes for 6.1 2024-07-22 13:43:34 +01:00
Thibaud Colas c569e08d7d Release notes for #12099 2024-07-19 13:14:30 +01:00
Sage Abdullah f8564055b1 Add WAGTAIL_EDITING_SESSION_PING_INTERVAL setting 2024-07-19 13:14:30 +01:00
Matt Westcott a7d72f9fbf Fix formatting errors 2024-07-19 00:21:39 +01:00
Chris Shenton d1c020cd5f Fix Page.copy ref; silence warnings due to Sphinx missing support for type hints
Builds upon HimanshuGarg47:fix/11972-documentation-build-with-errors
2024-07-18 23:15:58 +01:00
Himanshu Garg 9adf742580 fixes errors by adding aliases, double backtick, changing indexentry 2024-07-18 23:15:40 +01:00
Himanshu Garg e02ca6ce62 fixes some of errors by removing directives 2024-07-18 23:13:26 +01:00
smark-1 95eac5ab78
Allow page to change private page options 2024-07-18 17:23:30 +01:00
Sage Abdullah f126a4860e Deprecate user form-related settings 2024-07-10 17:10:36 +02:00
Sage Abdullah 449a48d7f9 Reorganise docs for custom user forms to prefer UserViewSet customisation
And make small tweaks to the GroupViewSet docs so the custom apps
examples align.
2024-07-10 17:10:36 +02:00
Andy Chosak a81cabce05 Expose URL resolver match for RoutablePageMixin (#11953)
Django provides an `HttpRequest.resolver_match` attribute [0] that
allows downstream code to inspect a request object to see how its URL
was resolved to a view.

Wagtail's RoutablePageMixin does its own sub-URL routing to call
different view functions on a page object, but the resolver result isn't
similarly made available.

This commit sets a new `routable_resolver_match` attribute on the
request object, akin to Django's `resolver_match`, that stores this
sub-URL routing information for downstream use.

Documentation has been updated appropriately (along with a couple of
other minor broken things in the RoutablePageMixin docs).

[0] https://docs.djangoproject.com/en/5.0/ref/request-response/#django.http.HttpRequest.resolver_match
2024-07-03 14:17:12 +01:00
Sage Abdullah b3e87bcee8
Register permissions for models registered with ModelViewSet 2024-07-02 09:30:57 +01:00
Jake Howard 15511411bd Allow manually specifying credentials for CloudFront frontend cache backend (#10565) 2024-07-01 19:02:12 +01:00
Sage Abdullah e1b77ccd6f Add docs about not converting relative links when there are multiple sites 2024-06-25 17:59:37 +01:00
Arnar Tumi Þorsteinsson c700ed67ef Copy for translations done signal and test (#12033) 2024-06-12 15:41:04 +02:00
Byron Peebles e36c4d3fba Documentation: Update some Sphinx-style code ref roles to MyST style (#12030) 2024-06-12 11:47:06 +02:00
smark-1 5c85c127e6 add docs for page view restriction (#11917) 2024-05-03 15:33:16 +01:00
Matt Westcott 617e5129c5
Add management command to fix UUID fields under MariaDB / Django 5.0 (#11912) 2024-05-01 11:07:20 +01:00
Matt Westcott 7900055afa Release note for #11858 2024-04-24 23:55:22 +01:00
Jake Howard c00c2b684f Allow frontend caching backends to limit which hostnames they respond to 2024-04-24 23:34:33 +01:00
Sage Abdullah fd659ae767
Remove versionadded / versionchanged annotations for 6.0 2024-04-22 09:00:36 +07:00
Saksham Misra 53d6ea4491 Add documentation to support password required settings change
PASSWORD_REQUIRED_TEMPLATE -> WAGTAIL_PASSWORD_REQUIRED_TEMPLATE
DOCUMENT_PASSWORD_REQUIRED_TEMPLATE -> WAGTAILDOCS_PASSWORD_REQUIRED_TEMPLATE
2024-04-18 07:03:08 +10:00
Alec Baron d71cf79520
Accept alias for WAGTAILIMAGES_RENDITION_STORAGE (#11749)
* Accept alias for WAGTAILIMAGES_RENDITION_STORAGE

* Update wagtail.images.models.get_rendition_storage to handle the case when the WAGTAILIMAGES_RENDITION_STORAGE setting is given a storage alias (defined in the STORAGES setting). Preserve old behavior when a dotted module path or a Storage instance are given.
* Refactor and improve all tests related to the WAGTAILIMAGE_RENDITION_STORAGE setting.
* Update related documentation.
2024-04-17 16:22:19 +01:00
LB Johnston e8f4d56583 Support forwards compatible configuration for private pages/collections
The new settings introduced in #11582 / #11536 only considered one use case of disabling the shared password option. However, we may want to allow for more complex configuration in the future in this area.

Ensure we can support potential future requirements such as #11640 with a more flexible structure for private pages & collections.

The following settings have been changed from boolean to dictionary values.

WAGTAIL_ALLOW_SHARED_PASSWORD_PAGE -> WAGTAIL_PRIVATE_PAGE_OPTIONS
WAGTAIL_ALLOW_SHARED_PASSWORD_COLLECTION -> WAGTAILDOCS_PRIVATE_COLLECTION_OPTIONS
2024-04-17 15:29:50 +01:00
Abdelrahman 61e803c740
Add choose parent view for creating pages via PageListingViewSet 2024-04-17 03:48:54 +07:00
Gordon Pendleton 06ed3ae6b8
Refactor page fetching logic to cache per request (#11683)
Adds two new helper static methods:
- `Page.route_for_request()` - to find the page route, given a request
  object and a URL path
- `Page.find_for_request()` - to find the page given, a request object and a URL
  path
2024-04-12 17:16:39 +01:00
Neeraj P Yetheendran 6843fbe643
Add re_path to imports in routablepage.md (#11841) 2024-04-12 14:22:15 +01:00
Sage Abdullah d0fa6abae9
Pass the request user object instead of context to register_user_listing_buttons hook 2024-04-09 08:54:48 +07:00
Sage Abdullah af80198c7d Rename SubmissionsListView.ordering to default_ordering for consistency with BaseListingView 2024-04-05 17:36:41 +01:00
Sage Abdullah a5aafe0d15
Remove support for customising the number of entries on the image listing 2024-03-11 09:55:41 +00:00
Matt Westcott 5e5619d43f Add warnings about XSS to WAGTAILDOCS_SERVE_METHOD and WAGTAILDOCS_EXTENSIONS settings docs 2024-03-07 12:19:22 +00:00
Matt Westcott b05c50b3f5
Add reference docs for PageListingViewSet 2024-03-07 09:57:11 +00:00
Pranith 1640104c57 Fixed formatting typo in --purge-only command flag
Was rendering as `-purge-only` (with one dash)
Fixes #11646
2024-02-29 07:32:27 +10:00
EK303 bd065c17cd Docs - Update and fix broken links
Fixes #11635
2024-02-16 17:23:53 +10:00
Rohit Sharma 427d821e3a Add system checks for WAGTAIL_DATE_FORMAT, WAGTAIL_DATETIME_FORMAT and WAGTAIL_TIME_FORMAT
- Includes a rework of #6168
- Fixes #11504
2024-02-13 08:27:00 +10:00
Buraah bfa29201c3 Docs - Page names & reference section - Update British spelling to American
- Changed all British spellings to American spellings, in the Customizing admin templates section of the docs
- Transferred all British spellings in the usage guide and advanced topics section to American spellings
- Update a series of other pages to use the spelling cutomize in the file name
Implemented all feedbacks on the usage guide and advanced topics section
2024-02-12 08:44:19 +10:00
Salvo Polizzi 502dd7c723 feature: allow disabling of shared password usage
Closes #11536
2024-02-09 08:52:32 +10:00