mirrors/wagtail
mirrors/wagtail
0
0
Fork 0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
Code Issues Releases Wiki Activity
13,313 Commits 56 Branches 258 Tags 413 MiB
77a8f76c97
Commit Graph

620 Commits

Author SHA1 Message Date
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
jacobtoppm
b3e5278a1b Remove spreadsheet export setting, and allow a user to select format via a dropdown instead 2020-03-13 17:33:22 +00:00
jacobtoppm
fbead4549b Add documentation for spreadsheet format setting and new modeladmin features 2020-03-13 17:33:20 +00:00
Andy Chosak
17e09fee76
Fix quotes in ModelAdmin documentation 
Building the docs currently generates a warning:

wagtail/docs/reference/contrib/modeladmin/indexview.rst:423: WARNING: Could not lex literal_block as "python". Highlighting skipped.

This is due to use of backticks instead of single quotes on this page:

https://docs.wagtail.io/en/v2.8/reference/contrib/modeladmin/indexview.html#modeladmin-get-queryset

In practice this doesn't seem to actually break highlighting, but it's still good to fix.
 2020-03-04 13:21:53 -05:00
Matt Westcott
09a2ccf8cc Documentation for custom tag models 2020-02-26 14:10:21 +00:00
dt
a6fb0762a8 Mention options for schema in sitemap 
Add clear way to change schema in `sitemap.xml` to https on `sitemap`
documentation page
 2020-02-25 21:33:21 +00:00
