Skip to content

Commit 06d26d4

Browse files
sideshowbarkersideshowbarker
committed
"validator" -> "markup checker"
1 parent 94acac8 commit 06d26d4

3 files changed

Lines changed: 52 additions & 53 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
# How to use the vnu.jar validator
1+
# How to use the vnu.jar markup checker
22

33
The `vnu.jar` application is a portable standalone version of the validator.nu
4-
validator. The [latest version][1] is available from the validator area at
5-
github. The following are instructions on how to use it to validate documents.
4+
markup checker. The [latest version][1] is available from the `validator`
5+
project at github. The following are instructions on how to use it to check the
6+
markup of documents.
67

78
[1]: https://github.com/validator/validator.github.io/releases
89

@@ -11,8 +12,8 @@ github. The following are instructions on how to use it to validate documents.
1112

1213
## Usage
1314

14-
You can use the `vnu.jar` validator as an executable for command-line validation
15-
of HTML documents by invoking it like this:
15+
You can use the `vnu.jar` markup checker as an executable for command-line
16+
checking of HTML documents by invoking it like this:
1617

1718
java -jar ~/vnu.jar [--entities] [--errors-only] [--no-stream]
1819
[--format gnu|xml|json|text] [--help] [--html] [--schema URL]
@@ -59,7 +60,7 @@ executable provides the following options:
5960

6061
#### --format _format_
6162

62-
Specifies the output format for validation results.
63+
Specifies the output format for reporting the results.
6364

6465
default: "gnu"
6566

@@ -92,26 +93,24 @@ executable provides the following options:
9293
#### --schema _URL_
9394

9495
Specifies a URL for a known http://s.validator.nu/* schema to use for
95-
document validation.
96+
document checking.
9697

9798
default: http://s.validator.nu/html5-all.rnc
9899

99100
#### --verbose
100101

101-
Specifies that the validator output should be "verbose". (Currently this
102-
just means that the names of files being validated are written to stdout.)
102+
Specifies that the output should be "verbose". (Currently this just means
103+
that the names of files being validated are written to stdout.)
103104

104105
default: [unset; output is not verbose]
105106

106107
#### --version
107108

108109
Shows the vnu.jar version number.
109110

110-
For details on using the `vnu.jar` validator to provide a service for
111-
browser-based validation of HTML documents over the Web, see [Using vnu.jar for
112-
Web-based validation][3].
111+
For details on using the `vnu.jar` markup checker to provide a service for
112+
browser-based checking of HTML documents over the Web, see [Using vnu.jar for
113+
Web-based markup checking][3].
113114

114115
[3]: http://validator.github.io/service.html
115116

116-
For more information... sources bugz etc.
117-

‎index.html‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
<!doctype html><html><head><meta charset=utf-8>
2-
<title>How to use the vnu.jar validator</title></head>
2+
<title>How to use the vnu.jar markup checker</title></head>
33
<body>
4-
<h1>How to use the vnu.jar validator</h1>
4+
<h1>How to use the vnu.jar markup checker</h1>
55

66
<p>The <code>vnu.jar</code> application is a portable standalone
7-
version of the validator.nu validator. The
7+
version of the validator.nu markup checker. The
88
<a href="https://github.com/validator/validator.github.io/releases"
99
>latest version</a>
10-
is available from the validator area at github.
11-
The following are instructions on how to use it to validate documents.
10+
is available from the <code>validator</code> project at github.
11+
The following are instructions on how to use it to check the markup of
12+
documents.
1213

1314
<p class=note><b>Note:</b> In the instructions, replace
1415
<var>"~/vnu.jar"</var> with the actual path to the <code>vnu.jar</code>
@@ -22,8 +23,8 @@ <h1>How to use the vnu.jar validator</h1>
2223
<section id=usage>
2324
<h2>Usage</h2>
2425

25-
<p>You can use the <code>vnu.jar</code> validator as an executable for
26-
command-line validation of HTML documents by invoking it like this:
26+
<p>You can use the <code>vnu.jar</code> markup checker as an executable for
27+
command-line checking of HTML documents by invoking it like this:
2728
<pre>
2829
java -jar ~/vnu.jar [--entities] [--errors-only] [--no-stream]
2930
[--format gnu|xml|json|text] [--help] [--html]
@@ -76,7 +77,7 @@ <h4 id="errors-only">--errors-only</h4>
7677

