657afde30a
Add more detail to SVG security notes, update settings reference
2023-03-30 10:19:43 +01:00
196ed4162d
Add SVG docs
2023-03-30 10:19:43 +01:00
d856e702e1
Update documentation on icons management, with available icons
2023-03-28 16:13:35 +01:00
094bb83848
Allow customising the number of snippets per page on the chooser view
2023-03-23 14:15:47 +00:00
f533ab219d
Allow customising the number of snippets per page on the listing view
2023-03-23 14:15:42 +00:00
b713a1753e
Allow admin URL customisation for snippet chooser views via SnippetViewSet
2023-03-23 13:54:59 +00:00
e6d920d435
Add docs and tests for snippets admin URL customisation
2023-03-23 13:54:49 +00:00
198388bf55
Add docs and tests for customising snippet icons
2023-03-22 15:15:30 +00:00
65f2eaa4d2
Documentation - Clean up minor formatting issues
2023-03-21 08:02:25 +10:00
66a086da29
Add support for double quotes query string searches
...
- Fixes #9951
2023-03-19 21:30:21 +10:00
cfcfd85525
Clarify ClusterableModel requirements for using relations with RevisionMixin-enabled models
2023-03-13 09:35:05 +00:00
af57a3eb7e
Add ability to disable search indexing for a model #9821
...
- Add tests for search disable capability
- Update index disable to use empty search_fields property
- Relates to #7570
2023-03-12 20:16:19 +10:00
a07fe20ceb
Add documentation for customising StreamField validation
2023-03-01 12:07:13 +01:00
c73b03e03c
Added requested changes
2023-02-16 16:17:03 +00:00
123d944674
Added docs about abtract model for InlinePanel ( #9887 )
2023-02-16 16:17:03 +00:00
e0ea3ee448
Added link to description of InlinePanel
2023-02-16 16:17:03 +00:00
d5f787030a
Update docs for use_json_field
...
Indicate that this must now be set to True.
2023-02-10 13:20:34 +00:00
18a574b520
Remove old versionadded / versionchanged directives from docs
2023-02-08 14:25:09 +00:00
7339f6c3d1
Update guide.wagtail.org links to use most up-to-date URL and page name, with "latest" redirect
2023-02-03 11:13:15 +00:00
9e016c17b8
Documentation - whitespace formatting fixes
...
- Includes small fix for #9969 missing space
2023-01-28 06:59:01 +10:00
a6a431a083
Return ScheduledForPublishLock from DraftStateMixin.get_lock()
...
Update docs to enforce that the LockableMixin should come last (but before RevisionMixin)
2023-01-19 14:07:54 +00:00
18c140e8be
Add docs for `WorkflowMixin` and enabling workflows for snippets
2023-01-19 14:07:51 +00:00
7a6feb188f
Link django docs to stable version
2023-01-11 20:18:04 +10:00
edb86a7e8f
Documentation - Fix missing links / images
...
Most of these are no longer applicable due to the introduction of Wagtail guide, where possible the new guide links are used now
- Re-add missing docs image for extending Draftail
- There is no Guide page (yet) for Inserting videos or images so those links have been removed
- Fix some additional reference issues where the page name and reference were causing issues
2023-01-05 12:08:27 +00:00
0b72e3f598
Fix typo in docs
...
Co-authored-by: Matt Westcott <matthew@torchbox.com>
2023-01-04 16:13:56 +00:00
0f209ee848
Add `{% fullpageurl %}` for resolving absolute URLs to pages
2023-01-04 16:13:56 +00:00
5cf621660c
Refactor Wagtail userbar as a web component ( #9816 )
...
* Add a border around the userbar menu in Windows high-contrast mode so it can be identified
* Make sure browser font resizing applies to the userbar
* Switch userbar to initialise a Web Component to avoid styling clashes
* Refactor userbar stylesheets to use the same CSS loading as the rest of the admin
2022-12-27 16:55:19 +00:00
8dcc292d26
Add docs for `LockableMixin` and locking snippets
2022-12-14 11:46:57 +00:00
e84cdc4e2c
Add wagtail-streamfield-migration-toolkit docs
...
- Move RichText -> StreamField migration guide into
advanced/streamfield_migrations.md
2022-12-09 16:40:07 +00:00
d3f9d2e9a3
Document ClusterableModel requirement for relations in RevisionMixin-enabled snippets
2022-12-08 11:46:59 +00:00
2cb12871ef
Fix RichTextField - StreamField migration example code
...
Follow-up to #8307 . It appears that the original code was designed for a StreamField setup where the `rich_text` block is not a RichTextBlock, but a StructBlock with a RichTextBlock child also named `rich_text`. #8307 correctly removed this redundant wrapper from page_to_streamfield, but there are corresponding changes required for the rest of the helper methods.
2022-12-08 07:39:37 +10:00
1f143cf8ca
Create and show publish permissions for snippets with `DraftStateMixin` applied ( #9711 )
2022-12-06 16:16:59 +00:00
4613fa2562
Fix RichTextField to StreamField example migration
2022-11-20 22:06:24 +10:00
26f5a4fcb1
Move custom image filter to extendig Wagtail section
2022-11-20 08:03:33 +10:00
1fb588c314
Add custom image operation example to docs
2022-11-20 08:03:33 +10:00
b20b98907a
Grammatical adjustments of `page models` usage guide to resolve issue #9398 ( #9399 )
...
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-11-18 15:01:31 +00:00
032f521bbf
Documentation - Improve grammar, spelling, and punctuation
2022-10-25 17:14:58 +10:00
d2b9ca9430
Grammatical adjustments of `searching` usage guide to resolve issue #9404 ( #9405 )
2022-10-21 00:27:59 +01:00
3ba25576f5
Add custom permissions section to permissions docs ( #9411 )
...
* Update docs/topics/permissions.md
2022-10-20 21:52:02 +10:00
0fb66cd663
Grammatical adjustments of `writing templates` usage guide to resolve issue #9400 ( #9401 )
...
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-10-20 08:29:09 +01:00
18371e2113
Documentation - adopt consistent `sh` console code snippets ( #9321 )
2022-10-13 07:25:19 +01:00
6fa4f8faca
Documentation - misc formatting clean up items
2022-10-13 05:46:26 +10:00
2e8709e0d6
Documentation - update dead/redirected links
2022-10-11 20:44:08 +10:00
9bf7a7423a
Documentation - Fix register_snippet import path typo
2022-10-05 21:39:48 +10:00
c94443fd96
Add docs on how to enable schedule publishing on snippets
2022-09-30 16:13:19 +01:00
0a0bd30fad
Allow customising snippet listing columns with list_display
2022-09-28 10:39:48 +01:00
a81f7f76b9
Release note for #9203
2022-09-27 11:16:53 +01:00
a7249a851f
Document SnippetViewSet and how to customise it
2022-09-27 10:18:18 +01:00
75b64f70b5
Remove unused `note` title from page inline panel docs
...
- add clarity to the docs that `admonition` is also not to be used
- title for this note is not required
- fixes #9125
2022-09-06 19:28:47 +10:00
5108b5f82a
Add ability to set default configurable attributes to image tags
...
- Allow users to override the default attributes given to an image
- Update tests to account for new tags
- Add documentation for custom image attributes
- Recommend that loading=lazy & decoding=async be considered for performance in front-end sites
2022-08-25 18:20:45 +10:00
d71a7ccdd4
Add links to topic guide from mixin reference docs
2022-08-21 07:18:27 +10:00
4d27fd1f54
Add docs for saving draft changes of snippets
2022-08-21 07:18:27 +10:00
9407be3d24
Add docs for saving revisions of snippets
2022-08-21 07:18:27 +10:00
a3255c1ee9
Add docs for making snippets previewable
2022-08-21 07:18:27 +10:00
cc0e14c38d
Improve snippets usage guide
...
- Use sentence case for headers in snippets usage guide
- Fix broken link to Django custom template tags
2022-08-21 07:18:27 +10:00
666cc5e8e5
fix up legacy release note refs & use consistent format
...
- fix some broken refs that were lost in the migration to markdown files
- use lower_snake_case for all internal refs (most follow this convention)
- release process sub-section in docs should be named release schedule instead
2022-08-16 12:42:42 +01:00
ca7f23d176
Update InlinePanel and StreamField styles for new designs ( #8983 )
2022-08-12 13:17:40 +01:00
3e6e9eb618
update docs/test spelling of colour
2022-08-12 17:29:16 +10:00
e29bb7e062
Update images.md
...
BASE_URL no longer works.
2022-08-12 17:17:33 +10:00
eac5e0bc2c
Finish re-implementing form styles based on design feedback & code review
...
Co-authored-by: LB Johnston <mail@lb.ee>
2022-08-05 10:36:52 +02:00
8cdb3f3a60
Added blocks_by_name, first_block_by_name methods to StreamValue
...
- A shortcut for accessing StreamField blocks by name
2022-07-20 17:13:20 +10:00
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
bc0f561240
documentation - migrate reference/pages/theory + index to markdown
2022-07-05 22:05:20 +10:00
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
ffda558015
Remove outdated references to old db search backend in docs
2022-07-04 07:59:23 +10:00
d4f6773940
fix documentation markdown conversion issue
...
- introduced in #8569
2022-06-30 16:55:42 +10:00
cda437804e
fix up markdown docs conversion issues
...
- introduced in #8759 & #8569
2022-06-30 16:36:37 +10:00
f535a0cc43
Documentation - migrate reference/** files to markdown content
...
- relates to #8383
2022-06-30 09:57:26 +10:00
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
4e7accda55
documentation migrate rest of topics/search/** to markdown
2022-06-30 09:16:42 +10:00
7d2545cddc
documentation - topics/search - rename files
...
- adding as separate commit to preserve file history
2022-06-30 09:16:42 +10:00
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
081f46c07f
Documentation - search indexing - Add link to the Postgres docs
...
- Postgres does not provide true control the search ranking using the database search backend.
- Postgres only supports four weight levels and this should be clarified in the documentation
2022-06-25 21:49:04 +10:00
a316408928
convert the docs/topics/** from RST to Markdown
...
Relates to #8383
* Convert the image tag topic to Markdown
* Convert the permissions usage to Markdown
* Convert the topic of snippets to Markdown
* Convert the streamfield topic to markdown
* Convert the writing templates doc to Markdown
2022-06-23 08:12:07 +10:00
50200f94c0
Release note for #8498
2022-06-20 14:18:29 +01:00
db7a0c96e3
Add Fuzzy() search query class ( #8498 )
2022-06-20 10:41:05 +01:00
adc2ea6a86
Use RichText object for adding rich text blocks ( #8675 )
...
I have just tried to follow the original instructions and got an `AttributeError: 'str' object has no attribute 'source'` when trying to append a rich text block to a `StreamField` programmatically.
Wrapping the value in a `RichText` object solved the issue. This seems to be in line with the behavior described further down the page.
2022-06-16 16:06:09 +02:00
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
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
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
0b8a8c2024
Added image management command to purge and regenerate renditions
...
- resolves #8107
2022-04-07 23:57:44 +10:00
113005aa05
Page description ( #8164 )
...
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
Co-authored-by: Kalob Taulien <kalob.taulien@gmail.com>
2022-04-01 22:16:41 +01:00
a70aefe243
fixed punctuation issues and modified text in wagtail documentation. ( #8262 )
2022-04-01 17:12:57 +01:00
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
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
dc4c9b704d
Rename the EditHandler base class to Panel
2022-03-25 10:44:25 -04:00
b189ab8382
Move wagtail.admin.edit_handlers to wagtail.admin.panels
2022-03-25 10:44:25 -04:00
75cc7da38a
Move wagtail.core to wagtail
2022-03-17 17:19:59 +00:00
6ed65f14c6
Move Markdown docs to MyST parser. Fix #8074 ( #8084 )
2022-03-09 11:48:19 +00:00
31139e8b24
Remove references to StreamFieldPanel and ChooserPanels from docs
2022-03-02 15:55:25 +00:00
bae76a2af0
Replace `content_json` `TextField` with `content` `JSONField` in `PageRevision`
2022-02-25 11:39:47 +00:00
d8d01f5ed2
Fixed typo in StreamBlock example ( #8020 )
2022-02-21 17:37:42 +00:00
cd8a1033b5
Updated docs link to supported Django version ( #7917 )
...
Using the `stable` URL fragment will always point to the latest major version, whereas 3.1, which was linked, is now end of life.
2022-02-04 12:33:56 +00:00
e3f38f0605
Remove errant greater than
2022-01-20 23:42:33 +00:00
abf408d8f6
Formally deprecate old db search backends ( #7651 )
...
As per #7633
2021-10-28 10:53:32 +01:00
c8d2562002
Create new permission policy CollectionMangementPermissionPolicy
...
Also updated tests, docs, and made a migration to move from model-level permissions to new granular collection management
2021-10-15 00:44:05 +01:00
a84c04af19
Document add, change, delete permissions when managing permissions
2021-10-15 00:26:37 +01:00
5a65cb7554
Expose preview mode to page and template rendering
...
Currently Wagtail defines `request.is_preview` as a way for both page
rendering and template rendering to modify logic based on whether the
page is being previewed.
If a page supports multiple preview modes, though, the information about
which mode is being previewed isn't made available. So, for example,
it's not possible to customize `Page.serve` or `Page.get_context` based
on a different preview mode. Or, consider customizing
`Page.get_template` so that it uses a different page template depending
on the mode being previewed.
This commit adds `request.preview_mode` so that the mode is available
downstream of previews, both in the page rendering logic and also in the
template itself.
A minor documentation change mentions this new property.
2021-10-14 06:47:26 +10:00
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
02d6d27a9c
add release notes
...
- autocomplete API - #4937 & #5960 & #4938
- Python 3.10 #7577
- unit tests #7578
2021-10-07 15:42:32 +10:00
Joshua Munn