.\" 
.\" htmlsection Copyright (C) 2001-2003 SAKAI Hiroaki.
.\" All Rights Reserved.
.\" 
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2, or (at your option)
.\" any later version.
.\" 
.TH HTMLSECTION 1 "HTMLSECTION"

.SH NAME

htmlsection - insert section number in HTML and make the table of contents.

.SH SYNOPSIS

.B htmlsection [-options] [files ...]

.SH DESCRIPTION

htmlsection is a perl script to insert section number in HTML. When you use
htmlsection, you don't have to manage section, table, figure, program-list,
reference, term and note numbers and you don't have to make the table of
contents, table index, figure index, and program-list index.
.PP
If files are specified, htmlsection reads HTML from these files. But, if
files are not specified, htmlsection reads HTML from standard input.
.PP
* Insert section number in HTML and make links to the section.
.br
* Make the table of contents.
.br
* Insert table, figure, and program-list numbers and make links.
.br
* Make the index of tables, figures, and program-lists.
.br
* Insert reference, term, and note numbers and make links.

.SH EXAMPLES

.TP 8
.B * Insert section number in HTML and make links to the section.
.PP

htmlsection changes <section></section> tag to <h1></h1> tag and section
number. You can use tag <section>, <subsection>, ..., and
<subsubsubsubsubsection>.
If name option is specified, htmlsection changes <sectionref> tag to the
number and title of the section and make link to the section.
If you want not to use number, use number option as <section number=no>.
.PP
Example:
.PP
For example, make the file example.html as below,
.PP
-------- begin of example --------
.br
<section name="intro" number=no>Introduction</section>
.PP
    This is introduction.
.PP
<section name="howto">How to use htmlsection</section>
.PP
<subsection name="howtouse">Let's use htmlsection!</subsection>
.PP
    If you want to know about htmlsection, see
.br
<sectionref name="howto">, and
<subsectionref name="howtouse" title=no>.
.PP
<section number=no>Ending</section>
.br
-------- end of example --------
.PP
And execute, 
.br
> cat example.html | htmlsection -no-spacer
.br
htmlsection will output as,
.PP
-------- begin of example --------
.br
<h1><a name="section_intro">Introduction</a></h1>
.PP
    This is introduction.
.PP
<h1><a name="section_howto">1 How to use htmlsection</a></h1>
.PP
<h2><a name="subsection_howtouse">1.1 Let's use htmlsection!</a></h2>
.PP
    If you want to know about htmlsection, see
.br
<a href="#section_howto">1 How to use htmlsection</a>, and
<a href="#subsection_howtouse">1.1</a>.
.PP
<h1><a name="section_toc2">Ending</a></h1>
.br
-------- end of example --------
.PP

.TP 8
.B * Make the table of contents.
.PP

htmlsection inserts the table of contents at
<tableofcontents></tableofcontents> tag.

.TP 8
.B * Insert table, figure, and program-list number and make links.
.PP

htmlsection inserts the number at <tablereference> tag.
.PP
Example:
.PP
Before convertion
.PP
-------- begin of example --------
.br
<center>
.br
<tablereference name="sample_table">Sample Table</tablereference>
.br
<table border=1>
.br
<tr><td align=center>name</td><td align=center>function</td></tr>
.br
<tr><td>printf</td><td>print strings by a format.</td></tr>
.br
</table>
.br
</center>
.PP
<p>
.br
<center>
.br
<img src="picture/sample.jpg">
.br
<br>
.br
<figurereference name="sample_figure">Sample Figure</figurereference>
.br
</center>
.PP
<p>
.br
<pre>
.br
<listreference name="sample_list">Sample List</listreference>
.PP
int main()
.br
{
.br
  int i;
.br
  for (i = 0; i < 10; i++)
.br
    printf("%d\\n", i);
.br
  exit (0);
.br
}
.br
</pre>
.PP
<p>
.br
See <tableref name="sample_table">.
.br
See <figureref name="sample_figure">.
.br
See <listref name="sample_list">.
.br
-------- end of example --------
.PP
After convertion by htmlsection
.PP
-------- begin of example --------
.br
<center>
.br
<a name="tbl_sample_table">table1: Sample Table</a>
.br
<table border=1>
.br
<tr><td align=center>name</td><td align=center>function</td></tr>
.br
<tr><td>printf</td><td>print strings by a format.</td></tr>
.br
</table>
.br
</center>
.PP
<p>
.br
<center>
.br
<img src="picture/sample.jpg">
.br
<br>
.br
<a name="fig_sample_figure">figure1: Sample Figure</a>
.br
</center>
.PP
<p>
.br
<pre>
.br
<a name="lst_sample_list">list1: Sample List</a>
.PP
int main()
.br
{
.br
  int i;
.br
  for (i = 0; i < 10; i++)
.br
    printf("%d\\n", i);
.br
  exit (0);
.br
}
.br
</pre>
.PP
<p>
.br
See <a href="#tbl_sample_table">table1</a>.
.br
See <a href="#fig_sample_figure">figure1</a>.
.br
See <a href="#lst_sample_list">list1</a>.
.br
-------- end of example --------
.PP

