OS/2 Shareware BBS: 5 Edit/05-Edit.zip/wset-os2.zip/DocuSrc/WSFDOCU.WS

Text File | 2003-05-23 | 111KB | 2,932 lines

..This is the unformatted raw text of the WSformat documentation in Wordstar/Write&Set
..format. You are encouraged to format and print the file. The file is also the source
..of the Winhelp file which part of the Write&Set archive. It was created by Hypermake.
..To learn more about the dot commands, move the mouse cursor over a dot command which
..you want to get described.
.bt₧ wsformat.bmp
.gs130
.bt¡ exclam.bmp
.gs300
.fi Title.ws
..(concerns Hypermake only)
.ti WSformat 0.95 Documentation
.<>
.bt■ blackdot.bmp
..(End Hypermake only)
.1
Introduction

.if not WSformat
.ep off
..principally, this code can be interpreted by WSformat,
..but is for Hypermake (generating online-help) only
.sfJ
₧ WSformat 0.95 Documentation
.sf
.ep on
.end not WSformat

.icµ
.in Introduction
.2
WSformat abstract

.in Write&Set
WSformat is a formatting and printing program for Wordstar (DOS) files. WSedit ì
and WSformat together are the full-featured word processing suite Write&Set, ì
running under current operating systems. Word processing with Write&Set ì
divides the job of producing a document in two parts: editing and - later - ì
formatting and printing. These two parts of the job are done by separate ì
programs: WSedit and WSformat. Nevertheless, running the two programs ì
simultaneously offers you the look-and-feel of a single program. The concept ì
of separate editing and setting simplifies word processing and enables you ì
compiling a single document with hundreds of pages without any problems.

