Contents
 Multi-Doc On-Line Help (Demo version)

About Multi-Doc

What is Multi-Doc

What is in Multi-Doc

How to Order

Product Overview

Steps to Using Multi-Doc

What is an Authoring Tool?

Choosing an Authoring Tool

What is an On-Line Help File?

Working with Help Files

Working with Rules & Styles

RTF & Multi-Doc

Converting Graphics

Usage Guide

Using MS Word and WordGen

Using WordPerfect and WPGen

Using an ASCII Text Editor and TxtGen

Using an Xbase Database Manager and DbfGen

Using Paradox and PdxGen

Converting from Windows Help to Expert Help

Converting from Expert Help to Windows Help

Converting from Windows Help to MS Word

Converting from Windows Help to WordPerfect

Converting from Windows Help to ASCII

Converting from Expert Help to MS Word

Converting from Expert Help to WordPerfect

Converting from Expert Help to ASCII

Reference

Style and Format Rule Reference


What is Multi-Doc
What is Multi-Doc?

*Databases can be converted from, but not to.


What is in Multi-Doc
What is in Multi-Doc?

Multi-Doc is a collection of individual programs, the Multi-Doc Tools, including:

Generator Tools for Creating Help Files from a Single Source

Conversion Tools for Converting From Windows Help Files

Conversion Tools for Converting From Expert Help Files

The Multi-Doc Tools can be run from DOS or from the following Windows icons:


Steps to Using Multi-Doc

1) Create an authoring document

Use MS Word, WordPerfect, or any word processing software or text editor which can produce ASCII text files.  Format the document with Multi-Doc styles .

...or create an authoring database

Use an Xbase database manager such as MS FoxPro, Borland dBase IV or CA Clipper, or use Borland Paradox.  Create the database with Multi-Doc's database structures.

Note: If you wish to convert an existing help file, skip this step.

2) Start one of the Multi-Doc Generator or Conversion Tools.

Multi-Doc tools can be loaded from DOS or Windows.  The previous topic, What is in Multi-Doc, explains which tool to use for each authoring tool, help file or document.

To run a Multi-Doc tool from Windows, select:

 the tool's icon from the Multi-Doc Program Group.

To run a Multi-Doc tool from DOS type:

MDCC [Enter]


What is an Authoring Tool?

An authoring tool is a software product used to create documents such as user manuals and technical specifications.  Authoring tools supported by Multi-Doc are word processors, ASCII text editors and database management systems.

Word Processor

A word processor is a software product for writing.  This manual was authored witha word processor called MS Word for Windows.  You can use MS Word or WordPerfect to create and maintain Multi-Doc author files, or any other word processor that can create ASCII text files.

Text Editor

A text editor is a type of word processor dedicated to working with ASCII text files.  ASCII text files are especially important to software developers -- people who write computer programs.  This is because most programs are produced by first creating ASCII text files containing computer language source code.  Many of the Multi-Doc examples were created using either the Multi-Edit or Brief text editors.

Database Management System

A database management system is an automated way to manage data, or organized information.  Multi-Doc currently supports Xbase and Paradox databases.  Xbase is a name given to dBase and dBase related products including dBase III, dBase IV, Clipper and FoxPro.

See Also

Choosing an Authoring Tool

Using MS Word and WordGen

Using WordPerfect and WPGen

Using an Xbase Database Manager and DbfGen

Using Paradox and PdxGen


Choosing an Authoring Tool

The choice of an authoring tool is a personal one which reflects the way one wishes to work.  The decision may depend on the type of documentation being produced.  For example, a user guide book might be better suited for a word processor, where one can freely edit lots of text.  A technical reference manual might be better suited for a database manager, since it contains extremely categorized information.

Flexibility

Multi-Doc does not require that you choose a particular authoring tool in order to produce a specific type of document.  For example, you can use a database manager to produce an on-line story book or a word processor to create a help file for a supply catalogue.  It would be better, though, to use a word processor to create the story book and the database to create the supply catalogue.

Multi-Doc for End-Users and Developers

End-users of software as well as software developers may wish to create on-line help files.  Frequently, people using a software program with a fixed help system wish they could create additional on-line notes to themselves.  It's common to see small paper notes glued around computer screens containing these notes.  With Multi-Doc and a standard word processing program, users can build a quick, pop-up help file to replace the paper.

See Also

What is an Authoring Tool?

Using MS Word and WordGen

Using WordPerfect and WPGen

Using an Xbase Database Manager and DbfGen

Using Paradox and PdxGen


What is an On-Line Help File?

An on-line help file is a document, such as a software manual, which can be viewed on a computer display, as opposed to printed on paper.

Help files are accessed by on-line help systems which read help files and display their contents.

The most popular help file systems today are hypertext help systems.  These allow for instant access of help topics by means of highlighted keywords called jumps.  For example, mouse clicking on the names of the help systems below will display a pop-up window containing the definition of each on-line help system or method Multi-Doc supports.

In addition, on-line help systems allow for context sensitive help.  You can press the [F1] key or other designated help key and get help for a current activity within an application program.

Select one of the following text items for more information:

Microsoft Windows Help

Expert Help

ASCII Text Manuals


Microsoft Windows Help
Microsoft Windows Help (WinHelp)

Microsoft Windows Help, often abbreviated as WinHelp, is used my the Microsoft Windows operating environment.  WinHelp is universally used by Windows applications to provide on-line help.  It allows for graphics and graphical controls as well as text.  It provides the most flexibility of any PC/compatible based help system.


Expert Help/Norton Guides

Expert Help, by SofSolutions, and Norton Guides are DOS based hypertext help systems.  Both products work similarly.  Expert Help, however is more friendly and powerful than the earlier Norton Guides, and works with help guides created using either product.  Expert Help can be loaded as a TSR - Terminate But Stay Resident Program, or it can be loaded in conventional memory.  As a TSR, it provides instant pop-up help in conjunction with any DOS application.


ASCII Text Manuals

Many manuals are simply stored on disk as an ASCII text file.  An ASCII text file is directly readable in DOS or Windows via any word processor or text editor.  Because ASCII text is universal, many software authors provide ASCII manuals as well as on-line help files.  In addition, on-line help files can only be printed out one topic at a time, but an ASCII manual can be printed in its entirety.


Jumps

A jump in a help file is a word, phrase or graphic which, when selected with a mouse click or key press, moves you to another place in the help file.  The place you are moved to, or destination of the jump, is a help topic .


Topics

The term topic refers to a text object in your help file.  Examples of topics are:

•  Sections of a document

•  Chapters of a document

•  Passages of text within a chapter

•  One or more paragraphs of text within a passage

•  Graphics or line drawing illustrations

•  Charts and figures

•  Cross References (Related Topic lists or "See Also" lists)

A topic can also be a list of jumps to other topics.  When you select a topic's jump with a mouse click or keypress, you are automatically moved to the topic itself.


Topic Names

A topic name is a unique topic heading.   Each major topic in this document has a heading which is also it's topic name.  Using the heading of a topicas a topic name makes it easy for both the computer and the computer user to find topics in a search list, table of contents, index, or See Also cross reference.  Some help systems refer to a topic name as a topic title.In Multi-Doc, a topic's name is also it's title.


Short and Long Entries

In some help systems, such as Expert Help, the topic jump is called a short entry.  The destination of a jump - the topic itself - is referred to as a long entry.  The item "Getting Started" in our sample table of contents is a short entry, and the chapter it refers to is a long entry.


Working with Help Files

To use Multi-Doc it is important to understand how help files work.  Help files must follow certain rules for structure and format.  These rules make for more readable printed manuals as well.  Multi-Doc makes these rules very simple to apply.

Please select one of the following for more information on help files andMulti-Doc:

Help file Topics

Help file Navigation

Working with Windows Help

Working with Expert Help

Tying Jumps to Their Topics


Help File Topics

 A help file topic is a block of text and/or graphics, such as a chapter, passage, or illustation in a document.  Main topics, such as chapters and passages, are translated into menu items called jumps in a help file.


Help File Navigation

Multi-Doc generated WinHelp and Expert Help files contain additional pull down menu items.

The "Contents" menu item displays the Contents menu of chapter topics.

The "Search"  menu item provides a list of all topics in your help file.  Pick from

a topic on the list and jump to that topic.

WinHelp also contains "Back"  and "History"  pull down choices.  Selecting Back  in WinHelp or

 pressing [Escape]  in Expert Help selects the previous menu choice.  Selecting "History"  in WinHelp

 provides a History of selected topics.


Working with Windows Help

 To create a Windows Help File, Main topics, such as chapters and passages, are translated into menu items called jumps in a help file.


Working with Expert Help

 When creating an Expert Help or Norton Guide using Multi-Doc, main topic headings appear on a table of contents screen of menu choices, and there are three pull down menu items called "Expand", "Table of Contents" and "Search". These menu choices, called jumps in WinHelp, are called short entries in Expert Help.

The first choice in an Expert Help menu is always "Expand".  When selected, the guide "expands", or selects the currently highlighted short or menu choice.


Tying Jumps to Their Topics

In order for an item of text to act as a jump to a topic, a link must be created between the two.  When translating from an existing help file to another, Multi-Doc translates these links automatically.  When creating help files for the first time, however, you must indicate and link jumps and topics.  This is done automatically by applying styles to your document or database.

Multi-Doc can tie jumps to topics in three ways:

Topic Names:

A Topic Name jump, or heading jump, can be any topic heading.   At your option, the heading is converted to a help file jump.  The text including and following the heading, up to the next heading, is the help topic.  For example, the heading above, "Tying Jumps to their Topics", is converted to a help file's jump to this topic.

See Also, or Cross Reference

A SeeAlso jump is used to navigate between related topics. In a document you can read from one topic to the next on a page.  In a help file each topic occupies it's own screen.  Multi-Doc builds SeeAlso jumps between adjacent topics, or topics within a particular section, chapter or passage.  You can also specify a link to a topic anywhere in the current authoring document or database.

Glossary

A Glossary jump is used in a Windows help file where it provides a pop-up definition and/or illustration for a highlighted word.  Multi-Doc automatically creates these jumps and definitions from a glossary of words and definitions.  To create a glossary, create a chapter in your word processing manual or create a group of topics in your database called "Glossary".

See Also

Working with Rules & Styles


Working with Rules & Styles

Multi-Doc creates help files and documents by applying rules.

Rules defined

Rules are instructions used by Multi-Doc to generate or convert help files and documents.  An example of a rule is when to use a topic heading as a help file jump.  Another example of a rule is the choice of font (typeface) to use in a Windows help file.  This and other rules are flexible so that users of Multi-Doc can change the rules if they wish.

Styles

A style is a set of format rules, called text attributes, and a unique name assigned to a text item.    Examples of text items are headings,  text paragraphs, and glossary definitions.

