summaryrefslogtreecommitdiff
path: root/support/TeX4ht/doc/mn-commands.html
blob: 9217522e1a19b1d9c754a904ead842e7c55f861c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
<?xml version="1.0" encoding="iso-8859-1" ?> 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">  
<!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd-->  
<html xmlns="http://www.w3.org/1999/xhtml"  
> 
<head><title>calling commands</title> 
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> 
<meta name="generator" content="TeX4ht (https://tug.org/tex4ht/)" /> 
<meta name="originator" content="TeX4ht (https://tug.org/tex4ht/)" /> 
<!-- xhtml,th4,index --> 
<meta name="src" content="mn.tex" /> 
<link rel="stylesheet" type="text/css" href="mn.css" /> 
<meta name="viewport" content="width=device-width, initial-scale=1" /> 
</head><body 
>
    <p class="rightline"><a 
 href="mn.html#mn-commands.html" >up</a></p>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-33"></a>Calling Commands</h2><div class="TableOfContents"><span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-34"  name="QQ2-9-34">From LaTeX to HTML</a></span> <span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-35"  name="QQ2-9-35">Available Values for the Options</a></span>
<span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-36"  name="QQ2-9-36">XHTML and Unicode</a></span> <span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-37"  name="QQ2-9-37">XHTML with MathML</a></span> <span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-38"  name="QQ2-9-38">OpenDocument, OpenOffice, and
MS Word</a></span> <span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-39"  name="QQ2-9-39">DocBook and TEI</a></span> <span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-40"  name="QQ2-9-40">JavaHelp</a></span> <span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-41"  name="QQ2-9-41">Private Configuration Files</a></span> <span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-42"  name="QQ2-9-42">Creating
Private Command Lines</a></span> <span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-43"  name="QQ2-9-43">An Insight into the Commands</a></span> <span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-44"  name="QQ2-9-44">A Deeper Insight</a></span>
<span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-45"  name="QQ2-9-45">TeX, ConTeXt, and TeXi</a></span> <span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-47"  name="QQ2-9-47">Other Options</a></span> <span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-48"  name="QQ2-9-48">Validation</a></span> <span class="DocChapter"><span 
class="cmsy-10">&#x2219;</span> <a 
 href="#QQ1-9-49"  name="QQ2-9-49">Recommendations</a></span>
    </div>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-34"></a>From LaTeX to HTML</h2>
<!--l. 4259--><p class="noindent" ><a 
  name="features"></a>The translation of a LaTeX source file into HTML involves of loading <span 
class="cmtt-10">tex4ht.sty </span>and *.4ht style files, choosing the
desirable options for the translation, compiling the source into <span 
class="cmtt-10">dvi </span>code with the native LaTeX engine, and
postprocessing the outcome with the <span 
class="cmtt-10">tex4ht </span>and <span 
class="cmtt-10">t4ht </span>programs (see <a 
 href="mn39.html" >overview</a>).
</p><!--l. 4268--><p class="indent" >    <a 
  name="index9-34001"></a>The <span 
class="cmtt-10">htlatex </span>command loads a script which takes on itself to invoke the different steps of the process, without
user intervention. The command assumes the form
</p>
    <div  
class="centerline"><span 
class="cmtt-10">htlatex filename "</span><span 
class="cmti-10">options1</span><span 
class="cmtt-10">" "</span><span 
class="cmti-10">option2</span><span 
class="cmtt-10">" "</span><span 
class="cmti-10">options3</span><span 
class="cmtt-10">" "</span><span 
class="cmti-10">options4</span><span 
class="cmtt-10">"</span></div>
<!--l. 4277--><p class="noindent" >where the first set of options is for the <span 
class="cmtt-10">tex4ht.sty </span>and <span 
class="cmtt-10">*.4ht </span>style files, the second set is for the <span 
class="cmtt-10">tex4ht</span>
postprocessor, the third for the <span 
class="cmtt-10">t4ht </span>postprocessor, and the last one is for the LaTeX compiler. For
instance,
</p><!--l. 4291--><p class="indent" >
</p><dl > <dt><span 
class="cmtt-10">htlatex filename</span></dt><dd>
This command requests a translation according to the default conditions, which are set to produce HTML
transitional 4.0 code.
    </dd><dt><span 
