\begindata{hlptext,538281340}
\textdsversion{12}
\template{help}
\define{xxx
attr:[Flags Underline Int Clear]
attr:[Flags Underline Int Clear]
attr:[FontFace Bold Int Clear]
attr:[FontFace Italic Int Clear]
attr:[FontFace FixedFace Int Clear]
attr:[FontSize ConstantFontSize Point 8]
attr:['color' 'Red']}
\chapter{htmltext: an editing package for HTML+ documents
}
\section{What htmltext is
}
\leftindent{Htmltext is an editing package used by EZ when editing HTML+
documents. HTML+ is a tag format used for files that are put on the World
Wide Web (WWW or "the Web"). Htmltext is intended primarily for creating
and modifying documents. For instructions on actually browsing the World
Wide Web, see the \helptopic{Mosaic} help file.
}
\section{Starting htmltext
}
\leftindent{At the Typescript prompt, type "ez file.html" and press Enter.
Use of a .html extension tells EZ to load the htmltext editing package,
according to the specifications in the global initialization file for EZ,
$ANDREWDIR/lib/global.ezinit.
If you create your own .ezinit file, you can override the global.ezinit
file or add other file extensions that will load the htmltext package. You
can also set various parameters of htmltext, which are listed below in the
section "Customizing htmltext in your .ezinit file." For details about
initialization files, see the \helptopic{initfiles} help file.
}
\section{Warnings
}
\leftindent{\bold{IMPORTANT:}
Since HTML+ only supports some, but not all the arbitrary multimedia insets
that EZ does, insertion of unsupported insets (e.g. "fad" or "zip" insets)
will result in them being discarded.
\bold{Less Important:}
Htmltext is not guaranteed to produce HTML+ documents that will be
interpreted correctly by all possible HTML and HTML+ browser applications.
The document, when viewed with EZ, will usually have a slightly different
appearance than when viewed with Mosaic.
If you edit an HTML+ document that was created by hand, and then save it,
the format and arrangement of the tags may differ slightly from the
original. However, these differences will not affect the appearance of the
interpreted document, only its "raw" content.
At this time, htmltext is not a complete implementation of the HTML+ spec.
However, any tags that are not recognized will be hidden in an inset
during the editing session, so that when the file is saved, those
unrecognized tags will remain intact.
\xxx{XXX- HTML+ as a document markup standard is defunct. HTML 3.0 is its
new name, and htmltext will be updated to follow any changes in the HTML
3.0 standard as they occur (and as resource permits).}
\xxx{XXX(techie)- A separate and distinct HTML edit view for EZ was created
earlier by a different unrelated party. Its class name is html[view] (this
one is htmltext[view]), so they can peacefully coexist, except they use the
same template name (html.tpl). If you have your own copy of html.tpl
copied from the first html dataobject, remove it from your TEMPLATEPATH.}
}
\section{Intro to HTML+ document format
}
\leftindent{HTML+ documents (in their raw format) look something like this:
\example{Rob's home page
This is my home page
This is the
stuff I'm working on:
Help files
Other stuff
...
}Htmltext reads those <>-delimited tags, interprets them, and turns them
into (as appropriate) styles or insets. These styles and insets can be
edited the same way as in other EZ documents. If you are unfamiliar with
how EZ works, see the \helptopic{EZ} help file.
}
\section{Pop-up menu meanings
}\leftindent{
}\italic{Front menu card
Search/Spell menu card
}\leftindent{See \helptopic{EZ} help file.
}
\italic{Page menu card
}\leftindent{\bold{Insert Horiz Rule:} Inserts a page-wide horizontal line
at the position of the text caret. (\typewriter{
} tag in HTML+)
\bold{Inset raw HTML+:} Inserts a \bold{hidden} inset, which will output
its contents verbatim. This is a feature for experts who wish to add HTML+
markup that EZ does not support directly.
\bold{Hide HTML+ insets:} This makes all \bold{hidden} insets invisible,
for better readability (this is their default appearance when a readonly
HTML+ file is loaded).
\bold{Expose HTML+ insets:} This makes all \bold{hidden} insets visible,
for experts who wish to browse or edit existing unsupported HTML+ markup
(this is their default appearance when editing an HTML+ file you have write
access to).
See \helptopic{EZ} help file for other entries.
}
\italic{Font menu card
Emphasis menu card
Header menu card
}\leftindent{These contain straightforward styles, which are explained in
the \helptopic{ez-styles} help file.
Note that the "Header" styles are numbered in increasing order from major
to minor, to coincide with the HTML+ tag names \typewriter{} (major)
through \typewriter{} (minor).
}
\italic{Region menu card
}\leftindent{Most of these menu items simply insert a style.
"Preformatted" is used most often, for large regions of text where
whitespace is significant and a fixed-width (\typewriter{typewriter}) font
is desired.
The "Edit Attributes" and "Add Link" menus are explained in separate
sections below.
}
\italic{List menu card
}\leftindent{Htmltext supports three kinds of lists:
\description{ 1. Ordered lists, which have a number associated with each
item in the list.
\symbola{7} Unordered lists, which have a round "bullet" in front of
each item in the list.
\bold{Definition lists} contain terms and definitions of those terms.
}
There are two ways to create an ordered or unordered list. To create a
list out of items that have already been entered, simply select all the
items and then choose "Ordered List" or "Unordered List" from the "List"
menu card. To start a new list from scratch, place the caret where you
want the list, then choose one of the "... List" menus.
You can add more items to any type of list by selecting the "Add List Item"
menu or pressing Tab when the cursor is at the start of a line. Or,
instead of pressing Enter then Tab for each new item, you can just press
Ctrl-J, which will add a new line with the appropriate number or bullet on
it.
Definition lists are a bit different. After creating a new list or adding
another item via Ctrl-J, the text that is entered will be the boldfaced
"term", until the Tab key is pressed. After Tab is pressed, any text
entered is the "description" of that term. (If no boldfaced term was there
when Tab is pressed, pressing Tab will turn all preceding text on that line
into the term, and you can then proceed to type the description, as usual.)
If the numbers in an ordered list become discontinuous (due to a Cut or
Paste or Insert File), place the caret anywhere within the ordered list and
select the "Renumber List" menu. (This is actually unnecessary, since the
numbers themselves are generated at the time the file is edited or browsed).
}
\italic{Media menu card
}\leftindent{This menu contains various insets that can be properly
translated into HTML+ tags. To insert one, position the caret at the
desired location and select the menu.
\bold{Table:} This uses the \helptopic{table} inset, and outputs the
HTML+ \typewriter{
} tag. You can combine cells, put styles inside
the cells, and add and remove cells.
\smaller{Warning: although you can use table's "spreadsheet" calculation
abilities, the \italic{formulae} will NOT be saved in the file; only its
value at the time of the save.
Warning: table allows precise control over which borders are drawn and
which borders are not. In HTML+, either \italic{all} the borders are drawn
or \italic{none} of the borders are drawn, so don't get fancy because the
individual border settings will be lost.
}
\bold{Image:} This uses the \helptopic{image} inset, and outputs the
HTML+ \typewriter{![]()
} tag. It typically contains a reference to a local
.gif file, or a URL. When inserting one, it will prompt for a
filename/URL, and load the image in as an inset. \xxx{XXX-only local files
will actually be displayed inline; remote URLs can't be fetched by EZ yet}
\bold{Figure:} This uses the \helptopic{figure} inset, and outputs the
HTML+ \typewriter{} tag. \xxx{XXX-not implemented}
\bold{Fill-out Form:} \xxx{XXX-not implemented; use "Page, Inset raw
HTML+" and type the