axp.def

Summary of tag definitions for book: AXP: AtoDP:

tagetaapiminmaxdescription
book··3  holds load commands in master document.
file· 2  holds material in one file.
p··3  holds material in one paragraph.
blocks· 0  holds <block>s. File is generated by ctoxml.
.block··119999holds lines in one block of material.
lnum ·0  inserts next set of line numbers for the current block.
lnumA ·0  inserts line numbers and a title.
figDefs· 2  holds all <figDef>s.
.figDef··01MAXFDholds items required to format one Figure.
..desc· 011holds the caption for the figure.
figShow ·1  formats Figure for its id.
figRef ·0  makes a reference to the Figure for its id.
newDiv··2  begins a new Part, Chapter, or Section.
.title· 011holds the main title for the new material.
.subtitle· 001holds the subtitle for the new material.
.vph· 001holds the verso-page header.
.rph· 001holds the recto-page header.
newss ·1  begin a new subsection in the current section.
parStyle··3  begin a custom paragraph style.
exercise· 3  begin a new exercise in the current chapter.

Details for tag definitions for book: AXP: AtoDP:

<book> . . . </book>   -AA-PI:  3

Description: holds load commands in master document.

Attributes for <book>:

attributereqdefaultdescription
part 1first Part number for items in this md.
chap 1first Chapter number for items in this md.
sect 1first Section number for items in this md.
page 1first Page number for items in this md.

(summary)


<file> . . . </file>PI:  2

Description: holds material in one file.

(summary)


<p> . . . </p>   -AA-PI:  3

Description: holds material in one paragraph.

Attributes for <p>:

attributereqdefaultdescription
indent YESYES if the paragraph should be indented, otherwise NO.

(summary)


<blocks> . . . </blocks>   -REC-PI:  0

Description: holds <block>s. File is generated by ctoxml.

Fields for <blocks>:

tagminmaxdescription
block19999holds lines in one block of material.

(summary)


<block> . . . </block>   -AA-   -FIELD-PI:  1

Complete tag name: blocks@block.

Description: holds lines in one block of material.

Attributes for <block>:

attributereqdefaultdescription
id· file-section. Must be unique in all blocks in project.
file· the file name.
section· the section name: either explicitly given or a function name.
lines· "[fl0,ll0],...,[fln,lln]" for the line ranges in this block.

(summary)


<lnum>   -AA-PI:  0

Description: inserts next set of line numbers for the current block.

Attributes for <lnum>:

attributereqdefaultdescription
id 0is the 4-digit block id number.
title gives a title that should appear with the line number range.
skip NOif YES, skip this line number range.
lnonly NOif YES, write the line number range by itself, not with a TeX macro.

(summary)


<lnumA>   -AA-PI:  0

Description: inserts line numbers and a title.

Attributes for <lnumA>:

attributereqdefaultdescription
lnum is the line or range of lines to add.
title gives a title that should appear with the line number range.

(summary)


<figDefs> . . . </figDefs>   -REC-PI:  2

Description: holds all <figDef>s.

Fields for <figDefs>:

tagminmaxdescription
figDef1MAXFDholds items required to format one Figure.

(summary)


<figDef> . . . </figDef>   -AA-   -REC-   -FIELD-PI:  0

Complete tag name: figDefs@figDef.

Description: holds items required to format one Figure.

Attributes for <figDef>:

attributereqdefaultdescription
id· is the 4-digit block id number which must be unique.
type· is 1-6 for: pic file, code block, tex or html, html or eps, ascii in a box, ascii w/o a box (may have line #s).
data· is the pic file name or the code file name-block.
cnum 0holds the chapter number. It is generated by axp.
fnum 0holds the part number. It is generated by axp.

Fields for <figDef>:

tagminmaxdescription
desc11holds the caption for the figure.

(summary)


<desc> . . . </desc>   -FIELD-PI:  0

Complete tag name: figDefs@figDef@desc.

Description: holds the caption for the figure.

(summary)


<figShow>   -AA-PI:  1

Description: formats Figure for its id.

Attributes for <figShow>:

attributereqdefaultdescription
id· is the 4-digit id number of the figure to format.
lnum 0is the first line number. Zero means NO line numbers.
parindent 0ptis the amount to indent each line.

(summary)


<figRef>   -AA-PI:  0

Description: makes a reference to the Figure for its id.

Attributes for <figRef>:

attributereqdefaultdescription
id· is the 4-digit id number of the figure. This makes `Figure XX'
id1 0is the 4-digit id number of a second figure. This makes `Figures XX and YY'

(summary)


<newDiv> . . . </newDiv>   -AA-   -REC-PI:  2

Description: begins a new Part, Chapter, or Section.

Attributes for <newDiv>:

attributereqdefaultdescription
id· Unique 3-letter (part, chapter, section) id code.
type Sectionmust be: Part, Chapter, or Section. Section is the default.

Fields for <Section>:

tagminmaxdescription
title11holds the main title for the new material.
subtitle01holds the subtitle for the new material.
vph01holds the verso-page header.
rph01holds the recto-page header.

(summary)


<title> . . . </title>   -FIELD-PI:  0

Complete tag name: newDiv@title.

Description: holds the main title for the new material.

(summary)


<subtitle> . . . </subtitle>   -FIELD-PI:  0

Complete tag name: newDiv@subtitle.

Description: holds the subtitle for the new material.

(summary)


<vph> . . . </vph>   -FIELD-PI:  0

Complete tag name: newDiv@vph.

Description: holds the verso-page header.

(summary)


<rph> . . . </rph>   -FIELD-PI:  0

Complete tag name: newDiv@rph.

Description: holds the recto-page header.

(summary)


<newss>   -AA-PI:  1

Description: begin a new subsection in the current section.

Attributes for <newss>:

attributereqdefaultdescription
title· holds the title of the subsection.

(summary)


<parStyle> . . . </parStyle>   -AA-PI:  3

Description: begin a custom paragraph style.

Attributes for <parStyle>:

attributereqdefaultdescription
ind 0ptindent to use at the start of each paragraph.
pfs 0pt plus 1filglue to put at the end of each paragraph.
lskip \parindentglue to put at the left of every line in the paragraph. The bullet is placed in this space.
rskip 0ptglue to put at the right of every line in the paragraph.
pskip 0ptglue to put between the paragraphs in this style.
tskip 0ptglue to put at the top of the style (i.e., when it begins).
bskip 0ptglue to put at the bottom of the style (i.e., when it ends).
bulstyle 00-9 for bullet style: 1 centered bullets, 2 left bullets, 3 custom bullets, 4-5 for numbers and '.' or ')' [e.g., 1. or 1)], 6-7 for uppercase letters and '.' or ')' [e.g., A. or A)], 8-9 for lowercase letters and '.' or ')' [e.g., a. or a)].
bulskip -0ptdistance from bullet to start of text. Useful only if bulstyle >= 3. The value x may be > 0 or <= 0. If x <= 0 then -x gives the distance from the left margin to the start of the bullet.
bulstart 0last case used. Only needed if list is interrupted by a sublist.

(summary)


<exercise> . . . </exercise>PI:  3

Description: begin a new exercise in the current chapter.