README
block specifies the additional text to be displayed
in a special text view control.
This can only be specified in a
PAGE
block
on a page which has the TYPE=README
attribute.
See the "Installation Scripts"
page for an overview where this element should be placed.
In between the <README>
and </README>
tags,
you must specifiy the text as it should be displayed in the multi-line entry field.
The text may be formatted according to the FORMAT
attribute (see below).
Attributes:
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.
However, you must make sure that the HTML text is XML-compliant, or WarpIN's
XML parser will report errors. Most importantly,
all HTML tags must appear as opening/closing XML elements, or they must be
marked as empty elements with a trailing " /"
.
See the list below.
Besides, you must close nested HTML tags in the same order in which they were opened
(e.g. <B><I>text</I></B>
).
Only the following HTML tags are supported (no attributes whatsoever):
<P />
starts a new paragraph.
Required for inserting line breaks. Note the "empty element" mark.
<BR />
starts a new line within the same paragraph.
Note the "empty element" mark.
<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.
Note the "empty element" mark.
<OL> ... <LI /> ... </OL>
describes an ordered list.
Note the "empty element" mark.
<DL> ... <DD /> ... <DT> </DL>
describes a definition list. Note the "empty element" mark.
<B> ... </B>
prints bold text.
<I> ... </I>
prints text in italics.
<U> ... </U>
underlines text.
<CODE> ... </CODE>
prints text in a monospaced
font.