The style name is used to assign a special meaning to a text item.  For example, the style "Heading 1" is applied as a primary heading.  This primary heading would be used as a primary jump in a help file.

A style contains one or more format rules, or attributes including character attributes and paragraph attributes.   Character attributes are font (typeface), size, bolding, underline, italics, and color.  Paragraph attributes are tabs, indents,  justification and pagination controls.

How to apply Styles in a Word Processor

The MS Word and WordPerfect word processors contain built-in style support.  Multi-Doc provides a ready to use MS Word for Windows template (MDOC.DOT), WordPerfect 6.0 template (MDOC.WPT) or WordPerfect 5.1/5.2 stylesheet (MDOC.STY).

See Also

Using MS Word and WordGen

Using WordPerfect and WPGen

How to apply Styles in ASCII Text or a Database Memo Field

ASCII text editors and database management systems provide no builit-in style or format rule support.  Multi-Doc provides styles in the way of rule commands for these authoring tools.

See Also

Using an ASCII Text Editor and TxtGen

How to apply Styles in a Database

Multi-Doc provides a styles database linked to a topics database when using a database as an authoring tool.  The styles database contains the names and attributes for all Multi-Doc styles.  There is a styles database for Xbase (Clipper, dBase, FoxPro) (mdstyles.dbf) and Paradox (mdstyles.db).

Multi-Doc also provides a topics database containing a character field for each topic heading, a memo field for the topic's text, and a character field for the topic's style.  A style name entered in for a topic in the topics database links the topic to a style name entered and defined in the styles database.  This link applies the style to that topic heading.

See Also

Using an Xbase Database Manager and DbfGen

Using Paradox and PdxGen


RTF & Multi-Doc
RTF (Rich Text Format) and Multi-Doc

What is RTF ?

When converting help files and documents to and from Microsoft Windows, WordPerfect, and Windows Help, Multi-Doc makes use of Microsoft's RTF, or Rich Text Format.  RTF is two things:

1) A text based conversion file format capable of storing both text and graphic information.

2) The text command language used within the RTF file format.

Making RTF easy

Anyone who has looked at an RTF file or tried to create one knows that RTF files and commands within them are not easy to understand or edit.  Multi-Doc, however, makes RTF easy.

Save and Open Word Processing Documents as RTF files

When using a word processor with Multi-Doc, you do not need to know any RTF commands.  You do not need to encode a complex, footnoted version of your document for WinHelp RTF compatibility.  However, you must save and open word processing documents as RTF files.

If you are creating authoring documents in MS Word or WordPerfect...

Save your authoring document to RTF format before converting it with WordGen or WPGen.

Note: a Multi-Doc macro will automatically save a document and run WordGen or WPGen from MS Word and WordPerfect, respectively, and run the WordGen or WPGen conversion program from within the Word or WordPerfect.

If you are opening documents converted from Help Files...

Open these Multi-Doc generated documents in RTF format.  Once opened, they can then be saved as normal MS Word or WordPerfect documents.

See Also:

Using MS Word and WordGen

Using WordPerfect and WPGen

The Multi-Doc RTF based authoring language

If you are using an ASCII text editor or database memo field to author documents and help files,  you need a formatting command language.  This is because neither a database nor an ASCII text editor has built-in text formatting capability.  Multi-Doc uses a superset of RTF commands for its text formatting command language.  In other words, RTF commands are embedded in database text fields and ASCII authoring files to control how text is formatted in a helpfile.

Making RTF commands simple

Multi-Doc makes RTF commands simple to use.  There are only a handful of RTF commands frequently used to format text.  Once you have learned these, you can leave the rest of the conversion process to Multi-Doc.

If you are a power-user and want full control of the conversion process, then you can:

1.	Use RTF commands more extensively in your authoring document or database and ;

2.	Use Multi-Doc to generate RTF source code for Windows help files and documents, and customize the source code before generating the actual help files and documents.

See Also:

Using an ASCII Text Editor and TxtGen

Using an Xbase Database Manager and DbfGen

Using Paradox and PdxGen

Working with Rules & Styles


Converting Graphics
Converting Windows Graphics and DOS Illustrations

To generate help files and documents for both DOS and Windows, or convert existing ones, graphics and DOS text mode illustrations need special attention.  This is because Windows graphics cannot be viewed in DOS text mode, and because Windows does not natively support DOS illustrations.  As a consequence, graphics contained in Windows help files cannot be translated to DOS.

About Windows Graphics

Windows Graphics are pictures displayed in Windows, including Clip-Art drawings, icons, and graphical controls such as buttons, check boxes and scroll bars.

About DOS Illustrations

DOS illustrations are drawings which use line drawing characters in place of graphics.  DOS illustrations, but not Windows Graphics, can be viewed in ASCII format or in Expert Help.

Authoring and Conversion Strategies for DOS and Windows Images

To use both DOS illustrations and Windows graphics in your target help files and documents, create a Windows graphic and a DOS illustration for each picture, graph or other illustration in your authoring document.  To use DOS illustrations only in both DOS and Windows, use the MS LineDraw font, provided with Multi-Doc.

For more specific information about Windows graphics and DOS illustration conversion, see the chapters on generating and converting documents and help files.

Symbol and Foreign Language Character Conversion

Windows uses different special symbols and foreign language characters than DOS.  For example,

a Windows bullet may look the same but is not the same character as DOS ASCII bullet.  A Windows umlaut is also not the same character as a DOS ASCII umlaut.  Multi-Doc automatically converts these symbols and foreign language characters from Windows to DOS.


Using MS Word and WordGen

Organization

Creating a New Document

Setting up an Existing Document for Multi-Doc

Working with Multi-Doc Styles

Formatting a Word Document for Multi-Doc

Creating Word Graphics for Help Files

Starting WordGen to Create Help Files

The WordGen Screen

How to Use WordGen


MS Word Authoring File Organization

To use MS Word as an efficient authoring tool, it is extremely helpful to organize your document carefully.  Your document should be organized by sections, chapters, passages, and paragraphs.  It should also contain headings for each chapter, passage or paragraph you wish to change into a help file topic.  All headings, topic text, illustrations, source code, tables, cross references and glossary items should be formatted with styles provided in the Multi-Doc Word for Windows template, MDOC.DOT.


Creating a New MS Word Authoring Document

To create a new authoring file in MS Word, choose File New...  and then select the Multi-Doc template:

 The Multi-Doc style template provides styles for section, chapter, passage, paragraphs, illustrations and source code.  It also adds a menu item to the MS Word Tools Menu Bar, so that you can convert your document into help from within MS Word.

See Also

Formatting a Word Document for Multi-Doc

Working with Multi-Doc Styles


Setting Up an Existing MS Word Authoring Document

To set up an existing file in MS Word, choose File Open...  and then attach the Multi-Doc template:

 The Multi-Doc style template provides styles for section, chapter, passage, paragraphs, illustrations and source code.  It also adds a menu item to the MS Word Tools Menu Bar, so that you can convert your document into help from within MS Word.

See Also

Formatting a Word Document for Multi-Doc

Working with Multi-Doc Styles


Working with Multi-Doc Styles in MS Word

To work with Multi-Doc styles in MS Word for Windows, you must first load the Multi-Doc template.  After the template is attached to your document, you will be able to select a Multi-Doc style just like any other Word style.

You can redefine almost all Multi-Doc style properties, including fonts and character attributes.  The only styles whose fonts and attributes you cannot redefine are Linedraw and DOSdraw.  These are dedicated to the MS Linedraw font.

Do not rename Multi-Doc styles.  Style names are used as rules for converting authoring documents into help files and other target documents.

Styles in MS Word for Windows can be accessed via the leftmost button control on the button bar or from the Format Styles menu.

See Also

Formatting a Word Document for Multi-Doc


Formatting a Word Document for Multi-Doc

Formatting Topics

Format your document with separate topic headings for each topic.  Try to use a unique text phrase for each of your topics.  Multi-Doc can then use the text phrase as a help file jump, an identifier for See Also references, a search list entry and a document index entry.

Topic Layout

Place topic headings above or in a separate column to the left of your topic.  For example:

Document topic, with heading to the side	Help file , with headings above
Topic Heading	This is the text for this topic.  Headings to the side leave nice white space for reading printed text.	Topic Heading This is the text for this topic.  Headings above are better for conserving paper and viewing on-line help.

All of the headings in this manual or help file are placed above topic text.

Order of Topics

The order of your topics should follow the normal order of a book or other publication.  That is,

organized by section, chapter, chapter topic, chapter topic paragraphs, chapter topic subparagraphs and illustration.  Use the standard heading styles 1-9 for this purpose.

Topic Headings as Help File Jumps

By default topic headings "Chapter" ( or "Heading 2" ) and "Paggage" ( or "Heading 3" ) are jumps.  This means that your chapter, and primary chapter topic, which we call "Passage" will be converted to menu, sub-menu, and sub-sub menu items in a help file.  All other headings will be treated as normal text headings.

Samples

Please refer to the sample MS Word documents on disk, in your multi-doc directory:


Creating Word Graphics for Help Files and Documents

You can include graphics as you would normally in a Word for Windows document.  It is strongly recommended, however, that each graphic be created as a separate bitmap and linked to the Word document.  To do this, use the MS Word Insert Picture feature, with Link to File checked.

DOS image support

If you plan to create help files and documents for DOS Expert Help or ASCII documents, you will need to create two versions of each picture or image -- one for Windows and one for DOS.  The Windows version can be a bitmap or other type of graphic.  The DOS version will be a drawing using ASCII line drawing characters.

Multi-Doc will, by default, automatically substitute line DOS drawing files for Windows graphic files, using common root names.  To make use of this feature, create a separate, ASCII drawing file for each Windows graphic file included in your document.  When creating each, separate file, save each DOS drawing with the same root name as your graphics bitmap file.  For example, if your illustration is called "MYGRAPH.BMP" the DOS text version will be called "MYGRAPH.TXT".

With Multi-Doc you can also embed ASCII Drawings directly in your Word documents.  To do this, use the Multi-Doc style Linedraw.  To use this style, the MS linedraw font must be installed in Windows.  This font includes the line drawing characters not normally in Windows.

See Also

Formatting a Word Document for Multi-Doc


Starting WordGen to Create Help Files

How to start Wordgen from Within MS Word for Windows

After selecting the Multi-Doc authoring template and formatting the authoring document with Multi-Doc styles, select the Tools pull-down menu.   Then select the Multi-Doc menu item from the Tools menu:

Once the Multi-Doc (WordGen) menu item is selected, Multi-Doc will then:

•	Run a Word macro to save your document as an RTF (Rich Text Format) file.  The RTF file will contain all styles and format rules in your original document.

•	Load the WordGen program, displaying the WordGen dialogue window.  The WordGen program and dialogue window are documented in the following topic.

Starting WordGen From the MS Windows Program Manager

•	Within MS Word, save your Word document as an RTF file.