Matt Westcott
4950158e46 Remove remaining references to request.site 2020-02-17 12:06:19 +00:00
Matt Westcott
f34891fbd3 Update docs to cover wagtail_site tag, find_for_request and deprecation of SiteMiddleware 2020-02-17 12:06:18 +00:00
Matt Westcott
5eec4d954e Deprecate SiteMiddleware (#3834, #5332, #5673) 
Squashed commit of the following:

commit 6ff78d0271ae9bb8be20edc77acc046b7ecd1190
Merge: cbb5575 b7872e3
Author: Matt Westcott <matt@west.co.tt>
Date:   Fri Jan 24 10:41:00 2020 +0000

    Merge branch 'master' into sitemiddleware-rebase-2

    Conflicts:
    	docs/reference/settings.rst
    	wagtail/api/v2/endpoints.py
    	wagtail/api/v2/filters.py
    	wagtail/api/v2/serializers.py

commit cbb5575fd8
Author: timothy@bttrcode <timothy@bttrcode.nl>
Date:   Sun Nov 3 02:30:00 2019 +0100

    Update branch, resolve conflicts, clean up

commit 6188742cfe
Merge: 4b4dee6 1c1341e
Author: timothy@bttrcode <timothy@bttrcode.nl>
Date:   Sun Nov 3 01:48:21 2019 +0100

    Resolve merge conflicts

commit 4b4dee6c47
Author: timothy@bttrcode <timothy@bttrcode.nl>
Date:   Sun Nov 3 01:42:37 2019 +0100

    Temporarily add Pipfile and yarn file

commit 540dff380b
Merge: 4a93424 0d2442f
Author: timothy@bttrcode <timothy@bttrcode.nl>
Date:   Fri Sep 27 20:22:00 2019 +0200

    Merge branch 'master' of https://github.com/aritas1/wagtail into aritasmaster

commit 0d2442fc1f
Author: Daniel <mail@aritas.de>
Date:   Wed Jun 26 03:01:44 2019 +0200

    clean tests and add ALLOWED_HOSTS globally

commit b7e6b8e655
Author: Daniel <mail@aritas.de>
Date:   Wed Jun 26 03:00:07 2019 +0200

    change context processor to be lazy

commit b16250fce9
Author: Daniel <mail@aritas.de>
Date:   Tue May 28 21:37:05 2019 +0200

    update SiteMiddleware documentation

commit 4be243f64d
Author: Daniel <mail@aritas.de>
Date:   Tue May 28 20:52:08 2019 +0200

    fix linting

commit 33151817a0
Author: Daniel <mail@aritas.de>
Date:   Tue May 28 19:11:47 2019 +0200

    add wagtail_site template tag

commit 38b304105a
Author: Daniel <mail@aritas.de>
Date:   Tue May 28 16:19:22 2019 +0200

    update tests for deprecated SiteMiddleware

commit f745aae9d0
Author: Daniel <mail@aritas.de>
Date:   Tue May 28 16:11:58 2019 +0200

    change Site finding mechanism to be independent of deprecated SiteMiddleware
 2020-02-17 12:06:18 +00:00
Samir Shah
dd4a04f843 Skip field validation when unpublishing pages. 2020-02-16 21:05:51 +00:00
Karl Hobley
2e23ef4ee4
Author specific locking docs changes (#5771) 
* Add to Dashboard docs

* Replace Dashboard image to show locked pages

* Add further explanatory text to Dashboard

* Improve image readability, add missing bracket

Co-authored-by: jacobtoppm <55137073+jacobtoppm@users.noreply.github.com>
 2020-01-28 09:07:01 +00:00
Matt Westcott
d2080ff892 Update docs to cover responsive HTML being disabled by default 2020-01-20 18:57:51 +00:00
Matt Westcott
3f27014a86 Merge branch 'author-specific-locking' of https://github.com/jacobtoppm/wagtail into kaedroho-author-specific-locking 2020-01-08 15:05:59 +00:00
Matt Westcott
ee8eda8353 Merge branch 'author-specific-locking' of https://github.com/kaedroho/wagtail into kaedroho-author-specific-locking 2020-01-08 15:02:19 +00:00
jacobtm
7421590dc7 Document reports submenu hooks 2020-01-02 09:47:52 +00:00
jacobtm
99cb3154cc Correct model reference for page, page cannot be edited when locked is True, rather than False 2020-01-02 09:41:42 +00:00
Dan Swain
749d0172e5 Documentation - include {{ block.super }} example in modelAdmin 2019-12-02 09:43:33 +10:00
Dan Swain
5a8c4edba5 Documentation - add StreamFieldPanel to available panel types 2019-12-01 19:13:11 +10:00
Karl Hobley
5f68627950 Merge branch 'master' into author-specific-locking 2019-11-26 15:55:49 +00:00
Karl Hobley
23145382e9 Move settings reference into separate doc 2019-11-20 17:39:46 +00:00
Tom Usher
644ee86e00 Add support for cloudflare API tokens (#5688) 2019-11-19 14:47:52 +00:00
Martey Dodoo
229103ff2e Update links in documentation. (#5689) 
Use HTTPS links instead of non-secure HTTP links wherever possible in
documentation.
 2019-11-08 09:15:01 +00:00
Matt Westcott
8577cc2d02 Remove old versionadded tags in the docs 2019-10-29 08:56:12 +00:00
Karl Hobley
ed32bc8444 fixup! Record time and user when a page is locked 2019-10-28 11:16:54 +00:00
Karl Hobley
67213d7286 Record time and user when a page is locked 2019-10-16 14:26:04 +01:00
Andreas Bernacca
3fd3d97850 Add model to PersonAdmin in documentation 2019-10-16 10:54:05 +01:00
Matt Westcott
34b3f0c0fc Recommend signals rather than hooks for model-level customisations 
As per #5620 - signals are often overlooked as a way of customising model-level behaviour. We should recommend them over admin hooks where possible, as they aren't reliant on users taking one particular path through the admin - for example, an 'add document' signal will be triggered regardless of whether a document is created through the single uploader, multiple uploader, chooser model or a scripted task, whereas a hook would not catch all of these cases.
 2019-10-15 13:52:32 +01:00
Matt Westcott
a0035c33c0 Add example of template rendering to TableBlock docs 
Addresses #5540
 2019-10-12 09:29:10 +10:00
Matt Westcott
3557c954c0 Clarify that menu item order attribute is ignored in construct_page_action_menu 2019-10-11 12:17:52 +01:00
Matt Westcott
6de06b6d04 Update construct_page_action_menu example 
Now avoids redefining the whole list, and reflects the fact that the first (rather than last) item is picked as the default.
 2019-10-11 12:11:09 +01:00
Rahmi Pruitt
fe2f8644fa Allow default item in action menu to be overridden with construct_page_action_menu hook 
Fixes #5438
 2019-10-11 12:11:08 +01:00
Matt Westcott
76d72a36c3 Documentation tweaks for WAGTAILDOCS_SERVE_METHOD 
As suggested by @chosak - https://github.com/wagtail/wagtail/pull/5296#discussion_r324252497 , https://github.com/wagtail/wagtail/pull/5296#discussion_r324257167
 2019-09-21 18:53:48 +01:00
Zac Connelly
a19571db7a update docs for TabbedInterface (#5374) 2019-08-29 11:23:13 +01:00
Matt Westcott
227221f7fb Update docs with new locations of wagtail.admin.utils definitions 2019-08-19 18:58:56 +02:00
rjpruitt16
f7ff6d39c4 Add caption field to TableBlock 
* Create caption field added to table block widget

Caption allows for users users with screen readers to be
able to understand the contents of a table.

* Fixed bugs in javascript and typos

* Updated documentation and change log

* Fixed table caption bug and requested pr edits

* Fixed table caption bug and request pr edits

* Removed changes in changelog.txt

* Fixed bug and requested PR edits
 2019-08-14 22:17:25 +02:00
Michael van Tellingen
9cd2fc2c82 Add a construct_page_listing_buttons hook 
This hook mimics the functiolity provided by `construct_page_action_menu`
in that it constructs the final list of buttons to be shown in the wagtail
admin interface.  This means that within this function button's can be
removed, added or re-ordered.

See #4925
 2019-07-21 17:40:26 +10:00
jordan_bauer
0dac8f0764 added construction_hook_name to settings_menu (#5384) 2019-06-25 12:04:53 +01:00
Karl Hobley
d008cc7e21 Implement Page.with_content_json and add to docs (fixes #5199) 2019-06-20 16:24:04 +01:00
kevinhowbrook
e8c64e593d Missing class imports 2019-06-11 11:53:19 +01:00
Andy Babic
13b485a2a9 Fix sphinx errors 2019-06-08 18:27:42 +01:00
Seb
b839bd65bb Add support for custom search handler classes to ModelAdmin's IndexView 
Author:    Seb <seb@takeflight.com.au>
Date:      Sun Apr 7 12:34:00 2019 +1000
 2019-06-08 17:57:24 +01:00
LB (Ben Johnston)
ddbbbe4417
Revise wording of static resources usage in modeladmin documentation 
Small wording revision
Merge pull request #5295 from DanielSwain/patch-35
 2019-05-23 07:25:12 +10:00
Kalob Taulien
9489cb0758 Added ButtonHelper example code 2019-05-23 07:18:50 +10:00
DanAtShenTech
ad7af7e191
Small wording revision 2019-05-13 14:09:18 -04:00
Adam
22e9e71ca7 Updated Page Chooser Panel ForeignKey 
Needs a related_name
 2019-05-10 14:41:09 +01:00
David Beitey
602cd50d18 Add Django models import to Site Settings docs 2019-05-03 17:11:27 +01:00
Samuel Mendes
352fa37dda Add documentation on supporting cell alignment 2019-05-03 13:51:51 +01:00
Samuel Mendes
ba78df06bc Upgrade handsontable to 6.2.2 and documentation 2019-05-03 13:36:51 +01:00
DanAtShenTech
751c666037 Grammar fixes 2019-04-12 16:24:20 +01:00
Nick Smith
21fc3d7679 Fix hooks documentation typo 2019-04-11 10:27:54 +01:00
DanAtShenTech
f4d3025022 Wording fixes to column/row header descriptions 
Also small grammar updates.
 2019-04-03 20:22:29 +01:00
LB Johnston
46c024ba06 add name attribute to all derived classes of ActionMenuItem 2019-03-29 11:48:15 +00:00
Wesley van Lee
c831d434ab Added an option to the page model to be able to define the amount of subpages underneath a specific parent page 2019-03-15 18:14:05 +01:00
Andy Babic
b2eee20e1b Move reversing_urls.rst into a subdirectory with it's own index, and include that index in the modeladmin docs' main toctree 2019-03-14 09:48:02 +01:00
LB Johnston
fc21729a24 add docs with instructions on how to generate urls for modeladmin 2019-03-13 07:41:34 +10:00
Thomas Kremmel
4e8f197a9d allow panels & edit_handler to be defined on ModelAdmin (#4900) 2019-03-06 12:26:20 +00:00
Matt Westcott
61e1e4c2f9 Add 'wagtail_update_index' as an alias for the 'update_index' command (#5009) 
Fixes #2447
 2019-03-01 11:01:41 +00:00
Matt Westcott
34d7efe4e3 Add note to clarify that construct_homepage_panels should modify the ist in place 2019-02-27 14:56:40 +00:00
Neil Lyons
f10c5cab58 Update docs for construct_homepage_panels hook (#5109) 
`construct_homepage_panels` hook doesn't need a return statement.

[Looking at the code](https://github.com/wagtail/wagtail/blob/master/wagtail/admin/views/home.py#L101-L102), the user doesn't need to return a list, they need to mutate the list passed in.
 2019-02-27 14:50:01 +00:00
Matt Collins
37a472834a Update legacy wagtail.wagtailadmin paths (#5090) 
Update legacy wagtail.wagtailadmin paths to wagtail.admin
 2019-02-19 10:49:15 +00:00
DanAtShenTech
56f29a0825 Clarify explanation of ParentalKey within InlinePanel (#5070) 
Make it clear that the relationship to relate a cluster of objects to a page is called ParentalKey.
 2019-02-13 16:32:22 +00:00
Vladimir Knobel
a0d6dbb5f4 Update primer.rst (#5068) 
path to overriding template doesn't match model name
 2019-02-13 15:16:44 +00:00
DanAtShenTech
dbb7ec77b3 Fix index_view_class in primer.rst 
Fix the "index_view_class=" reference.  Small grammar fixes.
 2019-02-08 17:32:57 +00:00
DanAtShenTech
f1e3e2e379 Update primer.rst (#5061) 
Small wording clarifications.
 2019-02-08 17:26:26 +00:00
DanAtShenTech
c9be245b0f Update primer.rst (#5062) 
Small grammar fixes
 2019-02-08 17:02:30 +00:00
ed@sharpertool.com
f39f018ebf Update hooks.rst (#5044) 
Document and Image fields changed from `uploaded_by` to `uploaded_by_user`
 2019-01-31 12:22:25 +00:00
Matthew Linares
a0b4efd414 Recipe: automatic redirect creation on url edit (#5002) 2019-01-24 14:06:44 +00:00
Matt Westcott
d731ea6c9f Add missing null=True and imports to modeladmin example code 2019-01-10 10:59:05 +00:00
Alex Gleason
e5f9c122ab Use better examples in ModelAdmin docs, add info about FieldPanels 2018-11-30 13:11:53 +00:00
Matt Westcott
b81e5c6b85 avoid referring to an internal function name in hook docs 2018-11-30 11:29:21 +00:00
Maylon Pedroso
f34bda64ea Add hooks for page move actions 2018-11-30 10:50:42 +00:00
Matt Westcott
cb8148ede2 Support media definitions on action menu items 2018-11-22 11:17:25 +00:00
Matt Westcott
b48566e735 Move action menu components to a new wagtail.admin.action_menu module 2018-11-22 11:16:59 +00:00
Matt Westcott
2a477c8e79 Add construct_page_action_menu hook 2018-11-22 11:14:01 +00:00
Matt Westcott
6adf7c8423 Add register_page_action_menu_item hook 2018-11-22 11:14:01 +00:00
Sergey Fedoseev
47465197a9 Use intersphinx for Django references when possible. (#4896) 2018-11-14 11:48:32 +00:00
Sergey Fedoseev
8f8faf3c60 Fixed some formatting in 'Customising IndexView' doc. (#4877) 
* Fixed some formatting in 'Customising IndexView' doc.

* Make coverage omit docs/conf.py.
 2018-10-30 12:29:11 +00:00
Sergey Fedoseev
29c8ad6637 Fix reference in ModelAdmin.ordering docs. 2018-10-30 12:23:17 +00:00
Matt Westcott
aaa0953d05
Document the Dockerfile in the project template (#4853) 2018-10-27 15:18:25 +02:00
Dan Braghis
3b1dc5be86 Add Page max_count 2018-10-27 15:13:16 +03:00
Matt Westcott
4965d85e72 Update hook examples to use django.templatetags.static 
django.contrib.staticfiles.templatetags.staticfiles is deprecated as of Django 2.0
 2018-10-18 08:49:15 +01:00
Jorge Barata
8161d7c14c Fix get_permission_helper_class documentation typo 2018-10-16 11:29:05 +01:00
Matt Westcott
b2b42faf14
Fix note about update_index not being required for the db backend 2018-09-21 10:59:52 +01:00
Matt Westcott
6454e500ab
Fix module path (wagtailforms.models should be wagtail.contrib.forms.models) 2018-09-21 10:53:51 +01:00
Michael van Tellingen
bad95cf37c Optimize the querycount for the sitemap.xml page 
By optionally passing the request object to Page.get_sitemap_urls() it
will now use the cached site root on the request object instead of
retrieving it for each call. This cuts the number of queries required
for a sitemap roughly in half.
 2018-07-10 16:53:19 +01:00
Matt Westcott
8d786c3534 Reference the get_url method in Page model reference docs 
Fixes #4424. As of #3354, `get_url` is the preferred way of obtaining a page URL, rather than the `.url` property;
.url is just a wrapper around get_url (which meant that the docstring for `get_url` was erroneously being picked up).
 2018-05-18 15:26:06 +01:00
DanAtShenTech
53881ebd0b Small wording, spelling, grammar edits (#4543) 2018-05-18 14:59:06 +01:00
DanAtShenTech
f58e85fa0f Fix wording 2018-05-18 14:55:29 +01:00
Victor Miti
c38b172793 updated Django Docs Links to point to *docs.djangoproject.com/en/stable/* 2018-05-18 14:43:42 +01:00
Matt Westcott
31a1126123 Remove construct_whitelister_element_rules hook 2018-05-18 11:43:28 +01:00
Matt Westcott
3fc9ed5119 Remove old versionadded/versionchanged notes 2018-05-18 11:43:28 +01:00
Matt Westcott
a9a69bedf5 Move HelpPanel documentation to avoid redefinition of wagtail.admin.edit_handlers module 2018-05-15 14:57:07 +01:00
Matt Westcott
5ce14841d8 Remove ancient versionchanged notes 2018-05-15 14:54:41 +01:00
Andy Babic
d0670da61b Fix minor typo in modeladmin docs (#4509) 
add_to_setings_menu -> add_to_settings_menu
 2018-05-02 18:11:01 +03:00
pyMan
b3fa09b95e Improved 'purge_page_from_cache' to purge the url for any managed language 2018-04-18 11:28:23 +01:00
DanAtShenTech
8c686b6a6b Typo 2018-04-11 13:22:45 +01:00
DanAtShenTech
950e77d2aa Wording change requested by Matthew Westcott 2018-04-11 13:22:45 +01:00
DanAtShenTech
2f43c10e6c Wording change to have this feature appear in search results 
Searching the docs for the phrases "add django model to wagtail admin" and "add model to wagtail admin" (without the quotes) did not even yield this crucial page as one of the results.  The proposed wording puts the main idea of being able to show/edit ANY model via the Wagtail admin at the top of the document and includes wording to, hopefully, have this page appear at the top for anyone searching for how to implement this functionality.
 2018-04-11 13:22:44 +01:00
Matt Westcott
af7cdb4354 another typo fix 2018-04-06 16:19:49 +01:00
DanAtShenTech
a179d0c331 Fix typos 
Conflicts:
	docs/reference/contrib/modeladmin/primer.rst
 2018-04-06 16:19:32 +01:00
Karl Hobley
f608c67eb1 Fix capitalisation of names 2018-04-05 12:13:05 +01:00
Karl Hobley
bf3e994505 Fix capitalisation of QuerySet 2018-04-05 12:13:05 +01:00
Karl Hobley
a70b8130a5 Add quotes around code 2018-04-05 12:13:05 +01:00
Karl Hobley
a9b4b09152 Fix spelling mistakes in documentation 2018-04-05 12:13:05 +01:00
Bertrand Bordage
0fcd6d8cc1 Improves #4421 documentation example. 2018-03-29 21:01:23 +02:00
Michael van Tellingen
c5d21a76d9 Add a new hook 'register_account_menu_item' (#4421) 
* Add a new hook 'register_account_menu_item'

This new hook makes it easier for third party apps to add new buttons on
the 'my account' page in the Wagtail admin. Existing buttons are
converted to the new hooks to make the code consistent.

* Add documentation for the new register_account_menu_item hook
 2018-03-29 20:48:23 +02:00
Dave Bell
b2ef833915 allow chunk_size to be set in update_index 2018-03-29 17:49:43 +02:00
Kevin Chung
d188576af8 Adds a new HelpPanel (#4374) 2018-03-15 16:46:34 +01:00
Matt Westcott
cde31260d8 add documentation for custom send_mail method 2018-02-26 19:06:18 +00:00