Skip to content

Commit c280104

Browse files
committed
Got service.html to be valid HTML5 & started documenting vnu.war
1 parent bd298c6 commit c280104

File tree

1 file changed

+124
-114
lines changed

1 file changed

+124
-114
lines changed

service.html

Lines changed: 124 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,138 @@
11
<!doctype html><html><head><meta charset=utf-8>
2-
<title>Using vnu.jar for Web-based markup checking</title></head>
2+
<title>Using vnu.jar or vnu.war for web-based markup checking</title>
3+
4+
<style type="text/css">
5+
html {
6+
background: #DDE5D9 url(data:image/gif;base64,R0lGODlhBAAEAIAAANra2v///yH5BAAAAAAALAAAAAAEAAQAAAIFTGB4xlcAOw==) repeat 0 0;
7+
font-family: "Lucida Sans Unicode", "Lucida Sans", verdana, arial, helvetica;
8+
}
9+
body {
10+
border: solid 1px #CED4CA;
11+
background-color: #FFF;
12+
padding: 4px 25px 4px 25px;
13+
margin: 20px 20% 20px 20px;
14+
line-height: 1.75;
15+
}
16+
h1 {
17+
font-size: 36px;
18+
font-weight: normal;
19+
color: #0B5B9D;
20+
vertical-align: top;
21+
margin-bottom: 0px;
22+
}
23+
h2 {
24+
font-size: 28px;
25+
font-weight: normal;
26+
color: #0B5B9D;
27+
vertical-align: top;
28+
margin-bottom: 0px;
29+
margin-top: 24px;
30+
}
31+
h3 {
32+
font-size: 22px;
33+
font-weight: normal;
34+
color: #0B5B9D;
35+
vertical-align: top;
36+
margin-bottom: 0px;
37+
margin-top: 32px;
38+
}
39+
h4 {
40+
font-size: 20px;
41+
font-weight: normal;
42+
color: #0B5B9D;
43+
vertical-align: top;
44+
margin-bottom: 0px;
45+
margin-top: 22px;
46+
}
47+
a {
48+
text-decoration: none;
49+
color: #0B5B9D;
50+
padding: 2px;
51+
}
52+
53+
a:hover {
54+
text-decoration: none;
55+
background-color: #0B5B9D;
56+
color: white;
57+
}
58+
a:active {
59+
text-decoration: none;
60+
background-color: white;
61+
color: black;
62+
}
63+
.set, .note {
64+
background-color: ivory;
65+
padding: 16px;
66+
padding-top: 4px;
67+
padding-bottom: 4px;
68+
padding-right: 32px;
69+
padding-left: 32px;
70+
border: 1px solid #ccc;
71+
margin-left: 2px;
72+
margin-right: 2px;
73+
border-radius: 6px;
74+
}
75+
.note {
76+
background-color: rgb(241, 255, 240);
77+
}
78+
.note p {
79+
margin-top: 8px;
80+
}
81+
code {
82+
background-color: #F8F8F8;
83+
border: 1px solid #ccc;
84+
border-radius: 3px;
85+
padding: 2px 6px;
86+
}
87+
pre {
88+
background-color: #F8F8F8;
89+
border: 1px solid #ccc;
90+
border-radius: 3px;
91+
padding: 10px;
92+
margin-right: 15%;
93+
margin-top: 6px;
94+
line-height: 1.2
95+
}
96+
.java-class, .java-property, .option-value {
97+
background-color: yellow;
98+
padding: 2px 6px;
99+
}
100+
.arg {
101+
color: green;
102+
}
103+
.links {
104+
text-align: center;
105+
}
106+
</style>
107+
108+
</head>
3109
<body>
4-
<h1>Using vnu.jar for Web-based markup checking</h1>
110+
<h1>Using vnu.jar or vnu.war for web-based markup checking</h1>
5111

6112
<p>The <code>vnu.jar</code> application is a portable standalone
7-
version of the validator.nu markup checker. The
113+
version of the validator.nu markup checker.
114+
It is well suited to <a href="./">command-line use</a> or as a simple,
115+
<a href="#web-based-usage">stand-alone HTTP server.</a>
116+
If you want to deploy the application to a servlet container
117+
such as Apache Tomcat you will probably want to use the
118+
<code>vnu.war</code> package instead.
119+
The
8120
<a href="https://github.com/validator/validator.github.io/releases"
9-
>latest vnu.jar release</a>
10-
is available from the <code>validator</code> project at github.
11-
The following are instructions on how to use it to provide a
12-
service for browser-based checking of HTML documents over the Web.
121+
>latest releases of these files</a>
122+
are available from the <code>validator</code> project at github.
123+
The following are instructions demonstrating how to use these two
124+
packages to provide a service for browser-based checking of
125+
HTML documents over the web.
13126

