Add an 'Extending Wagtail' section to the docs

pull/7396/head
Matt Westcott 2021-07-23 17:14:21 +01:00 zatwierdzone przez Matt Westcott
rodzic 5f452b3778
commit 4e2685f47d
16 zmienionych plików z 24 dodań i 16 usunięć

Wyświetl plik

@ -6,11 +6,6 @@ Customising Wagtail
:maxdepth: 2
page_editing_interface
rich_text_internals
extending_draftail
extending_hallo
admin_templates
custom_user_models
customising_group_views
streamfield_blocks
custom_account_settings

Wyświetl plik

@ -94,9 +94,9 @@ We have few additional feature identifiers as well. They are not enabled by defa
The process for creating new features is described in the following pages:
* :doc:`./rich_text_internals`
* :doc:`./extending_draftail`
* :doc:`./extending_hallo`
* :doc:`../../extending/rich_text_internals`
* :doc:`../../extending/extending_draftail`
* :doc:`../../extending/extending_hallo`
.. _rich_text_image_formats:

Wyświetl plik

@ -18,9 +18,6 @@ Advanced topics
testing
api/index
amp
adding_reports
custom_tasks
audit_log
accessibility_considerations
boundblocks_and_values
multi_site_multi_instance_multi_tenancy

Wyświetl plik

@ -153,11 +153,11 @@ They want to write articles about the stock market, refer to specific stocks any
The editor toolbar could contain a "stock chooser" that displays a list of available stocks, then inserts the users selection as a textual token. For our example, we will just pick a stock at random:
.. image:: ../../_static/images/draftail_entity_stock_source.gif
.. image:: ../_static/images/draftail_entity_stock_source.gif
Those tokens are then saved in the rich text on publish. When the news article is displayed on the site, we then insert live market data coming from an API next to each token:
.. image:: ../../_static/images/draftail_entity_stock_rendering.png
.. image:: ../_static/images/draftail_entity_stock_rendering.png
In order to achieve this, we start with registering the rich text feature like for inline styles and blocks:

Wyświetl plik

@ -0,0 +1,15 @@
Extending Wagtail
=================
.. toctree::
:maxdepth: 2
adding_reports
custom_tasks
audit_log
custom_account_settings
customising_group_views
rich_text_internals
extending_draftail
extending_hallo

Wyświetl plik

@ -40,6 +40,7 @@ Index
getting_started/index
topics/index
advanced_topics/index
extending/index
reference/index
support
editor_manual/index

Wyświetl plik

@ -214,7 +214,7 @@ Alternatively, it can also be added to a function. For example, this function is
def register_custom_settings_panel(request, user, profile):
return CustomSettingsPanel(request, user, profile)
More details about the options that are available can be found at :doc:`/advanced_topics/customisation/custom_account_settings`.
More details about the options that are available can be found at :doc:`/extending/custom_account_settings`.
.. _register_account_menu_item:

Wyświetl plik

@ -74,7 +74,7 @@ The configuration settings ``WAGTAILEMBEDS_EMBED_FINDER`` and ``WAGTAILEMBEDS_EM
Registering custom hallo.js plugins directly is deprecated
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ability to enable / disable ``hallo.js`` plugins by calling ``registerHalloPlugin`` or modifying the ``halloPlugins`` list has been deprecated, and will be removed in Wagtail 1.14. The recommended way of customising the hallo.js editor is now through :ref:`rich text features <rich_text_features>`. For details of how to define a hallo.js plugin as a rich text feature, see :doc:`../advanced_topics/customisation/extending_hallo`.
The ability to enable / disable ``hallo.js`` plugins by calling ``registerHalloPlugin`` or modifying the ``halloPlugins`` list has been deprecated, and will be removed in Wagtail 1.14. The recommended way of customising the hallo.js editor is now through :ref:`rich text features <rich_text_features>`. For details of how to define a hallo.js plugin as a rich text feature, see :doc:`../extending/extending_hallo`.
Custom ``get_admin_display_title`` methods should use ``draft_title``

Wyświetl plik

@ -15,7 +15,7 @@ Moderation workflow
This release introduces a configurable moderation workflow system to replace the single-step "submit for moderation" feature. Workflows can be set up on specific subsections of the page tree and consist of any number of tasks to be completed by designated user groups. To support this, numerous UI improvements have been made to Wagtail's page editor, including a new log viewer to track page history.
For further details, see :ref:`managing_workflows` and :doc:`../advanced_topics/custom_tasks`.
For further details, see :ref:`managing_workflows` and :doc:`../extending/custom_tasks`.
This feature was developed by Jacob Topp-Mugglestone, Karl Hobley, Matt Westcott and Dan Braghis, and sponsored by `The Motley Fool <https://www.fool.com/>`_.