•	From the Multi-Doc Program Group window, double click on the WordGen icon.

The Wordgen program will load once the WordGen icon is selected.

Starting WordGen From MS DOS

•	Within MS Word, save your Word document as an RTF file.

•	From the DOS prompt, type the DOS command:

mdwrd[Enter]

The DOS version of the Wordgen program will load once the WordGen DOS command is typed.


The WordGen Screen

When the WordGen program is loaded, the WordGen Screen, or dialogue window, appears.  The window contains all the controls you need to generate help files and documents from MS Word.  These controls include activity buttons, options radio buttons or check boxes and file name edit controls.


How to use WordGen

Selecting the Authoring Document (Convert File)

If you are starting WordGen from within MS Word, Multi-Doc will convert the authoring document you are currently working with in MS Word to RTF format.  WordGen will then use this MS Word RTF document as the default file to convert from.  It will also name the files to convert to with the same root name as the file to convert from.

If you are starting WordGen from outside of word, you will need to supply the name of the MS Word authoring document to convert form.  This authoring document must be saved within MS Word as an RTF file.

Selecting Target Help Files and Documents (Convert To)

In this version of Multi-Doc, you can create Windows Help, Expert Help and formatted ASCII text documents from MS Word documents.  Use the check boxes in the Muti-Doc Convert To dialogue box to choose which of these types to convert to.  Then select the folder button

next to each file's edit box to specify the name of the file, with directory path, for each type of file.  If a path is not specified, help files and documents are created in your current working directory.

Generating Source Code Option

When Multi-Doc converts documents and help files to other formats, it produces an intermediate file or set of files in the source code format of the target help file.  If you wish to keep this source code available so you can customize it later, select the Generate Source Code redio button.

Compiling into Help Option

Multi-Doc will automatically run the Windows Help and Expert Help compilers to create a help file.  If you do not want to perform this step, uncheck the Compile into Help button.

Starting the Conversion (Start button)

To start the actual conversion, press the start button.  This will start theactual conversion into help.  Do this after you have specified the files to convert from and to, conversion options to use, and any changes to conversion rules.


Using WordPerfect and WPGen

Organization

Creating a New Document

Setting up an Existing Document for Multi-Doc

Working with Multi-Doc Styles

Formatting a WordPerfect Document for Multi-Doc

Creating WordPerfect Graphics for Help Files

Starting WPGen to Create Help Files

The WPGen Screen

How to Use WPGen


WordPerfect Authoring File Organization

To use WordPerfect as an efficient authoring tool, it is extremely helpful to organize your document carefully.  Your document should be organized by sections, chapters, passages, and paragraphs.  It should also contain headings for each chapter, passage or paragraph you wish to change into a help file topic.  All headings, topic text, illustrations, source code, tables, cross references and glossary items should be formatted with styles provided in the Multi-Doc Word for Windows template, MDOC.DOT.


Creating a New WordPerfect Authoring Document

To create a new authoring file in WordPerfect, choose File New...  and then select the Multi-Doc template:

 The Multi-Doc style template provides styles for section, chapter, passage, paragraphs, illustrations and source code.  It also adds a menu item to the WordPerfect Tools Menu Bar, so that you can convert your document into help from within WordPerfect.

See Also

Formatting a WordPerfect Document for Multi-Doc

Working with Multi-Doc Styles


Setting Up an Existing WordPerfect Authoring Document

To set up an existing file in WordPerfect, choose File Open...  and then attach the Multi-Doc template:

 The Multi-Doc style template provides styles for section, chapter, passage, paragraphs, illustrations and source code.  It also adds a menu item to the WordPerfect Tools Menu Bar, so that you can convert your document into help from within WordPerfect.

See Also

Formatting a WordPerfect Document for Multi-Doc

Working with Multi-Doc Styles


Working with Multi-Doc Styles in WordPerfect

To work with Multi-Doc styles in WordPerfect for Windows, you must first load the Multi-Doc template.  After the template is attached to your document, you will be able to select a Multi-Doc style just like any other Word style.

You can redefine almost all Multi-Doc style properties, including fonts and character attributes.  The only styles whose fonts and attributes you cannot redefine are Linedraw and DOSdraw.  These are dedicated to the MS Linedraw font.

Do not rename Multi-Doc styles.  Style names are used as rules for converting authoring documents into help files and other target documents.

Styles in WordPerfect for Windows can be accessed via the leftmost button control on the button bar or from the Format Styles menu.

See Also

Formatting a WordPerfect Document for Multi-Doc


Formatting a WordPerfect Document for Multi-Doc

Formatting Topics

Format your document with separate topic headings for each topic.  Try to use a unique text phrase for each of your topics.  Multi-Doc can then use the text phrase as a help file jump, an identifier for See Also references, a search list entry and a document index entry.

Topic Layout

Place topic headings above or in a separate column to the left of your topic.  For example:

Document topic, with heading to the side	Help file , with headings above
Topic Heading	This is the text for this topic.  Headings to the side leave nice white space for reading printed text.	Topic Heading This is the text for this topic.  Headings above are better for conserving paper and viewing on-line help.

All of the headings in this manual or help file are placed above topic text.

Order of Topics

The order of your topics should follow the normal order of a book or other publication.  That is,

organized by section, chapter, chapter topic, chapter topic paragraphs, chapter topic subparagraphs and illustration.  Use the standard heading styles 1-9 for this purpose.

Topic Headings as Help File Jumps

By default topic headings "Chapter" ( or "Heading 2" ) and "Paggage" ( or "Heading 3" ) are jumps.  This means that your chapter, and primary chapter topic, which we call "Passage" will be converted to menu, sub-menu, and sub-sub menu items in a help file.  All other headings will be treated as normal text headings.

Samples

Please refer to the sample WordPerfect documents on disk, in your multi-doc directory:


Creating WordPerfect Graphics for Help Files and Documents
Creating Word Graphics for Help Files and Documents

You can include graphics as you would normally in a WordPerfect document, as long as the graphic is not too large.  If you wish to include large graphic images, you should reference them as external bitmaps.  To do this, place the name of the bitmap file in a separate paragraph formatted in the Multi-Doc ImageFile style.

DOS image support

If you plan to create help files and documents for DOS Expert Help or ASCII documents, you will need to create two versions of each picture or image -- one for Windows and one for DOS.  The Windows version can be a bitmap or other type of graphic.  The DOS version will be a drawing using ASCII line drawing characters.

Multi-Doc will, by default, automatically substitute line DOS drawing files for Windows graphic files, using common root names.  To make use of this feature, create a separate, ASCII drawing file for each Windows graphic file included in your document.  When creating each, separate file, save each DOS drawing with the same root name as your graphics bitmap file.  For example, if your illustration is called "MYGRAPH.BMP" the DOS text version will be called "MYGRAPH.TXT".

With Multi-Doc you can also embed ASCII Drawings directly in your Word documents.  To do this, use the Multi-Doc style Linedraw.  To use this style, the MS linedraw font must be installed in Windows.  This font includes the line drawing characters not normally in Windows.

See Also

Formatting a WordPerfect Document for Multi-Doc


Starting WPGen to Create Help Files

How to start WPGen from Within WordPerfect for Windows

After selecting the Multi-Doc authoring template and formatting the authoring document with Multi-Doc styles, select the Tools pull-down menu.   Then select the Multi-Doc menu item from the Tools menu:

Once the Multi-Doc (WPGen) menu item is selected, Multi-Doc will then:

•	Run a Word macro to save your document as an RTF (Rich Text Format) file.  The RTF file will contain all styles and format rules in your original document.

•	Load the WPGen program, displaying the WPGen dialogue window.  The WPGen program and dialogue window are documented in the following topic.

Starting WPGen From the MS Windows Program Manager

•	Within WordPerfect, save your Word document as an RTF file.

•	From the Multi-Doc Program Group window, double click on the WPGen icon.

The WPGen program will load once the WPGen icon is selected.

Starting WPGen From MS DOS

•	Within WordPerfect, save your Word document as an RTF file.

•	From the DOS prompt, type the DOS command:

mdwrd[Enter]

The DOS version of the WPGen program will load once the WPGen DOS command is typed.


The WPGen Screen

When the WPGen program is loaded, the WPGen Screen, or dialogue window, appears.  The window contains all the controls you need to generate help files and documents from WordPerfect.  These controls include activity buttons, options radio buttons or check boxes and file name edit controls.


How to use WPGen

Selecting the Authoring Document (Convert File)

If you are starting WPGen from within WordPerfect, Multi-Doc will convert the authoring document you are currently working with in WordPerfect to RTF format.  WPGen will then use this WordPerfect RTF document as the default file to convert from.  It will also name the files to convert to with the same root name as the file to convert from.

If you are starting WPGen from outside of word, you will need to supply the name of the WordPerfect authoring document to convert form.  This authoring document must be saved within WordPerfect as an RTF file.

Selecting Target Help Files and Documents (Convert To)

In this version of Multi-Doc, you can create Windows Help, Expert Help and formatted ASCII text documents from MS Word documents.  Use the check boxes in the Muti-Doc Convert To dialogue box to choose which of these types to convert to.  Then select the folder button

next to each file's edit box to specify the name of the file, with directory path, for each type of file.  If a path is not specified, help files and documents are created in your current working directory.

Generating Source Code Option

When Multi-Doc converts documents and help files to other formats, it produces an intermediate file or set of files in the source code format of the target help file.  If you wish to keep this source code available so you can customize it later, select the Generate Source Code option.

Compiling into Help Option

Multi-Doc will automatically run the Windows Help and Expert Help compilers to create a help file.  If you do not want to perform this step, uncheck the Compile into Help button.

Starting the Conversion (Start button)

To start the actual conversion, press the start button.  This will start theactual conversion into help.  Do this after you have specified the files to convert from and to, conversion options to use, and any changes to conversion rules.


Using an ASCII Text Editor and TxtGen

Using ASCII Text Authoring Rules(Commands)

Using TxtGen to Create Help files from ASCII Text (Commands)


ASCII Text Authoring Rules (Commands)

Special text instructions called rule commands are used in ASCII Text Rule commands can either be entered as RTF (Rich Text Format) commands or additional Multi-Doc commands.  The syntax of a format rule command is:

\<command><setting>

For example, the rule:

\s"Heading 1" Welcome

would apply the style "Heading 1" to the text 'Welcome'.

Embedded format Rules

Embedded format text rules are instructions within a stream of text.  For instance, the text stream:

This is a { \b\i  bold and italicized } statement

is translated to:

This is a bold and italicized statement.

Note that, to use embedded format rules, precede the text you wish to change with an open curly brace '{'. followed by a backslash '\'.  If you wish to change an attribute, enter

'b' for bold,

'i'  for italic

'u' for underline.

'\r' for reverse.

Then enter a space, followed by your text.  After the text to format, enter a closing curly brace '}'.

Definition Rules for ASCII Authoring Documents