Write&Set is based on the Wordstar DOS philosophy ('what you see is what you ì
want' and not 'what you see is what you get'). Nevertheless, WSformat does ì
have a provision for document preview.

WSformat is Shareware and WSedit is Freeware.

WSformat supports hyphenation, the creation of end notes and footnotes, ì
generation of tables of contents and indexes, line drawing, embedding graphics ì
in text and allows conditional statements. In contrast to the older DOS ì
Wordstar versions, document preview and printing use functions provided by the ì
Windows (or OS/2) operating systems. This means you have access to the ì
printers and type fonts which are installed on the operating system.

Wordstar Compatiblity: WSformat accepts all Wordstar (DOS) files, but does not ì
support all Wordstar DOS functions, i.e., those which were added after ì
Wordstar Version 4. Instead, some extended functions (such as generating ì
tables of contents or handling footnotes) are implemented in a ì
WSformat-specific way. Basic Wordstar 5-7 'symmetrical sequences' are ì
recognized (indentions, for example).

The Write&Set command syntax is very similar to that of Hypermake. From a WS ì
file, Hypermake will generate an equivalent file in RTF, Winhelp, HTML, IBM ì
Help or Microsoft HTML-Help format. The Windows and IBM Help files of WSformat ì
and WSedit were compiled from WS (Write&Set unformatted) files.

WSformat requires Windows 98, Windows NT 4, OS/2 Warp 3 or later.

.2
Word Processing with Write&Set

.ID P_PROCESSING
.in wordprocessing
Word processing with Write&Set is very different from those Windows word ì
processing programs such as Winword or StarOffice, and also differs in some ì
respects from Wordstar for DOS. Word processing operations are closer to Latex ì
than to Winword. With Write&Set, the task of 'text content editing' and that ì
of 'typesetting' are sequention operations, rather than simultaneously.

For the moment, forget all you have learned about computer word processing and ì
think about the time before the personal computer was invented, when your ì
'word processor' was pen, scissors, cement, etc. The way to get a complex ì
document involved some or all of the following steps:

Step 1:áWriting a draft in longhand, often including notes that would not ì
ááááááááappear in the final publication;
Step 2:áTyping the draft with a typewriter;
Step 3:áCorrecting the text by hand on the typewriter copy;
Step 4:áSending the typewritten manuscript to the typesetter.

In the first step there was no need to consider the layout - page size, ì
margins, type faces. The author concentrated only on the contents... The four ì
steps were performed step by step. Today when you prepare a document using ì
Winword, the steps are all intermingled, effectively taking place ì
simultaneously. Because of this mode of operation, Winword and its ì
counterpart word processors are difficult to use. This design philosophy ì
produces word processing programs that are big, slow, drain system resources, ì
crash often, and in some cases are unable to produce the document the user ì
requires.

By way of contrast, when documents are prepared with Write&Set, the four steps ì
take place sequentially rather than concurrently.

Step 1:áEditing: Text is prepared as an (unformatted) 'raw' text file (a ì
áááááááá*.WS file) using WSedit (or Wordstar DOS). Such a text file will not ì
ááááááááinclude fixed margins. If you use WSedit, the margin of the displayed ì
áááááááátext depends only on the settings of the editing window and the screen ì
ááááááááfont.

When preparing documents on your computer, WSformat will only rarely be called ì
upon to process the text. This is the reason why I have decided not to create ì
a single program incorporating both functions.

Step 2:áStarting WSformat, formatting the unformatted raw-text WS file to ì
ááááááááproduce a formatted FMT file:

The WSformat 'format' function reads the raw-text WS file and writes ì
an FMT file. It does not modify the WS file in any way. In the FMT file, which ì
can be also viewed using WSedit or Wordstar (DOS), the right margin is now ì
fixed, the page breaks are apparent, and words at the end of the line which ì
require hyphenation are displayed accordingly.

Step 3:áMinor changes by hand on the formatted FMT file

If you are not satisfied with some formatting details, you can make small ì
changes to the FMT file. These include such things as incorrect hyphenations, ì
and more importantly, page breaks which can be improved.

However, avoid making bigger changes to the FMT file; if these are considered ì
necessary, it is more expedient to make the changes to the WS file and run ì
WSformat again. Because WSformat formatting is extremely fast (about 100 pages ì
per second, depending on your processor and the nature of the text), this does ì
not represent a significant delay in production.

The WSformat preview feature helps in locating sections of the text where the ì
printout can be improved. The printout in the Preview window mirrors exactly ì
page printout.

Step 4:áPrinting the final version of the document

After making the final changes to the FMT file, select the physical or virtual ì
printer installed on your computer and print your document. This is done the ì
same way as it would be for other current word processors. Besides physical ì
printers (laser or inkjet printers), it is possible to use 'virtual' printers ì
(FAX and PDF creation programs). These also work on files produced with ì
WSformat.

.2
Who should use Write&Set?

The Write&Set word processing suite is useful for the following users:

■ááUsers of Wordstar (DOS): Of course, all computer users who resist ì
áááWinword and similar programs will find a new home with Write&Set. (I intend ì
áááto support Write&Set in the long term, because I myself for various reasons ì
áááfind Winword and similar programs unproductive.)

■ááAcademics and other authors who have to prepare large and complex ì
ááá(scientific) documentation: Authors, students and others often fear using ì
áááwinword-like programs when generating large, complex documents. Many people ì
áááhave found themselves typing and re-typing such documents, due to the ì
áááinherent instability (and the resulting crashes) when handling such ì
ááádocuments. Because of the serial processing of WSformat, there is virtually ì
áááno limit on file size. There are no problems in processing a document with ì
áááhundreds of pages, thousands of footnotes, and dozens of bitmap graphics. ì
áááAfter creating a formatted text file (FMT file), line breaks and page ì
ááábreaks are fixed even if you print the document to another printer.

Note to Students: WSformat is available for a special, very low student fee ì
(30$).

■ááAll people who do not like winword-like software: users who do not like ì
áááwinword-like word processing software are invited to switch to Write&Set. ì
áááWrite&Set is also a fast, easy-to-use and adequate software for writing ì
áááeven simple correspondence.

■ááCompanies who want to reduce software expenses: WSedit is free and ì
áááWSformat is much cheaper than word processors such as Winword. Helping a ì
áááWrite&Set user by telephone or by E-Mail is simpler, because dot commands ì
áááare transmitted within the document, instead of being forced to describe ì
ááámouse controlled actions. ('On the top left, you see an icon with a wide ì
áááborder...') By using the 'embed file .fi' command, it is possible to ì
áááobserve standards throughout documents regardless of the author. For ì
áááexample, the company letterhead to be used in all WSformat files can be ì
ááámaintained centrally, and when it is necessary to change 'boilerplate' ì
ááátext, those changes will appear in all subsequent publications.

Limitations

Write&Set does not support muli-column text editing and formatting. ì
(Nevertheless, I plan multi-column printouts.) It is not intended for ì
desktop-publishing of such things as newsletters, magazines, etc. It is not ì
possible to include output from other applications, such as the way Winword ì
does with Excel, Access and so on. Instead you have to generate a bitmap file ì
from your spreadsheet, database or graphics program which can then be embedded ì
into a text document produced by WSformat. When making changes to your ì
spreadsheet, you have to update the bitmap file manually, something Winword ì
will do automatically.

For technical writers (physicists and mathematicians, for example) Latex will ì
also be found useful because Write&Set has no specific provisions for handling ì
mathematical formulas. With Write&Set, you have to generate a bitmap file of ì
your formula.


.1
Installation and first steps

.ID P_INSTALLATION
.in Installation
.2
Installation of Write&Set

Download the Write&Set archive file and unpack it to a new directory, e.g:
C:\Programs\WriteSet.

The two programs WSedit and WSformat are now located in subdirectories:
C:\Programs\WriteSet\WSedit
C:\Programs\WriteSet\WSformat

Now simply run the INSTALL program in the WriteSet directory. INSTALL creates ì
file associations and program icons on the desktop (and in the Windows Start ì
Menu). INSTALL does not copy files.

When starting WSformat the first time, some initialization procedures run ì
automatically:

-ááA binary file WSformat.dta which retains user settings will be generated; ì
áááit contains the data found in the settings notebook (settings - settings ì
ááánotebook)
-ááA simple text file fonts.ini will be generated. It stores the information ì
áááabout the fonts which are available on your system. It is recommended that ì
áááyou modify this file to fit your needs. (settings - font definition)
-ááThe fonts.ini text file is converted to a binary file printername.dta ì
áááwhich holds detailed font information before formatting or printing. When ì
áááchanges are made to fonts.ini, e.g. 'HP Deskjet 600.dta' file is updated ì
áááautomatically and a small window 'registering fonts' appears.

It is also necessary to modify some entries in the settings notebook ì
(settings - settings notebook):

■ááTo start WSedit or your preferred Wordstar editor from WSformat, select the ì
áááProgram page of the settings notebook and check the correct full filename ì
áááof the editor. If the file exists, the edit field turns green; otherwise it ì
áááremains red. (The same procedure is necessary in WSedit to find ì
áááWSformat.)
■ááSelect the printer to which formatting refers to. This should be your ì
áááfavourite printer for printouts.

By default, hyphenation is turned off. If you want to turn hyphenation on, do ì
the following:

■ááSelect the Hyphenation page in the settings notebook. For all languages ì
áááother than German, click on 'external tex file' and select your language. ì
áááPlease note that some conventions of British and American English are ì
ááádifferent, so there are own settings. The browser, which uses the Google ì
ááásearch engine, is started and you are directed to download the file to the ì
ááádirectory where WSformat.exe resides. Tex hyphenation files are small.
■ááFor German users, I recommend the internal german hyphenation which is ì
ááábetter than the tex algorithm.

.2
Format and print this documentation

.in Documentation
The archive file contains the same documentation in WS format (unformatted ì
text) and in Help file format. You have got access to the Help file from the ì
WSformat main window, Help menu item, or by pressing the yellow questionmark ì
buttons. If you prefer a printed documentation, you are encouraged to print ì
your docu.

Select the WS file

Start WSformat. First select the file which you want to format and print, in ì
this case WSFDOCU.WS in the Write&Set directory, subdirectory DOCUSRC. Click ì
on the File menu item, and then choose select. You may also simply drop ì
the WSFDOCU.WS file icon into the dropdown field on the WSformat main ì
window.

Format the WS file

Simply press the format button. A new file, WSFDOCU.FMT, will be ì
generated.

Edit the FMT file

If you really want to create a paper print, take a look at the WSFDOCU.FMT ì
file. By default, after formatting the editor starts and selects the FMT file. ì
Take a look at the page breaks which are represented in WSedit by a floating ì
yellow background. If you want to improve some page breaks, do it and then ì
save the FMT file.

Preview

You are also encouraged to preview the file; simply press the preview ì
button. When saving the FMT file in the editor, the preview window is updated ì
automatically. In the preview window, use the Pg dn and Pg up keys on your ì
keyboard, or use the left and right mouse button. For example, to go to page ì
20, hold down the left mouse button and drag the mouse to the right. Change ì
the height and width of the Window. The preview scale depends on the window ì
width.

Print the file

Select a printer by using the dropdown box in the WSformat main window. Press ì
the Print button, or select File - Print pages from the menu. In this ì
case, you can select single pages.

.1
User interface

Because WSformat is a text compiler, there are only a few windows which forms ì
the user interface.

.dp#23
.2
Main Window

.ID P_MAIN
.in main window
.it file selection
The WSformat main window is the central command window for editing, ì
formatting, and printing text; it is where you start jobs and open other ì
windows. While merely editing text, you can operate on your WS files directly ì
with your WSedit or Wordstar editor. While formatting and printing, start ì
WSformat and leave the main window open. From there, you can also execute the ì
editor on unformatted text.

Selecting a WS file

There are several ways of selecting a WS file.

■ááClick on the File menu item, and then choose select. You will get a ì
áááfile dialog which is similar to those used in many other programs.
■ááDrop the WS file on the WSformat icon on your desktop
■ááDrop the WS file icon onto the dropdown field of the WSformat main ì
áááwindow
■ááEnter the WS file name after WSformat on the command line.

After successfully selecting a WS file, some of the five WSedit function ì
buttons are enabled, depending on the existence of the corresponding FMT ì
(formatted) file.

.in RTF to WS conversion
Converting an RTF file to WS

The RTF file format is a worldwide standard for transferring text data with ì
formatting information from one wordprocessing software to another. E.g. you ì
can import a text from Winword to Write&Set by using the RTF file format. This ì
allows you to import not only simple text: also headings and footnotes are ì
converted.

You can convert an RTF file to WS the same way like selecting a WS file: Use ì
the "File - Select" dialog or drop an RTF file onto the the dropdown field of ì
the WSformat main window.

Formatting a WS file

Press the Format button or select the menu item Make - formatted file. ì
Either choice is acceptable.

Editing files

To edit files from WSformat, the file name of your favourite editor has to be ì
entered in Settings - settings notebook, page Program.

Selecting the button unformatted - edit starts the editor with the ì
designated file (with the file extension WS); selecting formatted - edit ì
starts a file with the extension FMT.

The menu items file - edit - unformatted and file - edit - formatted have ì
the same effect as the corresponding buttons. If the FMT file does not exist, ì
the buttons are disabled, while the menu items remain enabled.

The menu item File - close editors closes all Editor windows (for ì
programmers: by sending WM_CLOSE messages) of the selected project file. This ì
has the same effect as clicking to the 'Window Close' button of each editor ì
window. Do not use this function with a DOS (Wordstar) editor. In this case, ì
you are asked whether to interrupt the DOS application or not. If you press ì
yes, all data in the DOS window will be lost.

Previewing formatted files

To open the preview window, press the Preview button or select File - ì
Preview.

Printing formatted files

To select a printer, press the dropdown button and make your selection. To ì
print the whole document, press the print button. To print only a section of ì
the document, select the menu item File - Print pages. Note that you get the ì
best result if the selected printer is also the printer where formatting ì
refers to. You can reselect the 'reference printer' in the settings notebook, ì
page Program.

While the print job is running, the print button turns into a stop ì
printing button. Note that if you interrupt printing, a lot of data likely ì
will have been sent to the printer queue. You can delete this data by opening ì
your printer object.

Dropdown field and compile information

.in Dropdown field
In the middle of the WSformat main window, there's the dropdown field where ì
you are able to drag and drop WS files. This will select the dropped WS ì
file.

In the dropdown field, there are three lines, each with an LED. These display ì
the current processing states of the three WSformat jobs:

■ááWhen formatting a text, the progress of the operation is displayed on the ì
áááfirst line. While formatting, the red LED glows.
■ááWhile preview is activated and the preview window is shown, the yellow ì
áááLED glows and the page number of the page currently displayed in the ì
ááápreview window is shown. The page number also appears in the title bar of ì
áááthe Preview window.
■ááWhile a print job is running, the blue LED glows.

The WSformat print job is faster than the printer can print the results. The ì
operating system buffers the data and sends it to the printer as requested, ì
depending on the speed of the printer.

.in Multithreading
WSformat is a multi-threaded program. This means that even while WSformat ì
is executing one job, it is able to do another job concurrently. Besides the ì
main thread - editing the settings notebook, for example - there are three ì
threads which are represented by the red, yellow and blue LED: When the LED ì
glows, the thread is running. This means that you can format a file while ì
another file is still being printed, but you cannot print a file while another ì
file is printed. While printing a file, you can select another file and format ì
or preview this new document.

The extended compile jobs Make - Text and Footnote, Make - Content and ì
Make - Index are also executed in the format thread.

You are not allowed to exit WSformat until all threads are finished. If ì
WSformat does not end a thread - we don't hope that such a bug occurs - close ì
the main window and answer "Yes". In this case, WSformat tries to kill the ì
threads and to close. Sometimes this trial fails and you have to kill the ì
WSformat application (in Windows, press Ctrl-Alt-Del simultaneously and select ì
WSformat to end the process). In any case, contact the author if the bug can ì
be reproduced.

.wa verti 25
.2
Settings Notebook

.in Settings notebook
The data of the settings notebook is stored in the file WSformat.dta.

.3
Program page

.ID P_PROGRAM
In the entry field Full filename of the embedded editor, you can select the ì
editor program to be executed when pressing the buttons edit unformatted and ì
edit formatted on the WSformat main window. If you don't remember the file ì
name, use the search button.

The checkbox auto save sends a message to WSedit to save the file currently ì
loaded. Running "format" automatically saves the WS file, running "preview" or ì
"print" automatically saves the formatted file.

If the checkbox open editor after make is checked, WSformat automatically ì
executes the editor with the generated file after finishing the task of ì
formatting the text, generating the table of contents, or performing any ì
similar operations.

You can restrict where WSformat is to search for files by supplying it with a ì
list of directories. The directories are separated from one another by a ì
semicolon ';'. Instead of typing the directory names directly, you can also ì
use the search button. The directory where WSformat.exe resides is always ì
searched, but only if the search in these directories has failed. The list of ì
directories refers to the following files:

■ááFormatted and unformatted files, by using the .FI command
■ááHeading template files (.HF command)
■ááBitmap files, by using the .BM and .BT commands.

Printer to which formatting refers is relevant only if you have installed ì
more than one printer on your system. In such a case, selecting the active ì
printer affects how WSformat will perform its calculations while formatting. ì
If you select another printer for printing, the spaces between words can ì
differ because of slight differences of printer font metrics. But neither ì
line breaks nor page breaks are affected.

Auto correct file extension affects the main window of WSformat. If this ì
setting is on, you can also drop FMT files into the dropdown window and the ì
unformatted file will be given the extension WS. Deselect the checkbox if ì
you:
■ááWant to re-format a FMT file
■ááWant to use extensions other than WS for the unformatted Wordstar file
■ááwant to preview or print files other than FMT or TAF files, for example, a ì
áááTOC (table of contents) file.

Allow printing unformatted WS files can be useful if you have a text file ì
with a table or graphics and no running text, and thus the text file will not ì
need to be reflowed. Running text will not look as good as it would be with ì
the formatted file. Normally, this setting should be turned off.

The program language is only English at this time. The German setting ì
affects only some error and information messages. To translate WSformat to ì
other languages, I need help from native speakers. Please contact me if you ì
are interested in such an effort - you will receive a donation for your ì
work.

Concern printing group box

Lower the Print job priority if user input slows down while running a print ì
job.

Concerning Preview groupbox

When using preview you can also choose between positioning of each character ì
and positioning only each word. Positioning only each word is faster, but it ì
affects the word spacing, because WSformat can only select integer values of ì
font sizes and then the spaces between words can differ. The default value is ì
enabled.

.3
Format page

.ID P_FORMAT
On the format page, you can change settings concerning formatting rather than ì
directly previewing or printing or setting margins. These settings are located ì
on the Layout page.

Change hard spaces to soft spaces at the beginning of a line is useful if ì
WordStar conventions using soft spaces have not been observed for text ì
indention. Note that enabling this function will result in a wrong format if ì
normal spaces have been used to indent the first line of a paragraph. The ì
default value is disabled.

Reduce factor of spaces in wrapped lines ('gum factor') affects the width of ì
the spaces between the words of a wrapped line. A gum factor of '1' means that ì
on average the sum of the width of all spaces in a line is reduced about the ì
width of one Courier 12 character (1/10 inch). A negative gum factor enlarges ì
the average width of spaces. You can change this setting in your document by ì
entering '.GU', followed by the value.

Stretch factor of tabs (soft spaces) applies only to proportional fonts. In ì
a proportional font, there's no single width for every character; instead ì
every character is assigned its own width. If text printed in a proportional ì
font table is indented using soft spaces, there is the question to which scale ì
the indention refers to. This scale is now defined by the 'tab stretch' (.TS) ì
value. A value of 60 means the width of one soft space is equal to 60% of the ì
widest character in the font, usually the capital 'W' in a Roman alphabet. If ì
you want to be sure to keep two columns of a table from overlapping, try a ì
value of 100. This applies even if the column contains only 'W's. Since this ì
is highly unlikely, adequate values are from 50 to 60. When creating tables ì
with a proportional font, it is strongly recommended to check carefully with ì
Preview.

All .LH Line Height values refer to default normal font
let WSformat change the .LH values in the formatted file, dependent on the ì
current font selected with .SF. This omits overprinting lines when using ì
large fonts. See Line Height.


Default fonts

.it default font
Using fonts is described in an own chapter of this document. Fonts are ì
represented by single letters (case-sensitive). In the file fonts.ini, font ì
letters are assigned to the fonts available on your operating system. Single ì
characters represent fonts with no attribute, adding ' means italic, " means ì
bold, and & bold-italic. Note however that all these conventions can be ì
redefined.

You can select default values for both the normal and alternate fonts. The ì
selected font written with the selected font is displayed in the white field ì
on the right.

.3
Hyphenation page

.ID P_HYPHENATION
.in Hyphenation
Hyphenation is an important feature of a word processing program that must ì
formatting text with a fixed right margin. The more hypenation points are ì
correctly found, the better the final appearance of the document.

The default value of hyphenation is no hyphenation.

External Tex file

For all languages other than German, the external tex file setting is ì
recommended. Use the Google search engine on the Internet to locate the tex ì
hyphenation file (there is one available for almost every language). Once ì
located, download it to your computer and then save it in or move it to your ì
WSformat directory so that it will be available. These files are available for ì
nearly every language. For additional information see the chapter on ì
installation.

Tex hyphenation files are data-based text files which can be viewed with an ì
ASCII editor that accepts the IBM-OEM codepage. If a word is not currently in ì
the database, that word will not be hyphenated in your document. This will ì
especially affect the hyphenation points of such complex substantives as ì
'news-paper. The database stores the syllables with interspersed digits which ì
represent the possible hyphenation points. An odd digit means 'hyphenation ì
allowed,' while an even digit indicates 'hyphenation not allowed.' These may ì
be considered indicators of 'fracture' points. Digits of larger values ì
indicate a low probability of a hyphenation point; low value digits indicate ì
'weak' and thus an increased likelihood. The factor Minimal rating refers to ì
these digits. A minimal rating of 1 can result in a larger number of ì
hyphenations; values of 3 and 5 reduce the frequency of hyphenations, and ì
produce only very good hyphenations. A lower frequency of hyphenations can ì
increase the average width of spaces between words. A rating of 2 is not ì
different from a value of 1.

Internal german hyphenation algorithm

In the German language, hyphenation is very important because of complex ì
substantives. The internal german hyphenation function is based on a ì
phonetic assessment of a word, rather than on a reference to a stored data ì
base. It can thus hyphenate words which occur in text only very seldom; proper ì
names fall into this category. It locates more possible hyphenations (nearly ì
all in fact) than the German TeX database. In the case of a few hyphenations, ì
the results of the algorithm are ambiguous. In these cases, there is a query ì
option (Rückfrage) where the user is called upon to make a judgment. Many of ì
these queries are humorous funny, because the wrong hyphenation alters the ì
meaning. It is possible that WSformat takes note of these corrected ì
hyphenations, and stores them in the files DEULERN.DTA and GRIELERN.DTA which ì
resides in the current directory (normally the directory where WSformat.exe is ì
located in). The additional 'Ancient Greek' algorithm is useful for scientific ì
documents where many words are derived from the Greek roots. This particularly ì
applies to syllables beginning with ps, pt, rh, sc and some others. In most ì
German (commercial, correspondence...) these syllables occur very seldom, and ì
the default setting is set to disabled.

The minimum of not separated chars settings refer to all hyphenation ì
algorithms. It's a matter of document ('house') style whether a hyphenation ì
will leave only two characters of the word on a line. Higher values will ì
reduce the number of hyphenations; useful values are 2, 3 or 4. You can change ì
this default value with the .HN (Hyphenation Number of not separated ì
characters) dot command.

Do not hyphenate areas with capital letters depends on your own style ì
requirements. Sometimes there are abbreviations with capital letters which ì
must not be hyphenated. If your text contains sections in capital letters, you ì
should disable this function. The default setting is enabled.

A manual hyphenation setting is also available. When a word must be ì
hyphenated, a simple YES-NO-CANCEL dialog box is presented to the user for his ì
decision.

You can change the hyphenation default setting by using the .HY command, see ì
chapter Select Hyphenation.

To indicate that no attempt should be made to hyphenate it, type a leading ^PG ì
character in front of the word.

.3
Layout page

.ID P_LAYOUT
On the settings notebook page Layout, you can set the default values of many ì
dot commands which refer to the default page layout.

The scale of all vertical values is the default typewriter line height ì
(.LH8) ('lines') and of the horizontal values the width of a Courier 12 font ì
character ('columns').

The dot commands also accept inch values (.PL 8.5") or cm values (.PL ì
23.0). To distinguish the line/column scale from cm scale, the latter always ì
requires a decimal point or comma.

On the settings notebook, only the column/inches values can be set, but if you ì
move the mouse over the entry fields, you will activate a bubble help which ì
shows you the value in inches or cm, depending on the scale for bubble help ì
radiobuttons.

Page Template let you restore and save other dot command settings referring ì
the page layout. To define a new value, select one of the "Template" items, ì
edit the combobox and change the dot command values. The last template you ì
have chosen is the template WSformat refers to.

Write default dot commands to FMT file is useful if you want to send a ì
formatted file to another WSformat user. All your dot command default settings ì
are automatically written at the beginning of the formatted file.

The ASCII codepage holds single line and double line images, e.g. single ─ ì
(Alt-196) and double ═ (Alt-205). WSformat does not send the ASCII code of ì
these 'characters' to the printer; instead it generates graphics. The Line ì
drawing settings refers to the width of lines in 1/300 inch pixels. Useful ì
values are from 2 to 10. Instead of a double line, WSformat creates a wide ì
line.

It is permissible to use these characters in situations other than in .LI ì
line drawing tables. The length of these lines in relation to text set in ì
proportional fonts depends on the '.TS' tab stretch value: The length of one ì
line character corresponds to one soft space.

Codepage has two settings. There are two code pages which are very similar, ì
both known as the 'IBM codepage' or the 'OEM codepage.' The difference is in ì
the line drawing characters, which are made up of both small and wide lines. ì
Code page 850 lacks these combined line drawing characters, but instead ì
contains additional accented characters for various languages.

An important consideration in Europe is the addition of Euro-character ╒ which ì
is available only on the 850 Code page. If you have selected code page 437, it ì
will be a line-drawing character instead of the Euro symbol.

.3
Notes page

.ID P_NOTES
WSformat handles endnotes, footnotes and margin notes.


Settings referring to Format function

Width of left margin for margin notes is the default value of the '.MN{}n' ì
dot command, where 'n' represents the maximal length of margin notes in ì
characters.

..Arndt wsfdocu3.ws
When bringing text and notes on a page together (Make - text and footnotes), ì
it is necessary that each footnote link in the text area be indicated with a ì
marker. This marker is the internal character for assigning footnotes and is ì
simply a character which is not used anywhere else in your document. The ì
default value is ^PQ (ASCII value of 17 decimal).

To enter Wordstar Printer chars ^PA...^PZ, type a ^ (circumflex) character ì
and then a capital letter.

There are different ways of showing footnote links. Footnote link text in ì
text area defines how the footnote link is to appear. Acceptable conventions ì
for footnote links are (1), [1], and ^T1^T (superscript). Remember that you ì
can define a superscript font, see chapter fonts.

Footnote link text in footnote area is the counterpart at the beginning of a ì
footnote. Note the use of leading spaces to represent indention.

If you want to insert a Return inside your footnote text, you need a ì
character for RETURN in footnote text which will later be converted to a ì
Return. Normal Returns in footnote text are filtered.


Settings referring to 'Making Text and Footnotes'

Number of empty lines between text area and footnotes defines the distance ì
between the text block and the footnote block of a single page.

The last setting hold number of lines in a paragraph together refers to the ì
Make - Text and footnote task. When creating a text and footnote file (TAF ì
file), WSformat has to generate the Page breaks on its own. If you select a ì
value of 2, WSformat holds the first two and the last two lines of a paragraph ì
together; using a value of 1 deactivates this function. Enabling this function ì
(values 2 or 3) is strongly recommended.

.3
Index page

.ID P_INDEX
The index page stores those settings which refer to the Make - contents ì
and the Make - index function of WSformat.

Concerning content creation

When creating a table of contents (TOC) files, you can select whether or not ì
to write page numbers.

With Highlight main headings enabled, main headings get bold toggles. ì
Anyway, WSformat writes an empty line above a main heading.

Concerning index creation

Highlight weighted page numbers generates bold face page numbers for ì
weighted index entries.

Sortiere... refers to a German 'umlaut' problem.


.2
Insert Dot Commands Window

.ID P_INSERTDOTCOMMANDS
If you don't know Wordstar and Write&Set dot commands by heart, you can use ì
the Insert Dot Commands Window to insert dot commands to your unformatted WS ì
file. You can reach this window via WSformat main menu, item Command.

All dot commands are part of the outline tree. They are sorted to logical ì
subjects.

If you know the name command, but don't remember the usage or syntax, type the ì
two letters of the dot command behind go to command. This let you jump to ì
the corresponding line in the outline tree.

Before pressing the Help button, select a line in the outline tree. Help ì
activates the page of the Online Help where the subject or dot command is ì
explained.

Insert inserts the current dot command to the editor. This only works if a ì
WS file was selected in WSformat and the unformatted editor window is open.

.2
Preview Window

.ID P_PREVIEW
.in Preview
To have access to the preview feature, first format your text. Then press the ì
preview button or select File - Preview. The preview window opens and the ì
yellow LED in the WSformat main window glows.

The title bar of the preview window now displays the current page number and ì
the filename.

When saving the FMT file in the editor, the preview window is updated ì
automatically. Changing settings in the settings notebook will also ì
automatically force a preview update.

In the preview window, use the Pg dn and Pg up keys of your keyboard or ì
the left and right mouse button. The left mouse button shows the next page, ì
the right mouse button the previous page. To go to page 20, for example, hold ì
down the left mouse button and drag the mouse to the right. Until the end of ì
the file is reached, WSformat does not know the page length. On reaching the ì
end, the number of pages is shown in the titlebar: '7 of 17' (pages).

Change the window with and height. The preview scale depends on the window ì
width. If you make the window width large, a vertical scrollbar appears.

If you have a slow computer and a large document, previewing backwards ì
requires some considerable time because WSformat must read the document again ì
from the beginning. (Perhaps that will improve in a later version.)

.2
Print pages dialog

.ID P_PRINTPAGES
.in print pages
To print a document from the first to the last page, select a printer in the ì
main window dropdown box and press the Print button.

To print selected pages of a document, click on File - print pages. This ì
brings up a small dialog window. If you press OK without entering values for ì
the first and last pages, the whole document will be printed.

You are allowed to enter several page numbers in the entry field, separating ì
them by commas or spaces. To print several pages, enter the first and the last ì
page numbers, separating them with a hyphen.

If you want to print from a specific page to the end of the document, select a ì
number for the last page which exceeds the size of the document, e.g. ì
18-999.

Enabling the Exclude pages checkbox means all pages will be printed, but now ì
the pages shown in the entry field are instead omitted.

You can select the Number of copies which you want printed. The document is ì
printed once from the first to the last page, and then the document is printed ì
a second time from the beginning. That means the page order is in collated ì
sequence, such as 1, 2, 3, 1, 2, 3, etc., and not as 1, 1, 2, 2, 3, 3.

Press OK to start printing and Cancel if you decide to terminate the ì
job.

.2
Info and Error Messages

.ID P_ERRORWINDOW
.it Info and Error Messages
The "Info and Error Messages" Window appears, if specific info or error ì
messsages do appear while compiling a job. Formatting simple text without ì
errors won't activate this window. The Preview and the Print function does not ì
use the "Info and Error Messages" Window, but formatting, converting RTF to ì
WS, creating index and "make text and footnotes" does.

An error message appears if e.g. a dot command has been used in a wrong way. ì
In the message, you can see the Paragraph number ("Par") where the bug occurs. ì
The paragraph number counts the Hard Returns, a dot command is also a ì
"Paragraph". WSedit shows the paragraph number in its titlebar.

If you use WSedit, you can doubleclick to the error message and this will run ì
WSedit with the cursor at the paragraph where the error or info messages ì
refers to.

.2
Command line Arguments

.in Command line argument
The current WSformat program allows only one file name to be entered as an ì
argument on the command line. Any additional arguments are ignored. If the ì
filename contains spaces, type 'file name' or "file name". Do not omit the ì
file extension.

I am planning to include support for full format and print control using ì
command line arguments in a later version.

.1
Conversion from WS to RTF and HTML

.in RTF conversion
.in HTML conversion
The RTF file format is a worldwide standard for transferring text data with ì
formatting information from one wordprocessing software to another. E.g. you ì
can import an (unformatted) text from Write&Set to Winword by using the RTF ì
file format. This allows you to import not only simple text: also headings and ì
footnotes are converted.

In the WSformat menu structure, you will find the command Make - RTF text. ì
But WSformat does not has the ability itself for this conversion. This does ì
Hypermake - also a Shareware program written by Martin Vieregg. The Hypermake ì
commandline version is part of the Write&Set package since version 0.95 and ì
gets executed from the WSformat Make - RTF text command. It runs separated ì
from WSformat in a text window (usually white letters on black background).

The HTML file format is the file format of the World Wide Web. These files ì
are viewed with a Web browser like Microsoft Internet Explorer, Netscape, ì
Mozilla or Opera.

Make - HTML also executes Hypermake. Hypermake does not create only one ì
single HTML file. Instead, a folder will be created containing a lot of HTML ì
files, one for each chapter. To view the HTML file with your browser, click to ì
the HTML file which has the same name as your WS file. E.g. if the name of ì
your WS file is MYDOC.WS, the HTML start file is MYDOC.HTML and all the HTML ì
files are located in the folder MYDOC.

If you want to create HTML files from the WS file format, you must use ì
headings, otherwise you will get an error message. Every text has to be part ì
of a chapter, so begin your text with ".1". Sometimes you will have different ì
commands or text, dependent on compiling HTML files or formatting and printing ì
a text. Use conditional statements in this case. When formatting a text with ì
WSformat, the condition "WSformat" is always set.

Behind the command ".TI" on top of your WS file, you can enter a document ì
title which will appear in the browser titlebar.

The user settings of Hypermake are hold in the file HMAKE\wsformat.ini which ì
can be viewed with WSedit. Here, the font letters are defined independent from ì
the Fonts.ini file and a lot of other settings are located here. If you are ì
interested in Hypermake, please download Hypermake from ì
http://www.hypermake.com . Hypermake compiles WS files, but the internal ì
editor of Hypermake reads and writes WS files only if you have got Hypermake ì
4.1 or later.

If you want to convert WS files which are bigger than 20 kB, you need a ì
Hypermake registration key. If you have registered WSformat, you are ì
encouraged use this key for Hypermake, too: Simply insert this key to the line ì
"Registration code = " of the file HMAKE\wsformat.ini. Now you can compile WS ì
files to RTF or HTML format without size limit. But if you want to generate ì
large Winhelp, IBM Help or MS HTML-Help files, you have to buy the specific ì
Hypermake registration key.

Nevertheless, you are allowed to compile the help source files located in the ì
DOCUSRC directory.

.dp#-
.1
Fonts

.ID P_FONTS
.in Fonts
Using fonts with WSformat is very different from Wordstar, but similar to ì
Hypermake. Fonts are selected by using specific dot commands.

In WSformat and Hypermake, fonts are represented by a font letter which is ì
a shortcut for a specific font description. Font letters are case-sensitive, ì
so you can use A to Z and a to z for a total of 52 letters.

.2
Storing font data

.in Fonts.ini
.in Printername.dta
The information about fonts is stored in two files: Fonts.ini and ì
Printername.dta. Both files are located in the directory where WSformat.exe ì
resides.

Fonts.ini is a text file which can be edited with any reliable ASCII editor, ì
with WSedit, or by selecting Settings - Font definition in the WSformat main ì
window.

Printername.dta is a binary file which stores the same information which is ì
held in the Fonts.ini file. It stores additional information about the ì
selected fonts, especially the pixel width of all characters. Because the font ì
metrics slightly differ from printer to printer, every printer installed on ì
your system gets such a file, e.g. 'HP Deskjet 600.dta'. After changing ì
Fonts.ini, the Printername.dta file is updated automatically before processing ì
the next format, preview or print job. When formatting or printing, WSFormat ì
gets the information from this file and not from the operating system. This ì
makes formatting and printing faster.

If formatting problems occur, regulary these binary font data files are ì
involved. In this case, deleting the Printername.dta file forces recalculating ì
all font data and the elimination of the problems.

.2
WSformat default fonts

.in Fonts.ini
.in Font definition
Starting WSformat the first time causes a new Fonts.ini file to be ì
generated. WSformat asks the operating system for the names of registered ì
Times Roman, Helvetica and Courier fonts. Depending on this computer-specific ì
query, WSformat generates a new Fonts.ini file. Please take a look at your ì
Fonts.ini.

On many systems, the following fonts are listed:

.sfM
Font A = Times New Roman 8
Font B = Times New Roman 10
Font C = Times New Roman 12
Font D = Times New Roman 14
Font E = Helvetica 8
Font F = Helvetica 10
Font G = Helvetica 12
Font H = Helvetica 14
Font I = Helvetica 16
Font J = Helvetica 18
Font K = Courier New 8
Font L = Courier New 10
Font M = Courier New 12
.sf

The font letters from A to M are allocated in every WSformat installation. ì
Use these fonts if you want to write a document to be sent to another WSformat ì
user. This font selection covers all normal word processing purposes.

If you miss some fonts, enter your own definitions, using the font letters N ì
to Z and a to z.

.2
Basic font selection in document

.in font selection
.it normal font
For selecting a font in your document, simply use the dot command

.SF (select font),

followed by the font letter. E.g.

.SFC

This selects the font 'Times New Roman 12,' because it is defined in the ì
Fonts.ini file as:

.sfM
Font C = Times New Roman 12
.sf

Typing .SF without a parameter selects the default font which is set in ì
the settings notebook, page format.


Alternate Font

.it alternate font
You can also define an alternate font

.AF (alternate font)

which is printed when a ^PA character appears at the beginning of a paragraph. ì
The syntax is similar to the .SF font:

.AFC  (selects alternate font C)
.AF   (selects default alternate font).

Behind the ^PA printer character, the alternate font rests activated until the ì
paragraphs ends with a Hard Return.

Subscript/Superscript font

It is useful to select a smaller font for subscript (^PV in pairs) and ì
superscript (^PT in pairs) text:

.SSB
select subscript/superscript font selects e.g. font B (Times Roman 10). The ì
default setting is the default font in the settings notebook, page ì
format.

.2
Extended Fonts.ini functionality

.it extended font
If you are more ambitious in your treatment of fonts, you can define manually ì
bold, italic and bold-italic fonts.

The default behaviour of WSformat is that you simply define a font by using ì
.SF. When you then use the ^PB (bold) and ^PY (italic) toggles, you will get ì
the same font in bold or italic styles respectively. You have the option to ì
redefine the bold, italic and bold-italic fonts manually.

When interpreting a 'Font' line in the Fonts.ini file, not only is a single ì
font defined, but the italic, bold and bold-italic fonts along with it:

.sfM
Font C = Times New Roman 12
Font C" = Times New Roman 12 bold
Font C' = Times New Roman 12 italic
Font C& = Times New Roman 12 bold italic
.sf

This default behavior can be turned off selectively by entering:

.sfM
AutoItalicBold = no
.sf

and can be turned on

.sfM
AutoItalicBold = yes
.sf

You can now define the bold, italic and bold-italic fonts by hand, or you can ì
override these settings. Because the Fonts.ini file is interpreted ì
sequentially, it is possible to repeat a font definition without turning off ì
the 'AutoItalicBold' setting.

.sfM
Font C = Times New Roman 12
Font C" = Times New Roman 13 bold
.sf

That means italic and bold-italic of the C type face are defined ì
conventionally, but the bold font is a slightly larger font (13 instead of ì
12).

.2
Extended font selection in document

.ID P_FONTSEXTENDED
The .SF command changes the previously selected fonts for normal, bold, ì
italic and italic-bold styles simultaneously. If you want to change a font ì
attribute selectively, there are specific dot commands which can be used, such ì
as the .SF command:

.SN   (select normal)
.SB   (select bold)
.SY   (select italic)
.SX   (select bold-italic)

.1
Basic text commands

'Basic text commands' refers to the formatting and printing commands - dot ì
commands, printer (^P) characters - which are similar to Wordstar DOS. The ì
next chapter 'Extended text commands' refers to advanced features such as ì
graphics, footnotes or contents which are implemented in a WSformat specific ì
way.

The majority of WSformat text commands are identical to those in Wordstar DOS, ì
but a few are new or different from Wordstar DOS. They are marked with the ì
following sign:


¡ Wordstar DOS user, please note!

Most word processing programs save formatting and printing information in a ì
binary format. Wordstar DOS and WSformat store this information as readable ì
text characters. There are two kinds of these commands:

■áádot commands: A text line beginning with a dot (period), followed by two ì
ááácharacters. Dot commands are not case-sensitive.

■ááprinter chars: Characters with an ASCII value lower than decimal 32. In ì
áááWordstar DOS and WSedit such characters are entered by type Ctrl-P, ì
áááfollowed by a letter.

.2
Syntax of dot commands

.in dot command
.id P_DOTCOMMANDS
A dot command must be typed on a separate line and begin with a dot in the ì
leftmost margin. If the dot is not located at the first column, it will not ì
treated as a dot command and will instead be be printed as text. In most ì
cases, the dot is followed by two characters which are not case-sensitive. ì
Many dot commands require a following argument. For example:

.RM70

sets the right margin to the value 70. You are allowed to enter spaces between ì
'RM' and the number.

In this documentation, I need to print dot commands without having them ì
interpreted. The first character in a line is the bold toggle and the second ì
the dot, thus isolating the latter from the right margin. A line so ì
constructed will thus show the dot in the left margin, as the first character ì
when it is printed, and it won't be interpreted.

In Wordstar, the default horizontal page measurement is characters and the ì
default vertical measurement is lines. Both directions refer to old ì
typewriter conventions. A character is considered to be as wide as a 'Courier ì
12' character - the only font with which most typewriters were provided - and ì
the line measurement is the default (narrow-spaced) line. WSformat assumes ì
1/48' to be the unit of vertical pitch, so .LH8 indicates a line spacing of ì
8/48' or 6 lines per inch).

All dot commands which allow character or line counts to indicate distances ì
will also accept inches and cm values:

.RM 7.0"
.RM 17.8


¡ Note that the use of dot (decimal point) or " makes the difference: If ì
the number contains a dot or a comma, it is treated as a measurement in ì
centimeters or inches. The inch value is marked by the " character.

Comments

.in comments
A very useful dot command is 'dot dot'

..This won't be printed

This allows you easily to enter text which won't be printed in the finished ì
document. In WSedit, these lines are shown on the editing screen in magenta.

.2
Printer command characters

.in Printer character
.in Printer char
.id P_PRINTERCHARS
In WSformat and Wordstar DOS, characters with an ASCII value lower than ì
decimal 32 have got a specific meaning. These characters are not printed, but ì
instead control the formatting and printing of the job.
In both Wordstar DOS and WSedit, you can enter a command to be sent to the ì
printer by typing Ctrl-P (P for 'printer'), followed by a letter from A to Z. ì
In the documentation, these commands are written ^PA... ^PZ.

printer chars not used in pairs

.tb6
^P@áá(Wordstar DOS) Text followed by this character is right-justified ì
áááááwhen printing
^PZáá(WSedit) Text followed by this character is right-justified when ì
áááááprinting
^PKááText followed by this character is centered when printing

^PAááTurn on the alternate font until the next Hard Return
^PGááThe following word is not hyphenated
^POáábinding space: a line will not be divided a binding space

printer chars used in pairs (toggles)

.it printer char bold
.it printer char italic
.it printer char superscript
.it printer char subscript
^PBááselect the bold font
^PSááselect underlined text
^PYááselect the italic font

^PTááSuperscript, e.g. square meter m2
^PVááSubscript, e.g. CO2 will be polluted
.SSA
.cp2


¡ WSedit shows the ^PT 2 ^PT sequence simply as 2 which is part of the IBM ì
Codepage, and ^PT 3 ^PT as 3. You can set the height and depth of the printout ì
with the .SR command (default is .SR3) and the superscript/subscript font ì
with the .SS command (select sub/superscript font), followed by a font ì
letter.

.2
Text formatting commands

.ID P_TEXTFORMATTING
.3
Indentions

Hard and Soft Spaces, indentions

.in indention
.in Soft space
.ID P_INDENTIONS
Wordstar DOS, WSedit and WSformat know two different kinds of Spaces: Soft ì
spaces (in WSedit shown as 'snow characters') and normal 'hard' spaces. Soft ì
spaces represent indentions and tabulations. While formatting, these soft ì
spaces can vanish and then appear on another place.

.tb4
áááThis is a sample showing soft spaces. To indent a line in WSedit, simply ì
áááuse the Tabulation (Tab) key, or press Ctrl-OG.
■ááIt is also possible first to enter text and then to indent by typing the ì
áááTab key, followed by the running text.
.tb10
.if WSformat
áááááááááI have now selected Tabstop 10. This is a sample of the use of soft ì
áááááááááspaces. To indent a line in WSedit, simply use the Tab key, or press ì
áááááááááCtrl-OG.
Note:ááááIt is possible to begin a line with non-indented text (in this case ì
áááááááááthe word 'Note:'), and then to indent text by typing soft spaces.
.end WSformat

To reformat a paragraph in WSedit after changing the '.TB' tab stop position, ì
type Ctrl-B. WSformat interprets the resulting soft spaces, not the '.TB' ì
command.

To select the indention tabulator stops, enter the WSedit and Wordstar ì
command

.TB 4,14,24
which e.g. sets tab stops to the rows 4, 14 and 24. In WSedit, use the tab key ì
several times to go to tabstop row 24. (WSedit does not support other scales ì
than rows in the .TB command.)

¡ The width of soft spaces (snow characters) can be defined with the .TS ì
tab stretch command.

.TS60 (also .DE60 or .DE6)
sets the width of a soft space to 60% of the capital W of the current ì
proportional font. When using a fixed font, this setting has no effect.

.3
Hard and Soft Returns

.it Soft Return
.it Hard Return
There are also two different kinds of Returns: lines can end with either a ì
Soft or a Hard Return. In WSedit, this is shown by color patches in the ì
rightmost column. Soft Returns vanish and appear on another place while ì
formatting. Hard Returns remain fixed at the same place. Soft Returns are ì
generated by the computer; Hard Returns by typing the Enter key on the ì
keyboard.

.3
Turning formatting off and on

.ID P_FORMATTING
.in formatting off
When typing tables, there is always the concern about destroying table ì
formatting, because WSformat might treat the table as running text and reormat ì
it. WSformat attempts to recognize the difference between tables or columns ì
automatically, if more than 4 normal spaces occur, but sometimes this rule ì
fails. In such instances, it is safer to turn off formatting explicitly:

.BD Formatting disabled (also .BA, .AW OFF)
.BE Formatting enabled (also .AW ON)

Typing ^B in the WSedit editor will not have an effect after typing .BD or ì
.BA.

If you type .BD TOTAL at the beginning of a Wordstar document, neither ì
WSformat will do any formatting whatever.

.3
Change the hyphenation algorithm

.in hyphenation
.id P_HYPHENATIONCOMMAND
You have access to the hyphenation algorithm choice within your document like ì
you have on the hyphenation page of your settings notebook. This is useful ì
when editing multilingual documents.

.HY OFF
or
.HY NO
hyphenation off turns hyphenation of words off.

.HY ON
turns hyphenation on again and activates the algorithm which was valid before ì
turning off hyphenation.

.HY GERMAN
turns the internal german hyphenation on, using the checkbox values of the ì
settings notebook.

.HY TEX
turns the external tex hyphenation on, with the tex hyphenation file which was ì
last selected.

.HY Languagename.TEX
turns the external tex hyphenation on and makes the tex file Languagename.tex ì
current

.HY MANUAL
or
.HY HAND
queries all possible hyphenations. A simple YES-NO-CANCEL dialog box is ì
presented to the user for his decision.


.HN3 (Hyphenation number of chars)

let you change the minimum number of not separated characters when hyphenation ì
is active. It can be useful to enlarge this number in headings. You are ì
encouraged to enter a higher value in the HEADINGS.WS headings template file ì
for every heading. Useful values are from 2 up to 5. The higher the value, the ì
less hyphenation will be active.

.HN

switches the minimum number of not separated characters back to the default ì
value, which is set in the settings notebook, page hyphenation.

.3
Line Height, superscript roll

.in Line Height
.ID P_LINEHEIGHT
.in superscript roll
.LH8
line height sets the line height to 8/48 inches. This is the default ì
linespacing of a conventional typewriter. .LH12 means 150% of the default ì
typewriter linespacing. .LH10. is a good choice for Times Roman 12 or ì
Helvetica 12.

In the settings notebook on the format page, you will find the checkbox
all .LH Line Height values refer to default normal font

This has got two effects:
.tb4
■ááall .LH commands gets changed in the FMT file, if you don't use the size of ì
áááthe default font, e.g. '12' for 'Times Roman 12'.
■ááafter selecting a new font with .SF, the line height is recalculated and ì
áááin the FMT file, WSformat generates a new .LH entry behind the .SF ì
ááácommand.

This setting omits that lines with large fonts are overprinted, but old ì
Wordstar DOS user could get confused. The default setting is enabled.


.SR3
superscript/subscript roll defines the height of superscript text (using ^PT ì
in pairs) or the depth of subscript text (^PV in pairs). The default value is ì
3.

.3
Text Width

.in Right Margin
.in Text Width
.ID PARAGRAPHWIDTH
.RM40 (or .BS40)
sets the width of the text block (right margin) to 40 (the measurement is in ì
Courier 12 characters). The WSformat default value is 60 and can be modified ì
in Settings - Settings notebook, page Page. The value does not correspond ì
to the width of the right paper margin; you enter instead the width of your ì
text (text width).

.PO8
page offset defines the left paper margin. This command affects only ì
previewing and printing, but not formatting. The measurement is in Courier 12 ì
characters, the default value is 8.

To enter separate left margins for left pages (with even page numbers) and ì
right pages (with odd page numbers), extend the ".PO Page Offset" command in ì
the following way:

.POL 13 (Page offset left)
.POR 7 (Page offset right)


The width of a default sheet of paper is 83 characters. If your .PO page ì
offset is 8 and the text block width (.RM 'right margin') is 60, then 83 - ì
8 - 60 = 15 characters are left for the right paper margin.

.3
Paragraph orientation

.it Paragraph orientation
.in centered
.ID P_PARAGRAPHORIENTATION
Output centered

To center text, instead of typing ^PK in front of each line you can also use ì
the appropriate dot commands:

.OC ON
.OC OFF

The default value is OFF.

.it Micro justification
Micro justification

You can also select whether text is to be set ragged right or justified:

.BL ON
Block on turns justification on (fixed right margin) using 'micro ì
justification'
.BL OFF
Block off turns justification off (ragged right margin). ('Micro ì
justification' is off.)

If the text is to be right justified (right margin is fixed - .BL ON), ì
WSformat distributes the empty space remaining at the end of the line equally ì
between all words. If the Printername.dta file which holds the character ì
width of all characters and fonts which are used by the document is corrupted, ì
micro justification will fail and the printed result will be unusable. In this ì
case, delete the Printername.dta file; it will be re-created ì
automatically.

By default, paragraphs are printed with fixed left and right margins (FMT ì
formatted files), or with a fixed left and a ragged right margin (WS ì
unformatted files).

The Wordstar commands .UJ and .OJ are also interpreted. However, you won't ì
see justification in the editor. .FL (German 'flatter' = bouncing) and ì
simply .BL (block) without parameters is also interpreted.


¡ Do not format double- and triple-spaced text (Wordstar .OJ ON). Only ì
paragraphs of single-spaced text can be formatted.

.3
Auto indention

.ID P_AUTOINDENTION
.it Auto Indention
.LM and .PM refer to the formatting process of WSformat. If you want to ì
indent your text in a uniform way without reformatting in the editor by using ì
'.TB' and Ctrl-B, you can use these two dot commands:

.LM6
left margin causes the text to begin in column 6; columns 1 through 5 will ì
be occupied by soft spaces.

.PM8
paragraph margin is like the .LM command, but affects only the first line ì
of each paragraph. In this case, the first line will be further indented.

To turn off automatic indention, set the default values .LM0 and .PM0.

.2
Page formatting commands

.ID P_PAGEFORMATTING
.3
New Page

.it New Page
.ID P_NEWPAGE
.PA
forces the following text to the beginning a new page.

.CP10
conditional page keeps the following 10 lines together. If there is ì
insufficient space on the page, a page break will be inserted at the location ì
of the .CP command.

.3
Page margins

.ID P_PAGEMARGINS
The following page margin commands are available. A table showing these dot ì
commands with their default values is available on WSformat Settings - ì
Settings notebook, page page.

.PL page length
.MT margin top
.MB margin bottom
.PO page offset (=left paper margin)
.RM right margin (=text width)

and, to define the separations between header/footer lines and text:

.FM footer margin
.HM header margin.

The european A4 page size is 8.25" x 11.666" and the US Letter standard is ì
8.5" x 11". So .PL66 is the length of a US Letter page, while .PL70 is ì
the length of an european A4 page. See page templates on settings ì
notebook, page Layout.

.3
Header and Footer Lines, Page Numbering

.in Header line
.in Footer line
.ID P_HEADERLINES
To get a header line which repeats on each subsequent page, enter (for ì
example) :

.HE My document, 1st Edition

You can place similar text at the bottom of the page (footer line):

.FO My document, 1st Edition


¡ You may then designate a font by combining the .HE Header and .SF Select ì
Font commands:

.sfE
.HE My document, 1st Edition

or

.HEsfE My document, 1st Edition

which has no effect on the font selection of lines which follow.

To center a header or footer line, use the printer command character ^PK. To ì
justify text right, use the WSedit ^PZ command (equivalent to Wordstar ^P@).

It is possible to define up to five Header or Footer lines:

.cp15
top of page
.H1
.H2
.H3
.H4
.H5 = .HE

(text area)

.F1 = .FO
.F2
.F3
.F4
.F5
end of page

Note that these lines can appear only if the .MT and .MB values (margin ì
top and margin bottom) have been assigned values which are high enough to ì
allocate the necessary space. Use Preview to test whether or not the header ì
and footer lines appear.


¡ You can set the vertical pitch (line spacing) of the header and footer ì
lines, comparable to the .LH dot command.

.HH Header line Height
.FH Footer line Height

The default value of these commands is 8 (= default Typewriter linespacing of ì
6 lines per inch).

Page numbering

By default the page number in the footer line is centered:

.FO ^PK #

# will be replaced by the current page number when the document is printed.

You can change this default setting by entering your own footer and header ì
commands.

.OP
To turn off printing of page numbers, use omit pages. This command let the ì
footer line get void.
.PG (or .PN)
turns printing page numbers on again.

.PC30
page column prints the page number at column 30 and is retained for Wordstar ì
compatibility, but will often produce unpredictable results when proportional ì
fonts are used.

.PN15
page number immediately advances the page counter to the value of 15. This ì
is no good practice, because it may result in the same page number occuring ì
twice in the same document.

.3
Odd and even pages

.it Odd and even pages
.ID P_ODDEVENPAGES
¡ By default, the page number value has no effect to WSformat printing. If you ì
want to write a book, the left page is always even (2, 4, 6), and the right ì
page is odd (1, 3, 5). (If you don't believe it, take any book from your ì
bookcase and make a spot check!)

.LR
Left-right causes WSformat to print all header/footer lines of left (even ì
numbered) pages left-justified and all header/footer lines of right (odd ì
numbered) pages right-justified.

You can treat right and left headers or footers separately:

.HER My Header text on the right side
.HEL My Header text on the left side

This can be also combined with the footers and with several header/footer ì
lines:

.H4R My header text on the right side, line 1
.H5R My header text on the right side, line 2
.F1R My footer text on the right side, line 1
.F2RsfE My footer text on the right side, line 2, Font E

and so on.

To enter separate left margins for the odd and even pages, extend the ".PO ì
Page Offset" command in the following way:

.POL 13 (Page offset left)
.POR 7 (Page offset right)

.3
Paper orientation

.ID P_ORIENTATION
.LA (also '.PR or=l')

.in Paper orientation
.in Landscape
.in Portrait
turns the printer orientation to landscape; the paper width is set larger ì
than the paper height. The default setting is portrait. The dot commands ì
referring to the page format do not change automatically. You have to select ì
the suitable page template on the Layout page of the settings notebook ì
before formatting. The .LA command only refers to printing.

.if os2
WSformat for OS/2 does not support changing the paper orientation. Instead, an ì
error message box appears while printing if the printer is not set to ì
landscape. You have to use the settings notebook of the printer object instead ì
(File - Print Setup - Properties).
.end

.2
Paragraph enumeration

.ID P_PARAGRAPHENUMERATION
.in paragraph enumeration
To locate a text in an unformatted or formatted, both WSedit and WSformat do ì
enumerate paragraphs. Lines with dot commands and empty lines are not part of ì
the enumeration, only "real" paragraphs. In WSedit, the paragraph number is ì
shown in the titlebar ("Par" or german "Abs"). Error messages of WSformat also ì
refer to the "Par" enumeration. If WSformat is running, doubleclicking to a ì
paragraph of WSedit (unformatted) let you go into WSedit (formatted) and the ì
cursor goes to the same paragraph. Because the line and page breaks are not ì
apparent in the unformatted file, page and line enumeration does not exist ì
here. The paragraph enumeration is the only way to locate specific text both ì
in unformatted and formatted files.

But if you copy text into the formatted files, the formatted file contains ì
more paragraphs than the unformatted file: In this case, the paragraph ì
enumeration below the inserted text is no more identical to the paragraph ì
enumeration of the unformatted file. To avoid this, you have to enclose the ì
inserted text with two enumerate paragraph dot commands:

.EP OFF
(here I've copied text into the formatted file which shall not be ì
enumerated)
.EP ON

Normally, paragraph enumeration is turned on.

It can be also useful to use the .EP command together with conditional ì
defines (.if). In this case, text which is only part of the unformatted file ì
has to be marked.

If you generate a table of contents (Make - contents), WSformat does insert ì
.EP commands automatically.

.2
Embedding files

.ID P_EMBEDDINGFILES
.it Embedding files
Embedding files

.FI Filename
File is a very powerful command. The contents of the file Filename are ì
inserted at the position where the .FI command is located. This command is ì
interpreted while formatting but not while printing.

The file extension makes a great difference.

.FI Filename.ws
.FI Filename.fmt

If the file extension is WS, WSformat interprets the file as an unformatted ì
file and while formatting, full dot command interpretation and formatting are ì
used. If the file extension is not WS, the contents of the file are simply ì
copied to the formatted file.

Save and Remember current formatting values

.in save values
.in remember values
When using the .FI embed file command, it can be useful to save and ì
remember current values of dot command settings.

.S:FONTS
.R:FONTS
saves and remembers all current font data (normal, alternate, bold, ì
italic, bold-italic).

.S:LINEHEIGHT
.R:LINEHEIGHT
saves and remembers the current state of the .LH command.

.1
Extended text commands

The extended text commands provide extended word processing facilities; these ì
are implemented in a WSformat specific way. For Wordstar DOS users, the ì
information in this chapter will be completely new.

.2
Embedding graphics

.in Graphic
.in Bitmap
.in GIF
.in JPEG
.ID P_GRAPHICS
A provision for embedding graphics was lacking in Wordstar DOS. In a graphical ì
environment, it is no longer difficult to handle graphics; their support in ì
WSformat is fully compatible with Hypermake syntax.

The graphics commands only support Windows Bitmap (BMP) files. GIF and JPEG ì
support is planned for a future version.

WSformat offers two simple ways of embedding graphics.

To embed a graphic in your document, simply enter

.BM Filename.bmp

The files are searched in all directories which are listed on the Program ì
page of Settings - Settings notebook.

The .BM command is interpreted both while formatting and while printing. ì
While formatting, WSformat calculates the width and height of your graphic. ì
The default behavior of WSformat is that the graphics file is stretched ì
horizontally and vertically until the width matches the text width (depending ì
on the .RM command). The height of the graphic is calculated and WSformat ì
enters empty lines into the FMT file:

.cp13
───────────────────────────────
(running text above the graphic)
.CP7






.BM Filename.bmp
(running text below the graphic)
───────────────────────────────

When previewing or printing, the graphics file is shown.

If you want the width of the graphics width to be different from the text ì
width, you can modify the size of the graphic by entering

.BW 80

bitmap width before typing the .BM command. A value of 80 means that the ì
width is 80% of the text width. The graphic will be printed centered, with a ì
margin of 10% on the left and 10% on the right side. The default value of ì
.BW is 100. This command also influences formatting. The smaller this value, ì
the fewer empty lines WSformat will insert.


Bitmap text

The .BM command is not appropriate if you want to embed a graphic in running ì
text. Instead, use:

.BTX Filename.bmp

X represents a bitmap character, an arbitrary character which will not ì
otherwise appear in the text. This character will be replaced in your text by ì
the bitmap 'filename.' Note that bitmaps can be higher than characters, so you ì
should select one that will not cause overprinting of characters on the line ì
above. Block chars like █ (Alt-219), ▄ (Alt-220), ▀ (Alt-223) are useful ì
bitmap chars (DOS/IBM codepage).

Text Bitmaps are already interpretated while formatting. WSformat treats such ì
bitmaps as characters and calculates the width of the bitmap to let the right ì
margin justified.

The scale of the .BT graphics is 300 bits per inch, which means that a ì
graphics file with a 300 pixel width gets a 1 inch (2,54 cm) width on your ì
printout. You can change this value by entering:

.GS
graphics scale. Place this command above your .BT command.

You are allowed to define up to 20 bitmap chars simultaneously.

To deactivate a character-bitmap definition, enter:

.BTX

without specifying a filename. The actual character will then be printed, ì
rather than the bitmap.

.2
Line drawing

.in line characters
.in line drawing
.ID P_LINEDRAWING
The IBM codepage contains some characters which represent lines instead of ì
letters. You can use combinations of these characters to draw boxes.

WSformat does not send line characters to the printer directly. Instead, it ì
sends bitmap images of the characters to be printed. The main reason for doing ì
this are that line drawing characters must be printed only at the default line ì
height .LH8. To draw an unbroken vertical line, line drawing characters are ì
converted to commands like 'draw a line from coordinate X to coordinate Y.'

You are encouraged to use these line drawing characters in running text ─ e.g. ì
as a dash (Alt-196, narrow lines)
.tb4
═ááor for lists (Alt-205, wide lines).

Characters which represent double lines are shown as wide lines in preview and ì
on printout. You can set the width of the narrow and wide lines in the ì
settings notebook, page Layout.

Block characters █ (Alt-219), ▄ (Alt-220), ▀ (Alt-223) and - only 437 codepage ì
- Alt-221 and Alt-222 are also sent as bitmap graphics. Here as an example is ì
a large exclamation mark

█
▄ which is made by using such block characters (not visible on Winhelp which ì
uses ANSI Codepage).


Creating Boxes

As creating boxes is usually a tedious job, a dot command has been defined to ì
facilitate line drawing. The following example illustrates its use.

.sfM
.cp12
 .LIXY

      X                           X

            Operating systems

      Y                 Y                X            X
            Novell         IBM              Hardware
      Y       Y                          X            X
          DOS   Netware    OS/2
      X                           X
 .LI
.sf

The result will be: (view FMT file or make preview)

.LIXY
.cp12

      X                           X

            Operating systems

      Y                 Y                X            X
             Novell        IBM              Hardware
      Y       Y                          X            X
         DOS    Netware    OS/2
      X                           X
.LI

.afB
In the dot command .LIXYZ, X represents an arbitrary character marking the ì
corners of the box, Y a partition of the box. Z, placed in front of X or Y, ì
generates double lines (wide lines). A combination of single and double lines ì
requires the Codepage 437 selection (Page Layout in the settings ì
notebook).

The Z char in the .LIXYZ command for producing double lines has to be a ì
^P-character like ^PE or ^PR. When using the ^OD toggle in Wordstar DOS, you ì
can make the ^P-characters invisible to check the correct orientation of the ì
box. (In WSedit 0.9, this functionality is missing yet, so after entering a ^P ì
character, the X chars are no more in the same column.)

WSformat supports proportional fonts in line drawings. The .TS tab stretch ì
command is very important in this case. You can specify the width of your ì
boxes with the .TS command. If this produces overlapping columns, enlarge ì
the .TS command value (default is 60).

.WA hori 30
.2
Chapters, headings, table of contents

.in heading
..in contents
.in chapters
.it table of contents
.ID P_HEADINGS
WSedit, WSformat and Hypermake provide easy-to-use support for headings and ì
tables of contents.

.3
Heading commands in your source text

You can arrange your text with heading levels, as you would in a technical ì
document:

first heading
    first sub-heading
    second sub-heading
         first sub-sub-heading
         second sub-sub-heading
    third sub-heading
second heading

In the WSedit/WSformat/Hypermake format, the headings are designated in the ì
following manner:

.sfM
 .1
 first heading

 .2
 first sub-heading

 .2
 second sub-heading

 .3
 first sub sub-heading

 .3
 second sub sub-heading

 .2
 third sub-heading

 .1
 second heading
.sf

On the line immediately following the dot command for the heading level, you ì
enter the heading text. Heading text can be longer than one line, but must not ì
extend beyond a single paragraph: a Hard Return marks the end of the ì
heading.

In your printout, your document is structured like this:

1. first heading
     1.1 first sub heading
     1.2 second sub heading
          1.2.1 first sub sub heading
          1.2.2 second sub sub heading
     1.3 third sub heading
2. second heading

WSformat handles up to 9 heading levels, but Hypermake is limited to only 6 ì
heading levels. WSformat also supports other conventions for enumerations ì
(letters, roman numerals, as well as others).

.3
Headings and WSedit

WSedit provides support for headings and tables of contents, expressed in ì
WSformat / Hypermake syntax.

First, headings are highlighted in green, if the heading checkbox is checked ì
on the Highlt page of the WSedit settings notebook (press ^OO).

Second, to help navigating in your unformatted text, WSedit has a contents ì
window. ^OC opens the contents window. ^OI also opens the contents window and ì
then jumps to the chapter where the text cursor is currently located.

.3
Formatting a text with headings

.ID P_HEADINGFORMATTING
When formatting a source text which contains heading commands, these commands ì
are converted to commands for font selection, line spacing and page breaks. ì
Previewing and printing the file will display headings in their final correct ì
form.

The way these dot commands are to be converted to other commands is defined in ì
the headings template file. This file can be viewed by selecting settings - ì
headings template in the WSformat main window. This shows the file ì
HEADINGS.WS which is located in the directory where WSformat.exe resides. The ì
file is self-explanatory. Instead of the word 'heading,' WSformat subsitutes ì
the heading text you have specified.

You are at liberty to modify this file. If you want to use other heading ì
files, first make a copy of HEADINGS.WS and then modify the copy. Simply place ì
your HEADINGS.WS file in the directory where your document files are located, ì
or substitute another filename, e.g. MYHEADING.WS, and then include the dot ì
command

.HF MyHeading.ws

heading file before entering the first .1 command.

.CN 3.2.5
sets the current content numbering. You have to enter decimal notation here. ì
Use e.g. .CN5 at the beginning if you have got a separate document ì
containing chapter 5 and 6. The equivalent Wordstar command .P# is also ì
interpreted.

.3
Non-decimal classification

Some people prefer other ways of enumerating headings. Today, although decimal ì
classification is a standard, WSformat also supports other forms of ì
enumerations:

1.1 Decimal classification without last dot
1.1. Decimal classification with last dot

I. Roman nnumerals (up to 38 = XXXVIII)
A. Capital letters
1. Customary (arabic) numerals
a. lowercase letters
aa. double lowercase letters
[alpha character]. Ancient greek characters (bu only those in codepage 437, ì
Alpha = Alt-224, etc.)

Instead of typing a dot behind the character, a right parenthesis ')'--is also ì
possible, thus: 1)

In the headings template file, you can define any or all of these styles of ì
enumeration.

.3
Writing out a table of contents file from your formatted file

.ID P_CONTENTS
After finishing your FMT formatted file and fixing all page breaks, WSformat ì
helps you prepare a properly numbered table of contents.

In the unformatted file enter, for example, something like:

.sfM
 .PA
 Contents of this document

 .ci7
 .. (later, place the table of contents file here)
 .PA
 .PA
.sf

There are two aspects to consider:

.in Contents Indention
.CI
contents indention sets the tab stop while formatting the table of contents ì
file, comparable to the Wordstar/WSedit .TB command. The value has to be the ì
maximum number of characters of your deepest heading enumeration plus 2. ì
E. g. if you have selected decimal classification and use headings up to level ì
3, the width of the heading enumeration does not exceed 5:

.sfM
123456789
1.1.1 TextTextText
.sf

In this case, a .CI value of 7 or more fits your purpose.

The other aspect to consider is how many pages the table of contents will ì
occupy. Because the table is printed before the running text begins, the ì
length of the table influences the page numbering of your document. You will ì
therefore have to estimate the length of the table (in pages) and then enter ì
several .PA page break commands, so the first page of your running text ì
will get the final page number after inserting the contents. If your first ì
trial fails, edit the FMT file and enlarge or reduce the number of .PA ì
commands. Please remember that you have to enter at least one empty line ì
between two .PA commands.

After inserting the .CI command and .PA page breaks as described above, do ì
the following to embed a table of contents file in your formatted file:

■ááSelect Make - Content in the WSformat main window. The extension of the ì
ááácontents file is TOC.
■ááNow open the formatted file which has remained unchanged while executing ì
áááMake - Content.
■ááRemember the page number of the first page of your running text.
■ááDelete the .PA commands you have inserted previously.
■ááCopy the contents of the TOC file to the location you previously ì
áááallocated.
■ááLocate the first page of your running text again and see what page number ì
áááWSformat has assigned to it. If the number has changed, leave the formatted ì
áááfile without saving any changes, re-open it, delete or insert a .PA ì
ááácommand, and repeat the procedure.

From a technical point of view, the Make - Content function operates ì
independently of the headings function, explained above. It does only ì
interpret formatted files which no longer contain any heading commands. So you ì
can also use Make - Content if you have entered your headings manually. ì
WSformat takes a careful look to the beginning of each paragraph of your ì
formatted file and decides whether or not to copy this file into the table of ì
contents file. If there is any uncertainty, the line is nevertheless copied to ì
the table of contents file. It is always advisable to take a close look at the ì
table of contents file and delete any lines which are not headings.

The criteria are: after reading spaces and printer characters at the beginning ì
of a paragraph, the first acceptable characters have to be
■ááone or two normal (arabic) digits or latin numberals up to XXXVIII, ì
áááfollowed by a dot or a close-parenthesis ')'
■ááone or two upper- or lower-case letters, followed by a close-parenthesis ì
ááá')'
■ááa single captial letter, followed by a dot.

.tb30
Unrecognized ááááááááááááááááRecognized
123. áááááááááááááááááááááááá12.
345) áááááááááááááááááááááááá34)
7  áááááááááááááááááááááááááá7.
IL. áááááááááááááááááááááááááXXXVIII.
IV  áááááááááááááááááááááááááIV)
B   áááááááááááááááááááááááááB.
ab. áááááááááááááááááááááááááab)
aac) ááááááááááááááááááááááááac)
.tb4

