Wykres commitów

275 Commity (4c109b0dd24d63254f76c13a05f56f724c88b576)

Autor SHA1 Wiadomość Data
LB Johnston 65f2eaa4d2 Documentation - Clean up minor formatting issues 2023-03-21 08:02:25 +10:00
Thibaud Colas fdc36a6989 Revert FieldRowPanel documentation removal, clarifying differences. Fix #10061 2023-03-14 22:44:11 +00:00
Vallabh c73b03e03c Added requested changes 2023-02-16 16:17:03 +00:00
Vallabh 407860286b Removed obsolete section of InlinePanels 2023-02-16 16:17:03 +00:00
Vallabh 996d45e0f0 Added description for parameters taken by InlinePanel 2023-02-16 16:17:03 +00:00
Matt Westcott 207493dc95 Fix broken formatting for MultiFieldPanel / FieldRowPanel permission kwarg docs 2023-02-14 20:34:35 +10:00
LB Johnston 93d3652a15 Documentation - fix whitespace issues 2023-02-11 08:29:13 +10:00
Matt Westcott a634045b6c Remove remaining versionadded directives from before 4.2 2023-02-10 13:20:34 +00:00
Matt Westcott 18a574b520 Remove old versionadded / versionchanged directives from docs 2023-02-08 14:25:09 +00:00
Matt Westcott 3cb4033a11 Remove deprecated edit handlers / panels 2023-02-08 14:25:09 +00:00
Thibaud Colas 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
Sage Abdullah ad3ef5875d
Update docs and changelog to reflect changes for #9817 2023-01-19 14:52:34 +00:00
Sage Abdullah 18c140e8be
Add docs for `WorkflowMixin` and enabling workflows for snippets 2023-01-19 14:07:51 +00:00
Sage Abdullah e1c6ae2d2b
Rename `Task.page_locked_for_user` to `Task.locked_for_user` 2023-01-19 14:06:04 +00:00
Sage Abdullah d8f9d9869a
Rename `page_revision` to `revision` in `TaskState` 2023-01-19 14:06:03 +00:00
Matt Westcott 515e76ab7b Add reference docs for MultipleChooserPanel 2023-01-18 14:31:08 +00:00
Matt Westcott c6de0ec067 Fix remaining imports deprecated in Wagtail 3.0 2023-01-11 13:35:39 +00:00
LB Johnston 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
Sage Abdullah 8dcc292d26
Add docs for `LockableMixin` and locking snippets 2022-12-14 11:46:57 +00:00
Oliver Parker 19fd2ceb98 Add ability to check permission on parent `PanelGroup` class
- Used by TabbedInterface, ObjectList, FieldRowPanel, MultiFieldPanel
2022-10-18 09:53:13 +10:00
LB Johnston 6fa4f8faca Documentation - misc formatting clean up items 2022-10-13 05:46:26 +10:00
LB Johnston 2e8709e0d6 Documentation - update dead/redirected links 2022-10-11 20:44:08 +10:00
Sage Abdullah 57beeb7154 Improve docs on scheduled publishing mechanism for clarity
Explicitly state that clicking Publish is required for the schedule to take effect.

Also document the edge cases for scheduled publishing when a page is scheduled to be unpublished
2022-09-30 16:13:19 +01:00
Sage Abdullah 48761ef5a9 Update docs for renaming publish_scheduled_pages command to publish_scheduled 2022-09-29 10:28:36 +01:00
Matt Westcott 528801f1a0
Ensure all panels output their own help_text (#9240)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2022-09-28 10:49:08 +01:00
Mehrdad Moradizadeh 180d43a200 Fix Page queryset.not_public returning all pages when no page restrictions exist. (#9067)
Fixes #8952
2022-08-24 17:57:22 +01:00
Sage Abdullah d71a7ccdd4 Add links to topic guide from mixin reference docs 2022-08-21 07:18:27 +10:00
Sage Abdullah e4509f3432 Improve Revision model docs 2022-08-16 07:58:28 +10:00
Sage Abdullah e864b9c4d1 Add docs for PreviewableMixin 2022-08-16 07:58:28 +10:00
Sage Abdullah fb6ec3ad00 Add docs for DraftStateMixin 2022-08-16 07:58:28 +10:00
Sage Abdullah cf3cea9a5b Add docs for RevisionMixin 2022-08-16 07:58:28 +10:00
Sage Abdullah 3151200288 Improve Page model reference documentation
- Use inline code for `Locale` and `TranslatableMixin` headers to be consistent with other classes in the page
- Move `locale` and `translation_key` of `TranslatableMixin` to its own "Database fields" section
- Add missing periods in Page.update_aliases parameter description
2022-08-16 07:58:28 +10:00
Thibaud Colas ca7f23d176
Update InlinePanel and StreamField styles for new designs (#8983) 2022-08-12 13:17:40 +01:00
Thibaud Colas 3d96e7fbe7 Implement collapsible and linkable panels
Co-authored-by: LB Johnston <mail@lb.ee>
2022-08-05 10:36:52 +02:00
Thibaud Colas af9b16e93d Re-implement base form field styles based on new page editor designs
Co-authored-by: LB Johnston <mail@lb.ee>
2022-08-05 10:36:52 +02:00
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
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
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
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
SilvestriStefano f535a0cc43 Documentation - migrate reference/** files to markdown content
- relates to #8383
2022-06-30 09:57:26 +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
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
Matt Westcott a3b1cb6c28 Add a page_type_display_name shortcut property 2022-06-08 17:35:40 +01:00
Dan Swain b53f12d394 Include missing import of FieldPanel 2022-05-28 06:40:25 +10:00
sag᠎e f4d5207fbd
Use `GenericForeignKey` and `GenericRelation` for `Revision` (#8571) 2022-05-26 00:08:30 +01:00
sag᠎e 52e5abfe62
Replace `PageRevision` with generic `Revision` model (#8441) 2022-05-17 11:46:30 +01: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
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
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
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
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
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
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 2c33c98eb4 Remove redirect auto-creation recipe from docs, as wagtail has this covered. 2022-02-22 16:18:46 +10:00
Andy Babic 236af3607f Documentation for #7827 2022-01-21 12:53:37 +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
Andy Babic d8c2e33505 Add PageQuerySet.ever_live() and PageQueryset.never_live() filters 2021-12-16 14:10:16 +00: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
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
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 59f63abdad Add documentation for commenting 2021-04-30 17:46:08 +01: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
Andy Babic f905e705da Add Page.specific_deferred (#6661) 2021-01-18 13:25:55 +00:00
minusf a18a36d820
Fix indentation of locked_by block in documentation (#6580) 2020-12-02 10:40:25 +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
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
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
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 e0dc53d9ad Remove versionadded/versionchanged notes for 2.9 2020-07-28 12:53:22 +01: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
Matt Westcott bf53123309 Fix sphinx warnings from workflow / audit log documentation 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 8911bd30d7 Add workflow models to reference 2020-07-24 16:59:33 +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
Tom Dyson 20b99d4386
Remove 'whitelist' from page reference docs (#6153) 2020-06-16 11:23:51 +01: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
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
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
jacobtoppm 12d5edcef6 Add heading option to panels reference 2020-03-19 16:10:30 +00:00
Matt Westcott 09a2ccf8cc Documentation for custom tag models 2020-02-26 14:10:21 +00:00
Matt Westcott 4950158e46 Remove remaining references to request.site 2020-02-17 12:06:19 +00:00