NAME

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

SYNOPSIS

htmlsection [-options] [files ...]

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.

If files are specified, htmlsection reads HTML from these files. But, if files are not specified, htmlsection reads HTML from standard input.

* Insert section number in HTML and make links to the section.

* Make the table of contents.

* Insert table, figure, and program-list numbers and make links.

* Make the index of tables, figures, and program-lists.

* Insert reference, term, and note numbers and make links.

EXAMPLES

* Insert section number in HTML and make links to the section.

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>.

Example:

For example, make the file example.html as below,

-------- begin of example --------

<section name="intro" number=no>Introduction</section>

This is introduction.

<section name="howto">How to use htmlsection</section>

<subsection name="howtouse">Let's use htmlsection!</subsection>

If you want to know about htmlsection, see

<sectionref name="howto">, and <subsectionref name="howtouse" title=no>.

<section number=no>Ending</section>

-------- end of example --------

And execute,

> cat example.html | htmlsection -no-spacer

htmlsection will output as,

-------- begin of example --------

<h1><a name="section_intro">Introduction</a></h1>

This is introduction.

<h1><a name="section_howto">1 How to use htmlsection</a></h1>

<h2><a name="subsection_howtouse">1.1 Let's use htmlsection!</a></h2>

If you want to know about htmlsection, see

<a href="#section_howto">1 How to use htmlsection</a>, and <a href="#subsection_howtouse">1.1</a>.

<h1><a name="section_toc2">Ending</a></h1>

-------- end of example --------

* Make the table of contents.

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

* Insert table, figure, and program-list number and make links.

htmlsection inserts the number at <tablereference> tag.

Example:

Before convertion

-------- begin of example --------

<tablereference name="sample_table">Sample Table</tablereference>

<tr><td align=center>name</td><td align=center>function</td></tr>

<tr><td>printf</td><td>print strings by a format.</td></tr>

</table>

</center>

<p>

<br>

<figurereference name="sample_figure">Sample Figure</figurereference>

</center>

<p>

<pre>

<listreference name="sample_list">Sample List</listreference>

int main()

{

int i;

for (i = 0; i < 10; i++)

printf("%d\n", i);

exit (0);

}

</pre>

<p>

See <tableref name="sample_table">.

See <figureref name="sample_figure">.

See <listref name="sample_list">.

-------- end of example --------

After convertion by htmlsection

-------- begin of example --------

<a name="tbl_sample_table">table1: Sample Table</a>

<tr><td align=center>name</td><td align=center>function</td></tr>

<tr><td>printf</td><td>print strings by a format.</td></tr>

</table>

</center>

<p>

<br>

<a name="fig_sample_figure">figure1: Sample Figure</a>

</center>

<p>

<pre>

<a name="lst_sample_list">list1: Sample List</a>

int main()

{

int i;

for (i = 0; i < 10; i++)

printf("%d\n", i);

exit (0);

}

</pre>

<p>

See <a href="#tbl_sample_table">table1</a>.

See <a href="#fig_sample_figure">figure1</a>.

See <a href="#lst_sample_list">list1</a>.

-------- end of example --------

* Make the index of tables, figures, and program-lists.

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

* Insert reference, term, and note number. And make links.

htmlsention makes reference, term, and note index.

Example:

Before convertion

-------- begin of example --------

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">.

<notes>

<note name="AboutMe">And make many programs.

<note name="htmlsection">All of htmlsection are written by perl.

<note>If you want to write other notes, you can write them after here.

<note>Sometimes, I use Tcl/Tk, Java, C++, ...

</notes>

<terms>

<term name="CLang">A programming language.

<term name="htmlsection">This program.

<term name="PerlLang">A programming language.

<term>If you want to write other terms, you can write them after here.

<term word="Tcl/Tk">A programming language.

<term word="Java">A programming language.

</terms>

<reference name="KandR">Brian W. Kernighan and Dennis M. Ritchie, "The C Programming Language", Prentice-Hall, 1978.

<reference name="KandR2">Brian W. Kernighan and Dennis M. Ritchie, "The C Programming Language", Second Edition, Prentice Hall, 1988.

<reference name="LamaBook">Randal L. Schwartz and Tom Phoenix, "Learning Perl", Oreilly & Associates Inc.

<reference>If you want to write other references, you can write them after here.

<reference name="CamelBook">Larry Wall, Tom Christiansen, and Jon Orwant, "Programming Perl", Oreilly & Associates.

<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.

</references>

-------- end of example --------

After convertion by htmlsection

-------- begin of example --------

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>.

<h1>Notes</h1>

<ul>

<li><a name="note_1_AboutMe">(*1)</a> And make many programs.

<li><a name="note_1_htmlsection">(*2)</a> All of htmlsection are written by perl.

<li><a name="note_1_noname_1">(*3)</a> If you want to write other notes, you can write them after here.

<li><a name="note_1_noname_2">(*4)</a> Sometimes, I use Tcl/Tk, Java, C++, ...

</ul>

<h1>Terms</h1>

<ul>

<li><a name="term_1_CLang">(1)C</a> A programming language.

<li><a name="term_1_htmlsection">(2)htmlsection</a> This program.

<li><a name="term_1_PerlLang">(3)perl</a> A programming language.

<li><a name="term_1_noname_1">(4)</a> If you want to write other terms, you can write them after here.

