>2& 4 : Complete TAG list  A 
A

The "Tag Manual" for JafSoft's text conversion utilities

E

This documentation can be downloaded as part of the Ldocumentation set in .zip format




Y Previous page $C Back to Contents List#  


 

4 Complete TAG list

 

BASEHREF

/, '    . D   - &   - i  
Type:
Directive
Description:
Specifies URL that is used to resolve relative URLs
Applies to:
Hyperlinks. HTML only
See policy:
"Document Base URL"
6

Syntax:


3

$_$_BASEHREF <base URL to be used>


(

New in version 4

*

Ignored in RTF conversions

H

In HTML the URL is added to a BASE tag inserted into the <HEAD>/section of the output page(s) as follows :-


"

<BASE HREF="url">


F

This tag is used to specify the base URL against which all relativeEURLs should be resolved. You might want to use this if you are goingIto copy the page to a mirror location, but not copy the pages referred toin the relative links.

J

The presence of a BASEHREF pre-processor command overrides any base URLyspecified via a "Document base URL" policy line.


 

BEGIN/END_CODE

/, '    . =   -    - m  
Type:
Directive
Description:
Delimits the start and end of a code sample.
Applies to:
Text analysis
See policy:
"Expect code samples"
6

Syntax:

*
        $_$_BEGIN_CODE        ...        (lines of code)        ...        $_$_END_CODE
1
E

The BEGIN_CODE ... END_CODE directives are used to bracket a piece&of sample code in the source text.

Q

In HTML this will either be rendered in <PRE> ... </PRE> markup orJ<CODE> ... </CODE> markup (see the discussion about the policy"Use <CODE>..</CODE> markup" to see why the formeris used as default).


/ (

BEGIN/END_COMMA_DELIMITED_TABLE

/, '    . 9   -    -   
Type:
Directive
Description:
Delimits a table of comma-delimited data
Applies to:
Text analysis
See policy:
(none)
6

Syntax:

*
'        $_$_BEGIN_COMMA_DELIMITED_TABLE        ...'        (lines of comma-delimited data)        ...%        $_$_END_COMMA_DELIMITED_TABLE
1
K

The BEGIN_COMMA_DELIMITED_TABLE ... END_COMMA_DELIMITED_TABLE directivesJcan be used to delimit a series of comma-delimited data values that should?be interpreted as a table (e.g. data originally exported from aspreadsheet such as Excel)

B

The presence of these directives overrides any value set in theq"Attempt table generation" policy


" 

BEGIN/END_CONTENTS

/, '    . E   - 8   -   
Type:
Directive
Description:
Delimits a contents list in the original source file
Applies to:
Text analysis. Mainly HTML generation.
See policy:
(none)
6

Syntax:

*
        $_$_BEGIN_CONTENTS        ...         (original contents list)        ...        $_$_END_CONTENTS
1
G

The BEGIN_CONTENTS ... END_CONTENTS directives are used to bracket aBcontents list in the source document. The program will attempt toCautomatically detect the presence and location of any contents list:in the document, but the algorithm can be problematic.

G

Use this markup only when the document contains a contents list that*the program fails to detect correctly.


) "

BEGIN/END_DELIMITED_TABLE

/, '    . 7   -    -   
Type:
Directive
Description:
Delimits a table of tab-delimited data
Applies to:
Text analysis
See policy:
(none)
6

Syntax:

*
!        $_$_BEGIN_DELIMITED_TABLE        ...'        (lines of comma-delimited data)        ...        $_$_END_DELIMITED_TABLE
1
?

The BEGIN_DELIMITED_TABLE ... END_DELIMITED_TABLE directivesHcan be used to delimit a series of tab-delimited data values that should?be interpreted as a table (e.g. data originally exported from aspreadsheet such as Excel)

B

The presence of these directives overrides any value set in theq"Attempt table generation" policy


! 

BEGIN/END_DIAGRAM

/, '    . ?   -    -   
Type:
Directive
Description:
Delimits the start and end of an ASCII diagram
Applies to:
Text analysis
See policy:
(none)
6

Syntax:

*
        $_$_BEGIN_DIAGRAM        ...        (ASCII diagram)        ...        $_$_END_DIAGRAM
1
K

The BEGIN_DIAGRAM ... END_DIAGRAM directives are used to bracket a piece4of Ascii art or text diagram in the source text.

L

In HTML this will be rendered in <PRE> ... </PRE> markup.


 

BEGIN/END_HTML

/, '    . >   - %   -   
Type:
Directive
Description:
Delimits some HTML to be copied to the output
Applies to:
HTML generation only
See policy:
(none)
6

Syntax:

*
        $_$_BEGIN_HTML        ...        (block of HTML code)        ...        $_$_END_HTML
1
2 AscToHTMD

The BEGIN_HTML ... END_HTML directives are used to bracket actual HTML in the source document.

M

The bracketed HTML will be transcribed to the output file unconverted.

D

This device will allow you to embed images, tables and other HTML2constructs not normally generated by AscToHTM.

K

This is how the image to the right has been added to the HTML version ofthis document.

]

If you simply wish to insert a single line of HTML, the HTML_LINE#tag offers a more compact form.

E

For in-line HTML use the HTML in-line tag.




BEGIN/END_IGNORE

/, '    . :   -    -   
Type:
Directive
Description:
Delimits a section of input to be ignored
Applies to:
All (ignored)
See policy:
(none)
6

Syntax:

*
      $_$_BEGIN_IGNORE	      ...      (text to be ignored)	      ...      $_$_END_IGNORE
1
J

This markup can be used to delimit a section to be wholly ignored. Any?markup and tags in the ignored section will have no effect.


 

BEGIN/END_PRE

/, '    . >   -    -  
Type:
Directive
Description:
Delimits a region of pre-formatted ASCII text
Applies to:
Text analysis
See policy:
"Minimum automatic <PRE> size"
6

Syntax:

*
        $_$_BEGIN_PRE        ...+        (lines of pre-formatted ASCII text)        ...        $_$_END_PRE
