Previous Up Next

7  Cutting your document into pieces with HACHA

HEVEA outputs a single .html file. This file can be cut into pieces at various sectional units by HACHA

7.1  Simple usage

First generate your html document by applying HEVEA:

# hevea doc.tex

Then cut doc.html into pieces by the command:

# hacha doc.html

This will generate a simple root file index.html. This root file holds document title, abstract and a simple table of contents. Every item in the table of contents contains a link to or into a file that holds a “cutting” sectional unit. By default, the cutting sectional unit is section in the article style and chapter in the book style. The name of those files are doc001.html, doc002.html, etc.

Additionally, one level of sectioning below the cutting unit (i.e. subsections in the article style and sections in the book style) is shown as an entry in the table of contents. Sectional units above the cutting section (i.e. parts in both article and book styles) close the current table of contents and open a new one. Cross-references are properly handled, that is, the local links generated by HEVEA are changed into remote links.

The name of the root file can be changed using the -o option:

# hacha -o root.html doc.html

Some of HEVEA output get replicated in all the files generated by HACHA. Users can supply a header and a footer, which will appear at the begining and end of every page generated by HACHA. It suffices to include the following commands in the document preamble:

  \htmlhead{header}
  \htmlfoot{footer}

HACHA also makes every page it generates a clone of its input as regards attributes to the <body ...> opening tag and meta-information from the <head><\head> block. See section B.2 for examples of this replication feature.

By contrast, style information specified in the style elements from rom the <head><\head> block is not replicated. Instead, all style definitions are collected into an external style sheet file whose name is doc.css, and all generated html files adopt doc.css as an external style sheet. It is important to notice that, since version 1.08, HEVEA produces a style element by itself, even if users do not explicitely use styles. As a consequence, HACHA normally produces a file doc.css, which should not be forgotten while copying files to their final destination after a run of HACHA.

7.2  Advanced usage

HACHA behaviour can be altered from the document source, by using a counter and a few macros.

A document that explicitly includes cutting macros still can be typeset by LATEX, provided it loads the hevea.sty style file from the HEVEA distribution. (See section 5 for details on this style file). An alternative to loading the hevea package is to put all cutting instructions in comments starting with %HEVEA.

7.2.1  Principle

HACHA recognizes all sectional units, ordered as follows, from top to bottom: part, chapter, section, subsection, subsubsection, paragraph and subparagraph.

At any point between \begin{document} and \end{document}, there exist a current cutting sectional unit (cutting unit for short), a current cutting depth, a root file and an output file. Table of contents output goes to the root file, normal output goes to the output file. Cutting units start a new output file, whereas units comprised between the cutting unit and the cutting units plus the cutting depth add new entries in the table of contents.

At document start, the root file and the output file are HACHA output file (i.e. index.html). The cutting unit and the cutting depth are set to default values that depend on the document style.

7.2.2  Cutting macros

The following cutting instructions are for use in the document preamble. They command the cutting scheme of the whole document:

\cuttingunit
This is a macro that holds the document cutting unit. You can change the default (which is section in the article style and chapter in the book style) by doing:
\renewcommand{\cuttingunit}{secname}.
\tocnumber
Instruct HEVEA to put section numbers into table of content entries.
\notocnumber
Instruct HEVEA not to put section numbers into table of content entries. This is the default.
cuttingdepth
This is a counter that holds the document cutting depth. You can change the default value of 1 by doing \setcounter{cuttingdepth}{numvalue}. A cutting depth of zero means no other entries than the cutting units in the table of contents.

Other cutting instructions are to be used after \begin{document}. They all generate html comments in HEVEA output. These comments then act as instructions to HACHA.

\cuthere{secname}{itemtitle}
Attempt a cut.
\cutdef[depth]{secname}
Open a new table of contents, with cutting depth depth and cutting unit secname. If the optional depth is absent, the cutting depth does not change. The output file becomes the root file. Result is unspecified if whatever secname expands to is a sectional unit name above the current cutting unit, is not a valid sectional unit name or if depth does not expand to a small positive number.
\cutend
End the current table of contents. This closes the scope of the previous \cutdef. The cutting unit and cutting depth are restored. Note that \cutdef and \cutend must be properly balanced.

Commands \cuthere and \cutend have starred variants, which behave identically except for footnotes (see 7.3.6).

Default settings work as follows: \begin{document} performs

\cutdef*[\value{cuttingdepth}]{\cuttingunit}

and \end{document} performs \cutend*. All sectioning commands perform \cuthere, with the sectional unit name as first argument and the (optional, if present) sectioning command argument (i.e. the section title) as second argument. Note that starred versions of the sectioning commands also perform cutting instructions.

