florath/rmtoo

.\" 
.\" Man page for rmtoo
.\"
.\" This is free documentation; 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 3 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" (c) 2010-2011 by flonatel (rmtoo@florath.net)
.\"
.TH rmtoo-art-html 1 2011-11-21 "User Commands" "Requirements Management"
.SH NAME
rmtoo-art-html \- requirements management tool: html artifact
.SH DESCRIPTION
The
.B rmtoo
requirment management tool is able to output one topic and all
possible subtopics including the containing requirements as a set of
HTML documents.
.P
Each HTML page is generated out of three parts: a header, a middle
part and a footer.  The header and footer are files which are copied
into each HTML page and are the same for all pages.  The middle part
is automatically generated.
.SH HEADER
The header must include the whole HTML header including the opening
html, full head and opening body tags.
.P
The header may also contain the definitions for the css tags which are
used in the middle part. See section \fBCSS\fR for more details.
.SH MIDDLE PART
The middle part is automatically generated.  The topic description is
used as a base for layout, text and requirements.
.SH FOOTER
The footer can contain arbritary HTML code.  It is copied to the end
of each page.  At least closing body and html tags must be included.
.SH CSS
Mostly each element in a requirement has a separate CSS class.
Therefore it is possible to format mostly every single bit of a
requirement output as wanted.  Please consult
\fIdoc/html/header.html\fR for an example.
Here is a list of all special
.B rmtoo
CSS classes used by the requirements output.  Of course additional
standard CSS classes or attributes (like h1, h2, a and so on) can be
defined.
.TP
\fBfltext\fR
The floating text which is specified in the \fIText:\fR tag in the
topic description.
.TP
\fBrequirment_end\fR
A separator can be defined here. This ends up a requirement.
.TP
\fBdlt_<name>\fR
The tag (key) of mostly all requirements keys can be defined. Example:
dlt_description 
.TP
\fBdlv_<name>\fR
The tag (key) of mostly all requirements keys can be defined. Example:
dlv_description 
.SH CONFIGURATION
To configure HTML output, three mandatory fields are needed:
.TP
\fBoutput_directory\fR output directory of the HTML files.
.TP
\fBheader\fR HTML header file name.
.TP
\fBfooter\fR HTML footer file name.
.SH "SEE ALSO"
.B rmtoo(7)
- overview of rmtoo including all references to available documentation. 
.SH AUTHOR
Written by Andreas Florath (rmtoo@florath.net)
.SH COPYRIGHT
Copyright \(co 2010 by flonatel (rmtoo@florath.net).
License GPLv3+: GNU GPL version 3 or later