1
C

The BEGIN_PRE ... END_PRE directives are largely replaced by theGBEGIN/END_TABLE, BEGIN/END_CODE and BEGIN/END_DIAGRAM directives. TheyGare maintained for backwards compatability, and have the same effect as"the BEGIN/END_DIAGRAM commands


 

BEGIN/END_TABLE

/, '    . ,   -    -   
Type:
Directive
Description:
Delimits a plain text TABLE
Applies to:
Text analysis
See policy:
(none)
6

Syntax:

*
        $_$_BEGIN_TABLE        ...0        (plain text table with data all aligned)        ...        $_$_END_TABLE
1
A

The BEGIN_TABLE ... END_TABLE directives are used to bracket aFplain text table in the source text. The program will then attempt to&analyse this table as best it can.

This is explained more in the AscToTab documentation.

E

Inside this section you can add other TABLE pre-processor commandsfto tailor the HTML generated (see The TABLE commands).


 

BR (line break)

/, '    . ,  n - -(  t - U O T
Type:
In-line
Description:
Signals a forced line break
Applies to:
HTML and RTF generation
See policy:
(none)
6

Syntax:



[[BR]]

r
i"

This tag has no attributes.


 i

CHANGE_POLICY

/,, ' i  6 . 8   - ;  : - a n n
Type:
Directive
Description:
Changes one of the program's "policies"
Applies to:
All
See policy:
(none)
6

Syntax:-




R? $_$_CHANGE_POLICY <policy text> : <policy vale>T


P


TQwhere <Policy_text> and <policy value> form a policy line as it would zappear in a policy file, and (usually) as it appears in the Policy manual.

Z
NOTE:
This feature has the potential to cause mayhem, and as such is offeredH to users on a "as is" basis. That is, we offer no support for getting4 this feature to have the effect a user may desire.
e
n

nAThis directive allows you change a particular policy in part of a"Idocument. This is a potentially powerful feature, allowing you to tailorOSthe conversion of your file in different sections of that file, or/Hto embed the policy particular to a file in commands inserted at the topof the file itself. 



"7For example the following would all be valid directives>

*
R1        $_$_CHANGE_POLICY Background Colour : redH;        $_$_CHANGE_POLICY Ignore multiple blank lines : Yese
1T
N

Although how and when they would take affect will depend on the policy.

I

For example, the background colour would only take effect if splitting Gthe file up, and only on the next file generation. This works, BTW, soMGif anyone wants to split a file into many pages, all different colours,Lthen be my guest.

EE

There are a many caveats to this behaviour :-

N
 <
K

Not all policies may be changed in this way. In particular policiesTE that open other policy files are not supported. Even if a policy G if "changed", it does not follow that changing the policy will have> an effect.


 B
M

It is unlikely that this feature can be sensibly used to influence the:I analysis of file, other than when placed at the top of the file only.eD If such a manner it is simply an alternative to using a separate policy file.


T 
N

Output policies are referenced at different times. Only those that areR referenced after the line is read from the source file may beE influenced, thus things like output file name may have no effect.e


e 
C

Not all policies once changed, can be changed back. This isPG particularly of policies that contain values to be added to a list.= This is an issue that may be addresses in later versions.d


s E
L

Messing with policies can cause unpredictable behaviour. For exampleH if you alter the section splitting parameters, then the chances of aF section cross-reference elsewhere in the document being calculated* as a correct hyperlink diminishes.

F

That's why this feature is offered UNSUPPORTED


D N
J

To further complicate matters, the software uses a readahead, writeF behind buffer which means that you may need to experiment with theE placing of your policy change to within 40 lines (the size of the buffer).

8

This problem is alleviated since version 3.2.



l
 O

CONTENTS_LIST

/T, ' eA ; / . N  e - ;' e u
Type:
Directive or in-line, but better as a directive.
Description:
Defines the location to place the contents list (if any). By
Applies to:
Mostly HTML generation
6
#
See policy
(none)
t@ default the contents list is placed at the top of the document! before any other end-user text.S


Syntax:

[

$_$_CONTENTS_LIST <number_levels>,<Style>, More to be defined

s
-

where,

>
'S, ) ? r e ( - m e / A' p t  M$ t t ( -  >
<number_levels>
D  

number of levels of heading to be shown in the list
u1 1,2,3... A value of "0" means all.
 
The default value will be 0.
<Style>
Style of contents list

  

1 - traditional list
% 2 - navigation bar
 
The default value will be 1.
.


0 )

DEFINE/END_BLOCK and RESET_BLOCK

</H, '    . ,  t - t&   -  a 
Type:
Directive
Description:
Delimits a definition block
Applies to:
Document construction
See policy:
(none)
6

R



D
Syntax:n

*
l8        $_$_BEGIN_BLOCK <block_name>,<scope>        ...e        Block of lines        ...         $_$_END_BLOCK
1

and


;

$_$_RESET_BLOCK <block_name>,<scope>

E
S

where


', 0 t> t t + e=  > ) A D . 2  t t 2 ! a / 2 &  n b b  -
<block_name>

  

The name used to refer to this block. Block names
9 may be reused, in which case the blocks will be
d? "scoped" so that required block can be resolved.
<scope>
N


  

The "scope" of this block. By default blocks are
/= scoped to be document wide. If the same name block
a< is defined multiple times then this will determine
8 the range of document to which this variant of
$ the block will apply.




  

The Scope will be a list of keywords with one keyword
? taken from each of the following sets. If no keyword
o@ is found, the set's default will be used. If multiple
> keywords from the same set are found, and error will
 be reported.
 
Range:
 
GLOBAL (default)
 
Application to pages:


  

ALL_PAGES (default)
I ODD_PAGES_ONLY
 EVEN_PAGES_ONLY
.
<
D
M

The DEFINE_BLOCK...END_BLOCK delimits a definition block. Such blocks mayINSERT_BLOCK or EMBED_BLOCKp&commands anywhere in the document.

M

The RESET_BLOCK tag may be used to effectively cancel a previously defined/ block.

M

If you define two blocks of the same name with the GLOBAL scope, the firstsNwill definition will apply up until the location of the second definition.


< 5

DEFINE_HTML_FRAGMENT and RESET_HTML_FRAGMENT

!/B, ' t  / . q d A - A.   - > O T
Type:
Directive
Description:
Delimits an HTML "fragment" (see Using HTML Fragments)
Applies to:
HTML Document generation only
See policy:
(none)
6

/



>
Syntax:N

*
 C        $_$_BEGIN_HTML_FRAGMENT <fragment_name>,<scope>>        ... :        Fragment of HTML which may include "fragment" tags        ...e        $_$_END_BLOCK>
1e

and


F

$_$_RESET_HTML_FRAGMENT <fragment_name>,<scope>


r
f

where


'I, L7 eD  c / h?  -
<fragment_name>
The name used to refer to this fragment. fragment names
< may be reused, in which case the fragments will be
B "scoped" so that required fragment can be resolved.
<scope>
The "scope" of this fragment. Same meaning as that
om explained in DEFINE/END_BLOCK and RESET_BLOCK.
.
b
"
(

New in version 4

M

The DEFINE_HTML_FRAGMENT...END_BLOCK delimits a fragment of HTML. Certain>Jfragment names have special meanings that indicate the HTML fragment is toFbe used to override the "standard" HTML generated by the software.

B

The RESET_HTML_FRAGMENT tag may be used to effectively cancel aGpreviously defined fragment. If a reserved fragment name is reset thisdDwill have the effect of suppressing the generation of that HTML.

N

See also Using HTML fragments


 

DEFINE_VARIABLE

/G, ' d   . ) d t - A&  H -  N A
Type:
Directive
Description:
Defines a variable value
Applies to:
Document construction
See policy:
(none)
6

Syntax:


G

$_$_DEFINE_VARIABLE <name>,<value>,<scope>

f
<
R

where


//, . ? t s / a2  ! / ,  m
<name>
The name by which the variable is to be known.
<value>
The (text) value for the variable
<scope>
The scope for the variable.
6
i
d

M

Defines a variable value. This value may be substituted into the documentIJtext wherever a matching VARIABLE tag is used.


 

DESCRIPTION

/, '   P . 5   - e9 T > - Ro A -
Type:
Directive
Description:
Specifies the document's description
Applies to:
HTML and RTF generation, but differently
See policy:
"Document description"
6

Syntax:


>

$_$_DESCRIPTION <Description on rest of line>


d
)S

You can repeat this directive over several lines, in which case the descriptionsdNwill be concatenated. This allows you to write multi-line descriptions making"your source file easy to read.

D

In RTF the description forms part of the document properties.

P

In HTML the description is added to a META tag inserted into the <HEAD>/section of the output page(s) as follows :-

o

E

<META NAME="description" CONTENT="your description">

o
d
tG

This tag is often used by search engines (e.g. AltaVista) as a brief=Cdescription of the contents of your page. If omitted the first fewlAlines may be shown instead, which is often less satisfactory.

LD

The presence of a DESCRIPTION pre-processor command overrides anydescription specified via a "Document description" policy line.

T
 N

EMBED_BLOCK

/, ' !  E . ,  u - H&  A - A > y
Type:
Directive
Description:
Delimits a definition block
Applies to:
Document construction
See policy:
(none)
6

Syntax:


'

$_$_EMBED_BLOCK <name>

"
>

where


/T, . 3 
<name>
Name of the block to be embedded. This
O8 will be a named DEFINE_BLOCK, resolved subject
$ to the scoping rules.
6
v


M

An EMBED_BLOCK command will cause the named DEFINE_BLOCK to be output, but=Jwithout regard to the current context information, and without causing theFprevailing context information (indentation, fonts) to be changed.

8

See also INSERT_BLOCK


 

ENTITY

t/L, ' s  l . ) G o - r% /  - > e m
Type:
In-line
Description:
Displays an HTML Entity.
Applies to:
HTML generation only
See policy:
(none)
6

Syntax:

,

[[ENTITY <HTML_entity number>]]

where,

!/B, n< B  T
<HTML_entity number>
Number to be placed inside &<entity>; markup
 in HTML
6_

This tag will create an html entity in the form &<name>; or &#<number>;.bLWhere the supplied number maps onto a known name, the name will be used withHa view to making the HTML more comprehensible, otherwise the number form is used.

L

If the software recognises that the requested entity may not be supportedIby those browsers deemed to match the targeted HTML version, a WARNING isa issued.

e
 

FILENAME

O/R, '   s . B   - &   - f s h
Type:
In-line
Description:
Substitutes the name of the files being converted
Applies to:
Document construction
See policy:
(none)
6

Syntax:




[[FILENAME]]

i

/J

The tag will be replaced by the name of the file being converted. This2facilitates the construction of sentences like

g

"This file was converted from [[FILENAME]] at [[TIMESTAMP]]"

h
a

which becomes

f

"This file was converted from tag_manual.txt at 1-Jul-2001"

F

With a change introduced in version April 2000 this tag may be used3in the document title and description policies.

,


FONT

e/ , ' N  E > . ! t)  , - !   ( - e s  /
Type:
In-line

Description:
Signals a change
in font, font attributes
Applies to:
Text generation.
Mostly HTML.
See policy:
(none)

6

Syntax:

W

[[FONT <flag>,<name>,<size>,<face>,<attribute>]]

T
N

where,

B' , > tE e > > s  e D &C O  . I u l . J  e  T   3 f4  T &   a
<flag>

  

Indicates whether this is a "physical" or "logical" font.
lC "Physical" in this content means an actual font name such
C as "times", "Logical" will refer to a CSS Class name

  

0 = physical
 1 = logical
<name>
  

Either the font name (physical markup) or the CSS class
% name (logical markup).
<size>
The font size in points. The default size will be 10pt.
<face>
Indicates whether the font is a serif or sans serif font.

  

0 = serif font
" 1 = sans serif font
<attribute>
Indicates the attribute of the font



  

0 = normal
 1 = italic
 2 = bold
 3 = bold italic
.

 

FRACTION

>/ , '    . &   -   - B t t
Type:
In-line
Description:
Implements a fraction
Applies to:
Text generation
See policy:
(none)
6

Syntax:

(

[[FRACTION <expression>]]

t

where

'e, 4 @  T ( - O P
<expression>
This is the fraction expression which should contain
E a slash ("/") separating the numerator and denominator
 
Both values must be present.
.
r



GOTO

=/>, ' f   . ? D R - ;K /  - R c e
Type:
In-line
Description:
Adds a hyperlink to the named section heading.
Applies to:
Hyperlink generation. HTML and RTF implementations differ
See policy:
(none)
6

Syntax:


(

[[GOTO <Heading_name>]]


p

where


/>, 6 5 
<Heading_name>
Name of a heading else where in the file.
d7 The text used must match exactly for this tag
0 to work (case insensitive though)
6
<
T

L

Creates a hyperlink to the named section heading. The heading must matchMthe text exactly, and be in the same file. It must also have been recognisednby AscToHTM as a heading.

>\

For more ambitious hyperlinks, check out the HYPERLINK tag. ThisHtag is a simplified version of the TOC variant of the HYPERLINK tag.




HTML

S/ , ' C   . D  p - T% a e - o  L
Type:
In-line
Description:
Allows raw HTML to be embedded in the end-user text
Applies to:
HTML generation only
See policy:
(none)
6

Syntax:

#

[[HTML <HTML_text>]]

n
f

where

', 3 >< G >
<HTML_Text>
Rest of line is the raw HTML to be placed in the
+ output stream at this point.
.
o
J

This new in-line tag will allow any additional HTML markup to be passedOdirectly to the output (e.g. <BLINK>). Use of this tag should be limitedIsolely to HTML effects that cannot be achieved through other tags as such/9markup will be meaningless in any future RTF context.

d
 

HTML_COMMENT

/, ' g  g . I  T - f%  O - B c L
Type:
In-line
Description:
Allows HTML comments to be embedded in the end-user text
Applies to:
HTML generation only
See policy:
(none)
6

Syntax:

)

[[HTML_COMMENT <comment>]]

e
e

where

'e, r1 c@  "
<comment>
Rest of line is the comment to be placed inside HTML
@ comment delimiters <!-- -->. By convention this
: shouldn't contain two dashes "--" anywhere.
.
!
N

This tag will allow HTML comments to be placed in the output. This effectTcan also be achieved using the HTML tag, but that method is moreliable to error.

1

Use of this tag should be limited HTML as sucht9markup will be meaningless in any future RTF context.

h
 s

HTML_LINE

/l, '   i . O > H - A% L  - B v >
Type:
Directive
Description:
Allows a single line of HTML to be embedded in the source file
Applies to:
HTML generation only
See policy:
(none)
6

Syntax:


J

$_$_HTML_LINE <raw HTML commands on the rest of the line>


R
HJ

This directive allows you to embed a single line of HTML in your sourceEfile. The rest of the line is copied across faithfully to the outputc file.

Pq

Essentially this offers the functionality as the BEGIN/END_HTML section commandsfbut in a more compact form.

E
 

HYPERLINK

/B, '    > . ' l8  ; - & 4  / - a l e e
Type:
In-line

Description:
Defines a hyperlink to
a LINKPOINT, TOC entry or external URL
Applies to:
Hyperlink generation.
HTML and RTF implementations differ
See policy:
(none)

6

Syntax:

N

[[HYPERLINK <type>,"<link_name>","<display_text>"]]

-

where,

=
'>, 8 - p / > r)  _ i/ eA  r o ? E e a2 c@ g t
<type>
Type of link. Choices are:-


  

TOC - link to a TOC entry
- LINK - link to a LINKPOINT entry
>, URL - link to a named URL
<link_name>
R
  

Name of link. For TOC and LINK this must be the name
U? used in the matching TOC or LINK tag. For a URL this
/* will be the URL to link to.



  

TOC and LINK hyperlinks will be checked against the
s= list of known link points. If no match is found an
o< error is generated, and the tag is simply replaced
# by the display text.
<display_text>
  

The on-screen text to be used for the hyperlink. If
? omitted it will default to the <link_name>
.
i

 c

IGNORE_THIS

/e, ' m  D . N  t - - ! > - e T T
Type:
In-line
Description:
A tag whose contents are ignored. Could be used for comments
Applies to:
Comments in the source text.
See policy:
(none)
6

Syntax:

2

[[IGNORE_THIS <anything_you_like>]]

O

This tag is ignored. It is replaced by a single space in the output stream.ALIt could be used to add a brief comment to your source that would not appearin the output.


 K

INCLUDE

/>, ' =   . R  O - R&  a -  > 
Type:
Directive
Description:
Specifies an external source file to be included at this location
Applies to:
Document construction
See policy:
(none)
6

Syntax:


'

$_$_INCLUDE <filespec>

i
a
oG

This directive allows you to specify the name of a source file to beBFincluded at this point. This is useful if you wish some standard textCinserted into many related documents, or into the same documents atNmany locations.

N

The <filespec> must be valid for the Operating system being used, and-the location of the original source file.

<G

The contents of the included file will be "copied into" the original Hsource file. The same file may be included more than once, and includedFfiles may contain other pre-processor commands, including more INCLUDE2statements, although there are limits on this.

K

The included file will be treated as though it were part of the originalT4file during both the analysis and output passes.

D

The INCLUDE will fail if the file cannot be found, and a test for)recursive include files will be made.

"
 

INSERT_BLOCK

T/i, ' t  i . + d a - w&  e - c d a
Type:
Directive
Description:
Invokes a definition block
Applies to:
Document construction
See policy:
(none)
6

Syntax:


(

$_$_INSERT_BLOCK <name>


m
e

where


/y, . 3  t
<name>
Name of the block to be inserted. This
r8 will be a named DEFINE_BLOCK, resolved subject
$ to the scoping rules.
6
>
s

K

An INSERT_BLOCK command will cause the named DEFINE_BLOCK to be inserted>7into the document source as seen as by the program.

iI

As such the inserted block will be subject to, and able to change, the =prevailing context information (indentation, fonts etc.).

6

See also EMBED_BLOCK


 

KEYWORDS

R/L, ' t  T > . # 3  A - y# E4  > - i B n n
Type:
Directive

Description:
Specifies keywords
that help index the file's content
Applies to:
Document indexing.
HTML and RTF implementations differ
See policy:
"Document keywords"

6

Syntax:


@

$_$_KEYWORDS <comma-separated list of keywords>


i
>O

You can repeat this directive over several lines, in which case the keywordsoHwill be concatenated. This allows you to write multi-line keyword lists)making your source file easy to read.

l@

In RTF the keywords form part of the document properties.

N

In HTML the keywords are added to a META tag inserted into the <HEAD>/section of the output page(s) as follows :-


G

<META NAME="keywords" CONTENT="your list or keywords">

s
<I

This tag is often used by search engines when indexing your HTML page. CYou should add here any relevant keywords possibly not contained in the text itself.

J

The presence of a KEYWORDS pre-processor command overrides any keywordsyspecified via a "Document keywords" policy line.

>
 

LINERULE

r/k, ' o% l . . *  o -   - > n >
Type:
Directive or in-line
Description:
Signals a horizontal rule
Applies to:
Text generation
See policy:
(none)
6

Syntax:

g

$_$_LINERULE <length>,<thickness>,<leading>,<alignment>,<colour>

>
R

or

g

[[LINERULE <length>,<thickness>,<leading>,<alignment>,<colour>]]

!
e

where

'R, T" >?  t 3 S0   1 @  t 3 [D  T e   n "" >  r
<length>
  

length of line in pixels/pts/percent. To specify a
TB percentage add the percent sign (%) after the value
<thickness>
thickness of line in pixels/pts
<leading>
leading of line in pixels (not yet implemented)
<alignment>
Code indicating the alignment. Possible values are



  

L - Left aligned
 R - Right aligned
< C - Centre aligned
 J - justified
<colour>


  

Colour value. Either an HTML colour like "AABBCC"
; or "red" or a (R,G,B) value like "0.12,0.57,1.0".
r= A RGB value must be included in quotes. If omitted
NB the linerule will adopt the prevailing text colour.
.
N
 T

LINKPOINT

/O, ' >  D T . # (  > - a# 4  l - O O U -
Type:
In-line

Description:
Marks the location
of an HTML anchor point
Applies to:
Hyperlink targets.
HTML and RTF implementations differ
See policy:
(none)

6

Syntax:

*

[[LINKPOINT "<link name>"]]

<

where,

>
'h, s3 >= y i
<link_Name>
This is the name by which the link will be known.
L= It is also the text that will be placed in the NAME
kE anchor point, so only valid characters should be used.
.
i

 

NAVIGATION_BAR

#/f, ' L   . L   - <,   - N > 
Type:
Directive
Description:
Specifies a navigation bar should be added at this location
Applies to:
Text generation. HTML only
See policy:
(none)
6

Syntax:




$_$_NAVIGATION_BAR

L
o
tG

The NAVIGATION_BAR command inserts a navigation bar that takes to toLGthe next/previous and contents files. This will only be generated wheneyou have selected to split your file by setting the "Split level" policy.


( !

NB "non-breaking spaces"

p/A, ' n  L . C s n -  P - E c c
Type:
in-line
Description:
Inserts multiple non-breaking spaces into the text
Applies to:
Text generation
See policy:
(none)
6

Syntax:


*

[[NB <Number_of_spaces>]]


R
:M

This tag causes the specified number of non-breaking spaces to be insertedeLinto the document. The default number is 1. In HTML this is likely to haveHan identical implementation to the SPACES tag.


$ 

SAVE/RESTORE_CONTEXT

>/e, ' E  - . ,  T - e4  o - >  s
Type:
Directive
Description:
Delimits a definition block
Applies to:
Document construction. Mostly HTML
See policy:
(none)
6

Syntax:




$_$_SAVE_CONTEXT
H $_$_RESTORE_CONTEXT



dL

The SAVE_CONTEXT and RESTORE_CONTEXT are intended for use with definition blocks.

UK

The SAVE_CONTEXT saves all the current context information (indentation,nFfont etc) so that the slate may be wiped clean ready for the output ofa new block.

K

The RESTORE_CONTEXT command recovers the previous SAVE_CONTEXT, allowingLKa document to continue as it was before the defined block was inserted.

vL

It's unlikely that these tags should been to be used explicitly, but they8will be used implicitly inside the implementation of the6BEGIN/END_HTML tags.


 

RULESET

/N, ' o  - . 5 h ; - e1 y e - l P E
Type:
In-Line
Description:
Identifies the "Ruleset" to be used.
Applies to:
Different default Policy values.
See policy:
(none)
6

Syntax:


+

$_$_RULESET <Ruleset name>

M
<J

For certain sets of files and customers the software has been optimisedBto define sets of rules (policy values) appropriate to the type ofIconversions being attempted. This is a bit like having a built-in policy file.

>
 

SECTION

/r, '    . V  > - l&   - a & >
Type:
Directive
Description:
Allows sections to be delimited in support of conditional conversions
Applies to:
Document construction
See policy:
(none)
6

Syntax:u




L$ $_$_SECTION <section_name>



>
o

kCThis directive is used to divide the document up into named sectionIDtypes. Section type names can be repeated through the document, and?by default text is assumed to belong to a section called "all", >indicating that this text is always copied to the output file.



_LSection type names must contain no white space, but may contain underscores.



DThis has no effect unless the user supplies a policy file indicating?that they wish to select only certain section types for output.t



U1For example, if the text document looks like this<

*
SH                Some text that'll always get copied, because it is in an.                "all" section type by default.        $_$_SECTION PrivateiJ                Some text that will be copied either when the preprocessorI                is switched off, or when the user's policy file indicates @                that "private" section types are to be included.        $_$_SECTION Other>:                Likewise, this is an "other" section type.        $_$_SECTION Privatel4                And here's some more "private" text.        $_$_SECTION allrN                Some text that will always get copied because it is explicitly)                in an "all" section type.t
1P
G

Then the two section types marked "private" won't be copied into the>Mconverted file unless the user then supplies a policy file with a policy lineTof the form

.

3

Include document section : Private


h
B1iE

If the "other" section is also wanted this should be change to

!.

:

Include document section : Private, Other


P
n1u

L
Note:
Be aware that any sections omitted are also omitted from9 the analysis pass. This may have unexpected results as; the program responds only to the input text that is to beE included in the output.N
 D

SOURCE_FILE

/t, ' o  T . G S > - !  c - > f t
Type:
In-line
Description:
Adds a hyperlink to the source file that was converted
Applies to:
Text generation
See policy:
(none)
6

Syntax:


1

[[SOURCE_FILE <hyperlink_text>]]

u
i

where


/f, 8 ' l  t
<Hyperlink_text>
Text displayed on the link.
i is "source file"
The default
6
I
n

J

Creates a hyperlink to the original source file. The generated link isGa local link that assumes the source is placed in the same directory aspthe HTML file.


 

SPACES

d/a, ' t  B . = / T -   - > c o
Type:
in-line
Description:
Inserts horizontal white space into the text
Applies to:
Text generation
See policy:
(none)
6

Syntax:


G

[[SPACES <Number_of_spaces>,<Size_of_space>]]

a
T
T
'C, : / =  7 - R
<number of spaces>
Size of white space in spaces.
<Size_of_space>
Size of white spaces in pts.
.
l



i
TN

This tag causes a number of spaces to be inserted into the document to givePa horizontal gap. The size of the gap can be specified in Spaces or points.

<

When present the size in points will take precedence.

O

In HTML this will probably be implemented by inserting multiple non-breakingnPspaces &nbsp;, the number being equal to the size in points divided by 5 androunded down.

A
 /

STYLE_SHEET

/ , ' v  R . J  B - <) n D - >o a d
Type:
Directive
Description:
Specifies the name of an external style sheet to be used.
Applies to:
HTML styling. HTML only
See policy:
"Document style sheet"
6

Syntax:


3

$_$_STYLE_SHEET <URL of .css file>

B
K
$'

Note, this applies to HTML only.

wF

This directive allows you to specify the URL of a style sheet file,Husually with a .css extension. Style sheet files are a new HTML featureLthat allow you specify fonts and colours to be applied to your document.

M

The resulting HTML is inserted into the <HEAD> section of the outputepage(s) as follows :-

e

C

<LINK REL="STYLESHEET" HREF="URL" TYPE="text/css">

l
O
OI

The presence of a STYLE_SHEET pre-processor command will overrides any<style sheet specified via a "Document style sheet" policya line.


 d

SUPER and SUB

/o, ' c  A . 5   - T! B  - > t O
Type:
In-line
Description:
Signals a superscript or a subscript
Applies to:
Text generation.
See policy:
(none)
6

Syntax:

.
+

[[SUPER <superscript_text>]]
>$[[SUB <subscript_text>]]

n1e

 

TABLE_ALIGN

/a, '   i . B  e - E/ N g - gu > t
Type:
Directive
Description:
Specifies the alignment of the table(s) concerned
Applies to:
Table generation. Mostly HTML
See policy:
"Default TABLE alignment"
6

Syntax:


1

$_$_TABLE_ALIGN <Alignment code>

S
f

where,

n

'g, .8   t
<Alignment code>
L[eft]
 R[ight]
 C[enter]
 A[utomatic]
.
R
K

Specifies how the table should be aligned with respect to the page. The>Idefault behaviour is "automatic", which usually means left-justified, butn6taking into account any indentation the table has.


 

TABLE_BGCOLOR

/e, ' e  O . F  N - N- > D - Gm  R
Type:
Directive
Description:
Sets the background colour for the table(s) concerned
Applies to:
Table generation. HTML only
See policy:
"Default TABLE color"
6

Syntax:


0

$_$_TABLE_BGCOLOR <HTML colour>



B0

This tag only applies to HTML production.

G

This tells the program what colour to use for the background to eachOEcell. Not all browsers support this. Only valid HTML Colours may be specified

>
 

TABLE_BORDER

B/I, ' h   . E D R - u- v a - yy D T
Type:
Directive
Description:
Specifies the border size for the table(s) concerned
Applies to:
Table generation. HTML only
See policy:
"Default TABLE border size"
6

Syntax:


0

$_$_TABLE_BORDER <integer size>



S
oL

This tag only applies to HTML production, where is sets the default value+for the <TABLE> BORDER attribute.

>J

A value of 0 means "no border". If omitted the border size will be set+according to the table characteristics.

>
! $

TABLE_BORDERCOLOR

/A, ' i  a . G . B - o- d A - A} t O
Type:
Directive
Description:
Specifies the border colour for the table(s) concerned
Applies to:
Table generation. HTML only
See policy:
"Default TABLE border colour"
6

Syntax:


<

$_$_TABLE_BORDER_COLOUR <HTML colour value>


SL

This tag only applies to HTML production, where is sets the border colour9for the table. Not all browsers support this option.


 K

TABLE_CAPTION

/L, ' n  i . G s r - -- T E - Nq < 
Type:
Directive
Description:
Specifies the table caption for the table(s) concerned
Applies to:
Table generation. HTML only
See policy:
"Default TABLE caption"
6

Syntax:


E

$_$_TABLE_CAPTION <rest of line is the caption text>

T
y
/Q

This tag only applies to HTML production, where it sets the table caption.

dG

The caption should normally only be applied to individual tables, asPJapplying the same caption to all tables is unlikely to may much sense.


! X

TABLE_CELLPADDING

/T, '   e . K a b - n- x  - t{ - c
Type:
Directive
Description:
Specifies the CELLPADDING value for the table(s) concerned
Applies to:
Table generation. HTML only
See policy:
"Default TABLE cell padding"
6

Syntax:


6

$_$_TABLE_CELLPADDING <Integer value>



t
RL

This tag only applies to HTML production, where it sets the <TABLE>KCELLPADDING attribute value. The CELLPADDING specifies the amount of whiteoKspace added inside each cell around the cell contents.

>
! R

TABLE_CELLSPACING

/:, ' Q  a . K o  - p- < > - t{ R 
Type:
Directive
Description:
Specifies the CELLSPACING value for the table(s) concerned
Applies to:
Table generation. HTML only
See policy:
"Default TABLE cell spacing"
6

Syntax:


6

$_$_TABLE_CELLSPACING <Integer value>



S
lL

This tag only applies to HTML production, where it sets the <TABLE>KCELLSPACING attribute value. The CELLSPACING specifies the amount of white-:space added between individual cells.




TABLE_CELL_ALIGN

/Q, ' o   . P   - o"  o - p  m
Type:
Directive
Description:
Specifies the alignment to be applied to each cell in the table
Applies to:
Table generation.
See policy:
"Default TABLE cell alignment"
6

Syntax:


6

$_$_TABLE_CELL_ALIGN <Alignment code>


b

where,


'h, 8  
<ALignment_code>
L[eft]
 R[ight]
 C[enter]
 J[ustified]
.
e



LSpecifies the default cell-alignment to be applied to table cells. NormallyIthe program will try to auto-detect a suitable cell alignment on a column!by column, cel by cell basis.

pL

You can use this to (rather crudely) set all cells to be aligned the same-way if the results are not to your taste.


# o

TABLE_COLO(U)R_ROWS

/B, ' O  m . I t a - c- > L - og a m
Type:
Directive
Description:
Specifies that table rows should be coloured differently
Applies to:
Table generation. HTML only
See policy:
"Colour data rows"
6

Syntax:


/

$_$_TABLE_COLOUR_ROWS <yes/no>


_

or


/

$_$_TABLE_COLOR_ROWS <yes/no>

B

D
G

Mote, this only works in HTML production, where the presence of thisTHtag specifies that the odd and even rows of the table should be coloureddifferently.

I

If the <yes/no> value is omitted the default value is "yes".

lg

The actual colours can be set using TABLE_ODD_ROW_COLO(U)R andTABLE_EVEN_ROW_COLO(U)R


# u

TABLE_CONVERT_XREFS

/h, ' B  e . N  T - ""  R - l  r
Type:
Directive
Description:
Specifies that section numbers should be made into hyperlinks
Applies to:
Table generation.
See policy:
"Convert TABLE X-refs to links"
6

Syntax:


"

$_$_TABLE_CONVERT_XREFS



d
tK

If present, indicates that any section cross-references in the table mayRbe converted to hyperlinks


' >

TABLE_EVEN_ROW_COLO(U)R

/h, ' t  > . 9 i e - >- _ & - / > l
Type:
Directive
Description:
Specifies colour of even rows in a table
Applies to:
Table generation. HTML only
See policy:
"Default TABLE even row colour"
6

Syntax:


=

$_$_TABLE_EVEN_ROW_COLOUR <HTML colour value> ori; $_$_TABLE_EVEN_ROW_COLOR <HTML colour value>

!

E
J

Applies to HTML only. When data rows are to be coloured this specifies)the colour of the even numbered rows.

f
! 

TABLE_HEADER_COLS

/t, ' p  u . B  A - - u  - y G >
Type:
Directive
Description:
Specifies the number of header columns in a table
Applies to:
Table analysis
See policy:
"Default TABLE header cols"
6

Syntax:


D

$_$_TABLE_HEADER_COLS <integer number of columns>



>
iT

Number of "header" columns (usually just 1). These will be marked up in bold


! /

TABLE_HEADER_ROWS

X

Description: Specifies the number of header rows in a table

8

Applies to: Table analysis

See policy: "Default TABLE header rows"

x

Syntax:


D

$_$_TABLE_HEADER_COLS <integer number of columns>



H
M

Number of "header" rows. These will be marked up in bold. If omitted theKKsoftware will attempt to detect the header by looking for an underline neartthe top of the table.

Q
# a

TABLE_IGNORE_HEADER

/ , ' "  = . W   - < T > - s  
Type:
Directive
Description:
Specifies that a table header should be ignored during column analysis
Applies to:
Table analysis
See policy:
"Ignore table header during analysis"
6

Syntax:


"

$_$_TABLE_IGNORE_HEADER


-
m"

This tag has no attributes.

K

If present, indicates that the first few lines of the table - assumed to;Ebe the header - should be ignored when calculating the table's column structure.

M

This should be enabled if the table has a particularly complex header thatemay confuse the program.


 

TABLE_LAYOUT

N/T, ' g$  R . :  > - T y . - Ao K 
Type:
(directive/In-line)
Description:
Specifies the column structure of a table
Applies to:
Table analysis
See policy:
"Default TABLE layout"
6

Syntax:


`

$_$_TABLE_LAYOUT <number of columns>,"<col 1 spec>","<col 2>",.....


N
I

where,

T

', 8 *  Q e& 1  l ( 8  t ( 2  T ( 4  n
<Number_of_cols>
Integer number of columns
<col_n_spec>
  

Specification of the nth column. The
n8 specification must be contained in quote.
 
Currently the specification consists of
 
- the end position of the column.
 
More may be added in later versions
.
>
R


An example would be


+

$_$_TABLE_LAYOUT 3,"6","21","32"

R
=K

which describes a 3-column table with column boundaries at the 6th, 21st"!and 32nd character positions.

-7

Normally this directive should be placed between theaGBEGIN_TABLE...END_TABLE directives for the table it applies to, thereby Ioverriding the "intelligent" analysis the program would otherwise attempt for a plain text table.

o
# u

TABLE_MAY_BE_SPARSE

/ , ' D  e . L  T - O h s - To T T
Type:
Directive
Description:
Specifies that a table may be expected to be largely empty.
Applies to:
Table analysis
See policy:
"Expect sparse tables"
6

Syntax:


"

$_$_TABLE_MAY_BE_SPARSE


/
"

This tag has no attributes.

M

If present, indicates that the TABLE may be sparse, that is it is expectedEOto have a large number of empty cells. This can affect the table analysis.


+ $

TABLE_MIN_COLUMN_SEPARATION

/e, ' s  A A . & *  < - a t T T - d  R o
Type:
Directive

Description:
Specifies the minimum
gap between table columns
Applies to:
Table analysis

See policy:
"Minimum TABLE column separation"

6

Syntax:


K

$_$_TABLE_MIN_COLUMN_SEPARATION <integer number of spaces>

a
B
>H

Number of spaces to be taken as a column separator when analysing the table.


& 

TABLE_ODD_ROW_COLO(U)R

p/o, ' n  ! . 8  < - i- <  - n T E
Type:
Directive
Description:
Specifies colour of odd rows in a table
Applies to:
Table generation. HTML only
See policy:
"Default TABLE odd row colour"
6

Syntax:


<

$_$_TABLE_ODD_ROW_COLOUR <HTML colour value> or: $_$_TABLE_ODD_ROW_COLOR <HTML colour value>



J

Applies to HTML only. When data rows are to be coloured this specifies(the colour of the odd numbered rows.


 L

TABLE_WIDTH

/l, ' s  B . 5 r T - - i R - /m > >
Type:
Directive
Description:
Specifies the width of an HTML table
Applies to:
Table generation. HTML only
See policy:
"Default TABLE width"
6

Syntax:


@

$_$_TABLE_WIDTH <table in pixels or percentage>


a
tJ

This tells the program what value to use for the WIDTH attribute of theHTML table.

K

The WIDTH is specified either as a number (of pixels) or as a percentageBG(of screen width). Thus "400" and "75%" are both valid values (without the quotes)

O


TEXT

i/g, ' S  u . B  L - D! e > - > t O
Type:
In-line
Description:
Adds text without applying any conversions to it.
Applies to:
Text generation.
See policy:
(none)
6

Syntax:


*

[[TEXT <protected_text>]]


a
y

where


/E, f8 6 I l
<protected_text>
Text to be protected. May contain number,
3 url or emphasis characters that shouldn't
 be converted
6
,N

Protects the supplied text from normal conversions. e.g a software versionNnumber that could become a hyperlink to a section number, a url that shouldn'tbe converted etc.

N
 A

TIMESTAMP

/Q, ' o  R . /  e - R!  a - R B 
Type:
In-line
Description:
Adds a date to the output text
Applies to:
Text generation.
See policy:
(none)
6

Syntax:




[[TIMESTAMP]]


o
Q

Outputs the date of conversion into the output file in the format dd-mmm-yyyy.$GNo attributes as yet, but expected to have formatting options added

C
 O

TITLE

/, ' n  > . -  o - H  d - oc t a
Type:
Directive
Description:
Specifies the document title
Applies to:
Document indexing. HTML and RTF implementations differ
See policy:
"Document Title"
6

Syntax:


;

$_$_TITLE <Rest of line is the title text>


y
<

In RTF this becomes the title in document properties.

W

in HTML this allows you to specify the <TITLE>...</TITLE> to be inserted>Linto the <HEAD> section of the output page. This title will appear inFthe browser's frame title whenever the page is viewed, and will be the)text shown in your browser's history.




TOC

/R, '   / . I L & - 1 P E
Type:
Directive
Description:
Marks a Table of Contents entry, and the location of the
Applies to:
Hyperlink generation. HTML only
6
#
See policy
(none)
o associated hyperlink


Syntax:

G

$_$_TOC <level>, <link name>, <display text>

o
t

where,

a
'u, n! /@ u h L% R@ " > <( ? X  Q a? b o
<level>
)  

the level in the TOC, starting with 1 being the most
3 significant, equivalent to "chapter"
<link name>
T

  

The (usually short) name by which this linkpoint may
? be known. This is the value used to create an ANCHOR
o3 point, and which may be referenced in any
N HYPERLINK tag.
<display text>


  

The text to be shown in the TOC. This will also be
v= used to generate an ANCHOR name, and may be used in
!? a TOC type HYPERLINK Tag, although this is marginally
/; less portable than referencing the link name

  

If omitted, defaults to the link name, and only one
! ANCHOR is created.
.
d
C

The TOC directive marks a point in the file that will receive an Janchor point, and then be linked to from any generated contents lists.

M

This can be useful to index non-headings like key diagrams and tables.

eG

See also the section on HYPERLINK tags.

N
 

VARIABLE

a/T, ' l  a . F  B - O  _ -  E Q
Type:
In-line
Description:
Adds text from the matching DEFINE_VARIABLE statement
Applies to:
Text generation
See policy:
(none)
6

Syntax:


$

[[VARIABLE <name>]]


Do

The tab will be replaced by the value of the nearest matching DEFINE_VARIABLETAstatement. Over time it is expected that some variables (sectionp
 m

VERSION

/<, ' i   . ?   -  T - f B L
Type:
In-line
Description:
Adds a description of the program name/version
Applies to:
Text generation
See policy:
(none)
6

Syntax:




[[VERSION]]


/
DP

Outputs the version name of the conversion into the output file. For example"AscToHTM 4".

n
2

R
_Y Previous page P$5 Back to Contents Liste#/  E


B? 
Valid HTML 4.0!Converted from a single text file by HREF="http://www.jafsoft.com/asctohtm/">AscToHTM
K© 1997-2001 John A. FotheringhamR
/T