.TP 8
.B * Make the index of tables, figures, and program-lists.
.PP

htmlsection inserts the index of table, figure, and list at
<tableindex></tableindex>, <figureindex></figureindex>, and
<listindex></listindex> tag.

.TP 8
.B * Insert reference, term, and note number. And make links.
.PP

htmlsention makes reference, term, and note index.
.PP
Example:
.PP
Before convertion
.PP
-------- begin of example --------
.br
The <termref name="CLang">C</termref> is a programming
language<ref name="KandR"><ref name="KandR2">.
I always use <termref name="CLang">C</termref><noteref name="AboutMe">.
But, <termref name="htmlsection">htmlsection</termref> is
<noteref name="htmlsection">written by
<termref name="PerlLang">perl</termref><ref name="LamaBook">.
<termref name="PerlLang">Perl</termref> is a very convenient
language<ref name="LamaBook"> and I always use
<termref name="PerlLang">perl</termref> too<noteref name="AboutMe">.
.PP
<notes>
.br
<note name="AboutMe">And make many programs.
.br
<note name="htmlsection">All of htmlsection are written by perl.
.br
<note>If you want to write other notes,
you can write them after here.
.br
<note>Sometimes, I use Tcl/Tk, Java, C++, ...
.br
</notes>
.PP
<terms>
.br
<term name="CLang">A programming language.
.br
<term name="htmlsection">This program.
.br
<term name="PerlLang">A programming language.
.br
<term>If you want to write other terms,
you can write them after here.
.br
<term word="Tcl/Tk">A programming language.
.br
<term word="Java">A programming language.
.br
</terms>
.PP
<references>
.br
<reference name="KandR">Brian W. Kernighan and Dennis M. Ritchie,
"The C Programming Language", Prentice-Hall, 1978.
.br
<reference name="KandR2">Brian W. Kernighan and Dennis M. Ritchie,
"The C Programming Language", Second Edition, Prentice Hall, 1988.
.br
<reference name="LamaBook">Randal L. Schwartz and Tom Phoenix,
"Learning Perl", Oreilly & Associates Inc.
.br
<reference>If you want to write other references,
you can write them after here.
.br
<reference name="CamelBook">Larry Wall, Tom Christiansen, and Jon Orwant,
"Programming Perl", Oreilly & Associates.
.br
<reference name="NumericalRecipe">William H. Press, Saul A. Teukolsky,
William T. Vetterling, and Brian P.Flannery,
"Numerical Recipes in C", Second Edition, Cambridge University Press, 1992.
.br
</references>
.br
-------- end of example --------
.PP
After convertion by htmlsection
.PP
-------- begin of example --------
.br
The <a href="#term_1_CLang">(1)C</a> is a programming
language<a href="#ref_1_KandR">[1]</a><a href="#ref_1_KandR2">[2]</a>.
I always use <a href="#term_1_CLang">(1)C</a><a href="#note_1_AboutMe">(*1)</a>.
But, <a href="#term_1_htmlsection">(2)htmlsection</a> is
<a href="#note_1_htmlsection">(*2)</a>written by
<a href="#term_1_PerlLang">(3)perl</a><a href="#ref_1_LamaBook">[3]</a>.
<a href="#term_1_PerlLang">(3)Perl</a> is a very convenient
language<a href="#ref_1_LamaBook">[3]</a> and I always use
<a href="#term_1_PerlLang">(3)perl</a> too<a href="#note_1_AboutMe">(*1)</a>.
.PP
<h1>Notes</h1>
.PP
<ul>
.br
<li><a name="note_1_AboutMe">(*1)</a>&nbsp;And make many programs.
.br
<li><a name="note_1_htmlsection">(*2)</a>&nbsp;All of htmlsection are written by perl.
.br
<li><a name="note_1_noname_1">(*3)</a>&nbsp;If you want to write other notes,
you can write them after here.
.br
<li><a name="note_1_noname_2">(*4)</a>&nbsp;Sometimes, I use Tcl/Tk, Java, C++, ...
.br
</ul>
.PP
<h1>Terms</h1>
.PP
<ul>
.br
<li><a name="term_1_CLang">(1)C</a>&nbsp;A programming language.
.br
<li><a name="term_1_htmlsection">(2)htmlsection</a>&nbsp;This program.
.br
<li><a name="term_1_PerlLang">(3)perl</a>&nbsp;A programming language.
.br
<li><a name="term_1_noname_1">(4)</a>&nbsp;If you want to write other terms,
you can write them after here.
.br
<li><a name="term_1_noname_2">(5)Tcl/Tk</a>&nbsp;A programming language.
.br
<li><a name="term_1_noname_3">(6)Java</a>&nbsp;A programming language.
.br
</ul>
.PP
<h1>References</h1>
.PP
<ul>
.br
<li><a name="ref_1_KandR">[1]</a>&nbsp;Brian W. Kernighan and Dennis M. Ritchie,
"The C Programming Language", Prentice-Hall, 1978.
.br
<li><a name="ref_1_KandR2">[2]</a>&nbsp;Brian W. Kernighan and Dennis M. Ritchie,
"The C Programming Language", Second Edition, Prentice Hall, 1988.
.br
<li><a name="ref_1_LamaBook">[3]</a>&nbsp;Randal L. Schwartz and Tom Phoenix,
"Learning Perl", Oreilly & Associates Inc.
.br
<li><a name="ref_1_noname_1">[4]</a>&nbsp;If you want to write other references,
you can write them after here.
.br
<li><a name="ref_1_CamelBook">[5]</a>&nbsp;Larry Wall, Tom Christiansen, and Jon Orwant,
"Programming Perl", Oreilly & Associates.
.br
<li><a name="ref_1_NumericalRecipe">[6]</a>&nbsp;William H. Press, Saul A. Teukolsky,
William T. Vetterling, and Brian P.Flannery,
"Numerical Recipes in C", Second Edition, Cambridge University Press, 1992.
.br
</ul>
.br
-------- end of example --------
.PP