Because a TAF file (text and footnotes) will usually contain many paragraphs ì
beginning with a number followed by ')' - the footnote paragraphs - all ì
lines in TAF files with a number and ')' are not copied to the Table of ì
Contents file.

In the settings notebook, page index, you can specify whether to write ì
page numbers or not, and whether or not to highlight main headings in ì
boldface. In any case, an empty line is inserted before writing a main ì
heading. The first heading type which occurs in the formatted file will be ì
considered the 'main heading.' This can differ from the .1 command in the ì
unformatted file.

.WA hori 30
.2
Footnotes, End Notes, Margin Notes

.in footnote
.in end note
.in margin note
.ID P_NOTESGENERAL
WSformat supports footnotes in an easy and uncomplicated way.

If you prepare a file using Wordstar DOS 5-7, load such a file with footnotes ì
or end notes into WSedit, and then save the file, these notes are converted to ì
WSformat and Hypermake format.

Because WSedit and WSformat does not support multi-column text, there is a ì
special implementation for creating margin notes. Margin notes are very ì
short text (e.g. 3 or 5 characters long) which appear in the left margin ì
area.

.3
Writing footnotes or end notes in your unformatted file

.in Footnote
.it footnote character
Generating Footnotes or end notes with Hypermake is very simple. For example, ì
footnote text can be quoted in brackets like [This will be the content of the ì
footnote] after entering the dot command footnote usage:

