Wykres commitów

789 Commity (a6a91e1a014912c6f7f65cc367c099e9338c8906)

Autor SHA1 Wiadomość Data
Matt Westcott 5521e3b59f Update panel templates for new designs (EditHandler rewrite)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-08-05 10:36:52 +02:00
Matt Westcott 02d836fe3e Make per_page configurable on viewsets 2022-08-05 08:34:14 +10:00
Matt Westcott 9667088e98 Move setting metadata / reindexing into form.save() 2022-08-02 18:53:56 +02:00
PaarthAgarwal 887a259723 added translate button to header actions dropdown, removed all the instances of is_parent
- Fixed failing tests, added check for simple_translations enabled
- resolves #8866
2022-07-26 22:36:35 +10:00
LB Johnston 1849122e5f documentation - update reference/contrib content to markdown 2022-07-23 10:42:06 +10:00
LB Johnston 4169d959fc documentation - rename reference/contrib files to .md 2022-07-23 10:42:06 +10:00
LB (Ben Johnston) aa55457c82
Convert reference pages documentation section to Markdown (#8881)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-07-20 16:49:25 +01:00
Matt Westcott 8f34e47b68 Note that paragraph / line breaks are not counted toward the limit 2022-07-20 13:59:03 +01:00
Matt Westcott 3fa5eb125c Implement max_length validation on RichTextBlock 2022-07-20 13:59:03 +01:00
LB Johnston c8d1a6b00a documentation - fix a few internal references 2022-07-20 17:30:08 +10:00
LB Johnston 0c9d72669c documentation - fix table of contents issue for pages reference 2022-07-20 17:11:23 +10:00
Dolidodzik b131b4813e replace latin abbreviations with english phrases & updated docs guidelines
- added sub-section to language part of general_guidelines.md
- fixes #8860
2022-07-20 16:11:38 +10:00
Paarth Agarwal 35b5ed350a
Adopt slim header in page listing views (#8792)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-07-18 18:28:51 +01:00
Matt Westcott d07ff422d8 Documentation and release note for #8703 2022-07-18 15:53:32 +01:00
vupham04 53e2bdbd0d Add option to set name to MenuItems generated by modeladmin (#8553)
Co-authored-by: Alexander Rogovskyy <A.rogovskyy@intershop.de>
2022-07-18 14:44:58 +01:00
Karl Hobley ed239157fd
Release note for #8327 (#8825)
* Delete unused settings.rst

* Release note for #8327

* Use single backticks in changelog/release notes
2022-07-18 13:01:29 +01:00
sag᠎e 5ee5acb7ce
Introduce a new auto-updating preview panel inside the page editor (#8671)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-07-14 13:59:05 +01:00
Kyle d967eccef2
Add generic settings to compliment site-specific settings (#8327) 2022-07-06 11:01:02 +01:00
Sandeep M A bc0f561240 documentation - migrate reference/pages/theory + index to markdown 2022-07-05 22:05:20 +10:00
LB Johnston 77a8f76c97 documentation - add cross-reference to field panel permissions
- permissions page had no reference to the newly introduced permission kwarg on FieldPanel
- fix minor typo
2022-07-05 20:45:13 +10:00
Matt Westcott 30054eda39 Add a 'create' view with a GET request handler 2022-07-04 13:48:35 +01:00
Matt Westcott 4dd3483617 Add a (non-functional) 'create' form to generic chooser modal 2022-07-04 13:48:35 +01:00
LB Johnston cda437804e fix up markdown docs conversion issues
- introduced in #8759 & #8569
2022-06-30 16:36:37 +10:00
SilvestriStefano f535a0cc43 Documentation - migrate reference/** files to markdown content
- relates to #8383
2022-06-30 09:57:26 +10:00
LB Johnston 0afe2f9c89 Documentation - rename docs/reference/**
- rename all files from rst to md so git history is preserved
2022-06-30 09:57:26 +10:00
LB Johnston 86cb09a534 Documentation - fix streamfield reference issue
- myst was building a doc link `streamfield` and also had a ref link `streamfield` which was causing conflicts
2022-06-30 09:57:26 +10:00
Josh Michael Karamuth 3374ccee5e Make password reset form customisable
- Use a setting called WAGTAILADMIN_USER_PASSWORD_RESET_FORM to allow
users to specify a custom form for use in PasswordResetView

- Add an extra_fields property so that fields other than the
mandatory email field can be easily rendered in the template.

- Add extra blocks to the default template to allow users to
easily add their own stuff.

- Render extra fields in the template like we're doing in the
login template.
2022-06-29 14:40:24 +10:00
LB Johnston e140c41a89 documentation - markdown formatting
- apply general fixes to existing markdown documentation
- various cases of rst syntax still used
- update some links to be the new format
- clean up line breaks (prettier)
2022-06-25 22:44:42 +10:00
LB Johnston c76579fc1e migrate docs contrib redirects & searchpromotions to md
- relates to #8383
2022-06-24 22:01:53 +10:00
LB Johnston 58095cde30 documentation minor fixes 2022-06-23 08:12:07 +10:00
Andy Babic 9ac3877980
Use iterator() wherever PageQueryset result caching is not needed (#8722) 2022-06-22 11:03:17 +01:00
Sage Abdullah dba42161e7 Move revision ForeignKey from PageLogEntry to BaseLogEntry 2022-06-22 09:31:25 +01:00
Sævar Öfjörð Magnússon 9dd4d6c6c4
Update documentation for the serve method override so that it does not mention a specific demo site. (#8714) 2022-06-21 09:13:58 +01:00
Oliver Parker 97d0d14cd8
Add add_to_admin_menu option for modeladmin (#8634) 2022-06-20 14:10:18 +01:00
Noble Mittal 0be024e024 documentation - migrate docs/extending/ to md 2022-06-20 16:36:25 +10:00
Matt Westcott 372965ef6a Put headers in markdown rather than rst 2022-06-12 15:47:24 +10:00
Matt Westcott 865df1153b Documentation for ChooserViewSet 2022-06-12 15:47:24 +10:00
Matt Westcott b00d19b3a0 Documentation for ModelViewSet 2022-06-12 15:47:24 +10:00
Matt Westcott b4d3cf1c30 Docs for base ViewSet class 2022-06-12 15:47:24 +10:00
BenedictFaw 952e57b916 Migrate docs for StreamField from md to rst
- relates to #8383
2022-06-09 20:21:50 +10:00
Matt Westcott a3b1cb6c28 Add a page_type_display_name shortcut property 2022-06-08 17:35:40 +01:00
LB Johnston fd5218220e form builder - allow clean_name generation to be overridden
- adds a new class method to AbstractFormField `get_field_clean_name`
- resolves #6903
2022-06-02 08:07:24 +10:00
Dan Swain b53f12d394 Include missing import of FieldPanel 2022-05-28 06:40:25 +10:00
Tibor Leupold 4f5d688021 Add ability for upgrade notification to show the relevant release to the user
This now implements the logic to link to the next minor's release notes
when such a version difference is computed. If a patch release
difference is computed, then those release notes are linked.

The utils.tests.js seemed a bit unexpected location, because there is no
`utils.js` module. Now the module defining the tests and the one
defining the functionality are named similarly, as is common in the rest
of the code base.

- resolves #7336
- resolves #7405
- resolves #3938
- fixes #8537

Fix issue where upgrade notification was not using translated content.
2022-05-26 19:57:46 +10:00
sag᠎e f4d5207fbd
Use `GenericForeignKey` and `GenericRelation` for `Revision` (#8571) 2022-05-26 00:08:30 +01:00
thoang43 2fbac52532 Documentation - Convert rst to md for ModelAdmin section
- Co-authored-by: Vu Pham
- relates to #8383
2022-05-20 08:32:21 +10:00
sag᠎e 52e5abfe62
Replace `PageRevision` with generic `Revision` model (#8441) 2022-05-17 11:46:30 +01:00
Paarth Agarwal a98f047950 removed trailing slash 2022-05-14 15:50:10 +10:00
Fabien Le Frapper aad51b2bb2 Update docs/reference/contrib/frontendcache.rst
Co-authored-by: Jake Howard <RealOrangeOne@users.noreply.github.com>
2022-05-13 08:15:35 +10:00
Fabien Le Frapper aff9b9a623 fix linting issues 2022-05-13 08:15:35 +10:00
Fabien Le Frapper 44456ff4dd Fix typo that broke a link 2022-05-13 08:15:35 +10:00
Fabien Le Frapper b54e9cbc62 Add instructions about where to find cloudflare zone id 2022-05-13 08:15:35 +10:00
LB Johnston d9981e0ec7 fix up spelling in documentation & docstrings (should be en-GB not en-US)
- customize -> customise
- color -> colour
- customizing -> customising
- organize -> organise
2022-05-13 08:13:06 +10:00
Matt Westcott 37784643e9 API docs for Panel 2022-04-22 17:25:30 +01:00
Vu Pham 68287e97e1 Add base_url_path functionality to ModelAdmin
- Co-Authored-By: Khanh Hoang <39248704+thoang43@users.noreply.github.com>
- adds ability to set `base_url_path` on ModelAdmin to override the `app_name`/`model` URL building behaviour
- fixes #8038
2022-04-18 14:32:18 +10:00
Daniel Kirkham c877bf9886 convert various documentation pages to Markdown
- Removes use of topic:: in docs as this directive is not needed
- resolves #8323
2022-04-18 08:16:27 +10:00
Dan Braghis 4cc10322a1
Sync tree: cascade unpublish, move and delete (#7984)
* Add construct_synced_page_tree_list hook and use in page unpublish view

* Implement construct_synced_page_tree_list in simple_translation

but only when sync page tree is enabled

* Add hook documentation

* Add construct_synced_page_tree_list hook tests (#8058)

* Move translated and alias pages when WAGTAIL_I18N_ENABLED and WAGTAILSIMPLETRANSLATION_SYNC_PAGE_TREE are enabled

Co-Authored-By: Kalob Taulien <4743971+KalobTaulien@users.noreply.github.com>

* Delete corresponding translations when WAGTAIL_I18N_ENABLED and WAGTAILSIMPLETRANSLATION_SYNC_PAGE_TREE are true

Co-Authored-By: Kalob Taulien <4743971+KalobTaulien@users.noreply.github.com>

* Rename the hook to be more specific

* Update singular string version in confirm_move.html

* Update test test_translation_count_in_context

Co-authored-by: Kalob Taulien <4743971+KalobTaulien@users.noreply.github.com>
Co-authored-by: Karl Hobley <karl@kaed.uk>
2022-04-17 17:34:38 +01:00
Matt Westcott 6d2dcee4b9
Remove a stray reference to ChooserPanels (#8360)
These are no longer required in Wagtail 3
2022-04-14 11:09:31 +01:00
Matt Westcott cdeb1cf479
Add use_json_field=True to all StreamField examples (#8359)
This argument should be used on all new StreamFields created under Wagtail 3. It does add some clutter to the examples, but only using it in select cases would create more confusion...
2022-04-14 11:09:19 +01:00
Jake Howard 59f901fb82 Use `JSONField` to store form submissions 2022-04-13 23:40:56 +10:00
Thibaud Colas 4dc5f3c595 Remove legacy sidebar, refactoring slim sidebar implementation 2022-04-08 11:51:09 -04:00
Hitansh Shah 0b8a8c2024 Added image management command to purge and regenerate renditions
- resolves #8107
2022-04-07 23:57:44 +10:00
eevel 1c7c5cfc0b Allow specifying an alternative storage backend for image renditions
- add setting `WAGTAILIMAGES_RENDITION_STORAGE`
- add AbstractRendition file storage to use new setting
- resolves #3183
2022-04-07 23:33:46 +10:00
LB Johnston 5f4942f9ad documentation - fix broken docs references
- remove 2.16 reference to setting that no longer exists
2022-04-07 12:52:03 +01:00
Sandil Ranasinghe cb7fc4cb14 Rename BASE_URL to WAGTAILADMIN_BASE_URL & add docs
- add documentation for WAGTAILADMIN_BASE_URL
- ensure that WAGTAILADMIN_BASE_URL is used via a util so that it can fallback from request
- resolves #3248
- remove settings URL from pagination template - not required for query string URLs
2022-04-06 19:43:46 +10:00
Abdul 9007bda686 documentation - add admin tag manager doc
- add documentation that describes how to use `ModelAdmin` to manage tags
- resolves #1220
2022-04-06 07:21:34 +10:00
Matt Westcott 97e781e31c Renumber Wagtail 2.17 to 3.0
As per discussion on https://github.com/wagtail/wagtail/discussions/7732, the changes in the upcoming release (sidebar redesign, removal of hallo.js, module reorganisation) warrant a version bump to 3.0 if we're following semantic versioning.
2022-03-31 06:38:27 +10:00
Sage Abdullah dcae64c255 Allow `StreamField` to use `JSONField` internal type via `use_json_field` kwarg
Add system check for use_json_field in StreamField

Change system check level to Warning

Add use_json_field argument to StreamField in test models

Use RemovedInWagtail219Warning instead of a system check

Handle unpacked values in to_python when use_json_field is True

Duplicate models and tests for JSONField-based StreamField

Add basic tests for JSONField-based StreamField

Add json_field property in StreamField to unify JSONField usage

Add docs

Don't use destructuring for kwargs in deconstruct

Add versionchanged note to StreamField reference
2022-03-29 18:18:08 +01:00
Matt Westcott 6bb26c774e Move template paths from edit_handlers to panels 2022-03-25 10:44:25 -04:00
Matt Westcott c7774ba0be Move wagtail.contrib.forms.edit_handlers to wagtail.contrib.forms.panels 2022-03-25 10:44:25 -04:00
Matt Westcott b189ab8382 Move wagtail.admin.edit_handlers to wagtail.admin.panels 2022-03-25 10:44:25 -04:00
Karl Hobley 75cc7da38a Move wagtail.core to wagtail 2022-03-17 17:19:59 +00:00
Matt Westcott dd37901428 Add documentation for the permission kwarg on FieldPanel 2022-03-16 11:47:51 +00:00
Serafeim Papastefanos 93da5bc793 Documentation - modelAdmin - add form clean example 2022-03-16 21:16:28 +10:00
LB Johnston 7c3ddb3bfc documentation - adopt MyST syntax for form builder section
- the original conversion to markdown happened around the same time as the MyST conversion
- this meant that the syntax was not in sync
- also run prettier over markdown for consistent formatting & whitespace
- see #8007
2022-03-16 20:51:43 +10:00
LB (Ben Johnston) e3b6e79a8e
Documentation - migrate form builder docs to markdown (#8007)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-03-10 08:43:49 +00:00
LB (Ben Johnston) 6ed65f14c6
Move Markdown docs to MyST parser. Fix #8074 (#8084) 2022-03-09 11:48:19 +00:00
LB (Ben Johnston) 70aabb5d34
Refine documentation for `show_in_menus` (#8072)
- this appears to be a point of confusion, where developers are unsure what this field does
- this update makes it more explicit that this field does not do anything, except the queryset usage, by default
2022-03-04 14:34:21 +00:00
Matt Westcott 31139e8b24 Remove references to StreamFieldPanel and ChooserPanels from docs 2022-03-02 15:55:25 +00:00
Matt Westcott c6f3b9982c Fix / remove broken documentation links 2022-03-02 11:48:06 +00:00
LB Johnston 6ecdc16bd4 remove Hallo references in the documentation 2022-03-02 20:15:33 +10:00
Sage Abdullah bf8d5b3f94 Replace `data_json` `TextField` with `data` `JSONField` in `BaseLogEntry` 2022-02-28 10:27:07 +00:00
Sage Abdullah bae76a2af0 Replace `content_json` `TextField` with `content` `JSONField` in `PageRevision` 2022-02-25 11:39:47 +00:00
Andy Babic 963c739f03 Remove a reference to the recipe from redirects.rst 2022-02-22 16:18:46 +10:00
Andy Babic 2c33c98eb4 Remove redirect auto-creation recipe from docs, as wagtail has this covered. 2022-02-22 16:18:46 +10:00
Matt Westcott 8d40a978ef Remove old versionadded / versionchanged notes 2022-02-08 19:00:47 +00:00
Matt Westcott 00582ba35a Remove 'db' and 'postgres_search' search backends 2022-02-08 19:00:47 +00:00
LB Johnston 5258f2899b hooks - update unnecessary format_html to mark_safe 2022-01-26 11:19:27 +00:00
Andy Babic 236af3607f Documentation for #7827 2022-01-21 12:53:37 +00:00
Cynthia Kiser 82d9330d77 Added a section to deployment docs about configuring serving of user uploaded files (#7553) 2022-01-21 11:21:53 +00:00
Thibaud Colas 20a7d1ef3a Mention WAGTAIL_SLIM_SIDEBAR will go away in Wagtail 2.18 2022-01-21 10:24:02 +00:00
Thibaud Colas 2e6378aa19 Add WAGTAIL_SLIM_SIDEBAR = False setting to switch back to legacy sidebar 2022-01-21 10:24:02 +00:00
Thibaud Colas 71be900e25 Update MenuItem API documentation 2022-01-21 10:24:02 +00:00
Naomi I. Morduch Toubman 9b1a05a55d
Change webmaster to website administrator in the admin (#6857)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-01-20 20:39:09 +00:00
Vladimir Tananko e07e1994de A Jinja2 version of wagtail_site tag 2022-01-20 14:05:13 +00:00
Jake Howard 0a9b23979b Update links to wagtail.io website to point to wagtail.org
This covers only links to the website, not other sites
2022-01-15 20:23:44 +10:00
LB (Ben Johnston) 707ea54f4f Update blocks.rst
Docs does not currently include the `rows` kwarg that is available on `TextBlock`.

See Question on slack https://wagtailcms.slack.com/archives/C81FGJR2S/p1635825388225100
2022-01-08 20:54:20 +10:00
Tidiane Dia 11e1ff03df Add register_page_header_buttons hook documentation 2022-01-07 16:23:17 +00:00
Karl Hobley 247030df14
Revert "Implement `page_url_path_changed` signal (RFC 34) (1 of 3)" (#7797)
* Revert "Release notes for #7761"

This reverts commit b062c22331.

* Revert "Fix incorrect logging of move VS reorder"

This reverts commit 0086c7ba7a.

* Revert "Update docs"

This reverts commit e602990e39.

* Revert "Add tests"

This reverts commit b10e545b14.

* Revert "Prevent the 'old_record' query being unnecessary triggered by page.move()"

This reverts commit 4fed675d7a.

* Revert "Implement the page_url_path_changed signal"

This reverts commit 2f86eda372.
2021-12-18 16:54:44 +00:00
Karl Hobley 6f2c576da0
Revert "Add `ever_live()` and `never_live()` filters to `PageQuerySet` (RFC 34) (2 of 3)" (#7796)
* Revert "Release notes for #7776"

This reverts commit a7e58e9c67.

* Revert "Tests for #7776"

This reverts commit 1f5734ce3f.

* Revert "Add PageQuerySet.ever_live() and PageQueryset.never_live() filters"

This reverts commit d8c2e33505.
2021-12-18 16:54:26 +00:00
Karl Hobley 7999cbf2c4
Revert "Add signal handler for automatic redirect creation (RFC 34) (3 of 3)" (#7795)
* Revert "Release notes for #7774"

This reverts commit e9eadb65c7.

* Revert "Docs for #7774"

This reverts commit d00a4c8a65.

* Revert "Automatically create redirects for when pages are moved or have their slug updated"

This reverts commit 31a7b11932.
2021-12-18 16:54:04 +00:00
Andy Babic d00a4c8a65 Docs for #7774 2021-12-16 16:06:11 +00:00
Andy Babic d8c2e33505 Add PageQuerySet.ever_live() and PageQueryset.never_live() filters 2021-12-16 14:10:16 +00:00
Andy Babic e602990e39 Update docs 2021-12-16 13:35:11 +00:00
LB (Ben Johnston) c9aa26e887
Documentation - remove all jQuery usage (#7658) 2021-12-07 15:37:33 +00:00
Tomasz Knapik 2c169a8d38 Add Azure CDN and Front Door backends 2021-12-03 08:05:12 +10:00
Matt Westcott 980d2c435e collapse option on StreamField, StreamBlock, ListBlock
Fixes #7705
2021-12-01 07:36:54 +10:00
Matt Westcott abf408d8f6 Formally deprecate old db search backends (#7651)
As per #7633
2021-10-28 10:53:32 +01:00
Coen van der Kamp 73f65e9357 Fix TableBlock -> TypedTableBlock in code samples 2021-10-18 12:42:20 +01:00
Shohan 4624d2d540 Fix typos and remove unwanted code from bulk actions (#7613)
* [refactor] Fix typos and documentation

* [refactor] Remove unused attribute object_key

* [refactor] Remove filters from page explorer

* [refactor] Remove unused code of page filters
2021-10-15 16:51:18 +01:00
Dan Braghis 247bfe883f Further tidy up following code review
Co-Authored-By: Thibaud Colas <thibaudcolas@gmail.com>
2021-10-15 16:51:18 +01:00
Shohan 24f987db49 Add bulk actions documentation
Co-Authored-By: Thibaud Colas <thibaudcolas@gmail.com>
2021-10-15 16:51:18 +01:00
Matt Westcott 78389caa95 Remove unnecessary indentation from code examples 2021-10-15 14:20:56 +01:00
Matt Westcott 6012291707 Documentation formatting fixes
Co-authored-by: Scott Cranfill <scott@scottcranfill.com>
2021-10-15 14:20:56 +01:00
Matt Westcott 55c72fd3ba Docs for typed table block 2021-10-15 14:20:56 +01:00
Karl Hobley e2ddd52030 Updates to docs for new database search backend
A more detailed comparison of the features supported in different
databases will come later.
2021-10-11 20:12:24 +01:00
LB Johnston f453092d0c update hooks documentation to use mark_safe as no variables are used 2021-10-06 20:57:32 +10:00
Daniel 381b11f54f Include custom permissions hook documentation 2021-10-01 06:52:43 +10:00
Joe Howard 4ab7080fb8 Documentation - Remove ambiguity about ModelAdmin templates
- The modeladmin folder needs to be inside the templates folder of the relevant app.
- The way it was written makes it seem like /modeladmin/ should be placed in the project root directory.
2021-09-30 21:32:57 +10:00
JaneLiu 92381698d0 Add code example for `before_delete_page` hook 2021-09-30 21:15:33 +10:00
Mitchel Cabuloy d026632894
Add page synchronization to simple_translation 2021-09-29 11:43:45 +01:00
Matt Westcott 3b972775fc Deprecate passing callables as log messages 2021-09-27 19:54:25 +01:00
Matt Westcott 0380f01b24 Allow specifying a format for the label of a collapsed StructBlock
Currently, the label shown for a StructBlock's collapsed representation takes its content from the first sub-block of the StructBlock, which isn't always what you want. Add a new `label_format` meta option to StructBlock to allow customising this - e.g. `label_format = "Profile for {first_name} {surname}"`
2021-09-27 19:07:14 +01:00
Scott Cranfill 27c3e7921a Docs: Clarify Jinja2 template configuration
Emphasizing and clarifying some parts that are easy to overlook, based on a Slack support conversation.
2021-09-26 20:48:28 +10:00
Victor Miti bb802509d2 Model Reference docs - correct field name
change `page revision` to `page_revision`
on the `TaskState` model
2021-09-26 20:46:29 +10:00
Jake Howard 4dc2967d26 Settings docs - remove duplicate word 2021-09-07 20:23:11 +10:00
Tibor Leupold 9ae4ab6084 Document how to limit a page parent to root
Closes #2768

Issue #2768 was created because a way how to limit a page to be only
available under the root page was unknown.

The implementation has allowed this for a while now, but the issue was
not closed (presumably due to missing documentation).

The documentation of the `parent_page_types` filed now includes this
"special" case.
2021-09-07 09:52:33 +01:00
fabienheureux cb08c997ea
Make all edit panels collapsible (#7365)
* Make more panels type collapsible
* Remove duplicate js in homepage template
* Move collapsible code into its own js file
* Change $li to $target in collapsible.js, as in #6342

Closes #7364, #6342, #6187, #2123

Co-authored by: Fabien Le Frapper <contact@fabienlefrapper.me>
Co-authored-by: Robbie Mackay <rm@robbiemackay.com>
Co-authored-by: Scott Cranfill <scott.cranfill@jpl.nasa.gov>
2021-08-30 08:33:43 -07:00
Matt Westcott e777517950 Update docs on action menu items to cover new API 2021-08-24 15:42:04 +01:00
Matt Westcott 1ad6f3518c Update docs to cover use of components in homepage panels / summary items 2021-08-24 15:42:04 +01:00
Andy Chosak e9e1a48b68 Fix broken references in Pages topic documentation
The "Page models" documentation page in the Wagtail usage guide has
several broken links (see current page at
https://docs.wagtail.io/en/stable/topics/pages.html).

These links work when developing the documentation locally, but not when
served on ReadTheDocs (docs.wagtail.io)

The broken links are all of the form /some/page.html#anchor - somehow
this format doesn't translate properly to get the necessary RTD prefix
(for example /en/stable/).

I've modified these links to use RST references, which will also make
them more robust to future changes.
2021-08-20 17:08:35 +01:00
jacobtoppm 1efbfd4994 Release note and CHANGELOG for #7376 2021-08-11 17:56:02 +01:00
jacobtoppm 7bf3f813ef Add link conversion configuration setting 2021-08-11 11:52:29 +01:00
Karl Hobley 8413d00bdd Spelling fixes 2021-08-06 20:11:30 +01:00
Matt Westcott 4e2685f47d Add an 'Extending Wagtail' section to the docs 2021-08-03 16:07:18 +01:00
Matt Westcott 8c97c254a7 Add server-side min_num and max_num validation for ListBlock
Fixes #5300
2021-07-14 13:14:15 +01:00
Matt Westcott bdfa3811d1 Remove outdated versionadded/versionchanged annotations 2021-07-13 17:10:56 +01:00
Nick Smith 1d03c36421 Change some word choices in the docs
This replaces several US English dialectical uses of _regular_ with
British English equivalents _normal_ or _standard_. This is the result
of a search of the docs for the string 'regular', rather than due to any
US English seen in the user interface.

This search also found one use of _regularly_ where _often_ was closer
to the intended meaning, a change which is less about dialect than about
word choice.
2021-07-13 10:51:46 +01:00
Thibaud Colas 55fe295346 Remove docs for WAGTAILSEARCH_RESULTS_TEMPLATE, WAGTAILSEARCH_RESULTS_TEMPLATE_AJAX
The templates they would override have been removed from our search app, and copies placed in the project template.
2021-06-28 11:23:24 +01:00
Thibaud Colas 86b84a2010 Add headings for all settings 2021-06-28 11:23:24 +01:00
Storm Heg 3ee060ffd7
Add keyboard and screen reader support to Wagtail user bar (#6994). Fix #6108
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2021-06-26 20:53:44 +01:00
Petr Dlouhý 50e4f5151d fix small youtube embed - allow to override max_width/max_height in EmbedBlock 2021-06-25 16:15:09 +01:00
Matt Westcott 87057501ac Add titlesonly to reference / topics top-level TOCs
This prevents duplicated headings in places where the second-level index page has intro blurbs for each subsection (and also means we're not listing out long multi-section pages in full in the index, but given how big these indexes are that's probably not a bad thing).
2021-06-18 15:17:24 +01:00
Matt Westcott de9588590b Allow workflows to be disabled (#7218)
Introduce a WAGTAIL_WORKFLOW_ENABLED setting; when false, the workflow report and settings menus are hidden, permissions are not registered, moderation-related dashboard panels on the homepage are skipped, workflow actions on add/edit page are hidden, and model methods such as page.current_workflow_state return None / False immediately without any db queries.
2021-05-26 19:23:28 +01:00
Bojan Mihelac 0dfc342d66 Small fix in doc for routablepage 2021-05-19 15:15:49 +01:00
Karl Hobley 8e25960972
Telepath set up for new sidebar
* Add ability to register multiple hooks with register_temporarily

It's not possible to add multiple items in a ``with`` block in multiple
lines. So to register multiple hooks, you either need to put them all on
one line or add many nested ``with`` blocks.

This commit adds the ability to pass in a list of hooks into one call.
This works around the syntax error, but there's still no way to
represent this in a way that flake8 is happy with so I've added
``#noqa`` in a few places.

* Telepath set up for new sidebar

* unindent hooks.register_temporarily with blocks

Co-authored-by: Matt Westcott <matt@west.co.tt>

* Update wagtail/core/telepath.py

Co-authored-by: Matt Westcott <matt@west.co.tt>

Co-authored-by: Matt Westcott <matt@west.co.tt>
2021-05-14 16:16:55 +01:00
fabienheureux 6d01ced56b
Fix usage of html syntax instead of html+django (#7138) 2021-05-05 11:08:40 +01:00
Matt Westcott 9d29ba862c Document idForLabel on the telepath widget API
Fixes #7145
2021-05-04 16:01:01 +01:00
jacobtoppm 59f63abdad Add documentation for commenting 2021-04-30 17:46:08 +01:00
jacobtoppm 24899dddb8 Add WAGTAILADMIN_COMMENTS_ENABLED default to docs 2021-04-28 10:08:13 +01:00
jacobtoppm 9728fab70e Add WAGTAILADMIN_COMMENTS_ENABLED setting 2021-04-27 19:28:51 +01:00
Karl Hobley ab8608a74f Docs for customising account settings 2021-04-20 18:43:22 +01:00
Coen van der Kamp b1b69360a3
Add contrib simple translation (#6528) 2021-04-14 08:56:00 +01:00
Samir Shah 0daae4a2b8 Allow a target variable to be specified for get_settings template tag. (#6891) 2021-03-26 23:28:07 +00:00
Matt Westcott 571b9e1918 Add example of a widget adapter class 2021-03-23 18:57:53 +00:00
Matt Westcott 3e2c928e2f Add StreamField context to block examples 2021-03-23 18:57:53 +00:00
Matt Westcott 0f75fb14f1 Add reference page for the client-side widget API 2021-03-23 18:57:53 +00:00
Matt Westcott b3c39216f2 Create a 'streamfield' subsection within the reference docs 2021-03-23 18:57:53 +00:00
Matt Westcott f3e33f849f Convert StreamField reference to proper class definition markup 2021-03-23 18:57:53 +00:00
Matt Westcott 37c2326150 Split up StreamField documentation [skip ci] 2021-03-23 18:57:53 +00:00
Jaap Roes 8d0eff1717
Fix typo in hooks reference example (#6926) 2021-03-16 17:14:52 +00:00
Thibaud Colas 8b07ad4cea
Add support for SVG icons to SearchArea subclasses and register_admin_search_area (#6493) 2021-03-09 11:33:06 +00:00
Thibaud Colas 5257ef6c84
Update register_admin_menu_item documentation to match SVG icons setup (#6892) 2021-03-09 12:04:09 +01:00
naglis 73d41059f8
Fix typo in site settings documentation example (#6881)
Lowercase `i` is used in the model definition and in other examples.
2021-03-08 13:19:31 +00:00
Naomi I. Morduch Toubman 664b0489fe
Change `master` to `main` (#6830)
* Update references to `master` branch to say `main`

* Update external links

* Update links in old release notes
  Use tagged versions of code rather than current code
2021-03-03 13:33:19 -05:00
Andy Babic fa8402f633 Implement PageQuerySet.defer_streamfields() 2021-03-03 13:03:46 +00:00
Andy Babic 8f38aaae87 Update type(), not_type(), exact_type() and not_exact_type() to accept multiple model classes as arguments 2021-03-02 20:00:28 +00:00
Storm Heg 24ef0e62e6 Fix documentation indentation
Fix code block indentation in tutorial.rst

Prevent it from being displayed as a quote.

Fix indentation in pages.rst

Fix indentation in indexing.rst

Fix indentation in searching.rst

Fix indentation in backends.rst

Fix indentation in renditions.rst

Fix indentation in custom_image_model.rst

Fix indentation in feature_detection.rst

Fix indentation in image_serve_view.rst

Fix indentation in custom_document_model.rst

Fix indentation in i18n.rst

Fix indentation in privacy.rst

Fix indentation in page_editing_interface.rst

Fix indentation in rich_text_internals.rst

Fix indentation in extending_hallo.rst

Fix indentation in configuration.rst

Fix indentation in usage.rst

Fix indentation in theory.rst

Fix indentation in model_reference.rst

Fix indentation in queryset_reference.rst

Configure editors to indent .rst files with 2 spaces

In order for the documentation to be styled correctly, the generator
depends on indentation. Too much indentation can result in the content
being wrapped in a quote block, which looks bad.

Fix indentation in sitemaps.rst

Fix indentation in frontendcache.rst

Fix indentation in routablepage.rst

Fix indentation in table_block.rst

Fix routablepage.rst autodocs disppearing

Fix indentation in table_block.rst

Fix indentation in redirects.rst

Fix indentation in table_documentation-modes.rst

Fix indentation in browser_issues.rst

Fix indentation in release_process.rst

Fix indentation of release notes

One more indent fix in the release notes

Fix indentation warnings

Fix warning about undefined label in docs

Error during `make html`:

  wagtail/docs/releases/1.7.rst:25: WARNING: undefined label: jpeg_image_quality
2021-02-26 09:17:00 +00:00
James Gutu 93abdabd41 moved jinja2 page from Advanced Topics to Reference 2021-02-04 12:12:11 -08:00
Matt Westcott 9886cb0476 add missing : to after_create_page example 2021-01-27 09:21:42 +00:00
Thibaud Colas 0dbd69f491
Configure Sphinx for Markdown support (#6711) 2021-01-26 22:09:52 +00:00
Matt Westcott 14daf4be0a Remove outdated versionadded/versionchanged notes in docs 2021-01-19 09:51:01 +00:00
Andy Babic f905e705da Add Page.specific_deferred (#6661) 2021-01-18 13:25:55 +00:00
Matthias Rohmer 9a1fc6d243 Add missing import to example code snippet (#6638)
Adding this makes the code snippet ready to use via copy and paste.
2021-01-15 21:10:55 +00:00
LB 7737497239 fix JS code example in hooks docs
- when returning format_html `{` (brace) characters must be escaped
- https://docs.python.org/3/library/string.html#format-string-syntax
2021-01-15 13:18:15 +00:00
Luis Nell a726c93df4 fix: signal receivers example raising exception
Signal receivers must accept `**kwargs`, otherwise one runs into this:

```
File "/lib/python3.8/site-packages/django/dispatch/dispatcher.py", line 94, in connect
raise ValueError("Signal receivers must accept keyword arguments (**kwargs).")
ValueError: Signal receivers must accept keyword arguments (**kwargs).
```
2021-01-11 11:25:19 +00:00
Bohreromir 3d18986610 fix ModelAdmin example (#6645) 2020-12-17 16:39:30 +00:00
Karl Hobley 45650053d5
Avoid recommending replacing image/document models entirely (#6624)
... when using the ``WAGTAILIMAGES_IMAGE_MODEL``/``WAGTAILDOCS_DOCUMENT_MODEL`` settings.

We can't really support this as we add new fields and methods to these base classes which all images/documents must support. If we did want to support swapping out the models entirely, every addition we make to the base models could be a breaking change.
2020-12-09 16:29:41 +00:00
Dan Braghis 05587e0d84 Allow customising image/document admin forms (#6462) 2020-12-09 12:35:19 +00:00
minusf a18a36d820
Fix indentation of locked_by block in documentation (#6580) 2020-12-02 10:40:25 +00:00
Matt Westcott 6e1e36256a Remove elasticsearch 2 support 2020-11-05 12:04:12 +00:00
Naglis Jonaitis 74c692ba21 Fix ModelAdmin documentation example
The `get_extra_class_names_for_field_col` seems to have an `if` missing
and uses an undefined `balance`.
2020-11-03 13:49:18 +00:00
Loic Teixeira 6c9478c139 Rework headings hierarchy
Initial hierarchy:

- Available panel types
    - FieldPanel
    - StreamFieldPanel
    - MultiFieldPanel
    - InlinePanel
    - FieldRowPanel
    - HelpPanel
    - PageChooserPanel
    - ImageChooserPanel
    - FormSubmissionsPanel
    - DocumentChooserPanel
    - SnippetChooserPanel
        - Built-in Fields and Choosers
        - Field Customisation
    - Full-Width Input
    - Titles
    - Placeholder Text
    - Required Fields
    - Hiding Fields
        - Inline Panels and Model Clusters

Revised Hierarcy:

- Panel types
    - Built-in Fields and Choosers
        - FieldPanel
        - StreamFieldPanel
        - MultiFieldPanel
        - InlinePanel
        - FieldRowPanel
        - HelpPanel
        - PageChooserPanel
        - ImageChooserPanel
        - FormSubmissionsPanel
        - DocumentChooserPanel
        - SnippetChooserPanel
    - Field Customisation
        - Full-Width Input
        - Titles
        - Placeholder Text
        - Required Fields
        - Hiding Fields
    - Inline Panels and Model Clusters
2020-10-23 10:36:01 +01:00
David Bramwell e28aa6b194 Document ModlelAdmin.prepopulated_fields 2020-10-19 21:36:05 +01:00
Karl Hobley 0efe4a75a5
[RFC 54] Internationalisation reference docs (#6377)
* Reference docs for internationalisation

* Update docs/reference/pages/model_reference.rst

Co-authored-by: Dan Braghis <dan@zerolab.org>

* Update docs/reference/pages/model_reference.rst

Co-authored-by: Dan Braghis <dan@zerolab.org>

* Update docs/reference/pages/model_reference.rst

Co-authored-by: Dan Braghis <dan@zerolab.org>

* Apply suggestions from code review

Co-authored-by: Dan Braghis <dan@zerolab.org>

* Add missing comma

* Apply suggestions from code review

Co-authored-by: Matt Westcott <matthew@torchbox.com>

Co-authored-by: Dan Braghis <dan@zerolab.org>
Co-authored-by: Matt Westcott <matthew@torchbox.com>
2020-10-19 18:40:58 +01:00
Matt Westcott 9fab50e87a remove trailing whitespace 2020-10-19 18:11:12 +01:00
Jean Zombie b5cfca31eb Add example of updating a page within after_create_page (#6373)
This update intends to add the answer I got on my slack support request (https://wagtailcms.slack.com/archives/C81FGJR2S/p1599209092087000).
2020-10-19 18:01:49 +01:00
Karl Hobley 7f7f9b4de1 Make snippets action menu hookable 2020-10-14 14:41:22 +01:00
Karl Hobley c170c50c78 Add view for converting aliases into regular pages 2020-10-08 10:24:58 +01:00
Karl Hobley b5eddca28b Synchronise alias page content when the source is updated 2020-10-08 10:24:58 +01:00
Karl Hobley 674fa8e27a Add Page.create_alias method 2020-10-08 10:24:58 +01:00
Karl Hobley 17f63f0efc Add alias_of field to Page 2020-10-08 10:24:58 +01:00
Matt Westcott dd442a3990 remove trailing whitespace to placate doc8 2020-10-05 12:44:57 +01:00
meghanabhange f1fbbcbc24
Add validation for file extension in AbstractDocument using WAGTAIL_DOCS_EXTENSIONS setting (#6423) 2020-10-05 12:26:00 +01:00
Karl Hobley cf38b2457d Put quotes around some inline code 2020-10-03 14:43:03 +01:00
Karl Hobley 39d931d77d Javascript => JavaScript 2020-10-03 14:43:03 +01:00
Karl Hobley 6e5f89adf2 General spelling fixes 2020-10-03 14:43:03 +01:00
Karl Hobley 9195131738 Lint docs with doc8 2020-10-03 14:43:03 +01:00
Ameet Virdee 48a8af71e5 Add documentation for placeholder text in Field Panels 2020-10-01 08:06:43 +02:00
Matt Westcott 008b6c12c4 Update BaseLogEntry docs to reference user_display_name. Fixes #6418 2020-09-30 15:43:27 +01:00