Definition rules for ASCII documents are RTF definitions for styles and format rules.  These include a stylesheet for all Multi-Doc styles, a Windows 3.1 standard font definition table and 16 standard color definition table for use by either DOS or Windows.

How to Apply an ASCII Include File of Rules Definitions

To apply the RTF header include file to your source document, use the following syntax:

Syntax: 	!include <filename>

Example:

!include: "mdoc.h"     // place at the top of your ASCII file

\s"Title" My Help File	// then enter some commands

\s"Heading 1" Section 1

\"Normal" This is the beginning of section 1...

\s"Heading 2" Chapter 1

\s"Normal" It was a dark and stormy night.  He did not have a surge protector...

\s"Heading 2" Chapter 2

\s"Normal" The sun rose, and he was still restoring files...

ASCII Text Comments

Multi-Doc enables you to place comment characters in you ASCII authoring file or in a database memo field.  These comment character are ignored by Multi-Doc.

To place a comment on a line, use the combined characters

// (double forward slash)

All text starting with and following these characters on the line becomes a comment.


Using TxtGen
Using TxtGen)

Starting TxtGen to generate help files and documents.

From the MS Windows Program Manager:

From the Multi-Doc Program Group window, double click on the TxtGen icon.

The TxtGen program will load once the TxtGen icon is selected.

From MS DOS:

From the DOS prompt, enter the DOS command:

mdtxt

The DOS version of the TxtGen program will load once the TxtGen DOS command is

entered.

The TxtGen Dialogue Window

When the TxtGen program is loaded, the TxtGen dialogue window appears.  The window contains all the controls you need to generate help files and documents from ASCII text formatted with Multi-Doc text formatting commands.  TxtGen controls include activity buttons, options radio buttons or check boxes and file name edit controls.

Selecting the authoring document (Convert File)

First supply TxtGen with the name of the ASCII authoring document or the name of an ASCII script containing the names of the authoring documents to convert from.  You can also include an optional path.

Selecting target help files and documents (Convert To)

In this version of Multi-Doc, you can create Windows Help, Expert Help and formatted ASCII output text documents from ASCII authoring documents.  Use the check boxes in the Muti-Doc Convert To dialogue box to choose which of these types to convert to.  Then specify the name of the file, with directory path, for each type of file.  If a path is not specified, help files and documents are created in your current working directory.

Generating source code option

When Multi-Doc converts documents and help files to other formats, it produces an intermediate

file or set of files in the source code format of the target help file.  If you wish to keep this source code available so you can customize it later, select the Generate Source Code option.

Compiling into help option

Multi-Doc will automatically run the Windows Help and Expert Help compilers to create a help file.  If you do not want to perform this step, uncheck the Compile into Help button.

Starting the Conversion (Start button)

To start the actual conversion, press the start button.  This will start the actual conversion into help.  Do this after you have specified the files to convert from and to, along with conversion options to use.

See Also

Working with Rules and Styles


Using an Xbase Database Manager and DbfGen

About Xbase Database Managers

Steps to Creating Help Files and Documents from Xbase Databases

Working with the Xbase Topics Table

Working with the Xbase Styles Table

Using DBFGen to Convert Xbase Tables to Help Files and Documents


About Xbase Database Managers

An Xbase database manager is any software tool or product which can read and write to dBase format databases, commonly called .dbf files.  These products include:

•	Borland dBase III and IV

•	Microsoft FoxPro for DOS or Windows

•	Computer Associates Clipper (Summer '87, 5.1 and 5.2)

•	Microsoft Visual Basic 3.0 Professional Edition

•	Sequiter Software CodeBase 5

•	Greenleaf Database Manager (formerly SoftC)

Terminology

This documentation assumes that the reader understands how to use one of the above Xbase products and is familiar with standard Xbase terminology.

Field Type Abbreviations

The following abbreviations are used for field types:

C Character field

N Numeric field

L Logical field

M Memo field

Support for proprietary index and memo formats

Multi-Doc supports the different proprietary index formats used by Xbase database managers.  This includes dBase IV MDX files, Clipper NTX files, and FoxPro CDX files.

Multi-Doc also supports the different proprietary memo formats used by Xbase database managers.

To configure Multi-Doc for a particular Xbase database manager, start DbfGen and select the Xbase version you want.


Steps to Creating Help Files and Documents from Xbase

1) Create a new authoring database

Use Multi-Doc's topic table structure.  A structure is an empty database table which is ready to be filled in with your data.  In an addition to empty tables, there are also sample topic tables filled in with data.

..or refer to an existing database

WIth Multi-Doc, you can set up a topic in the topic's table to merge existing data into your authoring database.

2) Start DbfGen

Start dbfGen by selecting its Windows icon or by typing in "DbfGen" from the DOS command line.  For portability and processing speed, DBFGen itself is a DOS based conversion program. DBFGen will convert your authoring database into help files and documents in the format(s) you desire.


Working with the Xbase Topics Table

The Topics Table

An authoring database is organized like a word processing document.  In a database, however, topic information is stored in topic's table containing records and fields of data.  The structure of the topics table is as follows:

Structure for Database: TOPICS.DBF

#	Field Name	Type	Width	Description
1	NAME	C	80	Optonal.  Contains a user defined name for a help file topic.  If this field is left blank,  The HEADING field is used as the topic name.
2	SORTORDER	C	20	Optional, but strongly recommended Contains a user defined value composed of letters/numbers to sort topics.
3	STYLE	C	20	Required.  Contains the name of a Multi-Doc style defined in STYLES.DBF.  The style identifies the type of topic (Section, chapter, passage, paragraph, source code, etc).  It also provides default attributes for topic headings as well as text.
4	HEADING	C	80	Optional.  Text used for a topic's document  heading or help file jump label.   The heading can be the title of a section, chapter, passage, paragraph, or other topic heading.  If not specified, the first line of the topic text, entered into the TEXT field, is used as a heading.
5	TEXT	M	10	Required.  Text of the topic entered as a memo field, or a form containing merge references to data  in another database.
6	COMMENTS	M	10	Optional.  Non-printing information about the topic.
The Topic Database: Detailed Description

Topic text and all other information about each topic is stored in a topics table record.  To create a topic, add a record to the topic's table and fill in the fields.

Field Name:	NAME

Type: 	Character

Length:	80

Input:	Optional

In this field enter your own optional identifier for a help file topic.  You can enter any combination of letters or numbers in this field.  This identifier is not used as a heading and does not appear in the generated help files or documents.

 Field Name:	SORTORDER

Type: 	Character

Length:	20

Input:	Optional, but strongly recommended

In this field enter a sorting order to use for topics.  A sorting order is a number or combination of letters and numbers.   For example: ("1" for the first topic, "2" for the second,  or "1.1", "1.2", etc.)

This field is provided to avoid using the physical order of the topics table when generating help files and documents.  The physical order is the order in which topics were originally added to the table.  When using the physical order of a table, it is difficult to insert new records between existing records.  However, if you use an index on the sortorder field, you can easily insert and otherwise rearrange the order of topics in a database.

Any topic record containing a blank SORTORDER field left will be generated using the topic table's physical order.

Field Name:	STYLE

Type: 	Character

Length:	20

Input:	Required

This field refers to the name of a style from the database MDSTYLES.dbf.  The style applies both a meaning and a format to the topic's heading when it is generated in a help file or document.

For example, the style "CHAPTER" or "HEADING 2" make the topic heading the title of a new chapter, as well as a jump in a help file.

Note: all default style attributes can be changed to other attributes.  When authoring a database, you can change the default style attribute in MDSTYLES.dbf.

 Field Name:	HEADING

Type: 	Character

Length:	80

Input:	Optional

In this field, enter a topic heading.  This is used as a document heading for a topic or help file jump label.   The heading can be the title of a section, chapter, passage, paragraph, or other topic heading.  If not specified, the first line of the topic text, entered intothe topic "TEXT" field, is used as a heading. For example, the heading for the first chapter of your manual might be "Chapter 1 - Overview".

If the heading is left blank, the first line of text from the text database is used as a heading.

 Field Name:	TEXT

Type: 	Memo

Length:	Variable

Input:	Optional

In this field, enter the text of the topic.  The topic text can be one or more paragraphs.  Paragraphs are blocks of text separated by two carriage-returns.

Text can be formatted using Multi-Doc text rules and RTF format commands.  Please see the Rule and Style and Format Rule Reference and RTF Reference for a list of these commands.  For example:

This is an { \b easy } programming example: // the word easy is bolded

\s"source" printf ( "hello world" ) ; // the style "source" is applied.

Field Name:	Comments

Type: 	MEMO

Length:	variable

Input:	Optional

This field contains non-printing information about the topic.  Use this field to enter your own notes about the topic.


Working with the Xbase Styles Table

Since a database manager has no built-in styles, styles must be defined in Multi-Doc's styles table.   The styles table is a .dbf file named MDstyles.dbf.  It is indexed on its NAME field.

Structure for database: MDSTYLES.DBF

#	FieldName	Type	Width	Dec	Description
1	NAME	C	30		The Style's name.  This is a key field used to look up the style information in this table
2	BASEDON	C	30		Style name for style this style is based on.
3	NEXTSTYLE	C	30		Style name for style to use after this topic.
4	BOLD	L	1		TRUE if bold.
5	ITALIC	L	1		TRUE if italicized.
6	UNDERLINE	L	1		TRUE if underlined
7	REVERSE	L	1		TRUE if reverse (Expert Help Only)
8	COLOR	C	30		Color Value or Name
9	FONT	C	30		Valid MS Windows Font Name
10	FONTSIZE	N	10	2	MS Windows Font Size in Points.
11	ALIGNMENT	C	15		Left, Right, Centered or Justifiied
12	LINDENT	N	10	2	Left Paragraph Indent in Inches
13	RINDENT	N	10	2	Right Paragraph Indent in Inches
14	FINDENT	N	10	2	First Line Paragraph Indent in Inches
15	SBEFORE	N	10	2	Spacing before paragraph in lines.
16	SAFTER	N	10	2	Spacing after paragraph in lines.
17	SLINE	N	10	2	Line Spacing within paragraph in lines.   Use 0 to specify automatic line spacing.  0 is the default
18	USECODES	L	1		TRUE, if RTF codes are used instead of the above fields to define a style.
19	CODES	M	10		RTF style codes.
20	COMMENTS	M	10		User comments entered as free form text in a memo field


Using DbfGen to Convert Help files and Documents

Using DbfGen

To generate Windows Help, Expert Help, Word for Windows RTF documents, WordPerfect documents and ASCII text documents, use the Multi-Doc DbfGen program.  This utility can be started from Windows or from DOS.

To start the DbfGen program from Windows, select the Multi-Doc program group window and select the DbfGen icon:

To start DBFGen from DOS, type the following command:

mddbf [Enter]

Once DBFGen is started, the following screen will appear:

