home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Club Amiga de Montreal - CAM
/
CAM_CD_1.iso
/
files
/
498b.lha
/
HyperText
/
SetUpInfo
< prev
next >
Wrap
Text File
|
1991-04-08
|
5KB
|
129 lines
\help ht.help
\title Setup Commands
\fgcolor 3
\bgcolor 1
\center
\under SETUP COMMANDS \under
\format
The Setup Commands. The purpose of these '\\' commands is to affect
the way HT looks and a little of how it behaves. These commands have to
come at the \ital BEGINNING \ital of your document. They are \bold not
\bold displayed, but must be at the beginning of your file.
\center
\under The Setup Commands are:\underl
\indent 20
\freeformat
\link { SetUpCommands \FONT } Setting the Font for a document. \endlink
\link { SetUpCommands \TITLE } Giving a window a specific Title. \endlink
\link { SetUpCommands \BGCOLOR } Setting the BackGround color. \endlink
\link { SetUpCommands \FGCOLOR } Setting the ForeGround color. \endlink
\link { SetUpCommands \LOCATION } Setting the Window Position. \endlink
\link { SetUpCommands \TEXTCOLOR } Setting the Text Color. \endlink
\link { SetUpCommands \HELP } Defining a help file. \endlink
\format
Setup commands are provided as a way to customize your documents and
to make them more visually appealing. In a sense they are a small header
which tells HT how to modify its basic display.
\bold
Restrictions on Setup Commands:
\bold
\format
Unfortunately there are some restrictions on the format of setup
commands. O.k., what are the restrictions? They are:
\indent 10
\freeformat
\bold
1. Setup commands must be lower case.
2. All of your setup commands *must* appear at the beginning
of the file
3. They must take less than 2k of space (not really a problem as
there are only 7 of them).
\bold
\format
That's basically it for restrictions (although any restrictions are
bad ones, the tradeoff here (internally) was well worth it).
Another thing to remember about setup commands is that they are one
command to a line. This means you would put them in this sort of format:
\freeformat
\indent 20
\\title My really nifty document
\\font diamond 25
\\location 25 25 400 100
The rest of your document...........
\format
If not, only the first command on each line will be recognized, and it
is even possible for another command to be treated as part of the title
if the line started with the \\title keyword.
\center
\bold On to more interesting things \bold
The setup commands are a useful tool for creating document
environments. Using the setup commands, it is possible to use \bold color
\bold coding to provide a sense of location. In a set of hypertext
documents, setting the same color for documents at roughly the same "level"
in the structure will help your reader to gain a subliminal feeling for
where they are (of course this isn't a substitute for a map facility, but a
supplement). The \link { SetUpCommands \FGCOLOR } \\fgcolor, \\bgcolor
commands are what you would use. \endlink
Setting the window title is another easy method of configuration.
Suppose you would like to convey some information through your title bar.
\it I.E. \it an indication of depth/width or some sort of cue. It is as
simple as putting a \link { Setupcommands \TITLE } \\Title command in your
document header. \endlink
Of course Help is always an important features, and since the Amiga has
a HELP key, I am practically compelled to make use of it ;-). You can define an
an individual help file for each document. Using the command \Link {
SetUpCommands HELP } \\HELP,\Endlink you can specify which file will be
brought up when the user presses the help key in that window. If you don't
define a help file for a particular window, HT will simply tell the user
there is no help file defined for this window. This would be a terrible
thing however, since it is so easy to do. Try to make use of this feature
when it is feasible. It will greatly aid the novice user.
Setting the font for a window is equally easy. All you must do is
enter the \link { SetUpCommands } \\FONT\endlink keyword with the name and
size of the font you want. That easy. Each window can have its own font.
If the document you are writing/modifying uses HT formatting (\ital i.e.
\ital the \\FORMAT keyword ), then HT will make sure all lines fit in the
window for the given font size. HT should work with just about any font,
however some proportional fonts can produce text lines that seem a tad bit
short for the actual window width. This is due to a combination of the way
the way HT is structured and how the Amiga deals with proportional fonts.
You certainly can give just about any font you want a try though.
You can also specify where HT should open the window that will contain
your document. This is done with the \link { SetUpCommands LOCATION }
\\Location \endlink keyword. For example if you had a need for a window
starting at 100,50 and dimensions of 300x125. You could embed a \\Location
command to instruct HT to do this. Obviously this is error checked for
sanity.
That about wraps it up for SetUp commands. You would want to refer to
the \link { SetUpCommands } SetUpCommands \endlink file for more detailed
information on each of these commands. Thank you for your continued
support.