ArborX

trefnote

Longname: t ref erence note   Open the Documentation Legend
Released: not available 
Created: not available 
See also: tfmode tfnote tformat

Summary
 Inserts a footnote reference point at the text cursor position. To edit the created stream, use the ttop or tend macros, or edit the default text after re-formatting.
Example (n/a)
 No example is available for this feature.

Syntax (SVNNA)
trefnote  group:n?  early_placement:o?  stream_name:t?  other_parameters...:s?  edit_now:n?  style_name:t?  foot_show:s?  list_stream:t?  first_show:s?  last_show:s?
group:n

The footnote group number. You can have up to five footnote groups, each of which can be positioned differently when you format your document using tformat.

Ø or 1  Group 1
2..5  Groups 2..5
early_placement:o

The early placement in trefnote applies to sidenotes placed top down in nominated columns. Sidenotes are normally placed after the rest of the page is formatted, but if you specify early placement, then they are placed as they are formatted.

Ø|0  Turns early placement off.
1  Turns early placement on.
stream_name:t

Stream name for a new footnote. This can take various forms, each of which change requirements and meaning of other_parameters depending on option used.

x  Manual include outstanding notes.
x  Create new note, (with default text if edit_now=0).other_parameters: [edit_now:n,] [style:n, [foot_show:n]]
| name  Inline to named stream. GSYM-supdag  other_parameters: [style:n, [foot_show:n]]
||  Inline to automatic stream.other_parameters: [style:n, [foot_show:n]]
|||name  Extract from list to named stream.GSYM-supdag;other_parameters: [list_stream:t, [first_show:s,[last_show:s, [foot_show:s]]]]
|||  Extract from list to automatic stream. other_parameters: [list_stream:t, [first_show:s,[last_show:s, [foot_show:s]]]]
other_parameters...:s

Varying validity determined by the option for the above parameter.
edit_now:n
0  (default) Create default text to be edited later.
1  Do not create default text, edit immediately.
style_name:t

Style name for footnote. The default footnote reference formats contained in stuk.3ad (as shown below) number each group individually, starting at 1. If you want to number all the footnotes within a group in some other way it would be best to change the Default show string in main text stream setting in part 2 of the footnote control stream dialogue box invoked by tfnote. These defaults can then be over-ridden by any specific change you want to make to an individual footnote reference using this style_name option. Defaults to last style specified, initially "fnote".
foot_show:s

Show name for footnote reference in main text. Overrides show string in footnote details if non--blank. Defaults to last string specified, initially blank.
list_stream:t

Stream containing paragraphs to be extracted. Defaults to last stream specified, initially none.
first_show:s

Show string which will generate ASCII digits representing sequence number of the first paragraph to extract. Defaults to last string specified , initially blank.
last_show:s

Show string which will generate ASCII digits representing sequence number of last paragraph to extract. Defaults to last string specified, initially blank.

Document created on 08-Feb-2003 (revision 1)