You can use reference, term, and note index to repeat every section
and use name option as same name.

.PP
Example:
.PP
Before convertion
.PP
-------- begin of example --------
.br
<section>The C Programming Language</section>
.PP
The <termref name="Lang">C</termref> is a programming
language<ref name="Book">.<noteref name="About">
.PP
<notes>
.br
<note name="About">A programming language.
.br
</notes>
.PP
<terms>
.br
<term name="Lang">It is a programming language.
.br
</terms>
.PP
<references>
.br
<reference name="Book">Brian W. Kernighan and Dennis M. Ritchie,
"The C Programming Language", Prentice-Hall, 1978.
.br
</references>
.PP
<section>The Perl Programming Language</section>
.PP
The <termref name="Lang">Perl</termref> is a programming
language<ref name="Book">.<noteref name="About">
.PP
<notes>
.br
<note name="About">A programming language.
.br
</notes>
.PP
<terms>
.br
<term name="Lang">It is a programming language.
.br
</terms>
.PP
<references>
.br
<reference name="Book">Randal L. Schwartz and Tom Phoenix,
"Learning Perl", Oreilly & Associates Inc.
.br
</references>
.br
-------- end of example --------
.PP
After convertion by htmlsection
.PP
-------- begin of example --------
.br
<h1><a name="section_1">1 The C Programming Language</a></h1>
.PP
The <a href="#term_1_Lang">(1)C</a> is a programming
language<a href="#ref_1_Book">[1]</a>.<a href="#note_1_About">(*1)</a>
.PP
<h1>Notes</h1>
.PP
<ul>
.br
<li><a name="note_1_About">(*1)</a>&nbsp;A programming language.
.br
</ul>
.PP
<h1>Terms</h1>
.PP
<ul>
.br
<li><a name="term_1_Lang">(1)C</a>&nbsp;It is a programming language.
.br
</ul>
.PP
<h1>References</h1>
.PP
<ul>
.br
<li><a name="ref_1_Book">[1]</a>&nbsp;Brian W. Kernighan and Dennis M. Ritchie,
"The C Programming Language", Prentice-Hall, 1978.
.br
</ul>
.PP
<h1><a name="section_2">2 The Perl Programming Language</a></h1>
.PP
The <a href="#term_2_Lang">(1)Perl</a> is a programming
language<a href="#ref_2_Book">[1]</a>.<a href="#note_2_About">(*1)</a>
.PP
<h1>Notes</h1>
.PP
<ul>
.br
<li><a name="note_2_About">(*1)</a>&nbsp;A programming language.
.br
</ul>
.PP
<h1>Terms</h1>
.PP
<ul>
.br
<li><a name="term_2_Lang">(1)Perl</a>&nbsp;It is a programming language.
.br
</ul>
.PP
<h1>References</h1>
.PP
<ul>
.br
<li><a name="ref_2_Book">[1]</a>&nbsp;Randal L. Schwartz and Tom Phoenix,
"Learning Perl", Oreilly & Associates Inc.
.br
</ul>
.br
-------- end of example --------
.PP