.sfM
 .FU[]
.sf

Other useful footnote bracket pairs are { }, < > or ▄ (Alt-220) ▀ (Alt-223).

In WSedit, you can highlight these specific characters (^OO settings notebook, ì
hightlt page, entryfield spec. chars).

You can add a font selection to the footnote dot command:

.sfM
 .FU[]sfB
.sf

This will select font B for your footnotes or end notes.

To select a line height for your footnotes or end notes, add LH followed by ì
your preferred value:

.sfM
 .FU[]sfXlh7
.sf

The order of SF and LH makes no difference.

While formatting, WSformat creates

■ an FMT file where the notes text has disappeared and instead a footnote link ì
appears
■ an FUN file (.FU Notes file) which contains the text for all notes.

You can modify the appearance of your footnote links in the settings ì
notebook, page notes.

.3
Handling end notes

To embed the .FU notes file at the end of your document, you can manually ì
copy the FUN file to the end of the FMT file, or you leave this job to ì
WSformat:

.FI *.FUN

Place this command exactly as it appears above (type the '*' sign, not the ì
filename) at the end of your unformatted file. This will cause the ì
contents of the FUN file to appear in the FMT file. You cannot enter ì
additional notes text in your running text after typing this .FI command.

.3
Getting real footnotes

Up to yet, you have only a separate file containing the text of your ì
footnotes.

