<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (c) 2010 Stijn van Dongen -->
<head>
<meta name="keywords" content="manual">
<style type="text/css">
/* START aephea.base.css */
body
{ text-align: justify;
margin-left: 0%;
margin-right: 0%;
}
a:link { text-decoration: none; }
a:active { text-decoration: none; }
a:visited { text-decoration: none; }
a:link { color: #1111aa; }
a:active { color: #1111aa; }
a:visited { color: #111166; }
a.local:link { color: #11aa11; }
a.local:active { color: #11aa11; }
a.local:visited { color: #116611; }
a.intern:link { color: #1111aa; }
a.intern:active { color: #1111aa; }
a.intern:visited { color: #111166; }
a.extern:link { color: #aa1111; }
a.extern:active { color: #aa1111; }
a.extern:visited { color: #661111; }
a.quiet:link { color: black; }
a.quiet:active { color: black; }
a.quiet:visited { color: black; }
div.verbatim
{ font-family: monospace;
margin-top: 1em;
margin-bottom: 1em;
font-size: 10pt;
margin-left: 2em;
white-space: pre;
}
div.indent
{ margin-left: 8%;
margin-right: 0%;
}
.right { text-align: right; }
.left { text-align: left; }
.nowrap { white-space: nowrap; }
.item_leader
{ position: relative;
margin-left: 8%;
}
.item_compact { position: absolute; vertical-align: baseline; }
.item_cascade { position: relative; }
.item_leftalign { text-align: left; }
.item_rightalign
{ width: 2em;
text-align: right;
}
.item_compact .item_rightalign
{ position: absolute;
width: 52em;
right: -2em;
text-align: right;
}
.item_text
{ position: relative;
margin-left: 3em;
}
.smallcaps { font-size: smaller; text-transform: uppercase }
/* END aephea.base.css */
body { font-family: "Garamond", "Gill Sans", "Verdana", sans-serif; }
body
{ text-align: justify;
margin-left: 8%;
margin-right: 8%;
}
</style>
<title>The Aephea ref definitions</title>
</head>
<body>
<p style="text-align:right">
8 Jan 2010
<a class="local" href="aephea-ref.ps"><b>aephea-ref</b></a>
1.002, 10-008
</p>
<div class=" itemize " style="margin-top:1em; font-size:100%">
<div class=" item_compact"><div class=" item_rightalign nowrap " style="right:-3em">1.</div></div>
<div class=" item_text " style="margin-left:4em">
<a class="intern" href="#name">NAME</a>
</div>
<div class=" item_compact"><div class=" item_rightalign nowrap " style="right:-3em">2.</div></div>
<div class=" item_text " style="margin-left:4em">
<a class="intern" href="#description">DESCRIPTION</a>
</div>
<div class=" item_compact"><div class=" item_rightalign nowrap " style="right:-3em">3.</div></div>
<div class=" item_text " style="margin-left:4em">
<a class="intern" href="#macro">MACROS</a>
</div>
</div>
<a name="name"></a>
<h2>NAME</h2>
<p style="margin-bottom:0" class="asd_par">
aephea-ref — A description of the Aephea definitions for referencing</p>
<a name="description"></a>
<h2>DESCRIPTION</h2>
<p style="margin-bottom:0" class="asd_par">
The following definitions are used by the Aephea <tt>simpledocument</tt>
class as well as the Portable Unix Documentation
(<acronym class="ucase" title="Portable Unix Documentation">PUD</acronym>) manual and <abbr class="ucase" title="Frequently Asked Questions">FAQ</abbr> classes
(see <a class="local sibling" href="pud-man.html">pud-man</a> and <a class="local sibling" href="pud-faq.html">pud-faq</a>).
</p>
<a name="macro"></a>
<h2>MACROS</h2>
<div class=" itemize " style="margin-top:1em; font-size:100%">
<div class=" item_cascade item_leftalign nowrap" ><tt>\refload#2</tt></div><div class=" item_cascade item_leftalign nowrap" ><tt>\refloadx#2</tt></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
Both macros take as first argument
a label that uniquely defines the reference.
The second argument is a vararg containing key-value pairs.</p>
<p style="margin-bottom:0" class="asd_par">
These macros are usually not needed in Aephea classes; they are
lower level facilities.
</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " ><tt>\ref#2</tt></div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
The first argument is a label. The second argument should be a key
associated with that label. The result is the value associated
with the label/key pair.</p>
<p style="margin-bottom:0" class="asd_par">
These macros are usually not needed in Aephea classes; they are
lower level facilities used by high level Aephea definitions (e.g. <tt>\iref#2</tt>,
and <tt>\secref#1</tt>).
</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade item_leftalign nowrap" ><tt>\refcaption#1</tt></div><div class=" item_cascade item_leftalign nowrap" ><tt>\refnumber#1</tt></div><div class=" item_cascade item_leftalign nowrap" ><tt>\reflevel#1</tt></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
The argument is a label. The result is respectively the caption, number,
or level associated with that label.</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade item_leftalign nowrap" ><a name="optreference">\<tt>reference#1</tt></a></div><div class=" item_cascade item_leftalign nowrap" ><a name="optrefer">\<tt>refer#1</tt></a></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
The first associates a number with the label that is in the first argument,
and prints it inbeween square brackets. The label is anchored to this
location. The second outputs the associated number inbetween brackets, and
makes it carry a link to the anchor. For example, I am about
to create a link <a class="intern" href="#pub1">[1]</a> and another link <a class="intern" href="#pub2">[2]</a>
to the items appearing below.</p>
<p style="margin-bottom:0" class="asd_par">
<a name="pub1">[1]</a> The first reference.</p>
<p style="margin-bottom:0" class="asd_par">
<a name="pub2">[2]</a> The second reference.</p>
<p style="margin-bottom:0" class="asd_par">
If you prefer another bibliography style, find the macros
and adapt them according to your needs — they are very simple.</p>
<p style="margin-bottom:0" class="asd_par">
<tt>\reference#2</tt> currently writes data to the file <tt>\__fnbase__.zmr</tt>,
to be read back in using a <tt>\load{\__fnbase__.zmr}</tt> statement.
This is automatically done when using any of the Aephea classes.
</p>
</div>
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
a47d51544ec63a4f57df69ffdfe2c320
>
files
>
15