class="cmtt-10">htlatex filename "html,2,info"</span></dt><dd>
This command is equivalent to the previous one, specifying explicitly the option <span 
class="cmtt-10">html </span>for <span 
class="cmtt-10">tex4ht.sty </span>instead of
doing so implicitly.
<!--l. 4301--><p class="indent" >    In addition, the command requests a break up of the output into separate web pages, in accordance to the two
top sectioning levels of the document.
</p><!--l. 4305--><p class="indent" >    Moreover, it asks for a listing in the log file of the information available for the style files in use.
That information, among other things, also introduces additional values available for the first list of
options.
</p>
    </dd><dt><span 
class="cmtt-10">htlatex filename "" "dbcs/!"</span></dt><dd>
This command requests the loading of the dbcs branch of Chinese hypertext fonts (on top of those already requested
by the default setting).
    </dd><dt> <a 
  name="index9-34002"></a> <a 
  name="index9-34003"></a> <a 
  name="index9-34004"></a> <a 
  name="index9-34005"></a> <a 
  name="index9-34006"></a><span 
class="cmtt-10">htlatex filename "foo,frames" "" "-p"</span></dt><dd>
This command requests LaTeX to load a private configuration file, named <span 
class="cmtt-10">foo.cfg</span>, and to place the
content and table of contents in separate frames. In addition, it asks <span 
class="cmtt-10">t4ht </span>not to produce bitmaps for
pictures.
    </dd><dt><span 
class="cmtt-10">htlatex filename "" " -ciso2htf" "" "-translate-file=il2-pl"</span></dt><dd>
This command invokes the LaTeX compiler with the instruction &#8216;<span 
class="cmtt-10">latex -translate-file=il2-plfilename</span>&#8217;.

    </dd></dl>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-35"></a>Available Values for the Options</h2>
<!--l. 4344--><p class="noindent" ><a 
  name="index9-35001"></a>The fields of <span 