Make - Text and Footnote merges an FMT (formatted text) with an FUN file ì
(notes text) file. The result is a TAF file which combines Text and ì
Footnotes.

When merging text and footnotes together, WSformat has to make page breaks by ì
itself. There is no way anymore to optimize the page break by hand in the ì
formatted file.

In the notes page of the settings notebook, you can define that e.g. the 2 ì
first and the 2 last lines of a paragraph are always hold together. This omits ì
a result where the first or the last line of a paragraphs rests alone on a ì
page.

However, this function is not adequate to produce proper page breaks. You ì
frequently have to use the .PA page break and especially .CP ì
conditional page break. All tables, enumerations and so on have to be ì
prefixed by .CP commands to omit page breaks. The more .CP commands you ì
use in your unformatted file, the fewer formatting runs you need to produce a ì
satisfactory final TAF file.

WSformat inserts the page breaks in the TAF file one line ahead of where they ì
are necessary. You are therefore both permitted and encouraged to make minor ì
changes in your TAF file by moving the last line on a page of your running ì
text (Wordstar DOS and WSedit ^Y and ^U) to the beginning of the next page, or ì
to do the converse.

.3
Margin Notes

Margin notes are short notes which occur in the indented left margin of the ì
formatted file. When insertion of margin notes is activated, all formatted ì
text will be indented. The usage is similar to the footnote / end note command ì
of WSformat.