All buttons and prompts contain an underlined letter.  Type Alt + <letter> to select a button or edit control with the keyboard.  Otherwise, select the button or edit

control with the mouse.

Selecting the authoring Xbase version (Convert Version)

To select the authoring Xbase version, Click on the radio button for the version you want.

Selecting the authoring Database Name (Convert Database Name) and Index

Enter the name of the authoring topics table to convert from.  This is the name of a Xbase .dbf file using the Multi-Doc topics table layout.  Also enter the name of the authoring topics index for the topics table, and an index tag if you are using a compound index.  You can  include an optional paths to these files.

Selecting target help files and documents (Convert To)

You can create Windows Help, Expert Help, a Word Document, a WordPerfect Document and a formatted ASCII output text document from your database(s).  Use the check boxes in the Multi-Doc Convert To dialogue box to choose which of these help files or documents to convert to.  Then specify the name of the file, with directory path, for each type of file.  If a path is not specified, help files and documents are created in your current working directory.

Generating source code option

When Multi-Doc converts documents and help files to other formats, it produces an intermediate

file or set of files in the source code format of the target help file.  If you wish to keep this source code available so you can customize it later, select the Generate Source Code option.

Compiling into help option

Multi-Doc will automatically run the Windows Help and Expert Help compilers to create a help file.  If you do not want to perform this step, uncheck the Compile into Help button.

Starting the Conversion (Start button)

To start the actual conversion, press the Start button.  This will start the actual conversion into help.  Do this after you have specified the files to convert from and conversion options to use.


Using Paradox and PdxGen

About Paradox

Steps to Creating Help Files and Documents from Paradox Tables

Working with the Paradox Topics Table

Working with the Paradox Styles Table

Using PDXGen to Convert Paradox Tables to Help Files and Documents


About Paradox

Paradox is a relational database manager similar to Xbase managers like dBase and FoxPro.  It uses a different file format called the .db file format for its tables.

Many software tools and products can read and write to the Paradox format tables.  These products include:

•	Borland Paradox for DOS or Windows

•	The Borland Paradox 'C' Engine

•	CA Clipper

•	MS Visual Basic 3.0 Professional Edition

Terminology

This documentation assumes that the reader understands how to use one of the above Paradox products and is familiar with Paradox terminology.

Field Type Abbreviations

The following abbreviations are used for field types:

A Alphanumeric field

N Number field

B Binary field

M Memo field


Steps to Creating Help Files and Documents from Paradox Tables

1) Create an authoring table

Use Multi-Doc's topic table structure.  A structure is an empty database table which is ready to be filled in with your data.  In an addition to empty tables, there are also sample topic tables filled in with data.

2) Start PDXGen

Start PDXGen by selecting its Windows icon or by typing in "PDXGen" from the DOS command line.  For portability and processing speed, PDXGen itself is a DOS based conversion program. PDXGen will convert your authoring database into help files and documents in the format(s) you desire.


Working with the Paradox Topics Table

An authoring database is organized like a word processing document.  In a database, however, topic information is stored in topic's table containing records and fields of data.  The structure of the topics table is as follows:

Structure for Table: TOPICS.DB

#	Field Name	Type	Width	Description
1	NAME	A	80	Optonal.  Contains a user defined name for a help file topic.  If this field is left blank,  The HEADING field is used as the topic name.
2	SORTORDER	A	20	Optional, but strongly recommended Contains a user defined value composed of letters/numbers to sort topics.
3	STYLE	A	20	Required.  Contains the name of a Multi-Doc style defined in MDSTYLES.DB.  The style identifies the type of topic (Section, chapter, passage, paragraph, source code, etc).  It also provides default attributes for topic headings as well as text.
4	HEADING	A	80	Optional.  Text used for a topic's document  heading or help file jump label.   The heading can be the title of a section, chapter, passage, paragraph, or other topic heading.  If not specified, the first line of the topic text, entered into the TEXT field, is used as a heading.
5	TEXT	M	10	Required.  Text of the topic entered as a memo field, or a form containing merge references to data  in another database.
6	COMMENTS	M	10	Optional.  Non-printing information about the topic.
The Topic Database: Detailed Description

Topic text and all other information about each topic is stored in a topics table record.  To create a topic, add a record to the topic's table and fill in the fields.

Field Name:	NAME

Type: 	AlphaNumeric

Length:	80

Input:	Optional

In this field enter your own optional identifier for a help file topic.  You can enter any combination of letters or numbers in this field.  This identifier is not used as a heading and does not appear in the generated help files or documents.

 Field Name:	SORTORDER

Type: 	AlphaNumeric

Length:	20

Input:	Optional, but strongly recommended

In this field enter a sorting order to use for topics.  A sorting order is a number or combination of letters and numbers.   For example: ("1" for the first topic, "2" for the second,  or "1.1", "1.2", etc.)

This field is provided to avoid using the physical order of the topics table when generating help files and documents.  The physical order is the order in which topics were originally added to the table.  When using the physical order of a table, it is difficult to insert new records between existing records.  However, if you use an index on the sortorder field, you can easily insert and otherwise rearrange the order of topics in a database.

Any topic record containing a blank SORTORDER field left will be generated using the topic table's physical order.

Field Name:	STYLE

Type: 	AlphaNumeric

Length:	20

Input:	Required

This field refers to the name of a style from the database MDSTYLES.dbf.  The style applies both a meaning and a format to the topic's heading when it is generated in a help file or document.

For example, the style "CHAPTER" or "HEADING 2" make the topic heading the title of a new chapter, as well as a jump in a help file.

Note: all default style attributes can be changed to other attributes.  When authoring a database, you can change the default style attribute in MDSTYLES.dbf.

 Field Name:	HEADING

Type: 	AlphaNumeric

Length:	80

Input:	Optional

In this field, enter a topic heading.  This is used as a document heading for a topic or help file jump label.   The heading can be the title of a section, chapter, passage, paragraph, or other topic heading.  If not specified, the first line of the topic text, entered intothe topic "TEXT" field, is used as a heading. For example, the heading for the first chapter of your manual might be "Chapter 1 - Overview".

If the heading is left blank, the first line of text from the text database is used as a heading.

 Field Name:	TEXT

Type: 	Memo

Length:	Variable

Input:	Optional

In this field, enter the text of the topic.  The topic text can be one or more paragraphs.  Paragraphs are blocks of text separated by two carriage-returns.

Text can be formatted using Multi-Doc text rules and RTF format commands.  Please see the Rule and Style and Format Rule Reference and RTF Reference for a list of these commands.  For example:

This is an { \b easy } programming example: // the word easy is bolded

\s"source" printf ( "hello world" ) ; // the style "source" is applied.

Field Name:	Comments

Type: 	MEMO

Length:	variable

Input:	Optional

This field contains non-printing information about the topic.  Use this field to enter your own notes about the topic.


Working with the Paradox Styles Table

Since a database manager has no built-in styles, styles must be defined in Multi-Doc's styles table.   The styles table is a .dbf file named MDstyles.db.  It is indexed on its NAME field.

Structure for table: MDSTYLES.DB

#	FieldName	Type	Width	Dec	Description
1	NAME	A	30		The Style's name.  This is a key field used to look up the style information in this table
2	BASEDON	A	30		Style name for style this style is based on.
3	NEXTSTYLE	A	30		Style name for style to use after this topic.
4	BOLD	L	1		TRUE if bold.
5	ITALIC	L	1		TRUE if italicized.
6	UNDERLINE	L	1		TRUE if underlined
7	REVERSE	L	1		TRUE if reverse (Expert Help Only)
8	COLOR	A	30		Color Value or Name
9	FONT	A	30		Valid MS Windows Font Name
10	FONTSIZE	N	10	2	MS Windows Font Size in Points.
11	ALIGNMENT	A	15		Left, Right, Centered or Justifiied
12	LINDENT	N	10	2	Left Paragraph Indent in Inches
13	RINDENT	N	10	2	Right Paragraph Indent in Inches
14	FINDENT	N	10	2	First Line Paragraph Indent in Inches
15	SBEFORE	N	10	2	Spacing before paragraph in lines.
16	SAFTER	N	10	2	Spacing after paragraph in lines.
17	SLINE	N	10	2	Line Spacing within paragraph in lines.   Use 0 to specify automatic line spacing.  0 is the default
18	USECODES	L	1		TRUE, if RTF codes are used instead of the above fields to define a style.
19	CODES	M	10		RTF style codes.
20	COMMENTS	M	10		User comments entered as free form text in a memo field


Using PDXGen to Convert Help files and Documents

To generate Windows Help, Expert Help, Word for Windows RTF documents, WordPerfect documents and ASCII text documents, use the Multi-Doc PDXGen program.  This utility can be started from Windows or from DOS.

To start the PDXGen program from Windows, select the Multi-Doc program group window and select the PDXGen icon:

To start PDXgen from DOS, type the following command:

mdpdx [Enter]

Once PDXGen is started, the following screen will appear:

All buttons and prompts contain an underlined letter.  Type Alt + <letter> to select a button, check box or edit control with the keyboard.  Otherwise, select the button or edit

control with the mouse.

Selecting the authoring Table Name (Convert Table Name) and Index

Enter the name of the authoring topics table to convert from.  This is the name of a Xbase .dbf file using the Multi-Doc topics table layout.  Also enter the name of the authoring topics index for the topics table, and an index tag if you are using a compound index.  You can include an optional paths to these files.

Selecting target help files and documents (Convert To)

You can create Windows Help, Expert Help, a Word Document, a WordPerfect Document and a formatted ASCII output text document from your database(s).  Use the check boxes in the Muti-Doc Convert To dialogue box to choose which of these help files or documents to convert to.  Then specify the name of the file, with directory path, for each type of file.  If a path is not specified, help files and documents are created in your current working directory.

Generating source code option

When Multi-Doc converts the database to help files, it produces an intermediate

file or set of files in the source code format of the target help file.  If you wish to keep this source code available so you can customize it later, select the Generate Source Code option.

Compiling into help option

Multi-Doc will automatically run the Windows Help and Expert Help compilers to create a help file.  If you do not want to perform this step, uncheck the Compile into Help button.

Starting the Conversion (Start button)

To start the actual conversion, press the Start button.  This will start the actual conversion into help.  Do this after you have specified the files to convert from and conversion options to use.


Converting from Windows Help to Expert Help

To convert from Windows Help  to Expert Help use the Multi-Doc Windows Help to Expert Help Converter. This utility can be started from Windows or from DOS.

The converter will take any Winhelp file and create from it Expert Help source code and/or an actual Expert Help guide.

Note: to create an actual Expert Help guide, you must have the Expert Help compiler and linker 	installed on your computer.

 To start the Windows Help to Expert Help Converter from Windows, select the Multi-Doc program group window and select the WinHelp to Expert Help icon.

To start the Windows Help to Expert Help Converter from DOS, type the following command:

mdwh2eh [Enter]

Windows Help to Expert Help conversion screen

Once the Windows Help to Expert Help Converter is started, the following screen will appear:

All buttons and prompts contain an underlined letter.  Type Alt + <letter> to select a button, radio button, check box or edit control with the keyboard.  Otherwise, select the button or edit

control with the mouse.

Windows Help to Expert Help conversion steps

•	Select the Help button to get context sensitive help at any time.

1.	Select the Windows Help file to Convert from.  Enter the name of the file, with an optional directory path.

2.	Select the Expert Help file to Convert to.  Enter the name of the file, with an optional directory path.

3.	Select the Conversion Options.  If  Generate Source Code is checked, Expert Help source code will be provided.  This source code will include a link (.lnk) file, response (.rsp) and encoded Expert Help source code files. A build batch file is also created so that the generated Expert Help source code can be compiled later into an Expert Help guide.

•	If Compile into Help is checked, an Expert Help guide will be compiled from the generated 	Expert Help source code, using the Expert Help compiler and linker.

Note: to compile into Expert Help, you must have the Expert Help compiler and linker 	installed on your computer.

4.	Select the Start button  to begin the conversion from Windows Help to Expert Help.

5.	Select the Exit button  to exit the program.


Converting from Expert Help to Windows Help

To convert from Expert Help to Windows Help use the Multi-Doc Expert Help to Windows Help Converter.  This utility can be started from Windows or from DOS.

 To start the Expert Help to Windows Help Converter from Windows, select the Multi-Doc program group window and select the WinHelp to Expert Help icon:

To start the Expert Help to Windows Help Converter from DOS, type the following command:

mdeh2wh [Enter]

Once the Expert Help to Windows Help Converter is started, the following screen will appear:

All buttons and prompts contain an underlined letter.  Type Alt + <letter> to select a button, radio button, check box or edit control with the keyboard.  Otherwise, select the button or edit control with the mouse.

Expert Help to Windows Help conversion steps

•	Select the Help button to get context sensitive help at any time.

1.	Select the Expert Help file to Convert from.  Enter the name of the file, with an optional directory path.

2.	Select the Windows Help file to Convert to.  Enter the name of the file, with an optional directory path.

3.	Select the Conversion Options.

•	If  Generate Source Code is checked, Windows Help source code will be provided.  This source code will include an RTF source file and HPJ project file, with context strings to each help topic.

•	If Compile into Help is checked, a Windows Help file will be compiled from the 	generated RTF source code and HPJ project, using the Windows Help compiler and linker.  At installation time, you can decide which version of the Windows Help compiler to use.

Note: Multi-Doc provides a licensed copy of the Microsoft Windows Help 3.1 compiler and documentation with each copy of Multi-Doc.

5.	Select the Start button to begin the conversion from Expert Help to Windows Help.

6.	Select the Exit button to exit the program.


Converting from Windows Help to MS Word

To convert from Windows Help to MS Word use the Multi-Doc Windows Help to MS Word Converter.  This will convert a Windows Help file to an MS Word RTF file containing all MS Word styles, fonts and other formatting instructions.

This RTF file can be viewed and printed in MS Word just like any MS Word document.  You can also save the RTF file as a standard MS Word document (.doc) file by selecting File Save As in MS Word.

 To start the Windows Help to MS Word Converter from Windows, select the Multi-Doc program group window and select the WinHelp to MS Word icon.

To start the Windows Help to MS Word Converter from DOS, type the following command:

mdwh2wrd[Enter]

Once the Windows Help to MS Word Converter is started, the following screen will appear:

All buttons and prompts contain an underlined letter.  Type Alt + <letter> to select a button, radio button, check box or edit control with the keyboard.  Otherwise, select the button or edit control with the mouse.

Windows Help to MS Word for Windows conversion steps

•	Select the Help button to get context sensitive help at any time.

1.	Select the Windows Help file to Convert from.  Enter the name of the help file, with an optional directory path.

2.	Select the MS Word RTF file to Convert to.  Enter the name of the MS Word RTF file, with an optional directory path.  This file should have a filename extension of .RTF.

3.	Select the Start button to begin the conversion.

4.	Select the Exit button to exit the program.

5.	Load MS Word for Windows, and open the RTF file created with the Windows Help to MS Word converter.  To open the RTF file select File Open and type:

<name of MS Word RTF file> [Enter].

Then MS Word will display a dialogue box titled  "Convert File" ,with Rich Text Format selected as the type of file to convert from.  To finish the conversion, Press [Enter] or Select [OK].  The MS Word RTF document created by Multi-Doc will then be displayed in MS Word.


Converting from Windows Help to WordPerfect

To convert from Windows Help to WordPerfect use the Multi-Doc Windows Help to WordPerfect Converter.  This will convert a Windows Help file to an WordPerfect RTF file containing all WordPerfect styles, fonts and other formatting instructions.

This RTF file can be viewed and printed in WordPerfect just like any WordPerfect document.  You can also save the RTF file as a standard WordPerfect document (.doc) file by selecting File Save As in WordPerfect.

To start the Windows Help to WordPerfect Converter from DOS, type the following command:

mdwh2wp[Enter]

Once the Windows Help to WordPerfect Converter is started, the following screen will appear:

All buttons and prompts contain an underlined letter.  Type Alt + <letter> to select a button, radio button, check box or edit control with the keyboard.  Otherwise, select the button or edit control with the mouse.

Windows Help to WordPerfect conversion steps

•	Select the Help button to get context sensitive help at any time.

1.	Select the Windows Help file to Convert from.  Enter the name of the help file, with an optional directory path.

2.	Select the WordPerfect RTF file to Convert to.  Enter the name of the WordPerfect RTF file, with an optional directory path.  This file should have a filename extension of .RTF.

3.	Select the Start button to begin the conversion.

4.	Select the Exit button to exit the program.

5.	Load WordPerfect, and open the RTF file created with the Windows Help to WordPerfect converter.

•	 Important Note:

There are known WordPerfect problem reading RTF files into WordPerfect prior to WordPerfect 6.  Therefore DABIWA strongly advises upgrading to WordPerfect 6 if you wish to use Multi-Doc and WordPerfect.  If you are working with an earlier version of WordPerfect and require an interim solution, we recommend that you convert your Windows help file to an ASCII text file and then import the ASCII text file into WordPerfect.


Converting from Windows Help to ASCII Text

To convert from Windows Help to ASCII use the Multi-Doc Windows Help to ASCII Converter.  This will convert a Windows Help file to a formatted ASCII Text file with page numbering  and page numbered cross references.

 To start the Windows Help to ASCII Converter from Windows, select the Multi-Doc Program Group Window and select the WinHelp to ASCII icon.

Once the Windows Help to ASCII Converter is started, the following screen will appear:

All buttons and prompts contain an underlined letter.  Type Alt + <letter> to select a button, radio button, check box or edit control with the keyboard.  Otherwise, select the button or edit control with the mouse.

To start the Windows Help to ASCII Converter from DOS, type the following command:

mdwh2txt[Enter]

Windows Help to ASCII for Windows conversion steps

•	Select the Help button to get context sensitive help at any time.

1.	Select the Windows Help file to convert from.  Enter the name of the help file, with an optional directory path.

2.	Select the ASCII text file to convert to.  Enter the name of the ASCII RTF file, with an optional directory path.  The default extension is .TXT.

3.	Select the Start button to begin the conversion.

4.	Select the Exit button to exit the program.

5.	Load your ASCII editor, (such as Windows NotePad, DOS EDIT, Brief, or Multi-Edit) and open the ASCII text file.  The ASCII text document created by Multi-Doc will then be displayed in your ASCII text editor.


Converting from Expert Help to MS Word

To convert from Expert Help to MS Word use the Multi-Doc Expert Help to MS Word Converter.  This will convert a DOS Expert Help file to an MS Word RTF file.

This RTF file can be viewed and printed in MS Word just like any MS Word document.  You can also save the RTF file as a standard MS Word document (.doc) file by selecting File Save As in MS Word.

 To start the Expert Help to MS Word Converter from Windows, select the Multi-Doc Program Group Window and select the Expert Help to MS Word icon.

To start the Expert Help to MS Word Converter from DOS, type the following command:

mdeh2wrd[Enter]

Once the Expert Help to MS Word Converter is started, the following screen will appear:

All buttons and prompts contain an underlined letter.  Type Alt + <letter> to select a button, radio button, check box or edit control with the keyboard.  Otherwise, select the button or edit control with the mouse.

Expert Help to MS Word for Windows conversion steps

•	Select the Help button to get context sensitive help at any time.

1.	Select the Expert Help file to Convert from.  Enter the name of the help file, with an optional directory path.

2.	Select the MS Word RTF file to Convert to.  Enter the name of the MS Word RTF file, with an optional directory path.  This file should have a filename extension of .RTF.

3.	Select the Start button to begin the conversion.  This conversion will first call the Expert Help decompiler, EHDD.exe to convert Expert Help files into source code.  Next, Multi-Doc will convert the Expert Help source code into an MS Word RTF file.

4.	Select the Exit button to exit the program.

5.	Load MS Word for Windows, and open the RTF file created with the Expert Help to MS Word converter.  To open the RTF file select File Open and type:

<name of MS Word RTF file> [Enter].

Then MS Word will display a dialogue box titled  "Convert File" , with Rich Text Format selected as the type of file to convert from.  To finish the conversion, Press [Enter] or Select [OK].  The MS Word RTF document created by Multi-Doc will then be displayed in MS Word.

Note: To use this or any other Multi-Doc Expert Help conversion tool, Expert Help, including the Expert Help compiler and decompiler, must be installed on your computer.


Converting from Expert Help to WordPerfect

To convert from Expert Help to WordPerfect use the Multi-Doc Expert Help to WordPerfect Converter.  This will convert a Expert Help file to an WordPerfect RTF file containing all WordPerfect styles, fonts and other formatting instructions.

This RTF file can be viewed and printed in WordPerfect just like any WordPerfect document.  You can also save the RTF file as a standard WordPerfect document (.doc) file by selecting File Save As in WordPerfect.

 To start the Expert Help to WordPerfect Converter from Windows, select the Multi-Doc program group window and select the Expert Help to WordPerfect icon.

To start the Expert Help to WordPerfect Converter from DOS, type the following command:

mdeh2wp[Enter]

Once the Expert Help to WordPerfect Converter is started, the following screen will appear:

All buttons and prompts contain an underlined letter.  Type Alt + <letter> to select a button, radio button, check box or edit control with the keyboard.  Otherwise, select the button or edit control with the mouse.

Expert Help to WordPerfect conversion steps

•	Select the Help button to get context sensitive help at any time.

1.	Select the Expert Help file to Convert from.  Enter the name of the help file, with an optional directory path.

2.	Select the WordPerfect RTF file to Convert to.  Enter the name of the WordPerfect RTF file, with an optional directory path.  This file should have a filename extension of .RTF.

