Skip to content

Commit 1bb72d6

Browse files
committed
Spelling fixes, thanks to @jschleus.
1 parent e03fee5 commit 1bb72d6

37 files changed

+72
-72
lines changed

README/CODESTYLE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ From reading of the Tidy source, some things are self evident, in no particular
1616

1717
- Use of 4-space indenting, and no tabs.
1818
- No C++ single line comments using `//`.
19-
- The openning `{` is indented on the next newline.
19+
- The opening `{` is indented on the next newline.
2020
- While the maximum code line length varies, generally long `if`, `while`, ... statements are wrapped to newlines.
2121
- Pointer operators in declarations must precede any macro documentation, e.g, `const tidyLocaleMapItem* TIDY_CALL getNextWindowsLanguage( TidyIterator* iter )` instead of `const tidyLocaleMapItem TIDY_CALL *getNextWindowsLanguage( TidyIterator* iter )` in case `TIDY_CALL` is defined.
2222

README/MESSAGES.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,6 @@ Note that Tidy doesn't currently support numbered `printf` parameters; parameter
3636

3737
The last step — hopefully — is adding the message key to the `dispatchTable[]` structure in `message.c`. This structure determines the `TidyReportLevel` (report severity) and message formatter (how to print the message). Then whenever you issue the report with `TY_(Report)()` or one of the existing convenience report functions, the correct message formatter will be used for the parameters that you specify.
3838

39-
Please read the source code in `message.c` for help on how to choose a message formatter, or how to modify one of the existing message formatters if you need to accomodate a new function signature for your report.
39+
Please read the source code in `message.c` for help on how to choose a message formatter, or how to modify one of the existing message formatters if you need to accommodate a new function signature for your report.
4040

4141
eof;

README/OPTIONS.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Tidy supports a quite large number of configuration options. The full list can be output using `-help-config`. This will show the option to be used either on the command line or in a configuration file, the type of option, and the value(s) that can be used. The current default value for each option can be seen using `-show-config`.
44