.SH OPTIONS

.TP 8
.B -h, -help

Output help messages.

.TP 8
.B -max-depth [depth]

Specify the max depth of subsection of section tag. If you specify
-max-depth 10, you can use <subsubsubsubsubsubsubsubsubsection> tag.

.TP 8
.B -spacer

Spacing <section>, <subsection> and <subsubsection> tag.

.TP 8
.B -no-spacer

No spacing.

.TP 8
.B -english, -japanese

Specify the language. If you don't specify these options, htmlsection
sees environment variable LANG.

.TP 8
.B -start-section [section]

Specify the section number at start. For example, if you specify
-start-section 3.5.6, htmlsection sets the section number to it at start.

.TP 8
.B -toc-section [section]

Specify the section depth to make the table of contents. If you
specify -toc-section 2, htmlsection makes the table of contents
by section and subsection only.
If you specify -toc-section 0, htmlsection makes the table of contents
by all of sections, subsections, subsubsections, ...

.TP 8
.B -table-section [section]

Specify the section number at beginning of table number.
If you specify -table-section 2, format of table number is
[section_number].[subsection_number].[table_number].
If you specify -table-section 0, format of table number is
[table_number] only.

.TP 8
.B -figure-section [section], -list-section [section]

Same as -table-section option.

.TP 8
.B -start-table [number]

Specify the table number at start.

.TP 8
.B -start-figure [number], -start-list [number]

Same as -start-table option.

.TP 8
.B -start-ref [number], -start-term [number], -start-note [number]

Same as -start-table option.

.TP 8
.B -ref-number

Numbering of references are available as default.

.TP 8
.B -term-number, -note-number

Same as -ref-number option.

.TP 8
.B -no-ref-number, -no-term-number, -no-note-number

No numbering as default.

.TP 8
.B -toc-file [filename]

If you specify -toc-file, output the table of contents to the file.

.TP 8
.B -table-file [filename]

If you specify -table-file, output the table index to the file.

