DRAFT: add sphinxcontrib-spelling as a test

.github/workflows/test.yml

@@ -9,12 +9,15 @@ jobs:
     runs-on: "ubuntu-latest"
     steps:
       - name: "Check out repository"
-        uses: "actions/checkout@v2"
+        uses: "actions/checkout@v4"
       - name: "Set up Python"
-        uses: "actions/setup-python@v2"
+        uses: "actions/setup-python@v5"
       - name: "Install requirements"
         run: |
           pip install -r requirements.txt
       - name: "Run build test"
         run: |
           make test
+      - name: "Check spelling"
+        run: |
+          sphinx-build -b spelling ./ _build/spelling

admin-manual/customization/theming.rst

@@ -135,6 +135,12 @@ plugin name. Next, we need to change the `class name <https://github.com/artefac
 to match the new config filename (`arCustomThemeB5PluginConfiguration` for this
 example).
 
+.. image:: images/theme-config.*
+   :align: center
+   :width: 80%
+   :alt: Example theme confiuration
+
+
 Optionally, you can update the theme summary and version within the config file
 and change the theme image thumbnail by replacing `arCustomThemeB5Plugin/images/image.png`.
 

conf.py

@@ -42,8 +42,17 @@
     "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
     "sphinx_version_ref",
+    "sphinxcontrib.spelling",
 ]
 
+# spelling
+
+spelling_lang="en_CA"
+
+spelling_word_list_filename = ['spelling_wordlist.txt']
+
+spelling_show_suggestions=True
+
 # Obtain intersphinx_mapping
 inventory = "https://gist.githubusercontent.com/qubot/2dd2f7f96e51121061d4/raw/sphinxdoc-inventory.json"
 response = urlopen(inventory)

requirements.txt

@@ -1,3 +1,4 @@
 sphinx
 sphinx_rtd_theme
-sphinx_version_ref
+sphinx_version_ref
+sphinxcontrib-spelling

spelling_wordlist.txt

@@ -0,0 +1,12 @@
+AtoM
+Archivematica
+Artefactual
+Calc
+Gearman
+config
+hostname
+subdirectory
+Symfony
+yml
+sfAPPCCache
+fonds

user-manual/administer/settings.rst

@@ -3043,7 +3043,7 @@ For more information, see :ref:`upload-digital-object`.
 
 .. TIP::
 
-   While this setting sets a default global limit per repository, an indiviual
+   While this setting sets a default global limit per repository, an individual
    upload limit can also be set by an :term:`administrator` on a per-repository
    basis, from the :term:`archival institution` page. For more information, see:
    :ref:`upload-limit`.

user-manual/administer/static-pages.rst

@@ -872,7 +872,7 @@ You can add styled boxes around text by wrapping content in the HTML ``<div>``
 element, and then using inline CSS to modify the
 appearance of the box. For colors, use the HTML or RGB values for the color you
 would like to use, rather than generic names such as "red," "blue," etc. - most
-browsers support a limited pallette of colors using names such as this, and the
+browsers support a limited palette of colors using names such as this, and the
 results may be inconsistent across browsers. There are many free HTML color
 wheels available that allow you to choose a color and copy its HTML# or RGB
 values; for example: http://www.colorpicker.com/

user-manual/administer/themes.rst

@@ -134,7 +134,7 @@ Edit theme for an archival institution
 
 In :term:`multi-repository systems <multi-repository system>` institutions
 can change the appearance of individual institution pages and results pages
-by uploading an instution logo, banner and changing the background colour.
+by uploading an institution logo, banner and changing the background colour.
 For instructions, see
 :ref:`Archival institutions- Edit theme <edit-institution-theme>`
 

user-manual/administer/visible-elements.rst

@@ -43,7 +43,7 @@ it will NOT be visible to public users (e.g. those not logged in).
 
 .. IMPORTANT::
 
-   ALL authenticated users, from contributers to adminstrators, **will** be
+   ALL authenticated users, from contributors to administrators, **will** be
    able to see those elements hidden from the public via the hidden elements
    module. If you are logged in, the Visible Elements module is not in
    operation.

user-manual/data-templates/dacs-template.rst

@@ -170,7 +170,7 @@ Title
 
 **ISAD CSV Column** ``title``
 
-**DACS Rule**: In the absense of a meaningful formal title, compose a brief
+**DACS Rule**: In the absence of a meaningful formal title, compose a brief
 title that uniquely identifies the material, normally consisting of a name
 segment, a term indicating the nature of the unit being described, and
 optionally a topical segment.
@@ -233,7 +233,7 @@ Extent
 extent as linear or cubic feet, number of items, or number of containers or
 carriers. (DACS 2.5.4) Optionally, record the quantity in terms of the
 material type(s) (DACS 2.5.5), and/or qualify the statement of physical extent
-to hgihlight the existence of material types that are important. (DACS 2.5.6)
+to highlight the existence of material types that are important. (DACS 2.5.6)
 
 **EAD**
 
@@ -987,7 +987,7 @@ Access points
 The DACS standard does not include rules about access points, but it does 
 include general high-level guidance on their use and where relevant information
 can be found when constructing controlled vocabulary terms (See pg xxiv in 
-Describing ARchives: A Content Standard, Second Edition). 
+Describing Archives: A Content Standard, Second Edition). 
 
 .. _dacs-subject-access-points:
 

user-manual/data-templates/isad-template.rst

@@ -314,7 +314,7 @@ Extent and medium
 **CSV Column** ``extentAndMedium``
 
 **ISAD Rule** "Record the extent of the unit of description by giving the number
-of physical or logical units in arabic numerals and the unit of measurement.
+of physical or logical units in Arabic numerals and the unit of measurement.
 Give the specific medium (media) of the unit of description. Separate
 multiple extents with a linebreak. (ISAD 3.1.5)"
 
@@ -418,8 +418,8 @@ a new name to create and link to a new authority record. (ISAD 3.2.1)
 
 :ref:`Back to the top <isad-template>`
 
-Biographical or Administative history
--------------------------------------
+Biographical or Administrative history
+--------------------------------------
 
 **Template field** N/A
 
@@ -687,7 +687,7 @@ Conditions of access and use area
 
    The data entry fields for the Conditions of access and use area in the
    ISAD(G) template, including Conditions governing access, Conditions governing
-   reproduction, Language of material, Script of material, Lanuage and script
+   reproduction, Language of material, Script of material, Language and script
    notes, Physical characteristics and technical requirements, and Finding
    aids.
 
@@ -1179,7 +1179,7 @@ Description control area
    :alt: An image of the data entry fields in the Description control area
 
    The data entry fields for the Description control are in the ISAD(G) template,
-   including Description identifier, Institution identidier, Rules or
+   including Description identifier, Institution identifier, Rules or
    conventions, Status, Level of detail, Dates of creation, revision and
    deletion, Language(s), Script(s), Sources and Archivist's notes.
 

user-manual/data-templates/premis-template.rst

@@ -61,7 +61,7 @@ values, drawn from PREMIS, are:
 * Policy
 * Statute
 
-A user with suffient :term:`permissions <access privilege>` can modify
+A user with sufficient :term:`permissions <access privilege>` can modify
 existing terms or add new terms to the taxonomy. When new terms are added,
 they will show up in the configurable Permissions table found in **Admin >
 Settings > Permissions**. For more information, see:

user-manual/data-templates/rad-template.rst

@@ -674,7 +674,7 @@ Issuing jurisdiction and denomination (philatelic)
 issuing the philatelic records." (RAD 12.3B1) "For all units possessing a
 denomination (e.g., postage stamps, revenue stamps, postal stationery items),
 give the denomination in a standardized format, recording the denomination
-number in arabic numerals followed by the name of the currency unit. Include a
+number in Arabic numerals followed by the name of the currency unit. Include a
 denomination statement even if the denomination is already recorded as part of
 the title proper or other title information." (RAD 12.3C1)
 
@@ -738,7 +738,7 @@ create and link to a new authority record.
 
    When entering the description manually, the Creator field is found in the
    RAD template  within the Dates of creation :term:`information area`,
-   labeled as "Actor name."
+   labelled as "Actor name."
 
 .. IMPORTANT::
 
@@ -1047,7 +1047,7 @@ Physical description
 **CSV Column** ``extentAndMedium``
 
 **RAD Rule** "At all levels record the extent of the unit being described by
-giving the number of physical units in arabic numerals and the specific
+giving the number of physical units in Arabic numerals and the specific
 material designation as instructed in subrule .5B in the chapter(s) dealing
 with the broad class(es) of material to which the unit being described
 belongs." (RAD 1.5B1) Include other physical details and dimensions as

user-manual/getting-started/getting-started.rst

@@ -427,7 +427,7 @@ Edit
 * Groups :term:`fields <field>` by collapsible :term:`information areas
   <information area>` - :term:`fields <field>` can be hidden or displayed by
   section.
-* Provides :term:`button block` that contains buttons for saving or canceling
+* Provides :term:`button block` that contains buttons for saving or cancelling
   changes.
 * Accessible to :term:`contributors <contributor>`, :term:`editors <editor>`,
   and :term:`administrators <administrator>`; not accessible to
@@ -446,7 +446,7 @@ Edit digital object
    :alt: Example of the edit digital object page
 
    An example of the edit page for a digital object. Access this page
-   throught the "More" button in the :term:`button block` of the related
+   through the "More" button in the :term:`button block` of the related
    description.
 
 The Edit digital object page allows the authorized (i.e. logged in) User with

user-manual/glossary/glossary.rst

@@ -188,16 +188,16 @@ Glossary
     logic, a subset of algebra used for creating true/false statements
     originally developed by George Boole, a 19th century English
     mathematician. Since computers operate in binary (using ones and zeroes),
-    computer logic can often be expressed in boolen terms (true/false).
+    computer logic can often be expressed in Boolean terms (true/false).
     Boolean expressions use a number of operators, the most common of which
     are AND, OR, and NOT - using Boolean operators in terms of search queries
     (Boolean search) allows a user to limit, widen, or otherwise define a
     search in granular terms. Most modern web search engines support Boolean
     search statements,allowing complex queries to be expressed in human-
     readable form - for example, searching "fonds OR collection" would widen a
     search to include results that have either term in their title. In AtoM,
-    boolean search operators are supported in the :term:`search box` and in
-    the Adanced search menu - see: :ref:`Search <search-atom>` and
+    Boolean search operators are supported in the :term:`search box` and in
+    the Advanced search menu - see: :ref:`Search <search-atom>` and
     :ref:`Advanced search <advanced-search>`.
 
   Breadcrumb trail
@@ -271,7 +271,7 @@ Glossary
   Clipboard
     The Clipboard is a :term:`user interface` element that allows users to
     select records while searching and browsing, and add them to a list (the
-    "clipboard"), for later review or further action. Authenicated users (i.e.
+    "clipboard"), for later review or further action. Authenticated users (i.e.
     those logged in) can also perform CSV exports of Clipboard results via the
     user interface. The clipboard is **session-based** - meaning that it does
     not persist between user sessions. When you close your browser, any
@@ -298,12 +298,12 @@ Glossary
   Color picker
     A color picker is a graphical :term:`user interface` element that allows
     users to set a :term:`hex color code` when theming an element of the
-    application by selecting from a visual representation of a color pallette,
+    application by selecting from a visual representation of a color palette,
     instead of keying in alphanumeric values such as a :term:`hex color code`.
     In AtoM, the color picker is made up of a text-box where users can enter a
     :term:`hex color code`, a preview box where the color selected is
     displayed, a slider (on the right-hand side of the drop-down) where a user
-    can select a hue, and a pallette (main part of drop-down) where a user can
+    can select a hue, and a palette (main part of drop-down) where a user can
     select a tint. In AtoM a color picker is used when choosing the background
     color of an :term:`archival institution` - see:
     :ref:`change-institution-background`.
@@ -363,7 +363,7 @@ Glossary
     in all term edit pages. Examples of default converse terms include: *is the
     parent of* and *is the child of*, or *is the employer of* and *is the
     employee of*. Actor relation terms are used in the ISAAR Relationships
-    dialogue to establish relationshps between
+    dialogue to establish relationships between
     :term:`authority records <authority record>`. When one term is added as a
     relationship qualifier to an authority record, its converse term will
     automatically appear on the related authority record. A term whose converse
@@ -417,7 +417,7 @@ Glossary
     fields, separated by commas (or in some cases, another separator). Often a
     header column (i.e. the cell values in first or top row of a CSV file) is
     included, naming each column and indicating what kind of data the column
-    contains. Data is then entered using a separator or delimitor (such as a
+    contains. Data is then entered using a separator or delimiter (such as a
     comma) to indicate a separation of fields (or cells), and a line break or
     carriage return to indicate rows (i.e. different records). Most
     spreadsheet applications (such as OpenOffice Calc or MS Excel) can open
@@ -789,8 +789,8 @@ Glossary
     :ref:`atom-header-bar`.
 
   Hex color code
-    A hexidecimal color code is a method of expressing web based colors using
-    hexidecimal notation. Hexidecimal notatation is a positional numerical
+    A hexadecimal color code is a method of expressing web based colors using
+    hexadecimal notation. Hexadecimal notation is a positional numerical
     system that uses a base of 16 distinct symbols (0-9 to represent values
     zero to nine, A-F to represent values ten to fifteen) to represent binary
     notation in a more human-readable manner. In a hex color code, 6
@@ -1151,7 +1151,7 @@ Glossary
     of* and *is the employee of*, while examples of a default self-reciprocal
     terms include *is the sibling of* and *is the associate of*. Actor relation
     :term:`terms <term>` are used in the ISAAR Relationships dialogue to
-    establish relationshps between :term:`authority records <authority record>`.
+    establish relationships between :term:`authority records <authority record>`.
     When one term is added as a relationship qualifier to an authority record,
     its converse term will automatically appear on the related authority record.
     Terms marked as self-reciprocal will automatically appear similarly on

user-manual/import-export/csv-export.rst

@@ -29,7 +29,7 @@ A CSV file consists of a number of records (rows), that have identical fields,
 separated by commas (or in some cases, another separator). Often a header
 column (i.e. the cell values in first or top row of a CSV file) is included,
 naming each column and indicating what kind of data the column contains. Data
-is then entered using a separator or delimitor (such as a comma) to indicate a
+is then entered using a separator or delimiter (such as a comma) to indicate a
 separation of fields (or cells), and a line break or carriage return to
 indicate rows (i.e. different records). Most spreadsheet applications (such as
 OpenOffice Calc or MS Excel) can open CSV files and express them as a
@@ -395,7 +395,7 @@ RAD description template.
             export
 
    For public users, the download notification will remain visible as you
-   navigate around AtoM until you click the "**X**" to remove the notifcation.
+   navigate around AtoM until you click the "**X**" to remove the notification.
 
 9. On the jobs page, authenticated users will find information about the
    export job, including a download link when the task is done. Check the "Job