3.	Select the Start button to begin the conversion.  This conversion will first call the Expert Help decompiler, EHDD.exe to convert Expert Help files into source code.  Next, Multi-Doc will convert the Expert Help source code into an MS Word RTF file.

4.	Select the Exit button to exit the program.

5.	Load WordPerfect, and open the RTF file created with the Expert Help to WordPerfect converter.

Notes:

To use this or any other Multi-Doc Expert Help conversion tool, Expert Help, including the Expert Help compiler and decompiler, must be installed on your computer.

There are known WordPerfect problem reading RTF files into WordPerfect prior to WordPerfect 6.  Therefore DABIWA strongly advises upgrading to WordPerfect 6 if you wish to use Multi-Doc and WordPerfect.  If you are working with an earlier version of WordPerfect and require an interim solution, convert your Windows help file to an ASCII text file and then import the ASCII text file into WordPerfect.


Converting from Expert Help to ASCII
Converting from Expert Help to ASCII Text

To convert from Expert Help to ASCII use the Multi-Doc Expert Help to ASCII Converter.  This will convert a Expert Help file to a formatted ASCII Text file with page numbering  and page numbered cross references.

 To start the Expert Help to ASCII Converter from Windows, select the Multi-Doc Program Group Window and select the Expert Help to ASCII icon.

To start the Expert Help to ASCII Converter from DOS, type the following command:

mdeh2txt[Enter]

Once the Expert Help to ASCII Converter is started, the following screen will appear:

All buttons and prompts contain an underlined letter.  Type Alt + <letter> to select a button, radio button, check box or edit control with the keyboard.  Otherwise, select the button or edit control with the mouse.

Expert Help to ASCII Text Conversion Steps

•	Select the Help button to get context sensitive help at any time.

1.	Select the Expert Help file to convert from.  Enter the name of the help file, with an optional directory path.

2.	Select the ASCII text file to convert to.  Enter the name of the ASCII RTF file, with an optional directory path.  The default extension is .TXT.

3.	Select the Start button to begin the conversion.

4.	Select the Exit button to exit the program.

5.	Load your ASCII editor, (such as Windows NotePad, DOS EDIT, Brief, or Multi-Edit) and open the ASCII text file.  The ASCII text document created by Multi-Doc will then be displayed in your ASCII text editor.

Note: To use this or any other Multi-Doc Expert Help conversion tool, Expert Help, including the Expert Help compiler and decompiler, must be installed on your computer.


Generator Tools for Creating Help Files from a Single Source


Conversion Tools for Converting From Windows Help Files


Conversion Tools for Converting From Expert Help Files


Style and Format Rule Reference

Multi-Doc Styles

Chapter Style

Comment Style

DosDraw Style

Example Style

ExampleText Style

Heading 1 Style

Heading 2 Style

Heading 3 Style

Heading 4-9 Styles

ImageFile Style

LineDraw Style

Normal Style

Passage Style

Reference Style

Section (Heading 1) Style

See Also Style

Source Style

Title Style

Multi-Doc Format Rules

Commonly used Format Rules


Chapter Style

The Multi-Doc heading style "Chapter" is the same as the style "Heading 2" and follows "Section" or "Heading 1" as a main heading.  Text in this style is converted to a level 1 jump in a Windows help file and level 1 short in an Expert Help file.  Selecting a "Chapter" jump will cause the text of the chapter topic and any "Passage" or "Heading 3" style jumps to appear.

Note: The Styles "Heading 2" and "Chapter" are equivalent.

Example:

This is an example of using heading styles in an ASCII text authoring file.

\s"Heading 1" Section 1

\s"Heading 2" Chapter 1 of Section 1

Chapter 1 Text

\s"Heading 2" Chapter 2 of Section 1

Chapter 2 Text

\s"Heading 1" Section 2

\s"Heading 2" Chapter 1 of Section 2

Chapter 1 Text

\s"Heading 3" Passage 1 of Chapter 1 of Section 2

Passage 1 Text

\s"Heading 3" Passage 1 of Chapter 1 of Section 2

Passage 2 Text

\s"Heading 2" Chapter 2 of Section 2

Chapter 2 Text

Output:

 Section 1

Chapter 1 of Section 1

Chapter 2 of Section 1

 Section 2

Chapter 1 of Section 2

Chapter 2 of Section 2

See Also

Passage Style

Working with Rules & Styles