7.2.3  Table of links organisation

A table of links generated by HACHA is a list of links to generated files. Additionally, some sublists may be present, up to a certain depth. The items in those sublists are links inside generated files, they point to sectional unit titles below the cutting unit, up to a certain depth.

More precisely, let A be a certain sectional unit (e.g. “part”), let B be just below A (e.g. “section”), and let C be just below C (e.g. “subsection”). Further assume that cutting is performed at level B with a depth of more than one. Then, every unit A holds a one or several tables of links to generated files, and each generated file normally holds a B unit. Sublists with links to C units inside B units normally appear in the tables of links of level A. The command-line options -tocbis and -tocter instruct hacha to put sublists at other places. With -tocbis sublists are duplicated at the beginning of the B level files; while with -tocter sublist only appear at the beginning of the B level files.

In my opinion, default style is appropriate for documents with short B units; while -tocbis style is appropriate for documents with long B units with a few sub-units; and -tocter style is appropriate for documents with long B units with a lot of sub-units. As you may have noticed, this manual is cut by following the -tocbis style.

Whatever the style is, if a B unit is cut (e.g. because its text is enclosed in \cutdef{C}\cutend), then every C unit goes into its own file and there is no sublist after the relevant B level entry in the A level table of links.

7.2.4  Examples

Consider, for instance, a book document with a long chapter that you want to cut at the section level, showing subsections:

\chapter{A long chapter}
.....

\chapter{The next chapter}

Then, you should insert a \cutdef at chapter start and a \cutend at chapter end:

\chapter{A long chapter}
%HEVEA\cutdef[1]{section}
.....
%HEVEA\cutend
\chapter{The next chapter}

Then, the file that would otherwise contain the long chapter now contains the chapter title and a table of sections. No other change is needed, since the command \section already performs the appropriate \cuthere{section}{...} commands, which were ignored by default. (Also note that cutting macros are placed inside %HEVEA comments, for LATEX not to be disturbed).

The \cuthere macro can be used to put some document parts into their own file. This may prove appropriate for long cover pages or abstracts that would otherwise go into the root file. Consider the following document:

\documentclass{article}

\begin{document}

\begin{abstract} A big abstract \end{abstract}
...

Then, you make the abstract go to its own file as it was a cutting unit by typing:

\documentclass{article}
\usepackage{hevea}

\begin{document}
\cuthere{\cuttingunit}{Abstract}
\begin{abstract} A big abstract \end{abstract}
...

(Note that, this time, cutting macros appear unprotected in the source. However, LATEX still can process the document, since the hevea package is loaded).

7.2.5  More and More Pages in Output