<li><a name="term_1_noname_2">(5)Tcl/Tk</a> A programming language.

<li><a name="term_1_noname_3">(6)Java</a> A programming language.

</ul>

<h1>References</h1>

<ul>

<li><a name="ref_1_KandR">[1]</a> Brian W. Kernighan and Dennis M. Ritchie, "The C Programming Language", Prentice-Hall, 1978.

<li><a name="ref_1_KandR2">[2]</a> Brian W. Kernighan and Dennis M. Ritchie, "The C Programming Language", Second Edition, Prentice Hall, 1988.

<li><a name="ref_1_LamaBook">[3]</a> Randal L. Schwartz and Tom Phoenix, "Learning Perl", Oreilly & Associates Inc.

<li><a name="ref_1_noname_1">[4]</a> If you want to write other references, you can write them after here.

<li><a name="ref_1_CamelBook">[5]</a> Larry Wall, Tom Christiansen, and Jon Orwant, "Programming Perl", Oreilly & Associates.

<li><a name="ref_1_NumericalRecipe">[6]</a> William H. Press, Saul A. Teukolsky, William T. Vetterling, and Brian P.Flannery, "Numerical Recipes in C", Second Edition, Cambridge University Press, 1992.

</ul>

-------- end of example --------

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

Example:

Before convertion

-------- begin of example --------

<section>The C Programming Language</section>

The <termref name="Lang">C</termref> is a programming language<ref name="Book">.<noteref name="About">

<notes>

<note name="About">A programming language.

</notes>

<terms>

<term name="Lang">It is a programming language.

</terms>

<reference name="Book">Brian W. Kernighan and Dennis M. Ritchie, "The C Programming Language", Prentice-Hall, 1978.

</references>

<section>The Perl Programming Language</section>

The <termref name="Lang">Perl</termref> is a programming language<ref name="Book">.<noteref name="About">

<notes>

<note name="About">A programming language.

</notes>

<terms>

<term name="Lang">It is a programming language.

</terms>

<reference name="Book">Randal L. Schwartz and Tom Phoenix, "Learning Perl", Oreilly & Associates Inc.

</references>

-------- end of example --------

After convertion by htmlsection

-------- begin of example --------

<h1><a name="section_1">1 The C Programming Language</a></h1>

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>

<h1>Notes</h1>

<ul>

<li><a name="note_1_About">(*1)</a> A programming language.

</ul>

<h1>Terms</h1>

<ul>

<li><a name="term_1_Lang">(1)C</a> It is a programming language.

</ul>

<h1>References</h1>

<ul>

<li><a name="ref_1_Book">[1]</a> Brian W. Kernighan and Dennis M. Ritchie, "The C Programming Language", Prentice-Hall, 1978.

</ul>

<h1><a name="section_2">2 The Perl Programming Language</a></h1>

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>

<h1>Notes</h1>

<ul>

<li><a name="note_2_About">(*1)</a> A programming language.

</ul>

<h1>Terms</h1>

<ul>

<li><a name="term_2_Lang">(1)Perl</a> It is a programming language.

</ul>

<h1>References</h1>

<ul>

<li><a name="ref_2_Book">[1]</a> Randal L. Schwartz and Tom Phoenix, "Learning Perl", Oreilly & Associates Inc.

</ul>

-------- end of example --------

OPTIONS

-h, -help: Output help messages.

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

-spacer: Spacing <section>, <subsection> and <subsubsection> tag.

-no-spacer: No spacing.

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

-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.

-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, ...

-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.

-figure-section [section], -list-section [section]: Same as -table-section option.

-start-table [number]: Specify the table number at start.

-start-figure [number], -start-list [number]: Same as -start-table option.

-start-ref [number], -start-term [number], -start-note [number]: Same as -start-table option.

-ref-number: Numbering of references are available as default.

-term-number, -note-number: Same as -ref-number option.

-no-ref-number, -no-term-number, -no-note-number: No numbering as default.

-toc-file [filename]: If you specify -toc-file, output the table of contents to the file.

-table-file [filename]: If you specify -table-file, output the table index to the file.

-figure-file [filename], -list-file [filename]: Same as -table-file option.

-ref-file [filename], -term-file [filename], -note-file [filename]: Same as -table-file option.

-o [filename]: Specify the output file. If you don't specify the filename, htmlsection outputs HTML to the standard output.

ENVIRONMENT VARIABLES

LANG: Specify the language.

FILES

/usr/local/share/doc/htmlsection - Documents.

/usr/local/share/doc/htmlsection/README - Readme file.

/usr/local/share/doc/ja/htmlsection/README-j - Readme file (Japanese).

/usr/local/share/doc/htmlsection/htmlsection.html - Sample HTML file and description about htmlsection.

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

VERSION

This man page is from htmlsection-1.1.

AUTHOR

Programmed by SAKAI Hiroaki.

E-Mail: hsakai@m8.ffn.ne.jp

Web site:

http://web.ffn.ne.jp/~hsakai/myfreesoft/index.html

Mirror site:

http://hp.vector.co.jp/authors/VA014157/myfreesoft/index.html

COPYRIGHT

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.

NAME

SYNOPSIS

DESCRIPTION

EXAMPLES

OPTIONS

ENVIRONMENT VARIABLES

TAGS

SEE ALSO

FILES

VERSION

AUTHOR

COPYRIGHT