Wykres commitów

728 Commity (0016ee7dfdd11cdad52463e1df222e1a65f38fd2)

Autor SHA1 Wiadomość Data
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
Matt Westcott 8edf16e5ff Serve PDFs inline in the browser
Fixes #1158
Add config options WAGTAILDOCS_CONTENT_TYPES and WAGTAILDOCS_INLINE_CONTENT_TYPES to determine the Content-Type and Content-Disposition headers returned for documents when using the Django serve view, and default to application/pdf being served inline.
2020-09-28 07:22:58 +10:00
Scott Cranfill 70bb9d934b
Support SVG icons in ModelAdmin menu items (#6402)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2020-09-25 15:58:52 +01:00
Andy Babic 8fd5d66756 Add RoutablePage.render() helper method and update documentation 2020-09-01 22:24:08 +01:00
Matt Westcott a1f882b7c9 Convert remaining gettext .format strings to old-style string formatting
As per #5548 / #6238. Fixes #6343
2020-08-21 13:26:00 +01:00
Matt Westcott 8542f5fe9c Fix underline lengths to prevent Sphinx warnings 2020-08-07 17:23:42 +01:00
jacobtoppm e85f16b500 Add a use case example for WAGTAIL_WORKFLOW_CANCEL_ON_PUBLISH=False 2020-08-07 17:10:24 +01:00
Karl Hobley 9ad14ea439
Add hooks for snippet listing buttons 2020-08-07 15:47:27 +01:00
Karl Hobley 9b02147d3e Add hooks.register_temporarily for testing hooks
There's currently a number of places where we test hooks by registering
hook functions from test methods. These are never cleaned up so that
hook remains registered in future tests. This can cause issues with
tests not working consistently when you run a subset of the tests.

This adds a `register_temporarily` function to the hooks module. This
function can be used either as a decorator or a context manager. It'll
always remove the hook after the decorated function or with block exits,
even if it exits through an exception.
2020-08-07 15:47:04 +01:00
Karl Hobley 4bf28b502c Fix docs for `construct_page_listing_buttons` 2020-07-31 11:14:48 +01:00
Karl Hobley f3f932d2e5
Add before_{create,edit,delete}_snippet hooks 2020-07-30 08:08:40 +01:00
Matt Westcott e0dc53d9ad Remove versionadded/versionchanged notes for 2.9 2020-07-28 12:53:22 +01:00
Chris Contolini 4231d9ef11
Fix minor typo in TableBlock docs (#6259)
Also a small grammatical fix.
2020-07-28 07:14:05 -04:00
jacobtoppm c79668929e Update reference documentation, custom task guide, and release notes, and fix documentation build errors 2020-07-24 16:59:33 +01:00
jacobtoppm 85e4426948 Cancel ongoing workflows when a page is published, depending on the value of a new setting, WAGTAIL_WORKFLOW_CANCEL_ON_PUBLISH. Add a warning modal before publication if a workflow will be cancelled 2020-07-24 16:59:33 +01:00
Matt Westcott bf53123309 Fix sphinx warnings from workflow / audit log documentation 2020-07-24 16:59:33 +01:00
Matt Westcott 6f85bca664 Use % formatting for new workflow / audit log translation strings
See #5548 - Transifex recognises % formatting, and will guard against translators introducing errors by attempting to translate the embedded variable names.
2020-07-24 16:59:33 +01:00
Matt Westcott c8a8689cee Document icon_name and classname for register_page_action_menu_item 2020-07-24 16:59:33 +01:00
Dan Braghis f69287f6f4 Add documentation 2020-07-24 16:59:33 +01:00
jacobtoppm df3a63c7a2 Add new page methods and updated workflow state methods 2020-07-24 16:59:33 +01:00
jacobtoppm 2037e8c089 Update images in documentation 2020-07-24 16:59:33 +01:00
jacobtoppm 8911bd30d7 Add workflow models to reference 2020-07-24 16:59:33 +01:00
jacobtoppm bf168df9f9 Document workflow signals 2020-07-24 16:59:33 +01:00
jacobtoppm c75a2a3549 Add workflow settings 2020-07-24 16:59:33 +01:00
Matt Westcott e8d02091ee Add warning about WAGTAILFORMS_HELP_TEXT_ALLOW_HTML 2020-07-20 10:36:41 +01:00
Matt Westcott d9a41e7f24 Escape help text in form builder forms by default
This can be disabled with the setting WAGTAILFORMS_HELP_TEXT_ALLOW_HTML
2020-07-20 10:36:28 +01:00
Matt Westcott 78c9ef31d7 Typo fixes 2020-07-15 17:18:46 +01:00
Martin Sandström c8f493c095 Add documentation for WAGTAIL_REDIRECTS_FILE_STORAGE setting (#6114) 2020-07-15 16:35:04 +01:00
Matt Westcott 9917d7d2e9 Additional documentation for next_url 2020-07-15 11:53:39 +10:00
Kevin d75ab584c7 Fixing typos 2020-07-14 10:56:28 +01:00
Andy Babic dd680ae4d4 Factor out content type fetching into a separate Page method, simplify the specific specific_class methods, and improve docstrings 2020-07-13 18:25:11 +01:00
Steven Wood 5611f5ef6c Clarify origin of From address used in password reset emails (#6219) 2020-07-13 18:15:21 +01:00
Storm Heg 8c306910dd Fix incorrect urls in the docs 2020-07-06 13:15:40 +01:00
Storm Heg 4076b9ef5e Replace calls to django.conf.urls.url with django.urls.path or django.urls.re_path 2020-07-06 13:15:37 +01:00
Matt Westcott e9e6a8d5e7 Add more detail to RoutablePageMixin example (#6128) 2020-06-25 16:57:58 +01:00
Gassan Gousseinov a4e05f4538 I would like only add my own editor without to redefine a default one. (#6118) 2020-06-25 16:53:06 +01:00
Jean Zombie 9baf6ce62a Update hooks.rst (#6160 / #6161)
This proposed update is in regard to Issue #6160
2020-06-25 14:54:16 +01:00
Tom Dyson 20b99d4386
Remove 'whitelist' from page reference docs (#6153) 2020-06-16 11:23:51 +01:00
Martin Sandström 301d1bc7f5 Add ability to import redirects from a file wagtail.contrib.redirects
* Add support for importing redirects via tsv, csv, xls and xlsx files
* Add import_redirects management command to redirects documentation
2020-06-07 11:20:39 +10:00
jacobtoppm ead6c8b2a6 Add WAGTAIL_TIME_FORMAT to settings reference 2020-05-27 13:55:52 +01:00
GTpyro 147fda12fa Update signals.rst for Python 3 compatibility
The send_to_slack example was not compatible with Python 3. Example is updated using the requests & json libraries (instead of urllib & urllib2)
2020-05-26 19:21:13 +02:00
Coen van der Kamp a1a2c35c1c Template render richtext without wrapper, add wagtail.contrib.legacy.richtext
* Add wagtail.contrib.legacy.richtext with tests & docs
* Make RichText.__html__ behave the same as template filter
* Resolves #1214
2020-05-21 07:53:31 +10:00
Karl Hobley 58f6aecfc7
Some cleanups in PostgreSQL search module (#5953)
* Separated logic for extracting indexable content

* Docs edits

* Readability improvements

* Simplify/deduplicate indexing code

* Simplify search code

Pulled in some code that will be included in a future Django release
(query.py)

* Reword a limitation

* Fix typo in docstring

* Raise a warning when Boost() is used in PostgreSQL search backend

* Add note mentioning that RawSearchQuery can be replaced in Django 3.1

* Add comment mentioning that we can replace query.py if Django PR merged
2020-05-18 15:54:31 +01:00
Kalob Taulien b5f5ac10db
Add export_filename option to modeladmin
Merge pull request #6031 from wagtail/reports-filename
2020-05-15 10:04:57 -06:00
jacobtoppm cc676c4c9e Add export_filename option to modeladmin 2020-05-14 15:50:47 +01:00
Kalob Taulien f757324039 Add Snippet hooks (after_edit_snippet, after_create_snippet and after_delete_snippet) 2020-05-14 20:47:36 +10:00
Cameron Lamb 55476426db Fix typo in ModelAdminGroup example 2020-05-14 20:37:34 +10:00
Brylie Christopher Oxley ff37ad6ab9 Add 'add_redirect' static method to Redirect
* This method was inspired by a Lacey Williams Henschel (@williln) presentation at Wagtail Space US 2018, called  'What the Wagtail docs don't tell you'. https://www.youtube.com/watch?v=PCkxBNXWM64&t=1220s
* Add docs section reference/contrib/redirects
2020-05-10 18:48:33 +10:00
jacobtoppm 30c398c91a Add purge_revisions management command
* Fix typo in publish_scheduled_pages dry run
* Add purge_revisions to docs
* Resolves #5192
2020-05-08 11:35:30 +10:00
LB (Ben Johnston) 9359b14326
fix sphinx warnings (#6001)
- use .add_css_file instead of .add_stylesheet in conf.py
- use .add_js_file instead of .add_javascript in conf.py
- fix duplicate clss references in pages model reference (for grouping of methods & attributes)
- rename wagtailspace.js to banner.js (may be used in the future for a generic banner)
2020-05-03 14:02:43 +02:00
Andy Babic 4846a3e801 Add get_page_url() method to BaseSetting
* adds a convenience `page_url` shortcut to improve how page URLs can be accessed from site settings in Django templates
2020-05-03 15:14:41 +10:00
Jonatas Baldin a7f58821a7 Add publish & unpublish page hooks
* Add `before_unpublish_page` and `before_unpublish_page` hooks
* Add `before_publish_page` and `before_publish_page` hooks
* Resolves #4590
2020-05-03 14:18:13 +10:00
danbentley 1156182283
Add Page.context_object_name (#5999)
Page.context_object_name can be used to define a more meaningful name
for the page variable in the template.

If defined, the default `page` and `self` are still available for use in
shared templates.

Resolves #5213
2020-05-01 20:01:02 +02:00
Andy Babic 3fe8775024 Add pre_page_move and post_page_move signals
* Documentation for pre_page_move and post_page_move signals
* Resolves #2728
2020-04-28 20:26:40 +10:00
Haydn Greatnews 165c5c0ce5 Add date & datetime formatting to AbstractEmailForm + split out render_email method
* Rewrite AbstractEmailForm render to use cleaned_data
* Add date time formatting to AbstractEmailForm's render method according to Django settings SHORT_DATE_FORMAT and
SHORT_DATETIME_FORMAT
* Previously it was iterating over `form` which left no place to remove
data from the submission without removing the field from the form (which
is inadvisable, as discussed on #4313)
* Preserve order of fields in form emails using cleaned data
* Add a test for consistent date rendering in email forms
* update form customisation examples and add note about date / time formatting in email form usage (docs)
* resolves #3733
* resolves #4313
2020-04-26 20:25:48 +10:00
Ascani Carlo 5f3c12682f Redirect to previous url when deleting/copying/unpublish a page
* modify register_page_listing_buttons & register_page_listing_more_buttons to handle next_url kwarg
* resolves #3010
2020-04-26 18:24:13 +10:00
Matt Westcott ceb4270e01 Remove versionadded/versionchanged notes for 2.8 2020-04-22 13:54:09 +01:00
Andy Babic db8ab0875d Update BaseSetting to make it easier to utilise QuerySet.select_related() for more complex settings which reference related objects (such as pages) 2020-04-03 22:01:08 +01:00
Andy Babic 18118f54b6 Update docs 2020-04-03 21:28:13 +01:00
Mohamed Feddad bb2e460c0b Replace deprecated ugettext, ungettext with gettext and ngettext. (#5907) 2020-04-02 17:15:26 +01:00
Matt Westcott 3f86de27e0 Document AdminOnlyMenuItem in hooks documentation 2020-03-19 17:57:52 +00:00
jacobtoppm 12d5edcef6 Add heading option to panels reference 2020-03-19 16:10:30 +00:00