aephea-base(7) | MISCELLANEOUS | aephea-base(7) |
NAME¶
aephea-base - a description of Aephea base definitions The macros in this package have been ported to both html and troff.
DESCRIPTION¶
aephea-base - A description of Aephea base definitions. The macros in this package have been ported to both html and troff. This package is used by the Aephea simpledocument class and by the Portable Unix Documentation (pud) mini-languages for authoring manual pages ( pud-man) and the pud language for faq authoring ( pud-faq). There is a small list of known issues in the ISSUES section, mostly concerning the troff device. These should generally be of no concern at all, but if you run into trouble look there first. A quick glance through the list before you run into trouble may be the wisest thing to do.
INTRODUCTION TO THE ITEMIZE ENVIRONMENT¶
The itemize environemnt is the Aephea workhorse for lists, enumerations, itemizations, and other tailed creatures. A simple and valid use is for example
\begin{itemize} \item{\bf{foo}} \car{ For I am foo. } \items{ {\bf{barra}} {\bf{zuttelezut}} } \car{ For we are bar and zut. } \end{itemize}
This source result in the following output:
foo
barra
zuttelezut
This is not impressive at all, but it gives an idea of how itemize works. The following example is a single itemize environment providing a rollercoasterride through most of the features of the itemize environment. As shown below, it is possible to change all the itemize settings and styles at will even within a single itemize instance. Of course this is not useful at all except for demonstrating the itemize capabilities, but it goes to show that the itemize macros are quite robust (by virtue of modularity). NOTE
1 Spacing modes compact and cascade are determined by the key flow. The current mode is compact, meaning that the itemize token and the ensuing text are on the same line. Below, compact mode is switched off (approximately) halfway. The interitem key determines the amount skipped between an item description and the next item.
2 Several item modes (custom, mark, enumeration).
3 Several enumeration modes (roman, arabic, alphabetic).
iv) The style of a list can be changed while in the middle of it.
v) Nuther item.
vi) The list can be 'interupted' and resumed (by means of the \intermezzo#1 macro).
Perhaps you wonder what good is THAT for, and justly so. The \intermezzo#1 macro should only be used inbetween different items, i.e. it should not split content belonging to a single item.
[7] Items can be optionally and automatically right and/or left delimited. The current item is delimited with square brackets.
[8] Items can be left or right aligned.
[9] Items can be stacked, which is supported only when flow is set to cascade.
[10]
Implying
That
Stacking
[12]
[18] (back to compact) But the counter can be manipulated at will.
• A bullet item.
• Now interitem is set to 0 (affecting the current list), and a new list is started contiguous to the present text (by having its margintop set to 0).
a. Hubris
b. Laziness
c. Impatience
Are the three virtues of programming.
• This concludes a listing showing most of the itemize capabilities.
USING THE ITEMIZE ENVIRONMENT¶
You steer the itemize environment by providing it with tag-value pairs like so:
\begin{itemize}{ {flow}{compact} {interitem}{1} {align}{right} {type}{abc} {rp}{.} }
This is the list of tags that you may use.
margintop
interitem
flow
textindent
itemmargin
mark
align
class_all
lp
rp
type
itemcount
You need to know that the itemize environment internally maps these tags to dollar keys simply by prepending a dollar. Thus, if you want to reset one of the values associated with such a tag, you need to do e.g.
\set{$align}{right} \set{$itemcount}{30}
A more robust to do this is to ensure that the modified key is retrieved from the right dictionary, i.e. the top-level itemize dictionary, as follows.
\set{{dict}{itemize}}{$align}{right} \set{{dict}{itemize}}{$itemcount}{30}
THE SPACING ENVIRONMENT¶
Its syntax is identical to that of the itemize environment. It accepts tags left, right, top, and bottom. These should receive numeric values. The associated unit is em. The troff device does not yet support the top and bottom tags.
MACROS¶
\ enref#2
\ iref#2
\ lref#2
\ aref#2
\ httpref#1
\ sibref#1
\ sibref#2
\ sibref#3
\ par#1
\ cpar#2
\ car#1
\ ccar#2
• After an environment that always carries a bottom margin.
• After an environment that does not carry a bottom margin, and where you specifically want the environment to be contiguous to the enclosing text. The listing you are currently reading is an example of this.
As promised. The \car macro may feel a little unusual. If you don't mind standing the chance of a little spurious vertical white-space just use \par all the time. If you really need it, such as in an 'inline' listing as above, the \car macro is ready to do the job.
\ bf#1
\ it#1
\ tt#1
\ v#1
\ ftinc#2
\ ftdec#2
\ verbatim#1
\ verbatix#1
ISSUES¶
Nesting
The rest of this list pertains to the itemize environment.
Margins
8 Jan 2010 | aephea-base 1.002, 10-008 |