a18a36d820
Fix indentation of locked_by block in documentation ( #6580 )
2020-12-02 10:40:25 +00:00
6e1e36256a
Remove elasticsearch 2 support
2020-11-05 12:04:12 +00:00
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
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
e28aa6b194
Document ModlelAdmin.prepopulated_fields
2020-10-19 21:36:05 +01:00
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
9fab50e87a
remove trailing whitespace
2020-10-19 18:11:12 +01:00
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
7f7f9b4de1
Make snippets action menu hookable
2020-10-14 14:41:22 +01:00
c170c50c78
Add view for converting aliases into regular pages
2020-10-08 10:24:58 +01:00
b5eddca28b
Synchronise alias page content when the source is updated
2020-10-08 10:24:58 +01:00
674fa8e27a
Add Page.create_alias method
2020-10-08 10:24:58 +01:00
17f63f0efc
Add alias_of field to Page
2020-10-08 10:24:58 +01:00
dd442a3990
remove trailing whitespace to placate doc8
2020-10-05 12:44:57 +01:00
f1fbbcbc24
Add validation for file extension in AbstractDocument using WAGTAIL_DOCS_EXTENSIONS setting ( #6423 )
2020-10-05 12:26:00 +01:00
cf38b2457d
Put quotes around some inline code
2020-10-03 14:43:03 +01:00
39d931d77d
Javascript => JavaScript
2020-10-03 14:43:03 +01:00
6e5f89adf2
General spelling fixes
2020-10-03 14:43:03 +01:00
9195131738
Lint docs with doc8
2020-10-03 14:43:03 +01:00
48a8af71e5
Add documentation for placeholder text in Field Panels
2020-10-01 08:06:43 +02:00
008b6c12c4
Update BaseLogEntry docs to reference user_display_name. Fixes #6418
2020-09-30 15:43:27 +01:00
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
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
8fd5d66756
Add RoutablePage.render() helper method and update documentation
2020-09-01 22:24:08 +01:00
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
8542f5fe9c
Fix underline lengths to prevent Sphinx warnings
2020-08-07 17:23:42 +01:00
e85f16b500
Add a use case example for WAGTAIL_WORKFLOW_CANCEL_ON_PUBLISH=False
2020-08-07 17:10:24 +01:00
9ad14ea439
Add hooks for snippet listing buttons
2020-08-07 15:47:27 +01:00
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
4bf28b502c
Fix docs for `construct_page_listing_buttons`
2020-07-31 11:14:48 +01:00
f3f932d2e5
Add before_{create,edit,delete}_snippet hooks
2020-07-30 08:08:40 +01:00
e0dc53d9ad
Remove versionadded/versionchanged notes for 2.9
2020-07-28 12:53:22 +01:00
4231d9ef11
Fix minor typo in TableBlock docs ( #6259 )
...
Also a small grammatical fix.
2020-07-28 07:14:05 -04:00
c79668929e
Update reference documentation, custom task guide, and release notes, and fix documentation build errors
2020-07-24 16:59:33 +01:00
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
bf53123309
Fix sphinx warnings from workflow / audit log documentation
2020-07-24 16:59:33 +01:00
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
c8a8689cee
Document icon_name and classname for register_page_action_menu_item
2020-07-24 16:59:33 +01:00
f69287f6f4
Add documentation
2020-07-24 16:59:33 +01:00
df3a63c7a2
Add new page methods and updated workflow state methods
2020-07-24 16:59:33 +01:00
2037e8c089
Update images in documentation
2020-07-24 16:59:33 +01:00
8911bd30d7
Add workflow models to reference
2020-07-24 16:59:33 +01:00
bf168df9f9
Document workflow signals
2020-07-24 16:59:33 +01:00
c75a2a3549
Add workflow settings
2020-07-24 16:59:33 +01:00
e8d02091ee
Add warning about WAGTAILFORMS_HELP_TEXT_ALLOW_HTML
2020-07-20 10:36:41 +01:00
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
78c9ef31d7
Typo fixes
2020-07-15 17:18:46 +01:00
c8f493c095
Add documentation for WAGTAIL_REDIRECTS_FILE_STORAGE setting ( #6114 )
2020-07-15 16:35:04 +01:00
9917d7d2e9
Additional documentation for next_url
2020-07-15 11:53:39 +10:00
d75ab584c7
Fixing typos
2020-07-14 10:56:28 +01:00
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
5611f5ef6c
Clarify origin of From address used in password reset emails ( #6219 )
2020-07-13 18:15:21 +01:00
8c306910dd
Fix incorrect urls in the docs
2020-07-06 13:15:40 +01:00
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
e9e6a8d5e7
Add more detail to RoutablePageMixin example ( #6128 )
2020-06-25 16:57:58 +01:00
a4e05f4538
I would like only add my own editor without to redefine a default one. ( #6118 )
2020-06-25 16:53:06 +01:00
9baf6ce62a
Update hooks.rst ( #6160 / #6161 )
...
This proposed update is in regard to Issue #6160
2020-06-25 14:54:16 +01:00
20b99d4386
Remove 'whitelist' from page reference docs ( #6153 )
2020-06-16 11:23:51 +01:00
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
ead6c8b2a6
Add WAGTAIL_TIME_FORMAT to settings reference
2020-05-27 13:55:52 +01:00
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
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
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
b5f5ac10db
Add export_filename option to modeladmin
...
Merge pull request #6031 from wagtail/reports-filename
2020-05-15 10:04:57 -06:00
cc676c4c9e
Add export_filename option to modeladmin
2020-05-14 15:50:47 +01:00
f757324039
Add Snippet hooks (after_edit_snippet, after_create_snippet and after_delete_snippet)
2020-05-14 20:47:36 +10:00
55476426db
Fix typo in ModelAdminGroup example
2020-05-14 20:37:34 +10:00
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
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
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
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
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
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
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
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
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
ceb4270e01
Remove versionadded/versionchanged notes for 2.8
2020-04-22 13:54:09 +01:00
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
18118f54b6
Update docs
2020-04-03 21:28:13 +01:00
bb2e460c0b
Replace deprecated ugettext, ungettext with gettext and ngettext. ( #5907 )
2020-04-02 17:15:26 +01:00
3f86de27e0
Document AdminOnlyMenuItem in hooks documentation
2020-03-19 17:57:52 +00:00
12d5edcef6
Add heading option to panels reference
2020-03-19 16:10:30 +00:00
b3e5278a1b
Remove spreadsheet export setting, and allow a user to select format via a dropdown instead
2020-03-13 17:33:22 +00:00
fbead4549b
Add documentation for spreadsheet format setting and new modeladmin features
2020-03-13 17:33:20 +00:00
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
09a2ccf8cc
Documentation for custom tag models
2020-02-26 14:10:21 +00:00
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
4950158e46
Remove remaining references to request.site
2020-02-17 12:06:19 +00:00
f34891fbd3
Update docs to cover wagtail_site tag, find_for_request and deprecation of SiteMiddleware
2020-02-17 12:06:18 +00:00
5eec4d954e
Deprecate SiteMiddleware ( #3834 , #5332 , #5673 )
...
Squashed commit of the following:
commit 6ff78d0271ae9bb8be20edc77acc046b7ecd1190
Merge: cbb5575b7872e3cbb5575fd86188742cfe4b4dee61c1341e4b4dee6c47540dff380b4a934240d2442fhttps://github.com/aritas1/wagtail into aritasmaster
commit 0d2442fc1fb7e6b8e655b16250fce94be243f64d33151817a038b304105af745aae9d0
2020-02-17 12:06:18 +00:00
dd4a04f843
Skip field validation when unpublishing pages.
2020-02-16 21:05:51 +00:00
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
d2080ff892
Update docs to cover responsive HTML being disabled by default
2020-01-20 18:57:51 +00:00
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
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
7421590dc7
Document reports submenu hooks
2020-01-02 09:47:52 +00:00
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
749d0172e5
Documentation - include {{ block.super }} example in modelAdmin
2019-12-02 09:43:33 +10:00
5a8c4edba5
Documentation - add StreamFieldPanel to available panel types
2019-12-01 19:13:11 +10:00
5f68627950
Merge branch 'master' into author-specific-locking
2019-11-26 15:55:49 +00:00
23145382e9
Move settings reference into separate doc
2019-11-20 17:39:46 +00:00
644ee86e00
Add support for cloudflare API tokens ( #5688 )
2019-11-19 14:47:52 +00:00
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
8577cc2d02
Remove old versionadded tags in the docs
2019-10-29 08:56:12 +00:00
ed32bc8444
fixup! Record time and user when a page is locked
2019-10-28 11:16:54 +00:00
67213d7286
Record time and user when a page is locked
2019-10-16 14:26:04 +01:00
3fd3d97850
Add model to PersonAdmin in documentation
2019-10-16 10:54:05 +01:00
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
a0035c33c0
Add example of template rendering to TableBlock docs
...
Addresses #5540
2019-10-12 09:29:10 +10:00
3557c954c0
Clarify that menu item order attribute is ignored in construct_page_action_menu
2019-10-11 12:17:52 +01:00
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
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
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
a19571db7a
update docs for TabbedInterface ( #5374 )
2019-08-29 11:23:13 +01:00
227221f7fb
Update docs with new locations of wagtail.admin.utils definitions
2019-08-19 18:58:56 +02:00
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
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
0dac8f0764
added construction_hook_name to settings_menu ( #5384 )
2019-06-25 12:04:53 +01:00
d008cc7e21
Implement Page.with_content_json and add to docs ( fixes #5199 )
2019-06-20 16:24:04 +01:00
e8c64e593d
Missing class imports
2019-06-11 11:53:19 +01:00
13b485a2a9
Fix sphinx errors
2019-06-08 18:27:42 +01:00
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
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
9489cb0758
Added ButtonHelper example code
2019-05-23 07:18:50 +10:00
ad7af7e191
Small wording revision
2019-05-13 14:09:18 -04:00
22e9e71ca7
Updated Page Chooser Panel ForeignKey
...
Needs a related_name
2019-05-10 14:41:09 +01:00
602cd50d18
Add Django models import to Site Settings docs
2019-05-03 17:11:27 +01:00
352fa37dda
Add documentation on supporting cell alignment
2019-05-03 13:51:51 +01:00
ba78df06bc
Upgrade handsontable to 6.2.2 and documentation
2019-05-03 13:36:51 +01:00
751c666037
Grammar fixes
2019-04-12 16:24:20 +01:00
21fc3d7679
Fix hooks documentation typo
2019-04-11 10:27:54 +01:00
f4d3025022
Wording fixes to column/row header descriptions
...
Also small grammar updates.
2019-04-03 20:22:29 +01:00
46c024ba06
add name attribute to all derived classes of ActionMenuItem
2019-03-29 11:48:15 +00:00
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
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
fc21729a24
add docs with instructions on how to generate urls for modeladmin
2019-03-13 07:41:34 +10:00
4e8f197a9d
allow panels & edit_handler to be defined on ModelAdmin ( #4900 )
2019-03-06 12:26:20 +00:00
61e1e4c2f9
Add 'wagtail_update_index' as an alias for the 'update_index' command ( #5009 )
...
Fixes #2447
2019-03-01 11:01:41 +00:00
34d7efe4e3
Add note to clarify that construct_homepage_panels should modify the ist in place
2019-02-27 14:56:40 +00:00
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
37a472834a
Update legacy wagtail.wagtailadmin paths ( #5090 )
...
Update legacy wagtail.wagtailadmin paths to wagtail.admin
2019-02-19 10:49:15 +00:00
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
a0d6dbb5f4
Update primer.rst ( #5068 )
...
path to overriding template doesn't match model name
2019-02-13 15:16:44 +00:00
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
f1e3e2e379
Update primer.rst ( #5061 )
...
Small wording clarifications.
2019-02-08 17:26:26 +00:00
c9be245b0f
Update primer.rst ( #5062 )
...
Small grammar fixes
2019-02-08 17:02:30 +00:00
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
a0b4efd414
Recipe: automatic redirect creation on url edit ( #5002 )
2019-01-24 14:06:44 +00:00
d731ea6c9f
Add missing null=True and imports to modeladmin example code
2019-01-10 10:59:05 +00:00
e5f9c122ab
Use better examples in ModelAdmin docs, add info about FieldPanels
2018-11-30 13:11:53 +00:00
b81e5c6b85
avoid referring to an internal function name in hook docs
2018-11-30 11:29:21 +00:00
f34bda64ea
Add hooks for page move actions
2018-11-30 10:50:42 +00:00
cb8148ede2
Support media definitions on action menu items
2018-11-22 11:17:25 +00:00
b48566e735
Move action menu components to a new wagtail.admin.action_menu module
2018-11-22 11:16:59 +00:00
2a477c8e79
Add construct_page_action_menu hook
2018-11-22 11:14:01 +00:00
6adf7c8423
Add register_page_action_menu_item hook
2018-11-22 11:14:01 +00:00
47465197a9
Use intersphinx for Django references when possible. ( #4896 )
2018-11-14 11:48:32 +00:00
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
29c8ad6637
Fix reference in ModelAdmin.ordering docs.
2018-10-30 12:23:17 +00:00
aaa0953d05
Document the Dockerfile in the project template ( #4853 )
2018-10-27 15:18:25 +02:00
3b1dc5be86
Add Page max_count
2018-10-27 15:13:16 +03:00
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
8161d7c14c
Fix get_permission_helper_class documentation typo
2018-10-16 11:29:05 +01:00
b2b42faf14
Fix note about update_index not being required for the db backend
2018-09-21 10:59:52 +01:00
6454e500ab
Fix module path (wagtailforms.models should be wagtail.contrib.forms.models)
2018-09-21 10:53:51 +01:00
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
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
53881ebd0b
Small wording, spelling, grammar edits ( #4543 )
2018-05-18 14:59:06 +01:00
f58e85fa0f
Fix wording
2018-05-18 14:55:29 +01:00
c38b172793
updated Django Docs Links to point to *docs.djangoproject.com/en/stable/*
2018-05-18 14:43:42 +01:00
31a1126123
Remove construct_whitelister_element_rules hook
2018-05-18 11:43:28 +01:00
3fc9ed5119
Remove old versionadded/versionchanged notes
2018-05-18 11:43:28 +01:00
a9a69bedf5
Move HelpPanel documentation to avoid redefinition of wagtail.admin.edit_handlers module
2018-05-15 14:57:07 +01:00
5ce14841d8
Remove ancient versionchanged notes
2018-05-15 14:54:41 +01:00
d0670da61b
Fix minor typo in modeladmin docs ( #4509 )
...
add_to_setings_menu -> add_to_settings_menu
2018-05-02 18:11:01 +03:00
b3fa09b95e
Improved 'purge_page_from_cache' to purge the url for any managed language
2018-04-18 11:28:23 +01:00
8c686b6a6b
Typo
2018-04-11 13:22:45 +01:00
950e77d2aa
Wording change requested by Matthew Westcott
2018-04-11 13:22:45 +01:00
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
af7cdb4354
another typo fix
2018-04-06 16:19:49 +01:00
a179d0c331
Fix typos
...
Conflicts:
docs/reference/contrib/modeladmin/primer.rst
2018-04-06 16:19:32 +01:00
f608c67eb1
Fix capitalisation of names
2018-04-05 12:13:05 +01:00
bf3e994505
Fix capitalisation of QuerySet
2018-04-05 12:13:05 +01:00
a70b8130a5
Add quotes around code
2018-04-05 12:13:05 +01:00
a9b4b09152
Fix spelling mistakes in documentation
2018-04-05 12:13:05 +01:00
0fcd6d8cc1
Improves #4421 documentation example.
2018-03-29 21:01:23 +02:00
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
b2ef833915
allow chunk_size to be set in update_index
2018-03-29 17:49:43 +02:00
d188576af8
Adds a new HelpPanel ( #4374 )
2018-03-15 16:46:34 +01:00
cde31260d8
add documentation for custom send_mail method
2018-02-26 19:06:18 +00:00
f6bcfbf31e
Update paths in documentation
2018-02-23 11:53:31 +00:00
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
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
c85e4a3ff0
add note for setting menu default globally ( #4244 )
2018-02-06 14:10:45 +00:00
c9704caf17
Documentation edits
2018-01-15 22:58:00 +00:00
3f0972507b
Initial scheduled publishing documentation.
2018-01-15 22:58:00 +00:00
3eac584c7c
Make FormBuilder more easy to extend
2018-01-10 19:04:42 +10:00
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
b9a548f424
Update documentation for rich text element whitelisting
2018-01-05 16:15:59 +00:00
0b44392c3d
Add missing import to tagging docs ( #4158 )
2017-12-29 17:54:38 +01:00
70eb2b6ae3
add on_delete argument to ParentalKey & ForeignKey
2017-12-15 10:33:09 +00:00
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
a9f51a09c4
[Docs] Fix imports in "Buttons with dropdown lists" hooks example
2017-12-05 00:12:06 +00:00
9610c2d3af
Make InlinePanel heading independent of label. Original commit by @Adrian-Turjak
2017-11-30 12:08:19 +00:00
bc0923b356
Add note that form_submission is passed to landing page context
2017-11-28 22:01:37 +08:00
afee487d52
Documentation example for render_landing_page
2017-11-28 22:01:18 +08:00
ffd93a0d28
Don't inherit from object
2017-11-27 10:06:03 +00:00
58ea7f824a
Renamed wagtail.contrib.wagtailsitemaps to wagtail.contrib.sitemaps
2017-11-26 22:43:47 +00:00
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
394274b0a1
Renamed wagtail.contrib.wagtailroutablepage to
...
wagtail.contrib.routable_page
Conflicts:
docs/reference/contrib/routablepage.rst
2017-11-26 22:43:47 +00:00
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
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
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
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
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
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
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
4300e19da2
Rename wagtail.wagtailcore to wagtail.core
2017-11-26 22:43:47 +00:00
48b6a1b067
add note about django-treebeard api
2017-11-12 18:13:23 +00:00
cd924d0948
add docs for exclude_fields_in_copy
2017-11-10 11:02:55 +00:00
aebb69a2ba
Remove dead links to API v1 docs
2017-11-03 17:03:57 +00:00
7859627a6e
Added hooks for user for create, delete, and edit actions
2017-11-03 16:53:32 +00:00
bf7936ade2
Replace `django.core.urlresolvers` with `django.urls`
2017-11-01 16:22:46 +00:00
b350672585
Merge pull request #3934 from gasman/cleanup/remove-python2
...
Remove Python 2 fallback code
2017-10-26 14:41:43 +01:00
fa302c0853
Remove wagtail.contrib.wagtailapi
2017-10-25 16:49:17 +01:00
bd38525e5b
Merge branch 'master' into cleanup/remove-python2
2017-10-25 16:21:27 +01:00
60c26e5565
Remove note about Django 1.10 being required for postgres search backend
2017-10-25 16:15:02 +01:00
5f382d8784
Remove Python 2 references from docs
2017-10-13 12:24:42 +01:00
119d2334ac
Replace insert_editor_js hook example with a non-registerHalloPlugin one
...
Fixes #3839
2017-10-10 11:51:45 +01:00
de3f9550b4
Release note for #3824
2017-10-05 15:40:55 +01:00
48cfb8e790
Tweaks to the docs
2017-10-05 15:15:21 +01:00
0cb63c72c5
Implemented suggestions from @chosak
2017-10-05 15:15:20 +01:00
8dc425660b
Docs for batch cache invalidation
2017-10-05 15:15:20 +01:00
b0aedf02dc
Remove old versionadded annotations from the docs
2017-08-22 14:08:44 +01:00
d56f1069ef
Updating to allow no limit max
2017-08-22 12:09:05 +01:00
b376da022f
Grammar nitpick ('By default' sounds more natural than 'Per default')
2017-08-11 09:58:44 +01:00
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
70aa876e55
Extra documentation / release note re the relationship between draft_title and get_admin_display_title
2017-08-03 12:05:52 +01:00
7b55c5094f
Backslash is not necessary when multi-line expression is parenthesized.
2017-07-18 09:56:42 +03:00
049b15f3fe
Define a 'before_serve_document' hook
2017-06-16 14:50:47 +01:00
18cb0245fc
allow default for show_in_menus
2017-06-09 12:50:39 +01:00
927770eaab
Release note / docs for #3608
2017-06-02 10:58:34 +01:00
2f2bfa0159
Make tagging example not rely on an unmentioned 'blogs' method - fixes #3602
2017-05-30 20:39:30 +01:00
411c117964
Fix typo in settings doc ( #3595 )
2017-05-15 09:12:16 +03:00
49d706b406
Update docs - run python manage.py migrate once
...
We have to run python manage.py migrate once, in order to create the necessary tables for the postgres search backend.
Otherwise we get an error, as the insert in the table is not possible.
2017-04-21 09:16:44 +01:00
7ad348ffa7
Minor documentation update for sitemaps
2017-04-19 13:40:43 +02:00
c6c2868c58
Update documentation related to the sitemaps
...
Since we now use regular Django sitemaps we can mostly just refer to the
Django documentation
Co-authored with @mikedingjan
2017-04-19 13:40:43 +02:00
0d1c277e85
Added versionadded tag to postgres search doc
2017-04-12 16:30:45 +01:00
e62d67bd73
Adds PostgreSQL search backend. ( #3515 )
...
* Adds PostgreSQL search backend.
* Isort nitpicks.
* Fixes PostgreSQL versions incompatibilities.
* Uses Django lru_cache instead of building our own.
* Fixes PostgreSQL search index on some empty vector & query cases.
* Never sets the PostgreSQL search vector to NULL.
* Simplification + removes caching on two fast enough functions.
* Rewrites stale entries deletion to use the ORM.
2017-04-12 16:16:16 +01:00
37bbbb9dba
Improved code separation in `contrib.modeladmin` ( #3467 )
...
* Split `helpers.py` into separate `url.py`, `permission.py` and `button.py`, dedicated to those separate concerns and update the docs accordingly
* Move `ThumbnailMixin` out to `mixins.py` and update documentation accordingly
* Ad #NOQA to import lines to hush pep errors
* Alphabetise helper import order
* - Delete `helpers/helpers.py`
- wagtal -> wagtail in docs
2017-03-28 10:34:03 +01:00
minusf