In some situations it may be appropriate to produce many pages from one source files. More specifically, loading the deepcut package will put all sectioning units of your document (from \part to \subsection in their own file.

Similarly, loading the figcut package will make all figures and tables go into their own file. The figcut package accepts two options, show and noshow. The former, which is the default, instructs HEVEA to repeat the caption into the main flow of text, with a link to the figure. The latter option disables the feature.

7.3  More Advanced Usage

In this section we show how to alter some details of HACHA behaviour. This includes controlling output file names and the title of generated web pages and introducing arbitrary cuts.

7.3.1  Controlling output file names

When invoked as hacha doc.html, HACHA produces a index.html table of links file that points into doc001.html, doc002.html, etc. content files. This is not very convenient when one wishes to point inside the document from outside. However, the \cutname{name} command sets the name of the current output file name as name.

Consider a document cut at the section level, which contains the following important section:

\section{Important\label{important} section}
...

To make the important section goes into file important.html, one writes:

\section{Important\label{important} section}\cutname{important.html}
...

Then, section “Important section” can be referenced from an HEVEA unaware html page by:

In this document, there is a very
<a href="important.html#important">important section</a>.

If you are reading the html version of this manual, you may check that you are now reading file cutname.html. This particular file name has been specified from the source using \cutname{cutname.html}.

7.3.2  Controlling page titles

When HACHA creates a web page from a given sectional unit, the title of this page normally is the name of the sectional unit. For instance, the title of this very page should be “Cutting your document into pieces with HACHA”. It is possible to insert some text at the beginning of all page titles, by using the \htmlprefix command. Hence, by writing \htmlprefix{\hevea{} Manual: } in the document, the title of this page would become: “HEVEA Manual: Cutting your document into pieces with HACHA” and the title of all other pages would show the same prefix.

7.3.3  Links for the root file

The command \toplinks{prev}{up}{next} instructs HACHA to put links to a “previous”, “up” and “next” page in the root file. The following points are worth noticing:

This feature can prove useful to relate documents that are generated independently by HEVEA and HACHA.

7.3.4  Controlling link aspect from the document

By default the links to the previous, up and next pages show a small icon (an appropriate arrow). This can be changed with the command \setlinkstext{prev}{up}{next}, where prev, up and next are some LATEX source. For instance the default behaviour is equivalent to:

\setlinkstext
  {\imgsrc[alt="Previous"]{previous_motif.svg}}
  {\imgsrc[alt="Up"]{contents_motif.svg}}
  {\imgsrc[alt="Next"]{next_motif.svg}}

Command \setlinkstext behaves as \toplinks does. That is, it must occur in document preamble, arguments are processed and empty arguments yield no effect (i.e. defaults apply).

7.3.5  Cutting a document anywhere

Part of a document goes to a separate file when enclosed in a cutflow environment:

\begin{cutflow}{title}\end{cutflow}

The content “…” will go into a file of its own, while the argument title is used as the title of the introduced html page.

The html page introduced here does not belong to the normal flow of text. Consequently, one needs an explicit reference from the normal flow of text into the content of the cutflow environment. This will occur naturally when the content of the cutflow environment. contains a \label construct. This look natural in the following quiz example:

\paragraph{A small quiz}
\begin{enumerate}
\item What is black?
\item What is white?
\item What is Dylan?
\end{enumerate}
Answers in section~\ref{answers}.
\begin{cutflow}{Answers}
\paragraph{Quiz answers}\label{answers}
\begin{enumerate}
\item Black is black.
\item White is white.
\item Dylan is Dylan.
\end{enumerate}
\end{cutflow}

The example yields:

A small quiz

  1. What is black?
  2. What is white?
  3. What is Dylan?

Answers in section 7.3.5.

However,introducing html hyperlink targets and references with the \aname and \ahrefloc commands (see section 8.1.1) will be more practical most of the time.

The starred variant environment cutflow* is the same as cutflow, save for the html header and footer (see Section 7.1) which are not replicated in the introduced page.

7.3.6  Footnotes

Footnote texts (given as arguments either to \footnote or \footnotetext) do not go directly to output. Instead, footnote texts accumulate internally in a buffer, awaiting to be flushed. The flushing of notes is controlled by the means of a current flushing unit, which is a sectional unit name or document — a fictional unit above all units. At any point, the current flushing unit is the value of the command \@footnotelevel. In practice, the flushing of footnote texts is performed by two commands:

The article style file performs \flushdef{document}, while the book style file performs \flushdef{chapter}. At the end of processing, \end{document} performs \footnoteflush{\@footnotelevel}, so as to flush any pending notes.

Cutting commands interact with footnote flushing as follows:

Later, when running across footnote texts in its input file, HACHA sometimes put notes in a separate file. More precisely, HACHA has knowledge of the current cutting level, the current sectional unit where cuts occur — as given by the relevant \cutdef. Moreover, HACHA knows the current section level — that is, the last sectional command processed. Besides, HACHA extracts the note level from the comments that surround the notes (as given by the command \footnoteflush that produced the notes). Then, HACHA creates a separate file for notes when the cutting level and the note level differ, or when the current level is above the cutting level (e.g. the current level is document while the cutting level is chapter). As a result, notes should stay where they are when they occur at the end of HACHA output file and otherwise go to a separate file.

To make a complicated story even more complicated, footnotes in minipage environments or in the arguments to \title or \author have a different, I guess satisfactory, behaviour.

Given the above description, footnotes are managed by default as follows.

In case you wish to adopt a book-like behaviour for an article (footnotes at the end of sections), it suffices to insert \flushdef{section} in the document preamble.

We now give a few example of interaction between notes and cutting. We first consider normal behaviour. The page you are reading is a section page, since the current cutting unit is “section”. The current unit is “subsection”. The following two subsubsections are sent to their own files by the means of a \cutdef{subsubsection}/\cutend pair. As a result the text of footnotes appear at the end of the subsubsection pages.

The following two subsubsections are sent to their own files by the means of a \cutdef*{subsubsection}/\cutend* pair. As a result, the text of footnotes in the subsections appear at the end of the current section page.3

Finally, to send the footnotes in subsubsections to a separate web page, one should use a \cutdef{subsubsection}/\cutend pair (to create a proper buffer for subsubsection notes), redefine the flushing unit, and flush notes explicitly.

\cutdef{subsubsection}\flushdef{document}%
\subsubsection{...}
  ...
\footnoteflush{document}\cutend

3
Standard section footnote.
4
Sent at the end of cutname.html
5
Sent at the end of cutname.html

Previous Up Next