Browse Source

Align recent docs & release notes to US spelling

LB Johnston 6 months ago
parent
commit
1790bdd158

+ 6 - 6
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)

+ 1 - 1
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.

+ 1 - 1
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

+ 2 - 2
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

+ 1 - 1
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):

+ 1 - 1
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):

+ 1 - 1
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:
 

+ 1 - 1
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
 

+ 1 - 1
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}

+ 1 - 1
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.
 

+ 2 - 2
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.

+ 1 - 1
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`
 

+ 1 - 1
docs/releases/5.0.md

@@ -461,7 +461,7 @@ Stimulus [targets](https://stimulus.hotwired.dev/reference/targets) and [actions
 * `<button ... class="custom-button" data-w-progress-active-class="custom-button--busy" ...>` - custom 'active' class to replace the default `button-longrunning-active` (must be a single string without spaces)
 * `<button ... ><strong data-w-progress-target="label">{% trans 'Create' %}</strong></button>` - any element can be the button label (not just `em`)
 * `<button ... data-action="w-progress#activate focus->w-progress#activate" ...>` - any event can be used to trigger the in progress behavior
-* `<button ... data-action="w-progress#activate:once" ...>` - only trigger the progress behaviour once
+* `<button ... data-action="w-progress#activate:once" ...>` - only trigger the progress behavior once
 * `<button ... data-action="readystatechange@document->w-progress#activate:once" data-w-progress-duration-value="5000" disabled ...>` - disabled on load (once JS starts) and becomes enabled after 5s duration
 
 

+ 2 - 2
docs/releases/5.1.md

@@ -162,7 +162,7 @@ We have made several improvements to snippets as part of [RFC 85: Snippets parit
  * Optimise use of `specific` on Task and TaskState (Matt Westcott)
  * Use table UI component for workflow task index view (Matt Westcott)
  * Make header search available on generic index view (Matt Westcott)
- * Update pagination behaviour to reject out-of-range / invalid page numbers (Matt Westcott)
+ * Update pagination behavior to reject out-of-range / invalid page numbers (Matt Westcott)
  * Remove color tokens which are duplicates / unused (Thibaud Colas)
  * Add tests to help with maintenance of theme color tokens (Thibaud Colas)
  * Split out a base listing view from generic index view (Matt Westcott)
@@ -435,7 +435,7 @@ Note: The `data-w-tag-options-value` is a JSON object serialized into string. Dj
 
 ### Header searching now relies on data attributes
 
-Previously the header search relied on inline scripts and a `window.headerSearch` global to activate the behaviour. This has now changed to a data attributes approach and the window global usage will be removed in a future major release.
+Previously the header search relied on inline scripts and a `window.headerSearch` global to activate the behavior. This has now changed to a data attributes approach and the window global usage will be removed in a future major release.
 
 If you are using the documented Wagtail [viewsets](viewsets_reference), Snippets or `ModelAdmin` approaches to building custom admin views, there should be no change required.
 

+ 3 - 3
docs/releases/5.2.md

@@ -92,7 +92,7 @@ Several tweaks have been made to the admin user interface which we hope will mak
  * Do not render minimap if there are no panel anchors (Sage Abdullah)
  * Use dropdown buttons on listings in dashboard panels (Sage Abdullah)
  * Implement breadcrumbs design refinements (Thibaud Colas)
- * 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)
 
 ### External links in promoted search results
@@ -192,7 +192,7 @@ As part of our [adoption of Stimulus](https://github.com/wagtail/rfcs/blob/main/
  * Add support for options/attrs in Telepath widgets so that attrs render on the created DOM (Storm Heg)
  * Update pre-commit hooks to be in sync with latest changes to ESLint & Prettier for client-side changes (Storm Heg)
  * Add `WagtailTestUtils.get_soup()` method for testing HTML content (Storm Heg, Sage Abdullah)
- * Allow `ViewSet` subclasses to customise `url_prefix` and `url_namespace` logic (Matt Westcott)
+ * Allow `ViewSet` subclasses to customize `url_prefix` and `url_namespace` logic (Matt Westcott)
  * Simplify `SnippetViewSet` registration code (Sage Abdullah)
  * Rename groups `IndexView.results_template_name` to `results.html` (Sage Abdullah)
  * Allow viewsets to define a common set of view kwargs (Matt Westcott)
@@ -207,7 +207,7 @@ As part of our [adoption of Stimulus](https://github.com/wagtail/rfcs/blob/main/
  * Deprecate legacy URL redirects in `ModelViewSet` and `SnippetViewSet` (Sage Abdullah)
  * Simplify code for registering page listing action buttons (Matt Westcott)
  * Removed the unused, legacy, Wagtail userbar views set up for an old iframe approach (Sage Abdullah)
- * Optimise `lru_cache` usage (Jake Howard)
+ * Optimize `lru_cache` usage (Jake Howard)
  * Implement `date_since` in `get_most_popular` inside `search_promotions.models.Query` (TopDevPros)
  * Refactor generic view subclasses to better reuse the generic templates and breadcrumbs (Sage Abdullah)
  * Adopt consistent `classname` (not `classnames`) attributes for all `MenuItem` usage, including deprecation warnings (LB (Ben) Johnston)

+ 1 - 1
docs/releases/6.0.md

@@ -102,7 +102,7 @@ This release comes with a high number of accessibility improvements across the a
  * Use SlugInput on all SlugFields by default (LB (Ben) Johnston)
  * Show character counts on RichTextBlock with `max_length` (Elhussein Almasri)
  * Move locale selector in generic IndexView to a filter (Sage Abdullah)
- * Add ability to [customise a page's copy form](custom_page_copy_form) including an auto-incrementing slug example (Neeraj Yetheendran)
+ * Add ability to [customize a page's copy form](custom_page_copy_form) including an auto-incrementing slug example (Neeraj Yetheendran)
  * Add [`WAGTAILADMIN_LOGIN_URL` setting](wagtailadmin_login_url) to allow customising the login URL (Neeraj Yetheendran)
  * Polish dark theme styles and update color tokens (Thibaud Colas, Rohit Sharma)
  * Keep database state of pages and snippets updated while in draft state (Stefan Hammer)

+ 1 - 1
docs/releases/6.1.md

@@ -86,7 +86,7 @@ Many thanks to Ben Morse and Joshua Munn for reporting this issue, and Jake Howa
  * Add support for related fields in generic `IndexView.list_display` (Abdelrahman Hamada)
  * Improve page fetching logic and cache route results per request. You can now use `Page.route_for_request()` to find the page route, 
    and `Page.find_for_request()` to find the page given a request object and a URL path, see [](page_model_ref). Results are cached on `request._wagtail_route_for_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`](wagtailimages_rendition_storage) (Alec Baron)
  * Update `PASSWORD_REQUIRED_TEMPLATE` setting to [`WAGTAIL_PASSWORD_REQUIRED_TEMPLATE`](frontend_authentication) with deprecation of previous naming (Saksham Misra, LB (Ben) Johnston)

+ 1 - 1
docs/releases/6.2.md

@@ -111,7 +111,7 @@ StreamField definitions within migrations are now represented in a more compact
  * Split `contrib.frontend_cache.backends` into dedicated sub-modules (Andy Babic)
  * Remove unused `docs/autobuild.sh` script (Sævar Öfjörð Magnússon)
  * Replace `urlparse` with `urlsplit` to improve performance (Jake Howard)
- * Optimise embed finder lookups (Jake Howard)
+ * Optimize embed finder lookups (Jake Howard)
  * Improve performance of initial admin loading by moving sprite hashing out of module import time (Jake Howard)
  * Remove workaround and inline scripts for activating workflow actions (Sage Abdullah)
  * Prevent `'BlockWidget' object has no attribute '_block_json'` from masking errors during StreamField serialization (Matt Westcott)

+ 1 - 1
docs/releases/6.3.md

@@ -31,7 +31,7 @@ This release adds formal support for Django 5.1.
 ### Documentation
 
  * Upgrade Sphinx to 7.3 (Matt Westcott)
- * Document how to customise date/time format settings (Vince Salvino)
+ * Document how to customize date/time format settings (Vince Salvino)
 
 
 ### Maintenance

+ 1 - 1
wagtail/admin/action_menu.py

@@ -238,7 +238,7 @@ BASE_PAGE_ACTION_MENU_ITEMS = None
 def _get_base_page_action_menu_items():
     """
     Retrieve the global list of menu items for the page action menu,
-    which may then be customised on a per-request basis
+    which may then be customized on a per-request basis
     """
     global BASE_PAGE_ACTION_MENU_ITEMS