5-
The options can also be listed in xml format. `-xml-help` will output each option plus a description. `-xml-config` will not only output the option and a desciption, but will include the type, default and examples. These xml outputs are used, with the aid of `xsltproc` and `doxygen`, to generate the [API Documentation](http://api.html-tidy.org/).
5+
The options can also be listed in xml format. `-xml-help` will output each option plus a description. `-xml-config` will not only output the option and a description, but will include the type, default and examples. These xml outputs are used, with the aid of `xsltproc` and `doxygen`, to generate the [API Documentation](http://api.html-tidy.org/).
66

77
These options can also be used by application linking with `libtidy`. For each option there is a `TidyOptionId` enumeration in the `tidyenum.h` file, and get/set functions for each option type.
88

@@ -17,7 +17,7 @@ This file indicates how to add a new option to tidy, here adding an option `Tidy
1717

1818
In `tidyenum.h` the `TidyOptionId` can be in any order, but please try to keep things alphabetical, and keep in mind that `N_TIDY_OPTIONS` must remain the last. Choosing the id name can be any string, but by convention it will commence with `Tidy` followed by brief descriptive text.
1919

20-
Naturally it can not be the same as any exisitng option. That is, it must be unique. And it will be followed by a brief descriptive special doxygen formatted comment. So for this new option I have chosen -
20+
Naturally it can not be the same as any existing option. That is, it must be unique. And it will be followed by a brief descriptive special doxygen formatted comment. So for this new option I have chosen -
2121

2222
~~~
2323
TidyEscapeScripts, /**< Escape items that look like closing tags */
@@ -105,7 +105,7 @@ The `key` is the option `ID`; The `pluralForm` is not used for options, and shou
105105

106106
Some care has to be taken with the description string. The only html allowed here is `<code>...</code>`, `<var>...</var>`, `<em>...</em>`, `<strong>...</strong>`, and `<br/>`. Entities, tags, attributes, etc., should be enclosed in `<code>...</code>`. Option values should be enclosed in `<var>...</var>`. It's very important that `<br/>` be self-closing! This string is processed to build the API documentation.
107107

108-
This is the desription added for this new option.
108+
This is the description added for this new option.
109109

110110
~~~
111111
{

README/README.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ <h2 id="prerequisites">Prerequisites</h2>
1111

1212
<p>CMake comes in two forms - command line and GUI. Some installations only install one or the other, but sometimes both. The build commands below are only for command line use.</p>
1313

14-
<p>Also the actual build tools vary for each platform. But that is one of the great features of CMake, it can generate variuous &#8216;native&#8217; build files. Running <code>cmake --help</code> should list the generators available on that platform. For sure one of the common ones is &#8220;Unix Makefiles&#8221;, which needs autotools make installed, but many other generators are supported.</p>
14+
<p>Also the actual build tools vary for each platform. But that is one of the great features of CMake, it can generate various &#8216;native&#8217; build files. Running <code>cmake --help</code> should list the generators available on that platform. For sure one of the common ones is &#8220;Unix Makefiles&#8221;, which needs autotools make installed, but many other generators are supported.</p>
1515

1616
<p>In Windows CMake offers various versions for MSVC. Again below only the command line use of MSVC is shown, but the tidy solution (*.sln) file can be loaded into the MSVC IDE, and the building done in there.</p>
1717

README/TAGS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This is about adding a new HTML **tag**.
44

5-
Tidy tries to support all **tags** supported by the W3C. To add a new supported **tag**, the defintion begins in `tidyenum.h`, to give it a value. Then it is added to the `tag_defs[]` table in `tags.c`, where it is given a unique string, supported html versions, attributes support, and a bit `type`.
5+
Tidy tries to support all **tags** supported by the W3C. To add a new supported **tag**, the definition begins in `tidyenum.h`, to give it a value. Then it is added to the `tag_defs[]` table in `tags.c`, where it is given a unique string, supported html versions, attributes support, and a bit `type`.
66

77
Note, there are a group of configuration options to add **tags** not yet approved by the W3C. These are [new-blocklevel-tags](http://api.html-tidy.org/tidy/quickref_5.2.0.html#new-blocklevel-tags), [new-empty-tags](http://api.html-tidy.org/tidy/quickref_5.2.0.html#new-empty-tags), [new-inline-tags](http://api.html-tidy.org/tidy/quickref_5.2.0.html#new-inline-tags). and [new-pre-tags](http://api.html-tidy.org/tidy/quickref_5.2.0.html#new-pre-tags). This provides a way to extend the `tag_defs[]` table just for that tidy session.
88

README/TESTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ write at least one test case in `github-cases` and put the expected results in
3737
importantly, will become part of the standard regression testing suite once the
3838
PR is merged.
3939

40-
Try to keep your test case(s) as succint as possible, and do try to put some HTML
40+
Try to keep your test case(s) as succinct as possible, and do try to put some HTML
4141
comments in the file explaining the purpose of the test case, and if applicable,
4242
the Github issue and/or PR number.
4343

@@ -69,4 +69,4 @@ determined that a standards change #yyyy impacts us because of zzz.
6969

7070
## Regression Testing Specifics
7171

72-
The regression testing mechanism is described more fully in [regression_testing/README.md](../regression_testing/README.md).
72+
The regression testing mechanism is described more fully in [regression_testing/README.md](../regression_testing/README.md).

README/VERSION.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ add_definitions ( -DLIBTIDY_VERSION="${LIBTIDY_VERSION}" )
7070
add_definitions ( -DRELEASE_DATE="${tidy_YEAR}/${tidy_MONTH}/${tidy_DAY}" )
7171
~~~
7272

73-
And in `CMakeLists.txt` there is the posibility to define another macro, when and if required:
73+
And in `CMakeLists.txt` there is the possibility to define another macro, when and if required:
7474

7575
~~~
7676
# add_definitions ( -DRC_NUMBER="D231" )

build/cmake/build-api.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ TMPZFIL="../../documentation/$TMPZIP"
3737
if [ -f "$TMPZFIL" ]; then
3838
ls -l $TMPZFIL
3939
echo "$BN: WARNING: Current ZIP will be overwritten!"
40-
echo "$BN: DO you want to coninue?"
40+
echo "$BN: DO you want to continue?"
4141
ask
4242
fi
4343

@@ -49,7 +49,7 @@ if [ ! -x "$TMPFIL" ]; then
4949
fi
5050

5151
if [ -d "$TMPDIR" ]; then
52-
echo "$BN: Directory '$TMPDIR' will be deleted prior the documentaion build..."
52+
echo "$BN: Directory '$TMPDIR' will be deleted prior the documentation build..."
5353
fi
5454

5555
./$TMPFIL -DBUILD_DOCUMENTATION:BOOL=YES

build/cmake/build-me.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
@if "%TMPINDBG%x" == "1x" (
6767
@echo Will install Debug and Release
6868
) else {
69-
@echo Will only intall Release
69+
@echo Will only install Release
7070
)
7171
@echo.
7272

build/win64/build-me.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
@if "%TMPINDBG%x" == "1x" (
6868
@echo Will install Debug and Release
6969
) else (
70-
@echo Will only intall Release
70+
@echo Will only install Release
7171
)
7272
@echo.
7373

console/tidy.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ typedef enum
310310
CmdOptCatLAST
311311
} CmdOptCategory;
312312

313-
/** This array contains headings that will be used in help ouput.
313+
/** This array contains headings that will be used in help output.
314314
*/
315315
static const struct {
316316
ctmbstr mnemonic; /**< Used in XML as a class. */
@@ -649,7 +649,7 @@ static void getSortedOption(TidyDoc tdoc, /**< The Tidy document. */
649649
tOption->topt[i] = NULL; /* sentinel */
650650

651651
qsort(tOption->topt,
652-
i, /* there are i items, not including the sentinal */
652+
i, /* there are i items, not including the sentinel */
653653
sizeof(tOption->topt[0]),
654654
cmpOpt);
655655
}
@@ -2224,7 +2224,7 @@ int main( int argc, char** argv )
22242224
else if ( strcasecmp(arg, "quiet") == 0 )
22252225
tidyOptSetBool( tdoc, TidyQuiet, yes );
22262226

2227-
/* Currenly user must specify a language
2227+
/* Currently user must specify a language
22282228
prior to anything that causes output */
22292229
else if ( strcasecmp(arg, "language") == 0 ||
22302230
strcasecmp(arg, "lang") == 0 )

experimental/httpio.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ int parseURL( HTTPInputSource *pHttp, tmbstr url )
7676
if (!pHttp->nPort)
7777
return -1;
7878
}
79-
else /* or just a misformed port number */
79+
else /* or just a malformed port number */
8080
return -1;
8181
}
8282
else

include/tidyenum.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -627,7 +627,7 @@ typedef enum
627627
TidyOutCharEncoding, /**< Output character encoding (if different) */
628628
TidyOutFile, /**< File name to write markup to */
629629
TidyOutputBOM, /**< Output a Byte Order Mark (BOM) for UTF-16 encodings */
630-
TidyPPrintTabs, /**< Indent using tabs istead of spaces */
630+
TidyPPrintTabs, /**< Indent using tabs instead of spaces */
631631
TidyPreserveEntities, /**< Preserve entities */
632632
TidyPreTags, /**< Declared pre tags */
633633
TidyPriorityAttributes, /**< Attributes to place first in an element */
@@ -646,7 +646,7 @@ typedef enum
646646
TidySkipNested, /**< Skip nested tags in script and style CDATA */
647647
TidySortAttributes, /**< Sort attributes */
648648
TidyStrictTagsAttr, /**< Ensure tags and attributes match output HTML version */
649-
TidyStyleTags, /**< Move sytle to head */
649+
TidyStyleTags, /**< Move style to head */
650650
TidyTabSize, /**< Expand tabs to n spaces */
651651
TidyUpperCaseAttrs, /**< Output attributes in upper not lower case */
652652
TidyUpperCaseTags, /**< Output tags in upper not lower case */

include/tidyplatform.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
*
1111
* @note It should be largely unnecessary to modify this file unless adding
1212
* support for a completely new architecture. Most options defined in this
13-
* file specify defaults that can be overriden by the build system; for
13+
* file specify defaults that can be overridden by the build system; for
1414
* example, passing -D flags to CMake.
1515
*
1616
* @author Charles Reitzel [[email protected]]

localize/language_ll_cc.h.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
*
2727
* Template Created by Jim Derry on 01/14/2016.
2828
*
29-
* Orginating PO file metadata:
29+
* Originating PO file metadata:
3030
* PO_LAST_TRANSLATOR=<%= po_content.last_translator %>
3131
* PO_REVISION_DATE=<%= po_content.po_revision_date %>
3232
*/

regression_testing/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Running Test Tests
9797

9898
### Preparing the Environment
9999

100-
Assuming that you have a working Ruby interpretor, version 2.7 or so, upon
100+
Assuming that you have a working Ruby interpreter, version 2.7 or so, upon
101101
`CD`-ing into the `tidy-html5-test` directory, you should execute `bundle
102102
install`, which ensures that any dependencies that your environment doesn’t
103103
already have will be downloaded.
@@ -155,7 +155,7 @@ set of case files).
155155

156156
- Optional Tidy configuration files shall be named `case-basename.conf`.
157157

158-
- In the absense of a configuration file, the file `config_default.conf` in
158+
- In the absence of a configuration file, the file `config_default.conf` in
159159
each directory will be used instead.
160160

161161
- `README<.txt|.md>`, which describes the test set.

regression_testing/test.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ def case_paths
135135
case_name = File.basename( html_file[/(.*)@/,1] )
136136
candidate_expects_html = File.join( self.dir_expects, "#{case_name}#{File.extname(html_file)}" )
137137
candidate_expects_output = File.join( self.dir_expects, "#{case_name}.txt" )
138-
#noinspection RubyNilAnalysis -- this is a false positive, because we've explicitely made this an array.
138+
#noinspection RubyNilAnalysis -- this is a false positive, because we've explicitly made this an array.
139139
@case_paths.push(html_file)
140140
unless File.exist?(candidate_expects_html) && File.exist?(candidate_expects_output)
141141
SHARED_LOGGER.warn("Note: #{html_file} is missing some expectations files in #{self.dir_expects}.")

src/access.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -540,7 +540,7 @@ static Bool IsValidSrcExtension( ctmbstr sType )
540540
/*********************************************************************
541541
* IsValidMediaExtension
542542
*
543-
* Checks to warn the user that syncronized text equivalents are
543+
* Checks to warn the user that synchronized text equivalents are
544544
* required if multimedia is used.
545545
*********************************************************************/
546546

@@ -2545,7 +2545,7 @@ static void CheckParagraphHeader( TidyDocImpl* doc, Node* node )
25452545
* CheckEmbed
25462546
*
25472547
* Checks to see if 'SRC' is a multimedia type. Must have
2548-
* syncronized captions if used.
2548+
* synchronized captions if used.
25492549
****************************************************************/
25502550

25512551
static void CheckEmbed( TidyDocImpl* doc, Node* node )
@@ -3426,7 +3426,7 @@ static void AccessibilityCheckNode( TidyDocImpl* doc, Node* node )
34263426
CheckParagraphHeader( doc, node );
34273427
}
34283428

3429-
/* Checks HTML elemnt for valid 'LANG' */
3429+
/* Checks HTML element for valid 'LANG' */
34303430
else if ( nodeIsHTML(node) )
34313431
{
34323432
CheckHTMLAccess( doc, node );

src/attrs.c

+4-4
Original file line numberDiff line numberDiff line change
@@ -1333,7 +1333,7 @@ static void AppendToStyleAttr( TidyDocImpl* doc, AttVal *styleattr, ctmbstr styl
13331333

13341334
if (end >0 && styleattr->value[end - 1] == ';')
13351335
{
1336-
/* attribute ends with declaration seperator */
1336+
/* attribute ends with declaration separator */
13371337

13381338
styleattr->value = (tmbstr) TidyDocRealloc(doc, styleattr->value,
13391339
end + TY_(tmbstrlen)(styleprop) + 2);
@@ -1894,7 +1894,7 @@ void CheckIs( TidyDocImpl* doc, Node *node, AttVal *attval )
18941894

18951895
/* Even if we fail the above test, we'll continue to emit reports because
18961896
the user should *also* know that his attribute values are wrong, even
1897-
if they should't be in custom tags anyway. */
1897+
if they shouldn't be in custom tags anyway. */
18981898

18991899
/* `is` MUST have a value */
19001900
if (!AttrHasValue(attval))
@@ -2103,7 +2103,7 @@ void CheckNumber( TidyDocImpl* doc, Node *node, AttVal *attval)
21032103
/* font size may be preceded by + or - */
21042104
if ( nodeIsFONT(node) && (*p == '+' || *p == '-') )
21052105
++p;
2106-
/* tabindex may be preceeded by - */
2106+
/* tabindex may be preceded by - */
21072107
if (attval->attribute && (strcmp(attval->attribute,"tabindex") == 0) && (*p == '-'))
21082108
++p;
21092109

@@ -2472,7 +2472,7 @@ void TY_(SortAttributes)(TidyDocImpl* doc, Node* node, TidyAttrSortStrategy stra
24722472
*
24732473
* Portions copyright Simon Tatham 2001.
24742474
*
2475-
* Merge sort algortithm adpated from listsort.c linked from
2475+
* Merge sort algorithm adapted from listsort.c linked from
24762476
* http://www.chiark.greenend.org.uk/~sgtatham/algorithms/listsort.html
24772477
*
24782478
* Original copyright notice proceeds below.

src/clean.c

+6-6
Original file line numberDiff line numberDiff line change
@@ -1339,7 +1339,7 @@ static Bool InlineElementToCSS( TidyDocImpl* doc, Node* node,
13391339
ctmbstr CSSeq;
13401340

13411341
/* if node is the only child of parent element then leave alone
1342-
Do so only if BlockStyle may be succesful. */
1342+
Do so only if BlockStyle may be successful. */
13431343
if ( node->parent->content == node && node->next == NULL &&
13441344
(CanApplyBlockStyle(node->parent)
13451345
|| CanApplyInlineStyle(node->parent)) )
@@ -1366,7 +1366,7 @@ static Bool Font2Span( TidyDocImpl* doc, Node *node, Node **pnode )
13661366
if ( nodeIsFONT(node) )
13671367
{
13681368
/* if node is the only child of parent element then leave alone
1369-
Do so only if BlockStyle may be succesful. */
1369+
Do so only if BlockStyle may be successful. */
13701370
if ( node->parent->content == node && node->next == NULL &&
13711371
CanApplyBlockStyle(node->parent) )
13721372
return no;
@@ -1882,7 +1882,7 @@ static Bool SingleSpace( Lexer* lexer, Node* node )
18821882
*/
18831883
void TY_(CleanWord2000)( TidyDocImpl* doc, Node *node)
18841884
{
1885-
/* used to a list from a sequence of bulletted p's */
1885+
/* used to a list from a sequence of bulleted p's */
18861886
Lexer* lexer = doc->lexer;
18871887
Node* list = NULL;
18881888
AttVal *next_attr, *attval;
@@ -1896,7 +1896,7 @@ void TY_(CleanWord2000)( TidyDocImpl* doc, Node *node)
18961896
if ( !TY_(IsWord2000) (doc) ) /* Is. #896 */
18971897
return;
18981898

1899-
/* Output proprietary attributes to maintain errout compatability
1899+
/* Output proprietary attributes to maintain errout compatibility
19001900
* with traditional Tidy. This is a result of moving all of the
19011901
* proprietary checks to near the end of the cleanup process,
19021902
* meaning this result would not ordinarily be displayed.
@@ -1984,7 +1984,7 @@ void TY_(CleanWord2000)( TidyDocImpl* doc, Node *node)
19841984
/* discards <o:p> which encodes the paragraph mark */
19851985
if ( node->tag && TY_(tmbstrcmp)(node->tag->name,"o:p")==0)
19861986
{
1987-
/* Output proprietary elements to maintain errout compatability
1987+
/* Output proprietary elements to maintain errout compatibility
19881988
* with traditional Tidy. This is a result of moving all of the
19891989
* proprietary checks to near the end of the cleanup process,
19901990
* meaning this result would not ordinarily be displayed.
@@ -2303,7 +2303,7 @@ Bool TY_(TidyMetaCharset)(TidyDocImpl* doc)
23032303
}
23042304
else
23052305
{
2306-
/* fix a mis-match */
2306+
/* fix a mismatch */
23072307
if (charsetFound)
23082308
{
23092309
prevNode = currentNode->prev;

src/config.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* continues on the next line
1515
*
1616
* Property names are case insensitive and should be less than 60 characters
17-
* in length, and must start at the begining of the line, as whitespace at
17+
* in length, and must start at the beginning of the line, as whitespace at
1818
* the start of a line signifies a line continuation.
1919
*
2020
* @author HTACG, et al (consult git log)
@@ -173,7 +173,7 @@ TY_PRIVATE const TidyOptionImpl* TY_(getNextOption)( TidyDocImpl* doc, TidyItera
173173
/** Initiates an iterator to cycle through all of the available picklist
174174
** possibilities.
175175
** @param option An instance of an option for which to iterate a picklist.
176-
** @returns An interator token to be used with TY_(getNextOptionPick)().
176+
** @returns An iterator token to be used with TY_(getNextOptionPick)().
177177
*/
178178
TY_PRIVATE TidyIterator TY_(getOptionPickList)( const TidyOptionImpl* option );
179179

0 commit comments

Comments
 (0)