Instead of .FU, you enter .MN margin notes (or .BV German ì
"Blattverweise").

.MN<>3
Here is an example of a margin note, as it would occur in the indented left ì
margin of your text. To insert such a note, you would mark<007> this line.

To see what the result would be, take a look at the FMT file!

.MN<>3
This is a sample for a margin note. Margin notes occur in the left indention ì
area of your text. Now I mark<007> this line.
.MN

The characters < and > bracket the text of a margin note. '5' sets the ì
maximum length of margin notes (in number of characters) to 3. That means ì
that the space allocated for the margin is sufficient to accommodate when ì
printing margin notes with a length of 3 characters: the first character of ì
the paragraph appears in column 5, and the number of soft spaces which are ì
inserted is 4.

In the settings notebook, page Notes you can set a default value for the ì
length of margin notes. A numeric value in the .MN command overrides this ì
default value.

When using margin notes, the text width is increased, while the right margin ì
gets less.

If you want to specify a font attribute (bold, italic) for your margin notes, ì
you can extend the .MN command by entering ^P, followed by the appropriate ì
Printer command character:

.MN<>3^Y^Y
sets the margin notes' font attribute to italic.

.MN
without parameters turns off the margin notes function.

Margin notes and error messages

It is not possible to print two margin notes on one line. Another limitation ì
is that the length of the margin notes may not exceed the numeric value ì
entered in the .MN command, because the space in the margin would be ì
insufficient to accommodate it.

