Skip to content

Commit 04c4abb

Browse files
committed
add initial spelling wordlist [build_translations]
1 parent cd09f50 commit 04c4abb

30 files changed

+186
-53
lines changed

conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,8 @@ def __getattr__(cls, name):
139139
'development/changelog/*',
140140
'development/changelog/mapcache/*',
141141
'development/changelog/tinyows/*',
142-
'development/rfc/*'
142+
'development/rfc/*',
143+
'mapscript/php/*'
143144
]
144145

145146
# Options for HTML output

en/MIGRATION_GUIDE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
MapServer Migration Guide
77
*****************************************************************************
88

9-
:Last Updated: 2026-03-25
9+
:Last Updated: 2026-03-29
1010

1111
.. contents:: Table of Contents
1212
:depth: 2

en/cgi/runsub.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
:Author: Steve Lime
1111
:Contact: sdlime at gmail.com
12-
:Last Updated: 2023-04-19
12+
:Last Updated: 2026-03-29
1313

1414
.. contents:: Table of Contents
1515
:depth: 2

en/development/documentation.txt

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
:Contact: hobu.inc at gmail.com
99
:Author: Jeff McKenna
1010
:Contact: jmckenna at gatewaygeomatics.com
11-
:Last Updated: 2026-03-28
11+
:Last Updated: 2026-03-29
1212

1313
.. contents:: Table of Contents
1414
:depth: 4
@@ -297,8 +297,14 @@ Installing and Using Sphinx for rst-html Generation
297297
If there are more than one translation, the above commands will automatically
298298
build all translations.
299299

300+
Spelling tools
301+
--------------
302+
303+
There are several methods to check and/or correct spelling issues in the
304+
documentation files:
305+
300306
(English) typo fixing script
301-
----------------------------
307+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
302308

303309
(Tested on Linux. Should also likely run on MacOSX. Windows users might need
304310
to install Cygwin, Python 3, git, curl, sed, grep, awk)
@@ -332,6 +338,27 @@ from CRLF to LF might be needed). scripts/typos_whitelist.txt should be used rat
332338
than WORDS_WHITE_LIST, only when a word is not a typo in a given context, but
333339
might be a typo in another context.
334340

341+
sphinxcontrib.spelling extension
342+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
343+
Here some important steps for using Sphinx's spelling extension:
344+
345+
- install the `extension <https://pypi.org/project/sphinxcontrib-spelling/>`__, such as:
346+
347+
::
348+
349+
python -m pip install sphinxcontrib-spelling==8.0.2
350+
351+
- the wordlist for MapServer is located in `/en/spelling_wordlist.dict <https://github.com/MapServer/MapServer-documentation/blob/main/en/spelling_wordlist.dict>`__
352+
353+
- edit the `options <https://sphinxcontrib-spelling.readthedocs.io/en/latest/customize.html>`__
354+
for the extension in your local `conf.py` (see the "spelling extension options" section),
355+
and make sure that the extension is enabled (see the "General configuration" section)
356+
357+
- run the spellcheck with:
358+
359+
::
360+
361+
make spelling
335362

336363
How translations are handled
337364
----------------------------