.TP 8
.B -figure-file [filename], -list-file [filename]

Same as -table-file option.

.TP 8
.B -ref-file [filename], -term-file [filename], -note-file [filename]

Same as -table-file option.

.TP 8
.B -o [filename]

Specify the output file. If you don't specify the filename, htmlsection
outputs HTML to the standard output.

.SH "ENVIRONMENT VARIABLES"

.TP 8
.B LANG

Specify the language.

.SH TAGS

.TP 8
.B <section>Title</section>, <subsection>Title</subsection>, ...
.PP
options:
.br
name="section_name"
.br
number=yes or no

.TP 8
.B <sectionref>, <subsectionref>, ...
.PP
options:
.br
name="section_name"
.br
title=yes or no

.TP 8
.B <tablereference>Title</tablereference>
.PP
options:
.br
name="table_name"
.br
number=yes or no

.TP 8
.B <figurereference>Title</figurereference>
.PP
options:
.br
name="figure_name"
.br
number=yes or no

.TP 8
.B <listreference>Title</listreference>
.PP
options:
.br
name="list_name"
.br
number=yes or no

.TP 8
.B <tableref>
.PP
options:
.br
name="table_name"
.br
title=yes or no

.TP 8
.B <figureref>
.PP
options:
.br
name="figure_name"
.br
title=yes or no

.TP 8
.B <listref>
.PP
options:
.br
name="list_name"
.br
title=yes or no

.TP 8
.B <references></references>
.PP
no options.

.TP 8
.B <reference>
.PP
options:
.br
name="reference_name"
.br
title=yes or no
.br
number=yes or no

.TP 8
.B <terms></terms>
.PP
no options.

.TP 8
.B <term>
.PP
options:
.br
name="term_name"
.br
word="term_word"
.br
title=yes or no
.br
number=yes or no

.TP 8
.B <notes></notes>
.PP
no options.

.TP 8
.B <note>
.PP
options:
.br
name="note_name"
.br
title=yes or no
.br
number=yes or no

.TP 8
.B <ref>
.PP
options:
.br
name="reference_name"
.br
title=yes or no
.br
number=yes or no

.TP 8
.B <termref>Word</termref>
.PP
options:
.br
name="term_name"
.br
title=yes or no
.br
number=yes or no

.TP 8
.B <noteref>
.PP
options:
.br
name="note_name"
.br
title=yes or no
.br
number=yes or no

.TP 8
.B <tableofcontents></tableofcontents>
.PP
no options.

.TP 8
.B <tableindex></tableindex>
.PP
no options.

.TP 8
.B <figureindex></figureindex>
.PP
no options.

.TP 8
.B <listindex></listindex>
.PP
no options.

.SH "SEE ALSO"

perl(1), 
.br
Comments at the head of htmlsection script,
.br
http://web.ffn.ne.jp/~hsakai/myfreesoft/htmlsection.html
.br
http://web.ffn.ne.jp/~hsakai/myfreesoft/htmlsection-j.html

.SH "FILES"

/usr/local/share/doc/htmlsection - Documents.
.br
/usr/local/share/doc/htmlsection/README - Readme file.
.br
/usr/local/share/doc/ja/htmlsection/README-j - Readme file (Japanese).
.br
/usr/local/share/doc/htmlsection/htmlsection.html
- Sample HTML file and description about htmlsection.
.br
/usr/local/share/doc/ja/htmlsection/htmlsection-j.html
- Sample HTML file and description about htmlsection (Japanese).

.SH VERSION

This man page is from htmlsection-1.1.

.SH AUTHOR

Programmed by SAKAI Hiroaki.
.br
E-Mail: hsakai@m8.ffn.ne.jp
.br
Web site:
.br
http://web.ffn.ne.jp/~hsakai/myfreesoft/index.html
.br
Mirror site:
.br
http://hp.vector.co.jp/authors/VA014157/myfreesoft/index.html

.SH COPYRIGHT
htmlsection Copyright (C) 2001-2003 SAKAI Hiroaki.
.br
All Rights Reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.