.WA verti 25
.2
Index

.in Index
.ID P_INDEXGENERAL
.3
Introduction

Both WSformat and Hypermake can prepare indexes; the commands in the source ì
text are nearly identical. However, the results differ. WSformat creates a ì
file INDEX_1.WS where the format of the index is the following:

Computer Networks 27

Workgroup
-, administration 53
-, computing 57

The INDEX_1.WS shows the index entries in alphabetic order.

To generate an index, mark the index entries in the unformatted WS file by ì
using dot commands and special characters. Then format the text. After the ì
page breaks of the FMT file are adjusted, the last task is to select the menu ì
item Make - Index. WSformat reads the FMT file, writes all index entries ì
into the temporary Wordstar file Projectname.IX1, merges the information of ì
all *.IX1 files (even of different WS projects, see Volumes) together and ì
writes a file INDEX_1.WS, which contains the generated index. You can then ì
copy this file by hand into your FMT file. (You may then delete the *.IX1 ì
files; they are not deleted by WSformat.)

There are some special features beyond those available in Hypermake:

■ emphasised index entries, where the page numbers appear in bold face
■ several indexes INDEX_2.WS, INDEX_3.WS, for example, one only for locations, ì
another only for persons.
■ one index for several WS project files which represent different volumes.

The index commands in your source text are identical to the Hypermake syntax. ì
The .IN and .IT commands in this document refer to this function, but it ì
is also possible to mark words or expressions in running text (not used in ì
this document).

Hypermake knows only one index and does not support emphasized entries. ì
Instead, it creates links from all other occurrences of the expression to the ì
marked occurrence.

.3
Index char, Marking a single word

Enabling index function; selecting the Index Character

In the WS file, the dot command

.IC#  (.ST#)

index character let you specify an index character. # represents an ì
arbitrary character which is not otherwise used in your text. This setting is ì
valid up to the end of your document.

.it index character
Marking a single word

You can mark a single word for indexing with the index char.

.sfM
A #workgroup is a group of people...
.sf

The index char is visible both in the WS and the FMT file, but is neither ì
printed nor shown in the Preview window.

.3
Marking a phrase of several words

When using the index char, only one word will be marked. A word ends with the ì
first character which is not a letter or '-'.

To mark a phrase, you have to use colons ':' as brackets:

.sfM
Today, the #:security of computers: is...
 ...
Nevertheless, the #:security of mainframes: can be...
 ...
But the #:usability of computers; has to...
.sf

In the index, it will appear as:

.sfM
computers, usability of 37
security
-, of computers 37
-, of mainframes 37
.sf

.in leading word
Note the difference between the first and second examples and the third: A ì
`#:XXXX:' with a colon at the end will use the first word of the phrase as the ì
leading word; a `#:XXXX;' with a semicolon after the last word. The leading ì
word is the word which determines the alphabetic order in the index.
You can use the `colon brackets' to crop endings:

.sfM
The importance of #:computer:s is growing...
.sf

In the index `computer' will appear without the `s'.

.3
Marking outside the running text

.ID P_linkingdotc
With the dot command INdex

.in security of computers