en/development/rfc/ms-rfc-58.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Supported Folder elements are:
128128
+-------------------------------------------------------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
129129
| TimePrimitive | No | |
130130
+-------------------------------------------------------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
131-
| styleUrl | Yes | The user can use the kml_folder_display layer or map level metedata to choose a setting. Possible values are 'check' (default), 'radioFolder', 'checkOffOnly', 'checkHideChildren'. |
131+
| styleUrl | Yes | The user can use the kml_folder_display layer or map level metadata to choose a setting. Possible values are 'check' (default), 'radioFolder', 'checkOffOnly', 'checkHideChildren'. |
132132
+-------------------------------------------------------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
133133
| RegionMetadataExtendedData | No | |
134134
+-------------------------------------------------------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -206,11 +206,11 @@ General notes on layers
206206
- Labelcache is turned off on each layer
207207
- Projection block should be set. If not set It will be assumed that the data is in lat/lon projection (a debug message will be sent to the user: Debug Message 1)
208208
- Possible to output vector layers as raster using metadata: "KML_OUTPUTASRASTER" "true"
209-
- The user can use the KML_FOLDER_DSIPLAY layer or map level metedata to choose a setting. Possible values are 'check' (default), 'radioFolder', 'checkOffOnly', 'checkHideChildren'.
210-
- The user can use metedata KML_DESCRIPTION or KML_INCLUDE_ITEMS to define the description attached to each feature.
211-
- The user can use metedata KML_ALTITUDEMODE to specify how altitude components in the <coordinates> element are interpreted. Possible values are: absolute, relativeToGround, clampToGround. https://developers.google.com/kml/documentation/kmlreference?csw=1#altitudemode
212-
- The user can use metedata KML_EXTRUDE to specify whether to connect the LinearRing to the ground. https://developers.google.com/kml/documentation/kmlreference?csw=1#tessellate
213-
- The user can use metedata KML_TESSELLATE to specify whether to allow the LinearRing to follow the terrain. https://developers.google.com/kml/documentation/kmlreference?csw=1#extrude
209+
- The user can use the KML_FOLDER_DSIPLAY layer or map level metadata to choose a setting. Possible values are 'check' (default), 'radioFolder', 'checkOffOnly', 'checkHideChildren'.
210+
- The user can use metadata KML_DESCRIPTION or KML_INCLUDE_ITEMS to define the description attached to each feature.
211+
- The user can use metadata KML_ALTITUDEMODE to specify how altitude components in the <coordinates> element are interpreted. Possible values are: absolute, relativeToGround, clampToGround. https://developers.google.com/kml/documentation/kmlreference?csw=1#altitudemode
212+
- The user can use metadata KML_EXTRUDE to specify whether to connect the LinearRing to the ground. https://developers.google.com/kml/documentation/kmlreference?csw=1#tessellate
213+
- The user can use metadata KML_TESSELLATE to specify whether to allow the LinearRing to follow the terrain. https://developers.google.com/kml/documentation/kmlreference?csw=1#extrude
214214

215215

216216

en/download.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ MapServer 7.x (Itasca) Demo
244244
The original MapServer Itasca demo (which does not work with recent MapServer
245245
versions) can still be `downloaded <https://download.osgeo.org/mapserver/docs/workshop-5.4.zip>`__.
246246

247-
MapServer 7.x Tutoral + data
247+
MapServer 7.x Tutorial + data
248248
The MapServer 7 tutorial, including all working mapfiles, highway shield icons,
249249
and data, is available for `download <https://download.osgeo.org/mapserver/docs/mapserver-tutorial.zip>`__.
250250
More info can be found on the :ref:`Tutorial Background <tutorial_background>` page.

en/input/raster.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
:Contact: warmerdam at pobox.com
1212
:Author: Jeff McKenna
1313
:Contact: jmckenna at gatewaygeomatics.com
14-
:Last Updated: 2022-08-20
14+
:Last Updated: 2026-03-29
1515

1616
.. contents:: Table of Contents
1717
:depth: 2

en/input/vector/ogr.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ OGR Vector Layers Through MapServer
99

1010
:Author: Jeff McKenna
1111
:Contact: jmckenna at gatewaygeomatics.com
12-
:Last Updated: 2021-05-06
12+
:Last Updated: 2026-03-29
1313

1414
.. contents:: Table of Contents
1515
:depth: 3

en/input/vector/oracle.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:Author: Bart van den Eijnden
88
:Author: Jeff McKenna
99
:Contact: jmckenna at gatewaygeomatics.com
10-
:Last Updated: 2026-03-28
10+
:Last Updated: 2026-03-29
1111

1212
.. contents:: Table of Contents
1313
:depth: 4

en/mapfile/encoding.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
:Author: Jeff McKenna
1111
:Contact: jmckenna at gatewaygeomatics.com
12-
:Last Updated: 2020-10-28
12+
:Last Updated: 2026-03-29
1313

1414
.. contents:: Table of Contents
1515
:depth: 3
@@ -42,7 +42,7 @@ Requirements
4242
.. note::
4343

4444
In terms of map labels with international characters, since the MapServer 7.0 release,
45-
other important dependant libaries besides libiconv are `Freetype <https://www.freetype.org/>`__
45+
other important dependent libraries besides libiconv are `Freetype <https://www.freetype.org/>`__
4646
(to get information about glyph sizes), `Fribidi <https://github.com/fribidi/fribidi>`__
4747
(to handle bidirectional text), and `Harfbuzz <https://github.com/harfbuzz/harfbuzz>`__
4848
(for text shaping).

0 commit comments

Comments
 (0)