Comment Style
Comment Style (//)

The style "Comment" is used to include text in an authoring document or database which is neither printed nor displayed as part of a document or help file.  The style "Comment" is implemented in WordPerfect via the 'Comment' feature of WordPerfect.  In MS Word, the style "Comment" makes all text have an MS Word 'Hidden' attribute.

In a database, each topic has a comment memo field, as well as a style called Comment.

In an ASCII text file, or database memo field, use the // (double forward slash) to start a comment character.

Example:

// comment:  This could be me talking to myself.

\s"Source" ? "Hello World" // This is a comment


DosDraw Style

The Multi-Doc style "DOSDraw" is based on the style "LineDraw".  DOSDraw is used to identify a line drawing which does not get included in a Windows help file or document.  If you build a drawing using the "DOSDraw" style in a Windows word processing document, its contents will not be printed with your authoring document.

The style "LineDraw" identifies a line drawing which includes DOS ASCII Line drawing characters.  In a Windows word processing document this line drawing is created using the TrueType font "MS LineDraw".  Since this font is a new addition to Windows, it is provided on the Multi-Doc distribution diskettes.

Example:

\s"DOSDraw"

This illustration is to appear only in Expert Help and ASCII documents.  It is created in the style DOSDraw.

\s "Normal"

See Also

LineDraw Style

Working with Rules & Styles


Example Style

The style "Example" is used as an optional help file jump to an example topic.  You can keep the example text as part of the current help file topic or require the user to select the word "Example" to show the topic.  Alternatively, you can show Example button with the other buttons in a Windows help file, or reference the example as a "See Also" in an Expert Help file.  By default examples are part of the topic text.

Note: text in the style "Source" which follows the style "Example" is treated as part of the example.

Example:

\s"Example" Example

\sThe following is an example of how to say "hello world" in the Xbase language:

? Hello World


ExampleText Style

The style "Exampletext" is used for example topic text following the style "Example".  You can treat examples as part of the help file topic, reference them with an Example button in a Windows help file, or reference the example as a "See Also" in an Expert Help file.  By default, examples are part of the topic text.

Note: text in the style "Source" which follows the style "Example" is treated as part of the example.

Example:

The following is an example of how to say "hello world" in the Xbase language:

? Hello World


Heading 1 Style
Heading 1 (or Section) Style

The heading style "Heading 1" or "Section" is used for a section heading in your document or help file.  If you do not intend to use sections, omit this style and begin with "Heading 2" or "Chapter" headings.  A "Heading 1" heading appears on the contents page or screen of your help file as a heading above Chapter headings.  A "Heading 1" heading is not used as a help file jump.  The heading will still appear in the help file, but will not be selectable.

Note: The Styles "Heading 1" and "Section" are equivalent.

Example:

This is an example of using heading styles in an ASCII text authoring file.

\s"Heading 1" Section 1

\s"Heading 2" Chapter 1 of Section 1

Chapter 1 Text

\s"Heading 2" Chapter 2 of Section 1

Chapter 2 Text

\s"Heading 1" Section 2

\s"Heading 2" Chapter 1 of Section 2

Chapter 1 Text

\s"Heading 3" Passage 1 of Chapter 1 of Section 2

Passage 1 Text

\s"Heading 3" Passage 1 of Chapter 1 of Section 2

Passage 2 Text

\s"Heading 2" Chapter 2 of Section 2

Chapter 2 Text

Output:

 Section 1

Chapter 1 of Section 1

Chapter 2 of Section 1

 Section 2

Chapter 1 of Section 2

Chapter 2 of Section 2

See Also

Heading 2 Style

Heading 3 Style

Working with Rules & Styles


Heading 2 Style
Heading 2 (or Chapter) Style

The heading style "Chapter" is the same as the style "Heading 2" and follows "Section" or "Heading 1" as a main heading.  Text in this style is converted to a level 1 jump in a Windows help file and level 1 short in an Expert Help file.  Selecting a "Chapter" or "Heading 2" jump will cause the text of the chapter topic and any "Passage" or "Heading 3" style jumps to appear.

Note: The Styles "Heading 2" and "Chapter" are equivalent.

Example:

This is an example of using heading styles in an ASCII text authoring file.

\s"Heading 1" Section 1

\s"Heading 2" Chapter 1 of Section 1

Chapter 1 Text

\s"Heading 2" Chapter 2 of Section 1

Chapter 2 Text

\s"Heading 1" Section 2

\s"Heading 2" Chapter 1 of Section 2

Chapter 1 Text

\s"Heading 3" Passage 1 of Chapter 1 of Section 2

Passage 1 Text

\s"Heading 3" Passage 1 of Chapter 1 of Section 2

Passage 2 Text

\s"Heading 2" Chapter 2 of Section 2

Chapter 2 Text

Output:

My Manual

 Section 1

Chapter 1 of Section 1

Chapter 2 of Section 1

 Section 2

Chapter 1 of Section 2

Chapter 2 of Section 2

Chapter 2 of Section 1

Chapter 1 Text

Passage 1 of Chapter 1 of Section 1

Chapter 2 of Section 1 of Section 1

See Also

Heading 1 Style

Heading 3 Style

Working with Rules & Styles


Heading 3 Style
Heading 3 (or Passage) Style

The heading style "Heading 3" or "Passage" is a sub-menu heading.  By default it is converted to a secondary, or level 2 jump, in a Windows help or Expert Help file.  After a "Heading 2" jump is selected, "Heading 3" jumps, placed within the "Heading 2" topic, will appear.  Selecting a "Heading 3" jump will cause its topic to appear.

Note: The Styles "Heading 3" and "Passage" are equivalent.

Example:

see the example for "Heading 2" or "Chapter"

Output:

My Manual

 Section 1

Chapter 1 of Section 1

Chapter 2 of Section 1

 Section 2

Chapter 1 of Section 2

Chapter 2 of Section 2

Chapter 2 of Section 1

Chapter 1 Text

Passage 1 of Chapter 1 of Section 1

Chapter 2 of Section 1 of Section 1

Passage 1 of Section 1

Passage 1 Text

Passage 2 of Section 1

Passage 2 Text

See Also

Heading 1 Style

Heading 2 Style

Working with Rules & Styles


Heading 4-9 Styles
Heading 4-9 (or Passage) Styles

The heading styles "Heading 4" through "Heading 9" can be used as additional subparagraph headings not used as jumps.

Note: The Styles "Heading 4-9" and "Paragraph 1-5" are equivalent.


ImageFile

The style "ImageFile" identifies a separate ASCII line drawing file and Windows bitmap file.

Upon reading this style, Multi-Doc will merge the contents of the specified files into your target documents and help files.

Multi-Doc expects the names of both types of files on separate lines, but using the same style.

If you are using MS Word, text in the ImageFile style is hidden.  If you are using WordPerfect, text in the ImageFile style is a comment.  Either way, text in this style is not printed with your

document or converted.

An ASCII line drawing file can be any single page illustration containing ASCII line drawing characters.  The extension name of the file must be .txt.  You can include an optional path (drive and directory) in the filename.

A Windows bitmap file can be any single page illustration containing a Windows bitmap.  The extension name of the file must be .bmp.  You can include an optional path (drive and directory) in the filename.

Example:

Please refer to the following illustration:

\s"ImageFile" drawing1.bmp  // show this one in Windows

\s"ImageFile" drawing1.txt     // show this one in DOS


LineDraw Style


LineDraw

The style "LineDraw" identifies a line drawing which includes DOS ASCII Line drawing characters.  In a Windows document or help file this line drawing is creating using the TrueType font "MS LineDraw".  Since this font is a new addition to Windows, it is provided on the Multi-Doc distribution diskettes.

See Also

DOSDraw Style

Working with Rules & Styles


Normal Style

The style "Normal" identifies plain text.  For documents and help files capable of supporting fonts, Multi-Doc assigns the TrueType font Times New Roman, 11 pitch.  No attributes are pre-assigned to this style.


Paragraph 1 - 5

The heading styles "Paragraph 1-5" through "Paragraph 5" can be used as subparagraph headings not used as jumps.

Note: The Styles "Heading 4-9" and "Paragraph 1-5" are equivalent.


Passage

The heading style "Heading 3" or "Passage" is a sub-menu heading.  By default it is converted to a secondary, or level 2 jump, in a Windows help or Expert Help file.  After a "Heading 2" jump is selected, "Heading 3" jumps, placed within the "Heading 2" topic, will appear.  Selecting a "Heading 3" jump will cause its topic to appear.

Note: The Styles "Heading 3" and "Passage" are equivalent.

Example:

see the example for "Heading 2" or "Chapter"

Output:

My Manual

 Section 1

Chapter 1 of Section 1

Chapter 2 of Section 1

 Section 2

Chapter 1 of Section 2

Chapter 2 of Section 2

Chapter 2 of Section 1

Chapter 1 Text

Passage 1 of Chapter 1 of Section 1

Chapter 2 of Section 1 of Section 1

Passage 1 of Section 1

Passage 1 Text

Passage 2 of Section 1

Passage 2 Text


Passage Style

The heading style "Heading 3" or "Passage" is a sub-menu heading.  By default it is converted to a secondary, or level 2 jump, in a Windows help or Expert Help file.  After a "Heading 2" jump is selected, "Heading 3" jumps, placed within the "Heading 2" topic, will appear.  Selecting a "Heading 3" jump will cause its topic to appear.

Note: The Styles "Heading 3" and "Passage" are equivalent.

Example:

see the example for "Heading 2" or "Chapter"

Output:

My Manual

 Section 1

Chapter 1 of Section 1

Chapter 2 of Section 1

 Section 2

Chapter 1 of Section 2

Chapter 2 of Section 2

Chapter 2 of Section 1

Chapter 1 Text

Passage 1 of Chapter 1 of Section 1

Chapter 2 of Section 1 of Section 1

Passage 1 of Section 1

Passage 1 Text

Passage 2 of Section 1

Passage 2 Text

See Also

Chapter Style

Working with Rules & Styles


Reference Style

The style "Reference" is used to create a reference jump.  This is a jump used to refer to a help topic elsewhere in the document.  It is placed on the line below a line formatted with the "See Also" style.

To resolve the reference, Multi-Doc uses a topic name or topic location.  In a word processor, the topic name is the text of the remote heading for that topic.  For example,

See Also

Style and Format Rule Reference

Refers to the topic in the document or help file below the heading "Style and Format Rule Reference"

In a database, each topic contains a field called "Reference".  This field can be filled in with one or more remote references.  If there is more than one reference in a field, it must be separated from the other by a comma.  For example,

Style and Format Rule Reference, My Reference

In an ASCII text file, use the styles "SeeeAlso" and "Reference", as follows:

\s"See Also" See Also

\s"Reference" Style and Format Rule Reference

See Also

See Also Style

Working with Rules & Styles


Section Style

The heading style "Heading 1" or "Section" is used for a section heading in your document or help file.  If you do not intend to use sections, omit this style and begin with "Heading 2" or "Chapter" headings.  A "Heading 1" heading appears on the contents page or screen of your help file as a heading above Chapter headings.  A "Heading 1" heading is not used as a help file jump.  The heading will still appear in the help file, but will not be selectable.

Note: The Styles "Heading 1" and "Section" are equivalent.

Example:

This is an example of using heading styles in an ASCII text authoring file.

Example:

This is an example of using heading styles in an ASCII text authoring file.

\s"Heading 1" Section 1

\s"Heading 2" Chapter 1 of Section 1

Chapter 1 Text

\s"Heading 2" Chapter 2 of Section 1

Chapter 2 Text

\s"Heading 1" Section 2

\s"Heading 2" Chapter 1 of Section 2

Chapter 1 Text

\s"Heading 3" Passage 1 of Chapter 1 of Section 2

Passage 1 Text

\s"Heading 3" Passage 1 of Chapter 1 of Section 2

Passage 2 Text

\s"Heading 2" Chapter 2 of Section 2

Chapter 2 Text

Output:

 Section 1

Chapter 1 of Section 1

Chapter 2 of Section 1

 Section 2

Chapter 1 of Section 2

Chapter 2 of Section 2

See Also

Chapter Style

Passage Style

Title Style

Working with Rules & Styles


See Also

The style "See Also" is used in conjunction with the style "Reference".  The style "Reference" is used to create a reference jump.  A reference jump is used to refer to a topic elsewhere in the document.  It is placed on the line below a line formatted with the "See Also" style.

To resolve the reference, Multi-Doc uses a topic name or topic location.  In a word processor, the topic name is the text of the remote heading for that topic.  For example,

See Also

Style and Format Rule Reference

Refers to the topic in the document or help file below the heading "Style and Format Rule Reference"

In a database, each topic contains a field called "Reference".  This field can be filled in with one or more remote references.  If there is more than one reference in a field, it must be separated from the other by a comma.  For example,

Style and Format Rule Reference, MyReference

In an ASCII text file, use the style commands "SeeeAlso" and "Reference", as follows:

\s"See Also" See Also

\s"Reference" Style and Format Rule Reference

See Also

Reference Style

Working with Rules & Styles


Source

The style "Source" is used as a convenient way to identify and format source code placed in your authoring document or database.  By default, "Source" is displayed and printed using the TrueType font New Courier.  This is a non-proportional font in Windows.

Example:

The following is an example of how to say "hello world" in Xbase using the style Source:

\s"Source" ? Hello World && This is in the style called "Source"


Title

The style "Title" is used at the beginning of your document or database to identify the title of

your manual or help file.  This should be a small text expression such as "MY MANUAL".

The title is used by both Windows Help and Expert Help to identify the help file internally.  The title is also used in a document on a title page which appears first in a manual.  You can also add additional text or graphics on the title page below the title.  This text or graphics can be in any text or graphic style or format.

See Also

Section Style

Working with Rules & Styles


Commonly used Format Rules

Text Attributes

Name	Code	Meaning
bold	\b	bold text
italic	\i	italicized text
underline	\u	underlined text
reverse	\r	reverse text (Expert Help only)

Description:

These commands are text formatting commands.  They are also used in embedded text commands within blocks of text.

In a Word Processor such as WordPerfect or MS Word, Multi-Doc format commands are not used.  Instead, Multi-Doc reads the attributes as you enter them normally in a word processing document.  In other words, Multi-Doc reads these attributes automatically.

Examples:

These are three examples of text attributes using the bold attribute.

From the Multi-Doc Conversion Rules Table:

!Winhelp2Eh  // windows help to expert help conversion rule

\b = \b           // bold in Windows help = bold in Expert Help

From a text stream:

this is a {\b bold statement}

From a word processor:

this is a bold statement.

Colors

Color in a Windows Help File is applied via the RTF command is {\cf# }, where # is a color number from the tables below., and <text> is colorized text.  If you are using a word processor as an authoring tool, you can instead select color using the word processor's color selection tools.

Color Table:

Color #	Color Name
1	Black
2	Blue
3	Green
4	Cyan
5	Magenta
6	Red
7	Yellow
8	White

Custom Color Table Format (from RTF)

{ \colortbl;	start a color table

red%,green%,blue%; 	RGB color value 1, where % represents a color percentage from 0 to 255

.......

red%,green%,blue%; 	RGB color value N, where % represents a color percentage from 0 to 255

}	end a color table

Example:

I am seeing {\cf6 red} today.

Output:

I am seeing red today.

Font Commands

Name	Code	Meaning
font:	\f#	use specified font (typeface)
fonttbl		table used to define fonts

Description:

These commands are text formatting commands.  They are also used in embedded text commands within blocks of text.

In a Word Processor such as WordPerfect or MS Word, fonts are entered directly into the  text.  Multi-Doc automatically reads these fonts when converting from a MS Word or WordPerfect document.

When using a Database Manager or ASCII text editor, fonts must be defined before they can be entered.  For this purpose, a font table must be set up.

If you are using a database manager, the font table is either an Xbase .dbf table or Paradox .pdx table.  A complete description of this table is provided in the "Using an Xbase database manager and dbfGen" and "Using Paradox and PdxGen" chapters.

If you are using an ASCII text editor, the font table is entered as an RTF font table within your ASCII document.

See Also:

Using an Xbase Database Manager and DbfGen

Using Paradox and PdxGen


Style Commands

Name	Code	Meaning
style:	\s#	use specified style
styletable or stylesheet		table used to define styles
Description:

Styles are text formatting commands.  Styles play a major role in Multi-Doc since they simplify the process of identifying text.  For a definition of styles, please refer to the chapter "Working with Rules and Styles".   For a complete description of each Multi-Doc styles, please see the other

topics in this "Styles and Format Rules Reference".

In a Word Processor such as WordPerfect or MS Word, styles are built-in features.

Multi-Doc automatically reads these styles when converting from a MS Word or WordPerfect document.

When using a Database Manager or ASCII text editor, styles must be defined before they can be entered.  For this purpose, a style table, sometimes called a stylesheet, must be set up.

If you are using a database manager, the style table is either an Xbase .dbf table or Paradox .pdx table.  A complete description of this table is provided in the "Using an Xbase database manager and dbfGen" and "Using Paradox and PdxGen" chapters.

If you are using an ASCII text editor, the style table is entered as an RTF stylesheet within your ASCII document.

See Also:

Using an ASCII Text Editor and TxtGen

Working with Rules & Styles


How to Order