class="cmti-10">option1 </span>should be separated by commas. An &#8216;<span 
class="cmtt-10">info</span>&#8217; field requests a listing in the .log file of many of the
the available values. If the list is not empty, it must start with the entry &#8216;<span 
class="cmtt-10">html</span>&#8217;, &#8216;<span 
class="cmtt-10">xhtml</span>&#8217;, or a name of a private
configuration file.
</p><!--l. 4351--><p class="indent" >    The fields of <span 
class="cmti-10">option2 </span>and <span 
class="cmti-10">options3 </span>should be separated by spaces. The available values can be listed by
executing the postprocessors <span 
class="cmtt-10">tex4ht.c </span>and <span 
class="cmtt-10">t4ht.c</span>, respectively, without arguments (or with wrong sets of
arguments).
</p><!--l. 4356--><p class="indent" >    The first field of <span 
class="cmti-10">option2 </span>should be empty or a subdirectory of <span 
class="cmtt-10">ht-fonts </span>(typically augmented with an
exclamation mark &#8216;<span 
class="cmtt-10">!</span>&#8217;). A space should separate the first field from the second one, also when the first field is
empty.
</p><!--l. 4361--><p class="indent" >    The underlying output formats of available <span 
class="cmtt-10">htlatex</span>-like commands are tailored into the commands through
fields of <span 
class="cmti-10">option1</span>. The names of these fields are defined in <span 
class="cmtt-10">tex4ht.4ht </span>and <span 
class="cmtt-10">tex4ht.usr </span>(see <a 
 href="mn11.html#confFiles">General Configuration
Files</a>). These values should be of little interest to most users.
</p><!--l. 4369--><p class="indent" >    <a 
  name="index9-35002"></a> <a 
  name="index9-35003"></a>Different variants of the <span 
class="cmtt-10">htlatex </span>command may be invoked by introducing the commands as
arguments to a driver named <span 
class="cmtt-10">mk4ht</span>. When provided without arguments, the driver lists the commands it
recognizes.
</p>
    <table id="TBL-1"  
><tr   style="vertical-align:top;" >
<td style="white-space: nowrap; margin-right:2em;" 
> <span 
class="cmtt-10">mk4ht mzlatex filename "html,3" </span></td><td 
><span 
class="cmtt-10">(htlatex filename "html,3,xhtml,mozilla" "</span><span 
class="cmtt-10">&#x00A0;-cmozhtf")</span>
</td></tr><tr   style="vertical-align:top;" >
<td style="white-space: nowrap; margin-right:2em;" 
> <span 
class="cmtt-10">mk4ht oolatex filename </span></td><td 
><span 
class="cmtt-10">(htlatex filename "xhtml,ooffice" "ooffice/!</span><span 
class="cmtt-10">&#x00A0;-cmozhtf" "-coo")</span>
</td></tr></table>
<!--l. 4383--><p class="indent" >    <a 
  name="index9-35004"></a>Alternatively, a compilation &#8216;<span 
class="cmtt-10">latex mkht-scripts.4ht</span>&#8217; produces different named scripts of similar
functionality.
</p>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-36"></a>XHTML and Unicode</h2>  <a 
  name="index9-36001"></a> <a 
  name="index9-36002"></a> <a 
  name="index9-36003"></a> <a 
  name="index9-36004"></a>The &#8216;<span 
class="cmtt-10">xhlatex</span>&#8217; command is a variant of the &#8216;<span 
class="cmtt-10">htlatex</span>&#8217; command requesting XHTML
output. It consists just of a call to &#8216;<span 
class="cmtt-10">htlatex</span>&#8217; with the entry &#8216;<span 
class="cmtt-10">xhtml</span>&#8217; in the first list of options and &#8216;<span 
class="cmtt-10">-cvalidate</span>&#8217; in
the third list. For instance, &#8216;<span 
class="cmtt-10">xhlatex filename</span>&#8217; or &#8216;<span 
class="cmtt-10">htlatex filename "xhtml"</span>&#8217;.
<!--l. 4401--><p class="noindent" >To request a Unicode representation of symbols, the first list of options should include the &#8216;<span 
class="cmtt-10">uni-html4</span>&#8217; entry, and
the second list should include the &#8216;<span 
class="cmtt-10">-cunihtf</span>&#8217; entry preceded by space. For instance, &#8216;<span 
class="cmtt-10">xhlatex filename</span>
<span 
class="cmtt-10">"xhtml,uni-html4" " -cunihtf"</span>&#8217;.
</p><!--l. 4407--><p class="indent" >    Unicode representations of symbols in UTF-8 encoding may be requested with the entry &#8216;<span 
class="cmtt-10">-utf8</span>&#8217;
added to the second list. For instance, &#8216;<span 
class="cmtt-10">xhlatex filename "xhtml,charset=utf-8" " -cunihtf</span>
<span 
class="cmtt-10">-utf8"</span>&#8217;.
</p><!--l. 4414--><p class="indent" >    To request expanded usage of unicode values in iso-8859-1 output employ commands similar to
</p>
    <div  
class="centerline"><span 
class="cmtt-10">htlatex file "" "iso8859/1/charset/uni/!"</span></div>
<!--l. 4420--><p class="noindent" >or introduce a similar charset path in tex4ht.env. Otherwise, non iso-8859-1 characters might obtain bitmap
representations.
</p>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-37"></a>XHTML with MathML</h2>
<!--l. 4429--><p class="noindent" ><a 
  name="index9-37001"></a> <a 
  name="index9-37002"></a> <a 
  name="index9-37003"></a> <a 
  name="index9-37004"></a> <a 
  name="index9-37005"></a> <a 
  name="index9-37006"></a>TeX4ht has different configurations for different modes of output. It is distributed with pre-tailored base
configurations for translating LaTeX math into MathML, and extra configurations for adjusting the outcome to
Mozilla, MathPlayer, and PMathML CSS. Only presentational MathML is supported.
</p><div class="Verbatim"><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;mzlatex</span><span 
class="cmtt-10">&#x00A0;filename</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;mzlatex</span><span 
class="cmtt-10">&#x00A0;filename</span><span 
class="cmtt-10">&#x00A0;"html,pmathml"</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;mzlatex</span><span 
class="cmtt-10">&#x00A0;filename</span><span 
class="cmtt-10">&#x00A0;"html,mathml-"</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;mzlatex</span><span 
class="cmtt-10">&#x00A0;filename</span><span 
class="cmtt-10">&#x00A0;"html,mathplayer"</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;xhmlatex</span><span 
class="cmtt-10">&#x00A0;filename</span><span 
class="cmtt-10">&#x00A0;</span>
<br /></div>
<!--l. 4453--><p class="indent" >    For XHTML+MathML to be served both by Mozilla and MSIE+MathPlayer use the command line option
&#8216;mathplayer&#8217;.

</p><!--l. 4457--><p class="indent" >    The <span 
class="cmtt-10">mzlatex </span>command is a short cut representation for the command &#8216;<span 
class="cmtt-10">htlatex filename "xhtml,mozilla"</span>
<span 
class="cmtt-10">" -cmozhtf" "-cvalidate"</span>&#8217;. It take into account special needs of browsers. The <span 
class="cmtt-10">xhmlatex </span>command is a short cut
representation for the command &#8216;<span 
class="cmtt-10">htlatex filename "xhtml,mathml" " -cunihtf" "-cvalidate"</span>&#8217;; it does not
make any compromizes toward browsers.
</p><!--l. 4465--><p class="indent" >    It might be worthwhile to notice some of the more <a 
 href="mml.html#mml-prob">common sources of problems</a> for MathML.  <a 
  name="index9-37007"></a>The &#8216;<span 
class="cmtt-10">mathml-</span>&#8217;
options asks for a degraded MathML output that sidetracks some of the problems.
</p>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-38"></a>OpenDocument, OpenOffice, and MS Word</h2>
<!--l. 4476--><p class="noindent" ><a 
  name="index9-38001"></a> <a 
  name="index9-38002"></a> <a 
  name="index9-38003"></a> <a 
  name="index9-38004"></a> <a 
  name="index9-38005"></a> <a 
  name="index9-38006"></a>A translation for an OpenDocument format can be requested by the &#8216;<span 
class="cmtt-10">\oolatex</span>&#8217; command. The command is a
variant of <span 
class="cmtt-10">htlatex </span>in which the first list of options holds the entries &#8216;<span 
class="cmtt-10">xhtml,ooffice</span>&#8217;, the second list holds the
entry &#8216;<span 
class="cmtt-10">-cmozhtf</span>&#8217; preceded by a space, and the third list contains &#8216;<span 
class="cmtt-10">-coo</span>&#8217; (<span 
class="cmtt-10">htlatex filename "xhtml,ooffice"</span>
<span 
class="cmtt-10">"ooffice/!</span><span 
class="cmtt-10">&#x00A0;-cmozhtf" "-coo -cvalidate"</span>). The output of a command &#8216;<span 
class="cmtt-10">oolatex filename</span>&#8217; is a zipped file
named with a &#8216;<span 
class="cmtt-10">.odt</span>&#8217; extension.
</p><!--l. 4496--><p class="indent" >    The OpenDocument code employs MathML for formulas, and XSL-FO for formatting. It can be viewed by the
<a 
 href="http://www.openoffice.org/" >OpenOffice</a> word processor which, in turn, can export RTF and other MicroSoft-based formats (see also, Maarten
Wisse, &#8220;Hacking TeX4ht for XML Output: The Road toward a TeX to Word Convertor&#8221;, <a 
 href="http://www.ntg.nl/maps/electromaps.html" >MAPS</a>&#x00A0;28&#x00A0;(2002),
pp.&#x00A0;28-35).
</p><!--l. 4508--><p class="indent" >    A command of the form &#8216;<span 
class="cmtt-10">htlatex filename "html,word" "symbol/!" "-cvalidate"</span>&#8217; asks for HTML
output tuned toward MicroSoft Word. Such a format, however, relies on bitmaps for mathematical
formulas.
</p>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-39"></a>DocBook and TEI</h2>
<!--l. 4517--><p class="noindent" ><a 
  name="index9-39001"></a> <a 
  name="index9-39002"></a> <a 
  name="index9-39003"></a> <a 
  name="index9-39004"></a> <a 
  name="index9-39005"></a> <a 
  name="index9-39006"></a> <a 
  name="index9-39007"></a> <a 
  name="index9-39008"></a> <a 
  name="index9-39009"></a> <a 
  name="index9-39010"></a>The following commands may be used for requesting DocBook and TEI output.
</p>
    <table id="TBL-2"  
><tr >
<td 
><span 
class="cmtt-10">dbmlatex: </span></td><td 
><span 
class="cmtt-10">htlatex </span><span 
class="cmti-10">filename </span><span 
class="cmtt-10">"xhtml,docbook-mml" " -cunihtf" "-cdocbk"</span></td></tr><tr >
<td 
><span 
class="cmtt-10">dblatex:</span></td><td 
><span 
class="cmtt-10">htlatex </span><span 
class="cmti-10">filename </span><span 
class="cmtt-10">"xhtml,docbook" " -cunihtf" "-cdocbk"</span></td></tr><tr >
<td 
><span 
class="cmtt-10">teimlatex:</span></td><td 
><span 
class="cmtt-10">htlatex </span><span 
class="cmti-10">filename </span><span 
class="cmtt-10">"xhtml,tei-mml" " -cunihtf" "-cdocbk"</span></td></tr><tr >
<td 
><span 
class="cmtt-10">teilatex:</span></td><td 
><span 
class="cmtt-10">htlatex </span><span 
class="cmti-10">filename </span><span 
class="cmtt-10">"xhtml,tei" " -cunihtf" "-cdocbk" </span></td></tr></table>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-40"></a>JavaHelp</h2>
<!--l. 4548--><p class="noindent" ><a 
  name="index9-40001"></a> <a 
  name="index9-40002"></a><a 
 href="http://java.sun.com/products/javahelp/index.jsp" >JavaHelp</a> is an online documentation system for use by Java-based applications. Such documents can be
produced from LaTeX files through commands similar to &#8216;<span 
class="cmtt-10">jhlatex </span><span 
class="cmti-10">filename</span>&#8217; for JavaHelp version
2.0.
</p><!--l. 4555--><p class="indent" >    The above invocation stands for &#8216;<span 
class="cmtt-10">htlatex </span><span 
class="cmti-10">filename </span><span 
class="cmtt-10">"html,3.2,xml,javahelp,unicode" " -cmozhtf</span>
<span 
class="cmtt-10">-u10" "-dfilename-doc/ -cjavahelp"</span>&#8217;. The &#8216;<span 
class="cmtt-10">-u10</span>&#8217; asks for entity references in base 10&#8212;JavaHelp
doesn&#8217;t seem to support hexadecimal representations. The <span 
class="cmtt-10">-cjavahelp </span>invokes the JavaHelp indexer to
produce the search database at &#8216;jobname-doc/jobname-jhs&#8217; with a command similar to &#8216;<span 
class="cmtt-10">java -jar</span>
<span 
class="cmtt-10">${HOME}/jh2.0/javahelp/bin/jhindexer.jar -db jobname-doc/jobname-jhs jobname*.html</span>&#8217;.
</p><!--l. 4567--><p class="indent" >    The Java program is to be distributed with the jobname-doc directory.
</p>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-41"></a>Private Configuration Files</h2>
<!--l. 4716--><p class="noindent" ><a 
  name="index9-41001"></a><a 
  name="prvCfgFiles"></a>The leading entry, in the first list of options of the <span 
class="cmtt-10">htlatex</span>-like commands, can equal &#8216;<span 
class="cmtt-10">html</span>&#8217; or &#8216;<span 
class="cmtt-10">xhtml</span>&#8217;. If this is not
the case, the entry is assumed to be the name of a configuration file. The extension &#8216;<span 
class="cmtt-10">cfg</span>&#8217; is assumed for names of
configuration files that are listed without their extension.
</p><!--l. 4724--><p class="indent" >    A configuration file should take the following form for LaTeX files.
</p>
    <div class="Template">   <span 
class="cmtt-10">...</span><span 
class="cmti-10">early definitions</span><span 
class="cmtt-10">...</span><br />
<span 
class="cmtt-10">\Preamble{</span><span 
class="cmti-10">options</span><span 
class="cmtt-10">}</span><br />
<span 
class="cmtt-10">...</span><span 
class="cmti-10">definitions</span><span 
class="cmtt-10">...</span><br />
<span 
class="cmtt-10">\begin{document}</span><br />
<span 
class="cmtt-10">...</span><span 
class="cmti-10">insertions into the header of the html file</span><span 
class="cmtt-10">...</span><br />
<span 
class="cmtt-10">\EndPreamble </span></div>
<!--l. 4738--><p class="indent" >    It is up to the user to decide the distribution of entries between the <span 
class="cmtt-10">\Preamble </span>and the <span 
class="cmtt-10">htlatex</span>-like

commands.
</p>
    <div class="EXAMPL"><span 
class="cmbx-10">Example </span>The command &#8216;<span 
class="cmtt-10">htlatex myfile "mycfg,2"</span>&#8217; requests the compilation of a file named myfile.tex, in
the presence of a configuration file named mycfg.cfg. The configuration file might have the following
content.
<div class="Verbatim"><span 
class="cmtt-10">\Preamble{html}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">\begin{document}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;\Css{body</span><span 
class="cmtt-10">&#x00A0;{</span><span 
class="cmtt-10">&#x00A0;color</span><span 
class="cmtt-10">&#x00A0;:</span><span 
class="cmtt-10">&#x00A0;red;</span><span 
class="cmtt-10">&#x00A0;}}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">\EndPreamble</span><span 
class="cmtt-10">&#x00A0;</span>
<br /></div>
    </div>
    <div class="Notes"><span 
class="cmbx-10">Notes</span>
<ul >
<li>Notice that for a LaTeX file the <span 
class="cmtt-10">\begin{document} </span>instruction should be present both in the configuration file and
the source file.
<!--l. 4761--><p class="noindent" ></p></li>
<li>Instructions defined within a source file may be redefined in a configuration file. Such a feature enables to keep
source files intact for compilation to different formats by different tools.
<!--l. 4766--><p class="indent" >    For instance, a definition of the form <span 
class="cmtt-10">\renewcommand\mycommand{...} </span>within a configuration file provided for
the following LaTeX source.
</p><div class="Verbatim"><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;\documentclass{...}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;\newcommand\mycommand{...}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;\begin{document}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;Use</span><span 
class="cmtt-10">&#x00A0;\mycommand{...}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;\end{document}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /></div>
    </li></ul>
    </div>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-42"></a>Creating Private Command Lines</h2>
<!--l. 4790--><p class="noindent" ><a 
  name="index9-42001"></a> <a 
  name="index9-42002"></a>
</p><!--l. 4793--><p class="indent" >    A htlatex-like script <span 
class="cmtt-10">foolatex.bat </span>can be obtained from the compilation under LaTeX of a file similar to the
following one.
</p><div class="Verbatim"><span 
class="cmtt-10">&#x00A0;\def\script{bat}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;\input</span><span 
class="cmtt-10">&#x00A0;mkht.4ht</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;\one{,html,next,3}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;\two{-ic:\tex4ht\texmf\tex4ht\ht-fonts\#1</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;</span><span 
class="cmtt-10">&#x00A0;-ic:\tex4ht\texmf\tex4ht\ht-fonts\symbol\!}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;\three{#1</span><span 
class="cmtt-10">&#x00A0;-dc:\my\dir}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;\make{foo}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /><span 
class="cmtt-10">&#x00A0;\end{document}</span><span 
class="cmtt-10">&#x00A0;</span>
<br /></div>
<!--l. 4807--><p class="indent" >    A call of the form
</p>
    <div  
class="centerline"><span 
class="cmtt-10">foolatex filename</span></div>
<!--l. 4811--><p class="indent" >    is then equivalent to a call of the following form.
</p>
    <div  
class="centerline"><span 
class="cmtt-10">htlatex filename "html,next,3" "symbol/!" "-dc:\my\dir"</span></div>
<!--l. 4817--><p class="indent" >    Scripts obtained in such a manner can embed parameters within their bodies instead of expecting the
parameters to be provided in command lines.
</p><!--l. 4820--><p class="indent" >    Details regarding the available options can be found by compiling under LaTeX a file of the following
form.
</p>
    <div  
class="centerline"><span 
class="cmtt-10">\input mkht.4ht \end{document}</span></div>

<!--l. 4826--><p class="indent" >    The compilation requires the <span 
class="cmtt-10">ProTex.sty </span>and <span 
class="cmtt-10">AlProTex.sty </span>files available at
<a 
 href="http://www.cse.ohio-state.edu/~gurari/systems.html." ><span 
class="cmtt-10">http://www.cse.ohio-state.edu/~gurari/systems.html</span></a>.
</p>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-43"></a>An Insight into the Commands</h2>
<!--l. 4844--><p class="noindent" >Given a LaTeX file
      </p><div class="ShowCode">
      <br />&nbsp;<span 
class="cmtt-10">\documentclass{article}</span>
      <br />&nbsp;<span 
class="cmtt-10">\begin{document}</span>
      <br />&nbsp;&nbsp;&nbsp;&nbsp;<span 
class="cmtt-10">..................</span>
      <br />&nbsp;<span 
class="cmtt-10">\end{document}</span>
</div>
<!--l. 4854--><p class="noindent" >the &#8216;<span 
class="cmtt-10">htlatex </span><span 
class="cmti-10">filename</span>&#8217; command produces a call &#8216;<span 
class="cmtt-10">latex </span><span 
class="cmti-10">filename</span>&#8217; to LaTeX on an implicit file of the following
form.
      </p><div class="ShowCode">
      <br />&nbsp;<span 
class="cmtt-10">\documentclass{article}</span>
      <br />&nbsp;&nbsp;&nbsp;&nbsp;<span class="showcode"><span 
class="cmtt-10">\usepackage{tex4ht}</span></span>
      <br />&nbsp;<span 
class="cmtt-10">\begin{document}</span>
      <br />&nbsp;&nbsp;&nbsp;&nbsp;<span 
class="cmtt-10">..................</span>
      <br />&nbsp;<span 
class="cmtt-10">\end{document}</span>
</div>
<!--l. 4868--><p class="noindent" >Similarly, the command &#8216;<span 
class="cmtt-10">htlatex </span><span 
class="cmti-10">filename </span><span 
class="cmtt-10">"</span><span 
class="cmti-10">options</span><span 
class="cmtt-10">"</span>&#8217; produces a call to a &#8216;<span 
class="cmtt-10">latex </span><span 
class="cmti-10">filename</span>&#8217; command on an
implicit file of the following form.
      </p><div class="ShowCode">
      <br />&nbsp;<span 
class="cmtt-10">\documentclass{article}</span>
      <br />&nbsp;&nbsp;&nbsp;&nbsp;<span 
class="cmtt-10">\usepackage[</span><span class="showcode"><span 
class="cmtt-10">options</span></span><span 
class="cmtt-10">]{tex4ht}</span>
      <br />&nbsp;<span 
class="cmtt-10">\begin{document}</span>
      <br />&nbsp;&nbsp;&nbsp;&nbsp;<span 
class="cmtt-10">..................</span>
      <br />&nbsp;<span 
class="cmtt-10">\end{document}</span>
</div>
    <a 
  name="index9-43001"></a>The command &#8216;<span 
class="cmtt-10">ht latex </span><span 
class="cmti-10">filename </span>&#8217; may be used, instead of the &#8216;<span 
class="cmtt-10">htlatex </span><span 
class="cmti-10">filename </span><span 
class="cmtt-10">"</span><span 
class="cmti-10">options</span><span 
class="cmtt-10">"</span>&#8217; command, in
cases that the <span 
class="cmtt-10">\usepackage </span>instruction is explicitly introduced into the source files.
    <h2 class="ChapterHead"><a 
  name="QQ1-9-44"></a>A Deeper Insight</h2>
<!--l. 4894--><p class="noindent" >From the perspective of TeX4ht, the <span 
class="cmtt-10">htlatex</span>-like commands, and the <span 
class="cmtt-10">\usepackage</span>, are indirect approaches for
getting LaTeX files of the following form. Such files can be explicitly provided for compilations requested through
the &#8216;<span 
class="cmtt-10">ht latex </span><span 
class="cmti-10">filename</span>&#8217; command.
      </p><div class="ShowCode">
      <br />&nbsp;<span 
class="cmtt-10">\documentclass{article}</span>
      <br />&nbsp;&nbsp;&nbsp;&nbsp;<span 
class="cmtt-10">.....</span>
      <br />&nbsp;&nbsp;&nbsp;&nbsp;<span 
class="cmtt-10">\input</span>&nbsp;<span 
class="cmtt-10">tex4ht.sty</span>
      <br />&nbsp;&nbsp;&nbsp;&nbsp;<span 
class="cmtt-10">.....</span>
      <br />&nbsp;<span 
class="cmtt-10">\Preamble{</span><span class="showcode"><span 
class="cmtt-10">options</span></span><span 
class="cmtt-10">}</span>
      <br />&nbsp;&nbsp;&nbsp;&nbsp;<span 
class="cmtt-10">.....</span>
      <br />&nbsp;<span 
class="cmtt-10">\begin{document}</span>
      <br />&nbsp;&nbsp;&nbsp;&nbsp;<span 
class="cmtt-10">.....</span>
      <br />&nbsp;<span 
class="cmtt-10">\EndPreamble</span>
      <br />&nbsp;&nbsp;&nbsp;&nbsp;<span 
class="cmtt-10">..................</span>
      <br />&nbsp;<span 
class="cmtt-10">\end{document}</span>
</div>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-45"></a>TeX, ConTeXt, and TeXi</h2>
<!--l. 4924--><p class="noindent" ><a 
  name="index9-45001"></a> <a 
  name="index9-45002"></a> <a 
  name="index9-45003"></a> <a 
  name="index9-45004"></a>Commands similar to those offered for LaTeX are also offered for TeX (dbmtex, dbtex, ht, httex, mztex, ootex,
t4ht, teimtex, teitex, tex4ht, xhmtex, xhtex) and TeXi (dbmtexi, dbtexi, httexi, mztexi, ootexi, teimtexi, teitexi,
xhmtexi, xhtexi). In the case of TeX, the fragment of code &#8216;<span 
class="cmtt-10">\csname tex4ht\endcsname</span>&#8217; should be introduced

by the user into the source file, after the preamble of the file where the document definitions reside
(<a 
 href="mn10.html"  name="mn10.html" >example</a>). In the case of TeXi, such a code fragment is introduced implicitly.
</p><!--l. 4952--><p class="indent" >    The private configuration files are similar to those of LaTeX, with the instruction &#8216;<span 
class="cmtt-10">\begin{document}</span>&#8217;
excluded.
</p>
    <div class="Template">   <span 
class="cmtt-10">...</span><br />
<span 
class="cmtt-10">\Preamble{</span><span 
class="cmti-10">options</span><span 
class="cmtt-10">}</span><br />
<span 
class="cmtt-10">...</span><br />
<span 
class="cmtt-10">\begin{document}</span><br />
<span 
class="cmtt-10">...</span><br />
<span 
class="cmtt-10">\EndPreamble</span><br />
<span 
class="cmtt-10">... </span></div>
    The &#8216;<span 
class="cmtt-10">ht tex </span><span 
class="cmti-10">filename </span>&#8217; and &#8216;<span 
class="cmtt-10">ht texi </span><span 
class="cmti-10">filename </span>&#8217; commands may apply for TeX and TeXi sources that embed
such code fragments in their body. The embeded code should replace the &#8216;<span 
class="cmtt-10">\csname tex4ht\endcsname</span>&#8217; fragment in
TeX sources, be palces at the strat of the files in TeXi sources, and not include the <span 
class="cmtt-10">\begin{document}</span>
instruction.
<!--l. 4976--><p class="indent" >    <a 
  name="index9-46001"></a> <a 
  name="index9-46002"></a>For <a 
 href="http://www.pragma-ade.com/" >ConTeXt</a> similar instructions apply with suffixes &#8216;<span 
class="cmtt-10">context</span>&#8217; instead of &#8216;<span 
class="cmtt-10">latex</span>&#8217;, &#8216;<span 
class="cmtt-10">tex</span>&#8217;, or &#8216;<span 
class="cmtt-10">texi</span>&#8217;. For
instance, &#8216;<span 
class="cmtt-10">htcontext&#8217; </span>.
</p>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-47"></a>Other Options</h2>
<!--l. 4989--><p class="noindent" >
</p><ul >
<li> <a 
  name="index9-47001"></a>XeTeX files can be compiled with htlatex-like instructions (e.g., htxelatex, htxetex, mzxelatex). Currently only
partial support is provided and only TeX-based fonts are handled. </li>
<li> <a 
  name="index9-47002"></a>A <a 
 href="http://www.math.union.edu/~dpvc/jsMath/welcome.html" >jsMath</a> mode of output may be requested with instructions similar to the following one.
    <div  
class="centerline"><span 
class="cmtt-10">htlatex file "xhtml,jsmath" " -cmozhtf"</span></div>
<!--l. 5002--><p class="noindent" ></p></li>
<li> <a 
  name="index9-47003"></a>The dvipng utility might be activated for bitmap constructions through a request &#8216;-cdvipng&#8217; in the third options
list. For instance,
    <div  
class="centerline"><span 
class="cmtt-10">htlatex file "" "" "-cdvipng"</span></div>
<!--l. 5009--><p class="indent" >    This utility is reported to produce fast high quality output with much smaller files than other
convertors.
</p><!--l. 5012--><p class="noindent" ></p></li>
<li> <a 
  name="index9-47004"></a>TeX4ht offers also <a 
 href="http://www.cse.ohio-state.edu/~gurari/laspeak" >speech</a> output formats.
    </li></ul>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-48"></a>Validation</h2>
<!--l. 5024--><p class="noindent" ><a 
  name="index9-48001"></a>The outcome of the translations should be checked by validators for proper syntax. Typically, with the presence of
validators, errors are easy to detect and correct, but they require human intervention.
</p><!--l. 5029--><p class="indent" >    TeX4ht doesn&#8217;t offer a built-in parser to verify the correctness of the outcome. However, external validator(s)
can quite easily be integrated into the compilation process.
</p>
    <h2 class="ChapterHead"><a 
  name="QQ1-9-49"></a>Recommendations</h2>
<!--l. 5038--><p class="noindent" >To keep with the spirit of LaTeX and hypertext, in which style is assumed to be separated from content, the users
are encouraged to avoid inserting TeX4ht code into their source files. Instead, they should place their
modifications, to the default settings, within private configuration files to be loaded by htlatex-like
commands.
</p><!--l. 5045--><p class="indent" >    On the other hand, it should be noted that hypertext markings should adhere to strict rules specified by
different standards. Consequently, it is strongly advised to check the output obtained from the default
configurations, before trying to tailor new ones.

</p>
    <hr />
<!--l. 5053--><p class="indent" >    <small>Generated August 24, 2020 - <a href="/tex4ht/">tex4ht home page</a></small></p> 
</body></html>