you can place a word or a phrase in the index. Because it is a dot command, ì
`phrase' will not be printed. You can use this command when the phrase you ì
want to place in the index does not appear explicitly in the running text.

For Wordstar compatibility, .IX with all specific Wordstar syntax is also ì
supported.

.in index turned
Normally, the first word of the phrase will be the leading word. If you want ì
instead to make the last word the leading word, such as using the brackets ì
colon-semicolon in running text, you can use the dot command index turned.

.it usability of computers

has the same effect as

.in computers usability of

Because Hypermake treats these two lines different, it is useful to use the ì
.in index turned notation in WSformat, and it is more legible in the WS ì
file.

.3
Emphasized Index entries

`Emphasized index entries' receive a bold-case page number in the index. To ì
emphasize an index entry, type the index char twice

.sfM
A ##workgroup is a group of people...
Today, the ##:security of computers: is...
.sf

or use the dot commands .IN or .IT in upper-case letters:

.IT usability of computers

instead of

.it usability of computers

.3
Several Indexes

WSformat supports more than one index; Hypermake does not.

To produce several indexes, you must use the .IC command several times, e. ì
g.:

.IC# (default index)
.IC& (location index)
.IC% (person index)

(But Hypermake allows only one index. In Hypermake, you can change the index ì
character when using .IC a second time.)

You can now use three index characters in the running text. It is possible to ì
mark an expression for several indexes:

.sfM
A #&%workgroup is a group of people...
.sf

You also have access to the additional indexes by using the dot commands:

.IN& New York
.IN#&% Workgroup

.IN with no index character refers to the first index.

When using Make - Index, the indexes are written to the files INDEX_1.WS, ì
INDEX_2.WS, INDEX_3.WS.


.3
Managing Project Volumes

.in Volumes
While running Make - Index, the current FMT file is read and information ì
about index entries is stored in the Wordstar file Projectname.IX1. You can ì
produce one or more such volumes. The only thing required is to write a number ì
between the name of the file and the file extension ".WS":

.sfM
MyProject1.WS
MyProject2.WS
MyProject3.WS
.sf

and then to run Make - Index on all these projects. Because the temporary ì
file MyProject1.IX1 remains available when running Make - Index on ì
MyProject2, you get several *.IX1 files. The merging function always ì
refers to all *.IX1 files and merges all Projects (Volumes) together. To ì
distinguish Page 30 of MyProject1 from Page 30 of MyProject2, the page ì
numbers are also shown as roman numerals for the different volumes:

security
-, of computers I-30
-, of mainframes II-30

WSformat can generate roman numerals up to 38.

.2
Conditional statements

.in if condition
.in conditional statement
.ID P_IFCONDITION
With conditional statements, you can create slightly different variations of ì
the FMT files, derived from the same source text. If you insert these commands ì
in the FMT file manually, these commands will not be interpreted during ì
previewing and printing, because only the format function recognizes these ì
commands.

There are three dot commands:

.sfM
 .IF CONDITION
 .ELSE
 .END
.sf

The condition statements are not case-sensitive. Note that The ELSE command ì
need not be included.

This means text between these commands is interpreted only if the condition is ì
set (is true). They are set in the WSformat main window, if entry field. You ì
may enter more than one condition, which must be separated by spaces.

The condition WSFORMAT is always set. Use this condition to distinguish text ì
designated for Hypermake or for WSformat. The OS/2 version of WSformat also ì
sets the condition OS2.

WSformat also supports the following expressions:

.sfM
 .IF NOT COND
 .IF COND1 AND COND2
 .IF COND1 OR COND2
.sf

I regret that more sophisticated if-conditions grouped with parentheses are ì
not supported.

The Wordstar command .EI end if can be used instead of the .END ì
command.

.1
FAQ

.in FAQ
I will place questions I get from you here.

.WA verti 25
.1
About

.in WSformat
.ID P_ABOUT
.2
Registration

.ID P_REGISTRATION
.in Registration
.in price
.in fee
WSformat is Shareware, but this refers only to the formatting function. If ì
you format documents often, you are asked to register. You are allowed to send ì
WSformat to friends or to a publishing house for printing your formatted ì
document. The registration key rests on your computer. WSedit is Freeware.

The normal registration fee is 120 Dollar or 100 EUR. The student ì
registration fee is only 30$ or 25 EUR.

The key is valid for all 1.X versions and for all supported operating ì
systems.

When ordering more than one licenses, you will get a 40% discount for every ì
additional license (non-student licenses).

.URL http://www.bmtmicro.com
.in BMT Micro
.LOCAL
You can register this software via BMT Micro. If you want to get the student ì
price, please send a copy of your Student ID to BMT Micro. Please visit
http://www.writeandset.com/english/register.html
to get a BMT Micro order form.

If you contact BMT Micro, I will get informed by E-Mail. Then I send you the ì
registration key. This process takes 1-2 days.

If you have got a bank account in an Euro country, you can transfer the money ì
to my bank account in Germany Dresdner Bank Ottobrunn, german bank code 700 ì
800 00, account Nr. 075 64 62 400. In this case send me your Student ID via ì
postal mail or fia FAX to Germany (I'll send you my FAX number via E-Mail.)

.2
Disclaimer

WSformat is provided as is and comes with no warranty of any kind, either ì
expressed or implied. In no event will the author be liable for any damages ì
resulting from the use of this software.

.2
Author

.bw 20
.bm center
.bm Martin.bmp

.in Author
Dr. Martin Vieregg, 37. I've studied economics. My main job is working in my ì
own consulting company. Our special subject is public transport, especially ì
railways and airports. The title of my doctoral (PhD) thesis was 'increasing ì
efficiency of railway long-distance passenger traffic'.

.in Contacting the author
.in E-Mail
E-Mail address: [e-mail]

Homepage of my Freeware- and Shareware programs:

http://www.hypermake.com


Postal Address:

Dr. Martin Vieregg
Emdenstr. 11
D-81735 Munich
(Germany)


.2
Versions and future plans

.in program versions
WSformat 0.81

The first published version of WSformat. 0.8X are alpha versions.

If you have bug reports and ideas for new functionality, please E-Mail me!

WSformat 0.82

is only a bugfix of 0.81.

WSformat 0.83

contains the index functionality. The index is also described in the docu ì
(chapter extended text formatting). A handful minor bugfixes.

WSformat 0.84

has got a "format info and error message window" where error and info messages ì
appear concerning formatting: E.g. an error message occurs here if a dot ì
command is used in a wrong way.
Then 0.84 fixes some redraw problems of the preview window.

WSformat 0.85

points the focus to communication between WSformat and WSedit. The archive ì
file also contains a new WSedit program.

The new functions concerning both programs are:
-ááDoubleclick to a message in the error message window opens WSedit with the ì
ááácursor in the paragraph refering to the error message
-ááRunning "format" automatically saves the WS file, running "preview" or ì
ááá"print" automatically saves the formatted file (see settings notebook, ì
ááápage Program, checkbox auto save).

The .FM formatting on/off command has been replaced by .BD .BE (enable/disable ì
formatting) because .FM is already allocated by "foot margin".

WSformat 0.92, 0.93

the first beta version, a lot of bugs fixed. Bubble help file dothelpe.txt ì
explains the WSformat commands in the WSedit editor window.

WSformat 0.94

A really important bugfix, dozens of smaller bugs now fixed. New Name ì
"Write&Set" for WSedit+WSformat. A "insert dot command" window (click to the ì
"command" menu item in WSformat main menu) is programmed new and let you ì
insert dot commands per mouse click.

Future versions

There are a lot of things to to in the next month.

Jobs I plan for the next time:

■áátranslating WSformat to german (WSedit is already translated)
■ááfaster preview on big documents when browsing a document back
■áámore graphics file formats (GIF and JPG)
■áámulti-colum support for preview and printing
■áájump from Preview back to FMT or WS file and search the same location

Perhaps I will publish a smaller Freeware EXE version with print functionality ì
only (WSview).

After publishing Write&Set 1.0, I want to publish a Linux version and to ì
translate Write&Set into German. To translate Write&Set to other languages, I ì
need help from native speakers. Please contact me if you are interested in ì
such an effort - you will receive a donation for your work.

Last but not least, I'm thinking about a substitute format for the WS file ì
format. Hypermake already interpretes ANSI text with dot commands, and for ì
WSedit and WSformat I plan this, too. But the concrete format definition has ì
to be considered very well. Perhaps I only implement this option for ì
unformatted files, and not for formatted files.

.2
History

.in History
In the late 80's, I published a Worstar DOS extension program 'StarExtender' ì
in german language which had hyphenation, footnote, Line drawing, index and ì
proportional printing support. WSformat is based on this program which is ì
very-well tested for a lot of years. This is the reason that the basic format ì
functionality works very well even WSformat is beta state software. Because ì
the formatting and printing kernel is optimized for old computers from the ì
80's, today WSformat is extremely fast.

.2
Bug report

.in bugs
Fixed Bugs

0.81.01: (Win95-98-ME) Registering printer fonts fails, program hangs
0.81.02: (all) WSformat.dta user settings were not written

0.82.01: malfunction using .PM and .LM
0.82.02: malfunction when creating Fonts.ini if a large number of fonts is ì
installed

0.83 fixes also a handful other minor bugs, not worth to mention.

0.84.01: redraw problems of the preview window

0.85.01: Preview in Landscape format was not programmed yet
0.85.02: running WSedit from WSformat with long filenames containing spaces ì
did not work
0.85.03: Underlining several words in running text was not continous

0.92, 0.93: smaller bugfixes

0.94.01: several Preview window redraw problems fixed
0.94.02: Fonts names with " characters, e.g. .SFA" did not work
0.94.03: wrong page break when using comment lines
0.94.04: WSformat crashes while closing when the "registering fonts" window ì
was active

0.94 and 0.95 fixes also a lot of smaller bugs, not worth all to mention. In ì
0.94, communication between WSformat, WSedit and reverse was buggy, especially ì
in the Windows version. So features which were already programmed have not ì
worked.

Known Bugs, not fixed yet

none yet

.2
Download Location

http://www.WriteAndSet.com

Filenames:
OS/2-eCS version: wset-os2.zip
Win95/98/ME/NT/Win2000/XP version: wset-win.zip

Archive file names with version number (e.g. wset100.zip) are usually the ì
Windows version.

.2
Trademarks

IBM and OS/2 is a registered trademark of International Business Machines ì
Corp.
WordStar is a trademark of The Learning Company.
Windows is a trademark of Microsoft.

.2
Other progs

Other programs I have written, both Windows 95/98/ME/NT/2000/XP and OS/2 ì
(Linux versions for some programs are planned)

.in Hypermake
Hypermake:
A Hypertext compiler which creates HTML files, Winhelp MS HTML-Help and OS/2 ì
Help from WSformat source files. The WSformat help file is created from this ì
docu by Hypermake. Automatic linking, window arrangement, helptables, ì
footnotes, tables and other features. Shareware if source file > 20 kB.

.in WSedit
WSedit:
Wordstar (DOS)-compatible editor: Reading and writing Wordstar (DOS) files, ì
ASCII IBM and ISO codepage. Supports Wordstar Ctrl key commands and CUA ì
commands. Syntax-highlightning, Translation, spell checking, function key ì
macro recorder and a lot of other features. WSedit handles very large ASCII ì
files. Freeware.

pmCalc: a "pocket" calculator automatic clipboard functionality, programmers ì
and scientific functions, Regression. There's a separate input and output ì
field, the formula you type rests in the input field. (Shareware)

TinyAlarm:
A simple countdown with a slider from 1 to 60, an alarm by entering alarm time ì
and a chime. System shutdown. Freeware.

cd-shortcut:
instead of whole directory names you enter only substrings. Searching through ì
several drives and opening OS/2 WPS folders. Freeware.

Simple Zipshell:
Packing and unpacking ZIP files by using the graphical desktop. Freeware.

Clear:
(only OS/2) Uses also Info-Zip and let you backup your data e.g. on floppies. ì
You can enter filenames like *.BAK which are not copied, directories which are ì
skipped. Then you can enter filenames with a specific age which are deleted. ì
Freeware.

For more information, screenshots and downloads, visit my Homepage

http://www.hypermake.com

end of document