Commit graph

369 commits

Author SHA1 Message Date
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
Loic Teixeira
f6bcfbf31e Update paths in documentation 2018-02-23 11:53:31 +00:00
LB (Ben Johnston)
39d5672c9c Fix modeladmin documentation typo (#4251)
Fix incorrect reference to a method name from the previous example.
2018-02-08 10:53:36 +00:00
Mads Jensen
b30c722728 Used Python 3 super() syntax also in documentation. (#4246)
This disregards the release notes for earlier releases and only deals
with current documentation.
2018-02-07 10:11:27 +00:00
LB (Ben Johnston)
c85e4a3ff0 add note for setting menu default globally (#4244) 2018-02-06 14:10:45 +00:00
Patrick Woods
c9704caf17 Documentation edits 2018-01-15 22:58:00 +00:00
Patrick Woods
3f0972507b Initial scheduled publishing documentation. 2018-01-15 22:58:00 +00:00
LB
3eac584c7c Make FormBuilder more easy to extend 2018-01-10 19:04:42 +10:00
Johan Arensman
815cb6e405 Use class based views instead of function views
Changes `index`, `delete_submissions` and `list_submissions`.
Adjusted view tests to properly test the new class based structure.
remove get_field_ordering from FormPage model - now on view
2018-01-08 16:27:09 +10:00
Matt Westcott
b9a548f424 Update documentation for rich text element whitelisting 2018-01-05 16:15:59 +00:00
kevin howbrook
0b44392c3d Add missing import to tagging docs (#4158) 2017-12-29 17:54:38 +01:00
LB
70eb2b6ae3 add on_delete argument to ParentalKey & ForeignKey 2017-12-15 10:33:09 +00:00
LB (Ben Johnston)
e20fbcc3cd Update register_page_listing_more_buttons example
Use Button instead of PageListingButton in **register_page_listing_more_buttons** section.
2017-12-14 12:37:16 +00:00
Philipp Bosch
a9f51a09c4 [Docs] Fix imports in "Buttons with dropdown lists" hooks example 2017-12-05 00:12:06 +00:00
Matt Westcott
9610c2d3af Make InlinePanel heading independent of label. Original commit by @Adrian-Turjak 2017-11-30 12:08:19 +00:00
LB
bc0923b356 Add note that form_submission is passed to landing page context 2017-11-28 22:01:37 +08:00
LB
afee487d52 Documentation example for render_landing_page 2017-11-28 22:01:18 +08:00
Mads Jensen
ffd93a0d28 Don't inherit from object 2017-11-27 10:06:03 +00:00
Karl Hobley
58ea7f824a Renamed wagtail.contrib.wagtailsitemaps to wagtail.contrib.sitemaps 2017-11-26 22:43:47 +00:00
Karl Hobley
fd8f642fb6 Renamed wagtail.contrib.wagtailsearchpromotions to
wagtail.contrib.search_promotions

Conflicts:
	wagtail/contrib/search_promotions/forms.py
	wagtail/contrib/search_promotions/templatetags/wagtailsearchpromotions_tags.py
	wagtail/contrib/search_promotions/wagtail_hooks.py
2017-11-26 22:43:47 +00:00
Karl Hobley
394274b0a1 Renamed wagtail.contrib.wagtailroutablepage to
wagtail.contrib.routable_page

Conflicts:
	docs/reference/contrib/routablepage.rst
2017-11-26 22:43:47 +00:00
Karl Hobley
7f1b60abca Renamed wagtail.contrib.wagtailfrontendcache to
wagtail.contrib.frontend_cache

Conflicts:
	docs/reference/contrib/frontendcache.rst
	wagtail/api/v2/signal_handlers.py
	wagtail/contrib/frontend_cache/signal_handlers.py
2017-11-26 22:43:47 +00:00
Karl Hobley
f29ce6c1f9 Renamed wagtail.wagtailforms to wagtail.contrib.forms
Conflicts:
	docs/reference/contrib/forms/customisation.rst
	docs/reference/contrib/forms/index.rst
	wagtail/contrib/forms/tests/test_forms.py
	wagtail/contrib/forms/tests/test_models.py
	wagtail/contrib/forms/tests/test_views.py
	wagtail/contrib/forms/views.py
	wagtail/contrib/forms/wagtail_hooks.py
	wagtail/tests/settings.py
	wagtail/tests/testapp/models.py
2017-11-26 22:43:47 +00:00
Karl Hobley
1ecf48fb3f Rename wagtail.wagtailsnippets to wagtail.snippets
Conflicts:
	docs/advanced_topics/settings.rst
	docs/getting_started/integrating_into_django.rst
	docs/topics/pages.rst
	docs/topics/snippets.rst
	gulpfile.js/config.js
	wagtail/contrib/wagtailstyleguide/views.py
	wagtail/project_template/project_name/settings/base.py
	wagtail/snippets/tests.py
	wagtail/snippets/views/chooser.py
	wagtail/snippets/views/snippets.py
	wagtail/snippets/wagtail_hooks.py
	wagtail/tests/settings.py
	wagtail/tests/snippets/models.py
	wagtail/tests/testapp/models.py
2017-11-26 22:43:47 +00:00
Karl Hobley
19730bea53 Renamed wagtail.wagtailsearch to wagtail.search
Conflicts:
	docs/advanced_topics/settings.rst
	docs/getting_started/integrating_into_django.rst
	docs/getting_started/tutorial.rst
	docs/topics/pages.rst
	docs/topics/search/searching.rst
	tox.ini
	wagtail/admin/tests/test_pages_views.py
	wagtail/admin/views/mixins.py
	wagtail/api/v2/filters.py
	wagtail/contrib/wagtailsearchpromotions/forms.py
	wagtail/contrib/wagtailsearchpromotions/views.py
	wagtail/documents/models.py
	wagtail/documents/views/chooser.py
	wagtail/documents/views/documents.py
	wagtail/documents/views/multiple.py
	wagtail/images/migrations/0001_initial.py
	wagtail/images/models.py
	wagtail/images/views/chooser.py
	wagtail/images/views/images.py
	wagtail/images/views/multiple.py
	wagtail/project_template/project_name/settings/base.py
	wagtail/project_template/search/views.py
	wagtail/search/tests/test_frontend.py
	wagtail/search/tests/test_index_functions.py
	wagtail/search/views/frontend.py
	wagtail/search/views/queries.py
	wagtail/search/wagtail_hooks.py
	wagtail/tests/demosite/models.py
	wagtail/tests/modeladmintest/models.py
	wagtail/tests/non_root_urls.py
	wagtail/tests/settings.py
	wagtail/tests/snippets/models.py
	wagtail/tests/testapp/migrations/0001_initial.py
	wagtail/tests/testapp/migrations/0020_customdocument.py
	wagtail/tests/testapp/models.py
	wagtail/tests/urls.py
	wagtail/wagtailsnippets/views/chooser.py
	wagtail/wagtailsnippets/views/snippets.py
2017-11-26 22:43:47 +00:00
Karl Hobley
bf0f3e02ba Rename wagtail.wagtailimages to wagtail.images
Conflicts:
	docs/advanced_topics/api/v2/configuration.rst
	docs/advanced_topics/jinja2.rst
	docs/advanced_topics/settings.rst
	docs/getting_started/integrating_into_django.rst
	docs/getting_started/tutorial.rst
	docs/topics/pages.rst
	docs/topics/streamfield.rst
	gulpfile.js/config.js
	tox.ini
	wagtail/admin/tests/test_compare.py
	wagtail/admin/tests/test_edit_handlers.py
	wagtail/api/v2/signal_handlers.py
	wagtail/contrib/wagtailstyleguide/views.py
	wagtail/core/tests/test_streamfield.py
	wagtail/documents/tests/test_models.py
	wagtail/images/models.py
	wagtail/images/permissions.py
	wagtail/images/tests/test_admin_views.py
	wagtail/images/tests/test_image_operations.py
	wagtail/images/tests/test_models.py
	wagtail/images/tests/test_signal_handlers.py
	wagtail/images/views/chooser.py
	wagtail/images/views/images.py
	wagtail/images/views/multiple.py
	wagtail/images/wagtail_hooks.py
	wagtail/images/widgets.py
	wagtail/project_template/project_name/settings/base.py
	wagtail/tests/demosite/models.py
	wagtail/tests/non_root_urls.py
	wagtail/tests/settings.py
	wagtail/tests/testapp/migrations/0001_initial.py
	wagtail/tests/testapp/migrations/0008_inlinestreampage_inlinestreampagesection.py
	wagtail/tests/testapp/migrations/0009_defaultstreampage.py
	wagtail/tests/urls.py
2017-11-26 22:43:47 +00:00
Karl Hobley
78b1372cd4 Rename wagtail.wagtaildocs to wagtail.documents
Conflicts:
	docs/advanced_topics/i18n/index.rst
	docs/advanced_topics/settings.rst
	docs/getting_started/integrating_into_django.rst
	gulpfile.js/config.js
	wagtail/admin/tests/test_collections_views.py
	wagtail/api/v2/signal_handlers.py
	wagtail/contrib/wagtailstyleguide/views.py
	wagtail/core/tests/test_collection_permission_policies.py
	wagtail/documents/permissions.py
	wagtail/documents/tests/test_admin_views.py
	wagtail/documents/tests/test_collection_privacy.py
	wagtail/documents/tests/test_models.py
	wagtail/documents/views/chooser.py
	wagtail/documents/views/documents.py
	wagtail/documents/views/serve.py
	wagtail/documents/wagtail_hooks.py
	wagtail/documents/widgets.py
	wagtail/project_template/project_name/urls.py
	wagtail/tests/demosite/models.py
	wagtail/tests/non_root_urls.py
	wagtail/tests/settings.py
	wagtail/tests/testapp/models.py
	wagtail/tests/urls.py
2017-11-26 22:43:47 +00:00
Karl Hobley
062d05189b Rename wagtail.wagtailadmin to wagtail.admin
Conflicts:
	docs/advanced_topics/customisation/admin_templates.rst
	docs/advanced_topics/customisation/page_editing_interface.rst
	docs/advanced_topics/i18n/duplicate_tree.rst
	docs/advanced_topics/jinja2.rst
	docs/advanced_topics/settings.rst
	docs/getting_started/integrating_into_django.rst
	docs/getting_started/tutorial.rst
	docs/reference/hooks.rst
	docs/reference/pages/panels.rst
	docs/topics/pages.rst
	docs/topics/streamfield.rst
	wagtail/admin/blocks.py
	wagtail/admin/checks.py
	wagtail/admin/edit_handlers.py
	wagtail/admin/forms.py
	wagtail/admin/rich_text.py
	wagtail/admin/search.py
	wagtail/admin/site_summary.py
	wagtail/admin/templatetags/wagtailadmin_tags.py
	wagtail/admin/tests/test_admin_search.py
	wagtail/admin/tests/test_buttons_hooks.py
	wagtail/admin/tests/test_compare.py
	wagtail/admin/tests/test_edit_handlers.py
	wagtail/admin/tests/test_page_chooser.py
	wagtail/admin/tests/test_pages_views.py
	wagtail/admin/tests/test_rich_text.py
	wagtail/admin/tests/test_widgets.py
	wagtail/admin/tests/tests.py
	wagtail/admin/urls/__init__.py
	wagtail/admin/views/account.py
	wagtail/admin/views/chooser.py
	wagtail/admin/views/collection_privacy.py
	wagtail/admin/views/collections.py
	wagtail/admin/views/home.py
	wagtail/admin/views/page_privacy.py
	wagtail/admin/viewsets/model.py
	wagtail/admin/wagtail_hooks.py
	wagtail/admin/widgets.py
	wagtail/contrib/settings/registry.py
	wagtail/contrib/wagtailsearchpromotions/wagtail_hooks.py
	wagtail/contrib/wagtailstyleguide/wagtail_hooks.py
	wagtail/project_template/project_name/settings/base.py
	wagtail/project_template/project_name/urls.py
	wagtail/tests/non_root_urls.py
	wagtail/tests/settings.py
	wagtail/tests/snippets/models.py
	wagtail/tests/testapp/models.py
	wagtail/tests/testapp/wagtail_hooks.py
	wagtail/tests/urls.py
	wagtail/wagtaildocs/models.py
	wagtail/wagtaildocs/views/chooser.py
	wagtail/wagtaildocs/wagtail_hooks.py
	wagtail/wagtailembeds/wagtail_hooks.py
	wagtail/wagtailforms/models.py
	wagtail/wagtailforms/tests/test_views.py
	wagtail/wagtailforms/views.py
	wagtail/wagtailforms/wagtail_hooks.py
	wagtail/wagtailimages/models.py
	wagtail/wagtailimages/views/chooser.py
	wagtail/wagtailimages/wagtail_hooks.py
	wagtail/wagtailredirects/forms.py
	wagtail/wagtailredirects/wagtail_hooks.py
	wagtail/wagtailsites/forms.py
	wagtail/wagtailsites/views.py
	wagtail/wagtailsites/wagtail_hooks.py
	wagtail/wagtailsnippets/tests.py
	wagtail/wagtailsnippets/wagtail_hooks.py
	wagtail/wagtailusers/forms.py
	wagtail/wagtailusers/views/groups.py
	wagtail/wagtailusers/wagtail_hooks.py
2017-11-26 22:43:47 +00:00
Karl Hobley
4300e19da2 Rename wagtail.wagtailcore to wagtail.core 2017-11-26 22:43:47 +00:00
LB
48b6a1b067 add note about django-treebeard api 2017-11-12 18:13:23 +00:00
LB
cd924d0948 add docs for exclude_fields_in_copy 2017-11-10 11:02:55 +00:00
Matt Westcott
aebb69a2ba Remove dead links to API v1 docs 2017-11-03 17:03:57 +00:00
Jonathan Carmack
7859627a6e Added hooks for user for create, delete, and edit actions 2017-11-03 16:53:32 +00:00
Karl Hobley
bf7936ade2 Replace django.core.urlresolvers with django.urls 2017-11-01 16:22:46 +00:00
Karl Hobley
b350672585 Merge pull request #3934 from gasman/cleanup/remove-python2
Remove Python 2 fallback code
2017-10-26 14:41:43 +01:00
Karl Hobley
fa302c0853 Remove wagtail.contrib.wagtailapi 2017-10-25 16:49:17 +01:00
Karl Hobley
bd38525e5b Merge branch 'master' into cleanup/remove-python2 2017-10-25 16:21:27 +01:00
Matt Westcott
60c26e5565 Remove note about Django 1.10 being required for postgres search backend 2017-10-25 16:15:02 +01:00
Matt Westcott
5f382d8784 Remove Python 2 references from docs 2017-10-13 12:24:42 +01:00
Matt Westcott
119d2334ac Replace insert_editor_js hook example with a non-registerHalloPlugin one
Fixes #3839
2017-10-10 11:51:45 +01:00
Matt Westcott
de3f9550b4 Release note for #3824 2017-10-05 15:40:55 +01:00
Karl Hobley
48cfb8e790 Tweaks to the docs 2017-10-05 15:15:21 +01:00
Karl Hobley
0cb63c72c5 Implemented suggestions from @chosak 2017-10-05 15:15:20 +01:00
Karl Hobley
8dc425660b Docs for batch cache invalidation 2017-10-05 15:15:20 +01:00
Matt Westcott
b0aedf02dc Remove old versionadded annotations from the docs 2017-08-22 14:08:44 +01:00
Joe Cronyn
d56f1069ef Updating to allow no limit max 2017-08-22 12:09:05 +01:00
Matt Westcott
b376da022f Grammar nitpick ('By default' sounds more natural than 'Per default') 2017-08-11 09:58:44 +01:00
Andreas Nüßlein
39bca11283 added default index_route for RoutablePageMixin
RoutablePageMixin has a default index_route method that is decorated
with `@route(r'^$')`. This way, including RoutablePageMixin doesn't
force you to re-enable the default functionality you would expect from a
Page anyways.
index_route behaves exactly like a standard Wagtail Page.
To override the default behaviour, one can simply override the route by
decorating another function with r'^$'.

(as disussed in issue #2866)
2017-08-11 09:58:44 +01:00
Matt Westcott
70aa876e55 Extra documentation / release note re the relationship between draft_title and get_admin_display_title 2017-08-03 12:05:52 +01:00
Eugene Morozov
7b55c5094f Backslash is not necessary when multi-line expression is parenthesized. 2017-07-18 09:56:42 +03:00
Matt Westcott
049b15f3fe Define a 'before_serve_document' hook 2017-06-16 14:50:47 +01:00
LB
18cb0245fc allow default for show_in_menus 2017-06-09 12:50:39 +01:00