7778
<h4 id="format">--format <var>format</var></h4>
7879
<pre>
79-
Specifies the output format for validation results.
80+
Specifies the output format for reporting the results.
8081

8182
default: <span class=option-value>"gnu"</span>
8283

@@ -110,15 +111,15 @@ <h4 id="no-stream">--no-stream</h4>
110111
<h4 id="schema-url">--schema <var>URL</var></h4>
111112
<pre>
112113
Specifies a URL for a known http://s.validator.nu/* schema to use for
113-
document validation.
114+
document checking.
114115

115116
default: <span class=option-value>http://s.validator.nu/html5-all.rnc</span>
116117
</pre>
117118

118119
<h4 id="verbose">--verbose</h4>
119120
<pre>
120-
Specifies that the validator output should be "verbose". (Currently this
121-
just means that the names of files being validated are written to stdout.)
121+
Specifies that the output should be "verbose". (Currently this just means
122+
that the names of files being validated are written to stdout.)
122123

123124
default: [unset; output is not verbose]
124125
</pre>
@@ -130,12 +131,12 @@ <h4 id="version">--version</h4>
130131
</section>
131132
</div>
132133

133-
<p>For details on using the <code>vnu.jar</code> validator to provide a
134-
service for browser-based validation of HTML documents over the Web, see
135-
<a href="http://validator.github.io/service.html">Using vnu.jar for Web-based validation</a>.
134+
<p>For details on using the <code>vnu.jar</code> markup checker to provide a
135+
service for browser-based checking of HTML documents over the Web, see
136+
<a href="http://validator.github.io/service.html">Using vnu.jar for Web-based markup checking</a>.
136137

137-
<p>
138-
For more information... sources bugz etc.
138+
139+
<!-- TODO: For more information... sources bugz etc. -->
139140

