From 1790bdd158a56fb09997734d8e724ac3af58d10a Mon Sep 17 00:00:00 2001 From: LB Johnston Date: Wed, 28 Aug 2024 20:20:44 +1000 Subject: [PATCH] Align recent docs & release notes to US spelling --- CHANGELOG.txt | 12 ++++++------ client/src/controllers/README.md | 2 +- docs/advanced_topics/accessibility_considerations.md | 2 +- .../customisation/custom_page_listings.md | 4 ++-- .../customisation/streamfield_blocks.md | 2 +- docs/extending/admin_views.md | 2 +- docs/extending/custom_tasks.md | 2 +- docs/getting_started/integrating_into_django.md | 2 +- docs/getting_started/tutorial.md | 2 +- docs/reference/contrib/forms/customization.md | 2 +- docs/reference/contrib/table_block.md | 4 ++-- docs/reference/settings.md | 2 +- docs/releases/5.0.md | 2 +- docs/releases/5.1.md | 4 ++-- docs/releases/5.2.md | 6 +++--- docs/releases/6.0.md | 2 +- docs/releases/6.1.md | 2 +- docs/releases/6.2.md | 2 +- docs/releases/6.3.md | 2 +- wagtail/admin/action_menu.py | 2 +- 20 files changed, 30 insertions(+), 30 deletions(-) diff --git a/CHANGELOG.txt b/CHANGELOG.txt index 5f3e611dd1..ddb4ac72de 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -13,7 +13,7 @@ Changelog * Fix: Fix typo in aria-label attribute of page explorer navigation link (Sébastien Corbin) * Fix: Reinstate transparency indicator on image chooser widgets (Sébastien Corbin) * Docs: Upgrade Sphinx to 7.3 (Matt Westcott) - * Docs: Document how to customise date/time format settings (Vince Salvino) + * Docs: Document how to customize date/time format settings (Vince Salvino) * Maintenance: Removed support for Python 3.8 (Matt Westcott) * Maintenance: Drop pytz dependency in favour of `zoneinfo.available_timezones` (Sage Abdullah) * Maintenance: Relax django-taggit dependency to allow 6.0 (Matt Westcott) @@ -107,7 +107,7 @@ Changelog * Maintenance: Split `contrib.frontend_cache.backends` into dedicated sub-modules (Andy Babic) * Maintenance: Remove unused `docs/autobuild.sh` script (Sævar Öfjörð Magnússon) * Maintenance: Replace `urlparse` with `urlsplit` to improve performance (Jake Howard) - * Maintenance: Optimise embed finder lookups (Jake Howard) + * Maintenance: Optimize embed finder lookups (Jake Howard) * Maintenance: Improve performance of initial admin loading by moving sprite hashing out of module import time (Jake Howard) * Maintenance: Remove workaround and inline scripts for activating workflow actions (Sage Abdullah) * Maintenance: Prevent `'BlockWidget' object has no attribute '_block_json'` from masking errors during StreamField serialization (Matt Westcott) @@ -172,7 +172,7 @@ Changelog * Update the minimum version of `djangorestframework` to 3.15.1 (Sage Abdullah) * Add support for related fields in generic `IndexView.list_display` (Abdelrahman Hamada) * Improve page fetching logic and cache route results per request (Gordon Pendleton) - * Optimise rewriting of links / embeds in rich text using bulk database lookups (Andy Chosak) + * Optimize rewriting of links / embeds in rich text using bulk database lookups (Andy Chosak) * Add normalization mechanism to StreamField so that assignments and defaults can be passed in a wider range of data types (Joshua Munn, Matt Westcott) * Allow specifying a `STORAGES` alias name for `WAGTAILIMAGES_RENDITION_STORAGE` (Alec Baron) * Update `PASSWORD_REQUIRED_TEMPLATE` setting to `WAGTAIL_PASSWORD_REQUIRED_TEMPLATE` with deprecation of previous naming (Saksham Misra, LB (Ben) Johnston) @@ -581,7 +581,7 @@ Changelog * Support extending Wagtail client-side with Stimulus (LB (Ben) Johnston) * Update all `FieldPanel('title')` examples to use the recommended `TitleFieldPanel('title')` panel (Chinedu Ihedioha) * The `purge_revisions` management command now respects revisions that have a `on_delete=PROTECT` foreign key relation and won't delete them (Neeraj P Yetheendran, Meghana Reddy, Sage Abdullah, Storm Heg) - * Add support for Shift + Click behaviour in form submissions and simple translations submissions (LB (Ben) Johnston) + * Add support for Shift + Click behavior in form submissions and simple translations submissions (LB (Ben) Johnston) * Improve filtering of audit logging based on the user's permissions (Stefan Hammer) * Fix: Ensure that StreamField's `FieldBlock`s correctly set the `required` and `aria-describedby` attributes (Storm Heg) * Fix: Avoid an error when the moderation panel (admin dashboard) contains both snippets and private pages (Matt Westcott) @@ -643,7 +643,7 @@ Changelog * Maintenance: Deprecate legacy URL redirects in `ModelViewSet` and `SnippetViewSet` (Sage Abdullah) * Maintenance: Simplify code for registering page listing action buttons (Matt Westcott) * Maintenance: Removed the unused, legacy, Wagtail userbar views set up for an old iframe approach (Sage Abdullah) - * Maintenance: Optimise `lru_cache` usage (Jake Howard) + * Maintenance: Optimize `lru_cache` usage (Jake Howard) * Maintenance: Implement `date_since` in `get_most_popular` inside `search_promotions.models.Query` (TopDevPros) * Maintenance: Refactor generic view subclasses to better reuse the generic templates and breadcrumbs (Sage Abdullah) * Maintenance: Adopt consistent `classname` (not `classnames`) attributes for all `MenuItem` usage, including deprecation warnings (LB (Ben) Johnston) @@ -783,7 +783,7 @@ Changelog * Maintenance: Optimise use of `specific` on Task and TaskState (Matt Westcott) * Maintenance: Use table UI component for workflow task index view (Matt Westcott) * Maintenance: Make header search available on generic index view (Matt Westcott) - * Maintenance: Update pagination behaviour to reject out-of-range / invalid page numbers (Matt Westcott) + * Maintenance: Update pagination behavior to reject out-of-range / invalid page numbers (Matt Westcott) * Maintenance: Remove color tokens which are duplicates / unused (Thibaud Colas) * Maintenance: Add tests to help with maintenance of theme color tokens (Thibaud Colas) * Maintenance: Split out a base listing view from generic index view (Matt Westcott) diff --git a/client/src/controllers/README.md b/client/src/controllers/README.md index 767af56b59..f0953b5354 100644 --- a/client/src/controllers/README.md +++ b/client/src/controllers/README.md @@ -2,7 +2,7 @@ **Important:** This is a migration in progress, any large refactors or new code should adopt this approach. -- Wagtail uses [Stimulus](https://stimulus.hotwired.dev/) as a way to attach interactive behaviour to DOM elements. +- Wagtail uses [Stimulus](https://stimulus.hotwired.dev/) as a way to attach interactive behavior to DOM elements. - This is a lightweight JavaScript framework that allows a JavaScript class to be attached to any DOM element that adheres to a specific usage of `data-` attributes on the element. - Each file within this folder should contain one Stimulus controller class, using a matching file name (for example `class MyAwesomeController, `MyAwesomeController.ts`, all TitleCase). - Controllers that are included in the `index.ts` default export will automatically be included in the core bundle and provided by default. diff --git a/docs/advanced_topics/accessibility_considerations.md b/docs/advanced_topics/accessibility_considerations.md index 4c922ad86c..c803f10ae1 100644 --- a/docs/advanced_topics/accessibility_considerations.md +++ b/docs/advanced_topics/accessibility_considerations.md @@ -84,7 +84,7 @@ Here are common gotchas to be aware of to make the site’s templates as accessi ### Alt text in templates -See the [content modelling](content_modeling) section above. Additionally, make sure to [customise images’ alt text](image_tag_alt), either setting it to the relevant field, or to an empty string for decorative images, or images where the alt text would be a repeat of other content. +See the [content modelling](content_modeling) section above. Additionally, make sure to [customize images’ alt text](image_tag_alt), either setting it to the relevant field, or to an empty string for decorative images, or images where the alt text would be a repeat of other content. Even when your images have alt text coming directly from the image model, you still need to decide whether there should be alt text for the particular context the image is used in. For example, avoid alt text in listings where the alt text just repeats the listing items’ title. ### Empty heading tags diff --git a/docs/advanced_topics/customisation/custom_page_listings.md b/docs/advanced_topics/customisation/custom_page_listings.md index b3d7362ec2..bf2d3672bd 100644 --- a/docs/advanced_topics/customisation/custom_page_listings.md +++ b/docs/advanced_topics/customisation/custom_page_listings.md @@ -28,7 +28,7 @@ def register_blog_page_listing_viewset(): return blog_page_listing_viewset ``` -The columns of the listing can be customised by overriding the `columns` attribute on the viewset. This should be a list of `wagtail.admin.ui.tables.Column` instances: +The columns of the listing can be customized by overriding the `columns` attribute on the viewset. This should be a list of `wagtail.admin.ui.tables.Column` instances: ```python from wagtail import hooks @@ -44,7 +44,7 @@ class BlogPageListingViewSet(PageListingViewSet): ] ``` -The filtering options for the listing can be customised by overriding the `filterset_class` attribute on the viewset: +The filtering options for the listing can be customized by overriding the `filterset_class` attribute on the viewset: ```python from wagtail import hooks diff --git a/docs/advanced_topics/customisation/streamfield_blocks.md b/docs/advanced_topics/customisation/streamfield_blocks.md index dff5f4db4a..0aaea57b70 100644 --- a/docs/advanced_topics/customisation/streamfield_blocks.md +++ b/docs/advanced_topics/customisation/streamfield_blocks.md @@ -92,7 +92,7 @@ A form template for a StructBlock must include the output of `render_form` for e ## Additional JavaScript on `StructBlock` forms -Often it may be desirable to attach custom JavaScript behaviour to a StructBlock form. For example, given a block such as: +Often it may be desirable to attach custom JavaScript behavior to a StructBlock form. For example, given a block such as: ```python class AddressBlock(StructBlock): diff --git a/docs/extending/admin_views.md b/docs/extending/admin_views.md index f23c865725..bcc43de051 100644 --- a/docs/extending/admin_views.md +++ b/docs/extending/admin_views.md @@ -246,7 +246,7 @@ class CalendarViewSet(ViewSet): menu_label = "Calendar" icon = "date" # The `name` will be used for both the URL prefix and the URL namespace. - # They can be customised individually via `url_prefix` and `url_namespace`. + # They can be customized individually via `url_prefix` and `url_namespace`. name = "calendar" def get_urlpatterns(self): diff --git a/docs/extending/custom_tasks.md b/docs/extending/custom_tasks.md index 9cffced979..c88220d483 100644 --- a/docs/extending/custom_tasks.md +++ b/docs/extending/custom_tasks.md @@ -129,7 +129,7 @@ class UserApprovalTask(Task): (custom_tasks_behavior)= -## Customising behaviour +## Customising behavior Both `Task` and `TaskState` have a number of methods that can be overridden to implement custom behavior. Here are some of the most useful: diff --git a/docs/getting_started/integrating_into_django.md b/docs/getting_started/integrating_into_django.md index 9ac93826db..c9512b53a0 100644 --- a/docs/getting_started/integrating_into_django.md +++ b/docs/getting_started/integrating_into_django.md @@ -74,7 +74,7 @@ Add a `WAGTAILDOCS_EXTENSIONS` setting to specify the file types that Wagtail wi WAGTAILDOCS_EXTENSIONS = ['csv', 'docx', 'key', 'odt', 'pdf', 'pptx', 'rtf', 'txt', 'xlsx', 'zip'] ``` -Various other settings are available to configure Wagtail's behaviour - see [Settings](/reference/settings). +Various other settings are available to configure Wagtail's behavior - see [Settings](/reference/settings). ## URL configuration diff --git a/docs/getting_started/tutorial.md b/docs/getting_started/tutorial.md index e9a38bcce1..6e5eefca60 100644 --- a/docs/getting_started/tutorial.md +++ b/docs/getting_started/tutorial.md @@ -304,7 +304,7 @@ python manage.py migrate ``` Also, since the model name is `BlogIndexPage`, the default template name, -unless you override it, is `blog_index_page.html`. Django looks for a template whose name matches the name of your Page model within the templates directory in your blog app folder. You can override this default behaviour if you want to. To create a template for the +unless you override it, is `blog_index_page.html`. Django looks for a template whose name matches the name of your Page model within the templates directory in your blog app folder. You can override this default behavior if you want to. To create a template for the `BlogIndexPage` model, create a file at the location `blog/templates/blog/blog_index_page.html`. ```{note} diff --git a/docs/reference/contrib/forms/customization.md b/docs/reference/contrib/forms/customization.md index 64feb0f1ed..d5e217bfc3 100644 --- a/docs/reference/contrib/forms/customization.md +++ b/docs/reference/contrib/forms/customization.md @@ -588,7 +588,7 @@ class FormPage(AbstractEmailForm): (custom_form_submission_listing)= -## Customise form submissions listing in Wagtail Admin +## Customize form submissions listing in Wagtail Admin The Admin listing of form submissions can be customized by setting the attribute `submissions_list_view_class` on your FormPage model. diff --git a/docs/reference/contrib/table_block.md b/docs/reference/contrib/table_block.md index ba037295f5..10cd97a204 100644 --- a/docs/reference/contrib/table_block.md +++ b/docs/reference/contrib/table_block.md @@ -89,12 +89,12 @@ default_table_options = { ### Configuration Options -Every key in the `table_options` dictionary maps to a [handsontable](https://handsontable.com/) option. These settings can be changed to alter the behaviour of tables in Wagtail. The following options are available: +Every key in the `table_options` dictionary maps to a [handsontable](https://handsontable.com/) option. These settings can be changed to alter the behavior of tables in Wagtail. The following options are available: - [minSpareRows](https://handsontable.com/docs/6.2.2/Options.html#minSpareRows) - The number of rows to append to the end of an empty grid. The default setting is 0. - [startRows](https://handsontable.com/docs/6.2.2/Options.html#startRows) - The default number of rows for a new table. - [startCols](https://handsontable.com/docs/6.2.2/Options.html#startCols) - The default number of columns for new tables. -- [colHeaders](https://handsontable.com/docs/6.2.2/Options.html#colHeaders) - Can be set to `True` or `False`. This setting designates if new tables should be created with column headers. **Note:** this only sets the behaviour for newly created tables. Page editors can override this by checking the “Column header” checkbox in the table editor in the Wagtail admin. +- [colHeaders](https://handsontable.com/docs/6.2.2/Options.html#colHeaders) - Can be set to `True` or `False`. This setting designates if new tables should be created with column headers. **Note:** this only sets the behavior for newly created tables. Page editors can override this by checking the “Column header” checkbox in the table editor in the Wagtail admin. - [rowHeaders](https://handsontable.com/docs/6.2.2/Options.html#rowHeaders) - Operates the same as `colHeaders` to designate if new tables should be created with the first column as a row header. Just like `colHeaders` this option can be overridden by the page editor in the Wagtail admin. - [contextMenu](https://handsontable.com/docs/6.2.2/Options.html#contextMenu) - Enables or disables the Handsontable right-click menu. By default this is set to `True`. Alternatively you can provide a list or a dictionary with [specific options](https://handsontable.com/docs/6.2.2/demo-context-menu.html#page-specific). - [editor](https://handsontable.com/docs/6.2.2/Options.html#editor) - Defines the editor used for table cells. The default setting is text. diff --git a/docs/reference/settings.md b/docs/reference/settings.md index 871d38de1f..8733e0e639 100644 --- a/docs/reference/settings.md +++ b/docs/reference/settings.md @@ -776,7 +776,7 @@ See [](private_pages) for more details. TAGGIT_CASE_INSENSITIVE = True ``` -Tags are case-sensitive by default ('music' and 'Music' are treated as distinct tags). In many cases the reverse behaviour is preferable. +Tags are case-sensitive by default ('music' and 'Music' are treated as distinct tags). In many cases the reverse behavior is preferable. ### `TAG_SPACES_ALLOWED` diff --git a/docs/releases/5.0.md b/docs/releases/5.0.md index 4e09de85aa..df90a6f985 100644 --- a/docs/releases/5.0.md +++ b/docs/releases/5.0.md @@ -461,7 +461,7 @@ Stimulus [targets](https://stimulus.hotwired.dev/reference/targets) and [actions * `` - any element can be the button label (not just `em`) * `