diff options
Diffstat (limited to 'setedit/doc/rhidemac.htm')
| -rw-r--r-- | setedit/doc/rhidemac.htm | 475 |
1 files changed, 475 insertions, 0 deletions
diff --git a/setedit/doc/rhidemac.htm b/setedit/doc/rhidemac.htm new file mode 100644 index 0000000..38726d3 --- /dev/null +++ b/setedit/doc/rhidemac.htm @@ -0,0 +1,475 @@ +@c rhidemac.htm: -*- Texinfo -*- + +@c ------------------------------------------------------------------------- +@c +@c Macros for making RHIDE documentation in HTML format. +@c +@c Author: Robert H”hne (robert.hoehne@gmx.net) +@c November 1996. +@c +@c Derived from 'faqmacros.txi', which is part of DJGPP FAQ written +@c by Eli Eli Zaretskii (eliz@is.elta.co.il) +@c +@c Many ideas taken from files `multifmt.texi' and html.texi' +@c written by Brian J. Fox and distributed with GNU Texinfo archive: +@c +@c Author: Brian J. Fox (bfox@ua.com) Sun Apr 2 07:56:23 1995. +@c +@c ------------------------------------------------------------------------- + +@c +@c This creates a standard HTML prolog. +@c +@macro htmlstart +<html> + +<pre> + +<!--- This HTML file has been created by Texinfo from --------- +------- rhide.txi, using a special set of macros from --------- +---- `rhidemac.txi' on @today{}. + +---- Please don't look at it but through your Web browser: --- +---- it looks ugly and ain't supposed to be read by humans. --- +---- You HAVE been warned! ---> + +</pre> +@end macro + +@c +@c TITLEs for HTML +@c +@macro htmltitle{line} +<head>@* +@w{<TITLE> \line\ </TITLE>}@* +</head>@* +<body>@* +@w{<H1> \line\ </H1>}@* +@end macro +@macro htmlsubtitle{line} +@w{<h2> \line\ </h2>}@* +@end macro +@macro htmlauthor{line} +@w{<ADDRESS> \line\ </ADDRESS>}@* +@end macro + +@c +@c When making HTML output, @bye does some cleanup. +@c +@macro bye +</body>@* +</html>@* +@bye +@end macro + +@c +@c @anchor{Brian Fox, http://www.ua.com/users/bfox/} +@c +@macro anchor-{text, link} +@w{<a href="\link\">\text\</a>} +@end macro + +@macro TeX- +<i>T</i>e<i>X</i> +@end macro + +@macro paragraph{} +<p> +@end macro + +@c +@c @mail{Eli Zaretskii, eliz@@is.elta.co.il} +@c +@macro mail{name, address} +@w{<a href="mailto:\address\">\name\</a>} +@end macro + +@c +@c @ftp{SimTel, ftp.coast.net/SimTel/vendors/djgpp/} +@c +@macro ftp{desc, path} +@w{<a href="ftp://\path\">\desc\</a>} +@end macro + +@c +@c @ftpdir{ftp.coast.net, /SimTel/vendors/djgpp} +@c +@macro ftpdir{host, dir} +@w{<a href="ftp://\host\\dir\/">\host\</a>} +@end macro + +@c +@c ftpusr{riceng.rice.edu, login: ezgcc, passwd: ezgcc} +@c +@macro ftpusr{desc, host, login, passwd} +@w{<a href="ftp://\login\:\passwd\@@\host\/">\desc\</a>} +@end macro + +@c +@c @www{DJGPP server, www.delorie.com/djgpp/} +@c +@macro www{desc, path} +@w{<a href="http://\path\">\desc\</a>.} +@end macro + +@c +@c @gopher{SimTel, ftp.coast.net/SimTel/vendors/djgpp/} +@c +@macro gopher{desc, path} +@w{<a href="gopher://\path\">\desc\</a>} +@end macro + +@c +@c @news{comp.os.msdos.djgpp} +@c +@macro news{name} +@w{<a href="news:\name\">\name\</a>} +@end macro + +@c +@c Redefine the TeXinfo commands which have direct HTML counterparts. +@c + +@macro html-define-0arg{command, html-insertion} +@macro \command\ +@w{\html-insertion\} +@end macro +@end macro + +@macro html-define-1arg{command, html-insertion} +@macro \command\{arg} +@quote-arg +@w{\html-insertion\} +@end macro +@end macro + +@macro html-define-line{command, html-insertion} +@macro \command\{line} +@w{\html-insertion\} +@end macro +@end macro + +@macro asis{arg} +\arg\ +@end macro + +@c +@c Various lists (@table, @itemize, @enumerate) +@c + +@ignore +@macro table{flavor} + +<dl>@* +@end macro +@macro end-table +@* +</dl>@* +@end macro + +@macro titem{line} +@* +<dt> \line\@* +<dd> +@end macro +@macro titemx{line} +<dt> \line\@* +@end macro +@macro titeml{line} +<dt> \line\@* +<dd> +@end macro +@end ignore + +@c I'm using now the table environment of HTML +@c Do not nest the table environment + +@macro table{table_format} +@macro _table_format{arg} +\table_format\{\arg\} +@end macro +<table border> +@end macro +@macro titem{line} +<tr><td>@_table_format{\line\}<td> +@end macro +@macro titemx{line} +@titem \line\ +@end macro +@macro end-table +<tr></table> +@unmacro _table_format +@end macro + +@macro itemize{style} +@* +<ul>@* +@end macro +@macro item{line} +@* +<li>\line\ +@end macro +@macro end-itemize +@* +</ul>@* +@end macro +@macro enumerate{style} +@* +<ol>@* +@end macro +@macro end-enumerate +@* +</ol>@* +@end macro + +@c . +@c Preformatted stuff (@example, @display, @smallexample, @quotation) +@c Expanded by SDH because they contain the command itself. + +@c @macro format- +@c @exdent <pre>@* +@c @format +@c @end macro +@c @macro end-format +@c @end format +@c @exdent </pre>@* +@c @* +@c @end macro + +@c @macro display- +@c @exdent <pre>@* +@c @display +@c @end macro +@c @macro example- +@c @exdent <pre>@* +@c @example +@c @end macro +@c @macro smallexample- +@c @exdent <pre>@* +@c @smallexample +@c @end macro +@c @macro quotation- +@c @exdent <blockquote>@* +@c @quotation +@c @end macro +@c @macro end-example +@c @end example +@c @exdent </pre>@* +@c @* +@c @end macro +@c @macro end-smallexample +@c @end smallexample +@c @exdent </pre>@* +@c @* +@c @end macro +@c @macro end-display +@c @end display +@c @exdent </pre>@* +@c @* +@c @end macro +@c @macro end-quotation +@c @end quotation +@c @exdent </blockquote>@* +@c @* +@c @end macro + +@c . +@c Nodes, chapters, sections and menus +@c . + +@macro menu- +<p>@* +<MENU>@* + +@end macro +@macro mitem{node, rest} +<LI>@w{<A HREF="#\node\"> \node\---\rest\ </A>}@* +@end macro +@macro end-menu + +</MENU>@* + +@end macro + +@macro node{this, next, prev, up} +<A NAME="\this\"> +@end macro + +@macro top{line} +<CENTER>@* +<H1> \line\ </H1></A><P>@* +</CENTER>@* +@end macro + +@macro chapter{line} +<CENTER>@* +<H2> \line\ </H2></A><P>@* +</CENTER>@* +@end macro + +@macro section{line} +@* +<H3> \line\ </H3></A><P>@* +@end macro + +@macro subsection{line} +@* +<H4> \line\ </H4></A><P>@* +@end macro + +@macro subsubsection{line} +@* +<H4> \line\ </H4></A><P>@* +@end macro + +@macro unnumbered{line} +@chapter{\line\} +@end macro + +@macro unnumberedsec{line} +@section{\line\} +@end macro + +@macro subsubheading{line} +@subsubsection{\line\} +@end macro + +@macro appendix{line} + \line\ </A></H3><P> + +@end macro + +@macro appendixsec{line} + \line\</A></H3><P> + +@end macro + +@c +@c Footnotes +@ + +@macro footnote{stuff} +@quote-arg + +<P><i><b> Note: </b>\stuff\ </i><P> + +@end macro + +@macro quest{stuff} +@quote-arg +@* +<em><strong>Question</strong>: \stuff\ </em> +<p>@* +@end macro + +@macro ans +@* +@exdent <hr> +<strong>Answer</strong>: +@end macro + +@c +@c Cross-references +@c + +@c NOTE: The internal cross-references only support 2-argument +@c varieties of the Texinfo commands, and the external +@c cross-reference only support 4-argument form! + +@macro ref{node, desc, title, file, doc} +@set desc_seen +@set doc_seen +@ifeq{"\doc\", "", @clear doc_seen } +@ifeq{"\desc\", "", @clear desc_seen } +@ifset doc_seen +@ifset desc_seen +<B>Section \desc\ in \doc\</B> +@end ifset +@ifclear desc_seen +<B>Section \node\ in \doc\</B> +@end ifclear +@end ifset +@ifclear doc_seen +@w{<A HREF="#\node\">} +@ifset desc_seen +\desc\ +@end ifset +@ifclear desc_seen +\node\ +@end ifclear +</A> +@end ifclear +@end macro + +@macro xref{node, desc, title, file, doc} +See @ref{\node\,\desc\,\title\,\file\,\doc\} +@end macro + +@macro mxref{node, desc, title, file, doc} +see @ref{\node\,\desc\,\title\,\file\,documentation for \doc\} +@end macro + +@macro pxref{node, desc, title, file, doc} +see @ref{\node\,\desc\,\title\,\file\,\doc\} +@end macro + +@c @macro extref{node, desc, file, title, url} +@c See @w{<A HREF="http://\url\">}the ``\node\'' section of the ``\title\''</A> +@c @end macro + +@macro extref{node, desc, file, title, url} +See @w{<A HREF="\url\#\node\">}the ``\node\'' section of the ``\title\''</A> +@end macro + +@c +@c ---------------- Common part ------------------------------------ +@c + +@macro b{arg} +<b>\arg\</b> +@end macro +@macro code{arg} +<code>\arg\</code> +@end macro +@macro file{arg} +<code>\arg\</code> +@end macro +@macro emph{arg} +<em>\arg\</em> +@end macro +@macro strong{arg} +<strong>\arg\</strong> +@end macro +@macro kbd{arg} +<kbd>\arg\</kbd> +@end macro + +@macro key{arg} +<kbd>\arg\</kbd> +@end macro + +@c @macro key{arg} +@c <table border><tr><td><kbd>\arg\</kbd><tr></table> +@c @end macro + +@macro samp{arg} +<samp>\arg\</samp> +@end macro +@macro var{arg} +<var>\arg\</var> +@end macro +@macro dfn{arg} +<dfn>\arg\</dfn> +@end macro +@macro il{arg} +<i>\arg\</i> +@end macro +@macro t{arg} +<tt>\arg\</tt> +@end macro +@macro sc{arg} +<b><tt>\arg\</tt></b> +@end macro +@macro copyright{} +© +@end macro |