14127
<p class=note><b>Note:</b> In the instructions, replace
15-
<var>"~/vnu.jar"</var> with the actual path to the <code>vnu.jar</code>
16-
file on your system.
128+
<var>"~/vnu.jar"</var> and <var>"~/vnu.war"</var>
129+
with the actual paths to those files on your system.
17130

18131
<p class=links>
19132
<a href="#web-based-usage">Usage</a> ·
20133
<a href="#http-client">Client</a> ·
21134
<a href="#http-client-options">Options</a>
135+
</p>
22136

23137
<div class=set>
24138
<section id=web-based-usage>
@@ -59,7 +173,7 @@ <h2>Web-based usage</h2>
59173
</pre>
60174

61175
</div>
62-
176+
</section>
63177
<section id=http-client>
64178
<h2>HTTP client (for fast command-line checking)</h2>
65179

@@ -178,107 +292,3 @@ <h4 id="nuvalidatorclientasciiquotes">nu.validator.client.asciiquotes</h4>
178292
</div>
179293

180294
<!-- TODO: For more information... sources bugz etc. -->
181-
182-
<style type="text/css">
183-
html {
184-
background: #DDE5D9 url(data:image/gif;base64,R0lGODlhBAAEAIAAANra2v///yH5BAAAAAAALAAAAAAEAAQAAAIFTGB4xlcAOw==) repeat 0 0;
185-
font-family: "Lucida Sans Unicode", "Lucida Sans", verdana, arial, helvetica;
186-
}
187-
body {
188-
border: solid 1px #CED4CA;
189-
background-color: #FFF;
190-
padding: 4px 25px 4px 25px;
191-
margin: 20px 20% 20px 20px;
192-
line-height: 1.75;
193-
}
194-
h1 {
195-
font-size: 36px;
196-
font-weight: normal;
197-
color: #0B5B9D;
198-
vertical-align: top;
199-
margin-bottom: 0px;
200-
}
201-
h2 {
202-
font-size: 28px;
203-
font-weight: normal;
204-
color: #0B5B9D;
205-
vertical-align: top;
206-
margin-bottom: 0px;
207-
margin-top: 24px;
208-
}
209-
h3 {
210-
font-size: 22px;
211-
font-weight: normal;
212-
color: #0B5B9D;
213-
vertical-align: top;
214-
margin-bottom: 0px;
215-
margin-top: 32px;
216-
}
217-
h4 {
218-
font-size: 20px;
219-
font-weight: normal;
220-
color: #0B5B9D;
221-
vertical-align: top;
222-
margin-bottom: 0px;
223-
margin-top: 22px;
224-
}
225-
a {
226-
text-decoration: none;
227-
color: #0B5B9D;
228-
padding: 2px;
229-
}
230-
231-
a:hover {
232-
text-decoration: none;
233-
background-color: #0B5B9D;
234-
color: white;
235-
}
236-
a:active {
237-
text-decoration: none;
238-
background-color: white;
239-
color: black;
240-
}
241-
.set, .note {
242-
background-color: ivory;
243-
padding: 16px;
244-
padding-top: 4px;
245-
padding-bottom: 4px;
246-
padding-right: 32px;
247-
padding-left: 32px;
248-
border: 1px solid #ccc;
249-
margin-left: 2px;
250-
margin-right: 2px;
251-
border-radius: 6px;
252-
}
253-
.note {
254-
background-color: rgb(241, 255, 240);
255-
}
256-
.note p {
257-
margin-top: 8px;
258-
}
259-
code {
260-
background-color: #F8F8F8;
261-
border: 1px solid #ccc;
262-
border-radius: 3px;
263-
padding: 2px 6px;
264-
}
265-
pre {
266-
background-color: #F8F8F8;
267-
border: 1px solid #ccc;
268-
border-radius: 3px;
269-
padding: 10px;
270-
margin-right: 15%;
271-
margin-top: 6px;
272-
line-height: 1.2
273-
}
274-
.java-class, .java-property, .option-value {
275-
background-color: yellow;
276-
padding: 2px 6px;
277-
}
278-
.arg {
279-
color: green;
280-
}
281-
.links {
282-
text-align: center;
283-
}
284-
</style>

0 commit comments

Comments
 (0)