README
block specifies the additional text to be displayed
in a special text view control on a page which has the TYPE=README
attribute. This tag can only appear within a
PAGE
block. If a page does not have
the TYPE=README
attribute, this block is ignored.
In between the <README>
and </README>
tags,
you must either
EXTRACTFROMPCK
is not specified, or
i
, if
if EXTRACTFROMPCK
is given.
<README>
tag can have the following attributes:
EXTRACTFROMPCK="i"
i
, and the text between the
README
and </README>
tags specify the relative path name of the file in
the package i
which holds the text to be displayed. This better
really be a text file. This is useful if you don't want to re-insert a readme text
into the script with every release.
Example:
<README EXTRACTFROMPCK="1">help\readme.txt</README>
If this is not specified, the contents of the README
block specify
the text to be displayed directly.
FORMAT={PLAIN|FLOW|HTML}
PLAIN
: the text is displayed "as is". No formatting,
not even word-wrapping, is done. This means that your text must have proper line breaks
every, say, 50-60 characters per line, or it will be hard to read in the
README window. This is the default.
FLOW
: single line breaks are removed and word-wrapping is enabled.
Since you can never be sure where WarpIN's text view control will perform word wrapping,
you can specify this style to have WarpIN remove all single line breaks
so that paragraphs appear as flowing text. If there are
double line breaks in the text (i.e. an empty line exists between two lines), WarpIN
will consider this a paragraph and insert a line break into the MLE as well.
HTML
: the text is considered HTML code and formatted
accordingly. WarpIN can translate a limited subset of HTML tags, which are:
<P>
starts a new paragraph. Required for inserting line breaks.
<BR>
starts a new line within the same paragraph.
<PRE> ... </PRE>
holds a block of pre-formatted text with
a monospaced font,
where line breaks are preserved.
<UL> ... <LI> ... </UL>
describes an unordered list.
<OL> ... <LI> ... </OL>
describes an ordered list.
<DL> ... <DD> ... <DT> </DL>
describes a definition list.
<B> ... </B>
prints bold text.
<I> ... </I>
prints text in italics.
<U> ... </U>
underlines text.
<CODE> ... </CODE>
prints text in a monospaced
font.