140141
<style type="text/css">
141142
html {

‎service.html‎

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
<!doctype html><html><head><meta charset=utf-8>
2-
<title>Using vnu.jar for Web-based validation</title></head>
2+
<title>Using vnu.jar for Web-based markup checking</title></head>
33
<body>
4-
<h1>Using vnu.jar for Web-based validation</h1>
4+
<h1>Using vnu.jar for Web-based markup checking</h1>
55

66
<p>The <code>vnu.jar</code> application is a portable standalone
7-
version of the validator.nu validator. The
7+
version of the validator.nu markup checker. The
88
<a href="https://github.com/validator/validator.github.io/releases"
99
>latest version</a>
10-
is available from the validator area at github.
10+
is available from the <code>validator</code> project at github.
1111
The following are instructions on how to use it to provide a
12-
service for browser-based validation of HTML documents over the Web.
12+
service for browser-based checking of HTML documents over the Web.
1313

1414
<p class=note><b>Note:</b> In the instructions, replace
1515
<var>"~/vnu.jar"</var> with the actual path to the <code>vnu.jar</code>
@@ -25,14 +25,14 @@ <h1>Using vnu.jar for Web-based validation</h1>
2525
<h2>Web-based usage</h2>
2626

2727
<p>You can use <code>vnu.jar</code> to provide a service for
28-
browser-based validation of HTML documents over the Web, similar to
28+
browser-based checking of HTML documents over the Web, similar to
2929
<a href="http://html5.validator.nu/">http://html5.validator.nu/</a>
3030
and
3131
<a href="http://validator.w3.org/nu/">http://validator.w3.org/nu/</a>.
32-
The service also includes a REST API for providing validation of HTML
32+
The service also includes a REST API for providing checking of HTML
3333
documents to non-browser clients.
3434

35-
<p>To run the validator as a service, open a new terminal window
35+
<p>To run the markup checker as a service, open a new terminal window
3636
and invoke <code>vnu.jar</code> like this:
3737

3838
<pre>
@@ -41,24 +41,24 @@ <h2>Web-based usage</h2>
4141

4242
<p>Then open
4343
<a href="http://localhost:8888">http://localhost:8888</a>
44-
in a browser. (To have the validator listen on a different port,
44+
in a browser. (To have the markup checker listen on a different port,
4545
replace <code class=arg>8888</code> with the port number.)
4646

4747
<p>You’ll see a form similar to
4848
<a href="http://validator.w3.org/nu/">http://validator.w3.org/nu/</a>
4949
that allows you to enter the URL of an HTML document and have the
50-
validation results for that document displayed in the browser.
50+
results for that document displayed in the browser.
5151

5252
<section id=http-client>
53-
<h2>HTTP client (for fast command-line validation)</h2>
53+
<h2>HTTP client (for fast command-line checking)</h2>
5454

5555
<p>You can also use <code>vnu.jar</code> from the command line to send
5656
HTML documents to a locally-running instance of the HTTP service for
57-
validation. To validate documents in that way, do this:
57+
checking. To check documents in that way, do this:
5858

5959
<ol>
6060

61-
<li>Open a new terminal window and start up the validator as an HTTP
61+
<li>Open a new terminal window and start up the markup checker as an HTTP
6262
service, as described in the
6363
"<a href="#web-based-usage">Web-based usage</a>" section.
6464

@@ -73,11 +73,11 @@ <h2>HTTP client (for fast command-line validation)</h2>
7373
<h3 id="http-client-options">HTTP client options</h3>
7474

7575
<p>When using <code>vnu.jar</code> for sending documents to a
76-
locally-running instance of the validator HTTP service for validation,
76+
locally-running instance of the checker HTTP service for checking,
7777
you can set Java system properties to control configuration options for the
78-
validation behavior.
78+
checker behavior.
7979

80-
<p>For example, you can suppress warning-level validation messages and only
80+
<p>For example, you can suppress warning-level messages and only
8181
show error-level ones by setting the value of the
8282
<code>nu.validator.client.level</code> system property to
8383
<code>error</code>, like this:</p>
@@ -94,14 +94,14 @@ <h3 id="http-client-options">HTTP client options</h3>
9494

9595
<h4 id="nuvalidatorclienthost">nu.validator.client.host</h4>
9696
<pre>
97-
Specifies the hostname of the validator for the client to connect to.
97+
Specifies the hostname of the checker for the client to connect to.
9898

9999
default: <span class=option-value>"127.0.0.1"</span>
100100
</pre>
101101

102102
<h4 id="nuvalidatorclientport">nu.validator.client.port</h4>
103103
<pre>
104-
Specifies the hostname of the validator for the client to connect to.
104+
Specifies the hostname of the checker for the client to connect to.
105105

106106
default: <span class=option-value>"8888"</span>
107107

@@ -110,7 +110,7 @@ <h4 id="nuvalidatorclientport">nu.validator.client.port</h4>
110110

111111
<h4 id="nuvalidatorclientlevel">nu.validator.client.level</h4>
112112
<pre>
113-
Specifies the severity level of validation messages to report; to
113+
Specifies the severity level of messages to report; to
114114
suppress warning-level messages, and only show error-level ones, set
115115
this property to "error".
116116

@@ -146,7 +146,7 @@ <h4 id="nuvalidatorclientcontent-type">nu.validator.client.content-type</h4>
146146

147147
<h4 id="nuvalidatorclientout">nu.validator.client.out</h4>
148148
<pre>
149-
Specifies the output format for validation messages.
149+
Specifies the output format for messages.
150150

151151
default: "gnu"
152152

@@ -156,7 +156,7 @@ <h4 id="nuvalidatorclientout">nu.validator.client.out</h4>
156156
<h4 id="nuvalidatorclientasciiquotes">nu.validator.client.asciiquotes</h4>
157157
<pre>
158158
Specifies whether ASCII quotation marks are substituted for Unicode
159-
smart quotation marks in validation messages.
159+
smart quotation marks in messages.
160160

161161
default: "yes"
162162

@@ -166,8 +166,7 @@ <h4 id="nuvalidatorclientasciiquotes">nu.validator.client.asciiquotes</h4>
166166
</section>
167167
</div>
168168

169-
<p>
170-
For more information... sources bugz etc.
169+
<!-- TODO: For more information... sources bugz etc. -->
171170

172171
<style type="text/css">
173172
html {

0 commit comments

Comments
 (0)