Internal Use Only
B2H: Convert BookMaster, GML,
Script/VS and 'flat' files to HTML
User's Guide
HTML 3 generated by B2H R3.0 (300)
Release 3.0
Gary L. Richtmeyer
Synopsis: B2H converts 'flat' files and files written in BookMaster, Generalized Markup Language (GML) and Script/VS into HyperText Markup Language (HTML) format suitable for use in an Internet World-Wide-Web environment
Caveats and restrictions (what's supported and what's not!)
Appendix A. Symbols, commands, macros and tags supported by B2H
Appendix B. &variables pre-defined by B2H
B2H reads files written in BookMaster, Generalized Markup Language (GML), Script/VS, and even 'flat' files, and converts them into HyperText Markup Language (HTML) format suitable for use in an Internet World-Wide-Web environment. B2H supports most commonly-used BookMaster, GML and Script/VS tags, macros and symbols.
B2H will be of interest to two audiences: those who simply want to convert existing BookMaster, GML, Script/VS or 'flat' files to HTML, and those who want to rapidly create HTML pages with many internal links, but avoid the tedious hypertext link syntax.
You don't need to know BookMaster, GML, Script/VS or HTML to do a conversion. However, those skills may be desirable if you want to create BookMaster, GML or Script/VS source files, or massage the HTML output.
B2H is a REXX program that runs under AIX, OS/2, VM/ESA, Windows 95 and Windows NT. On VM/ESA, B2H can run either as a stand-alone EXEC or as a CMS pipeline filter.
If your browser supports the HTML <FONT COLOR=> tag, updates will appear in red.
B2H reads files written in BookMaster, Generalized Markup Language (GML), Script/VS, and even 'flat' files, and converts them into HyperText Markup Language (HTML) format suitable for use in an Internet World-Wide-Web environment.
B2H is a REXX program that runs under AIX, OS/2, VM/ESA, Windows 95 and Windows NT. On VM/ESA, B2H can run either as a stand-alone EXEC or as a CMS pipeline filter.
B2H will be of interest to two audiences: those who simply want to convert existing BookMaster, GML, Script/VS or 'flat' files to HTML, and those who want to rapidly create HTML pages with many internal links, but avoid the tedious hypertext link syntax.
You don't need to know BookMaster, GML, Script/VS or HTML to do a conversion. However, these skills may be desirable if you want to create BookMaster, GML or Script/VS source files, or massage the HTML output.
B2H supports most commonly-used BookMaster, GML and Script/VS tags, macros and symbols. This document demonstrates many of the features of B2H and serves as an example of acceptable tag coding when restrictions apply. See also "Caveats and restrictions (what's supported and what's not!)".
One of the following platforms on which to run B2H:
No known restrictions
B2H is available on IBM's VM download page on the Internet at http://www.vm.ibm.com/download/. Follow the directions on the download page on how to download and extract the files.
B2H resides on the VMTOOLS disk. If your site supports the VM "TOOLCAT" command, the following will request a copy:
TOOLCAT VMTOOLS GET B2H PACKAGE
If "TOOLCAT" is not available in your environment, you can request B2H from the VMTOOLS master disk (note that it may "batch" your request with others and deliver the files on an overnight basis):
TOOLS SENDTO RALVM17 VMTOOLS VMTOOLS GET B2H PACKAGE
If you would like to subscribe to B2H so updates are automatically sent to you, enter:
TOOLCAT VMTOOLS SUBSCRIBE B2H PACKAGE
(or)
TOOLS SENDTO RALVM17 VMTOOLS VMTOOLS SUBSCRIBE B2H PACKAGE
B2H is easy to install and use right "out-of-the-box" However, advanced users who want to take advantage of the more powerful B2H and HTML features will want to perform some customization.
If you retrieved the VMARC file from the Internet, follow the instructions on the web page to upload the VMARC file to VM and then "extract" the component pieces onto a read/write disk (typically your A-disk).(5)
If you ordered the package from an internal IBM tools disk, receive the files to a read/write disk (typically your A-disk). (5)
Try converting a test file which is typical of the BookMaster, GML or Script/VS source files you will be processing:
B2H fn ft fmDownload the resulting HTML file (named "fn HTM A") to your workstation as fn.htm and point your browser at it. (6)
Try running B2H again, this time using different options to vary the output format. For example, specify your own title and don't generate a table-of-contents:
B2H fn ft fm ( TOC=NO TITLE='My sample title'To see the online help, type: B2H ?
Customize to your needs either by updating the system profile B2H PROFILE or by creating a user profile and using the USERPROF= option to process it.
If you retrieved the VMARC file from the Internet, follow the instructions on the web page to upload the VMARC file to VM and then "extract" the component pieces onto a read/write disk (typically your A-disk).
If you ordered the package from an internal IBM tools disk, receive the files to a read/write disk (typically your A-disk).
There are two ways to get the B2H files onto your workstation:
or
Caution:
If you must download the individual files, ensure that you
download B2H SEXEC and not
B2H EXEC for the main program.
B2H SEXEC contains the REXX source, whereas
B2H EXEC contains the compiled version for VM.
If downloading individual files, the suggested naming convention is:
Figure 1. Suggested naming conventions if downloading individual files
|
For use on a workstation, it is recommended that you
download B2H ZIPBIN and use one of the UNZIP-type programs to
extract the files as opposed to downloading individual files.
| |||
| VM/ESA | AIX | OS/2
(this is also the name contained within B2H ZIPBIN) | Windows 95 and Windows NT |
|---|---|---|---|
| B2H ANNOUNCE | b2h.announce | B2H.ANN | B2H.ANN |
| B2H EXEC (compiled version for VM) | not applicable | not applicable | not applicable |
| B2H SEXEC (REXX source) | b2h.exec | B2H.CMD | B2H.REX or B2H.CMD |
| B2H HELPCMS | b2h.helpcms | B2H.HLP | B2H.HLP |
| B2H NEWS | b2h.new | B2H.NEW | B2H.NEW |
| B2H PROFILE | b2h.profile | B2H.PRO | B2H.PRO |
| B2Hxxx SCRIPT | b2hxxx.script | B2Hxxx.SCT | B2Hxxx.SCT |
| B2H HTML | b2h.html | B2H.HTM | B2H.HTM |
| B2HR2 HTML | b2hr2.html | B2HR2.HTM | B2HR2.HTM |
| B2H SYMBOLS | b2h.symbols | B2H.SYM | B2H.SYM |
| B2HLINK GIFBIN | b2hlink.gif | B2HLINK.GIF | B2HLINK.GIF |
| B2HIBM FOOTER | b2hibm.footer | B2HIBM.FOT | B2HIBM.FOT |
| B2HUSER EXEC | B2HUSER.EXEC | B2HUSER.CMD | B2HUSER.CMD |
| B2HUSER SYMBOLS | b2huser.symbols | B2HUSER.SYM | B2HUSER.SYM |
Further installation information for AIX users:
rexx b2h input_file '(' options
Or, do the following two steps so you don't have to explicitly
prefix the program name with rexx:
#!/usr/bin/rexx (or wherever REXX "lives")
chmod ugo+rx b2h
Further installation information for Windows 95 and Windows NT users:
For all AIX, OS/2, Windows 95 and Windows NT users:
Try converting a test file which is typical of the BookMaster, GML or Script/VS source files you will be processing:
AIX | b2h file Point your browser at the resulting HTML file ("file.html"). |
OS/2 | B2H fn.ext Now point your browser at the resulting HTML file ("fn.htm"). |
Windows 95 | REXX B2H fn.ext Now point your browser at the resulting HTML file ("fn.htm"). |
Windows NT | REXX B2H fn.ext Now point your browser at the resulting HTML file ("fn.htm"). |
Try running B2H again, this time using different options to vary the output format. For example, specify your own title and don't generate a table-of-contents:
AIX | b2h file '(' TOC=NO TITLE='My sample title' (8) |
OS/2 | B2H fn.ext ( TOC=NO TITLE='My sample title' |
Windows 95 | REXX B2H fn.ext ( TOC=NO TITLE='My sample title' |
Windows NT | REXX B2H fn.ext ( TOC=NO TITLE='My sample title' |
To see the online help, type:
AIX: b2h ? OS/2: B2H ? Win95: REXX B2H ? WinNT: REXX B2H ?
Customize to your needs either by updating the system profile or by creating a user profile and using the USERPROF= option to process it.
The B2H package contains the following files:
| File | Also within the ZIP file? | Description |
|---|---|---|
| B2H ANNOUNCE | Yes | The announcement and installation instructions file |
| B2H EXEC | No | Main-line routine (compiled using the VM REXX Compiler) |
| B2H SEXEC | Yes | Main-line routine (REXX source) |
| B2H HELPCMS | Yes | Online help file |
| B2H NEWS | Yes | List of recent changes |
| B2H PROFILE | Yes | System profile |
| B2H SYMBOLS | Yes | System symbol definition file |
| B2HLINK GIFBIN | Yes | Default graphic image for use with ARTSHOW=LINK option |
| B2H SCRIPT
B2HSETUP SCRIPT B2HINF SCRIPT B2HSYS SCRIPT B2HUSE SCRIPT B2HEXA SCRIPT B2HAPP SCRIPT | Yes | User's Guide (BookMaster source) |
| B2H LIST3820 | No | User's Guide (3820 print-ready) |
| B2H HTML | Yes | User's Guide (HTML 3 format) |
| B2HR2 HTML | Yes | User's Guide (HTML 2 format) |
| B2HIBM FOOTER | Yes | Sample "footer" file containing standard IBM Home page linkages |
| B2HUSER EXEC | Yes | Sample user exit |
| B2HUSER SYMBOLS | Yes | Sample user symbol definitions (as distributed, allows B2H to support users of the BookHype HTML converter program) |
| B2H ZIPBIN |
| Contains the above marked files to simplify downloading to a workstation |
At startup, B2H queries the environment to determine on what platform it is running. If on OS/2, it further determines whether it should run in "FAT" or "HPFS" mode by examining the name of the input file. If the name contains more than one period, the filename is longer then eight characters or the extension is longer then three characters, then "HPFS" mode is assumed; otherwise, "FAT" mode is assumed.
This assumes you have installed B2H according to the steps described in "Quick Install-and-Go (AIX, OS/2, Windows 95 and Windows NT)".
b2h file [ '(' option1=value1 ... optionx=valuex ]
B2H fn.ext [ ( option1=value1 ... optionx=valuex ]
B2H fn fn [ft] [ ( option1=value1 ... optionx=valuex ]
PIPE ... | REXX (B2H EXEC) [ ( option1=value1 ... optionx=valuex ] | ...
or, if you copy B2H EXEC to B2H REXX ...
PIPE ... | B2H [ ( option1=value1 ... optionx=valuex ] | ...
REXX B2H fn.ext [ ( option1=value1 ... optionx=valuex ]
When B2H ends, it sets a return code corresponding to the most severe condition encountered.
RC | Description |
0 | No warnings, errors or termination messages issued |
4 | At least one warning message issued |
8 | At least one error message issued |
12 | B2H abnormally terminated |
B2H supports a wide variety of processing options (for a complete list, see "Available B2H Options"). Plus, these options can be specified in a number of places, such as within a profile, as parameters on the command line when B2H is invoked, even within the source file itself.
The following describes the various ways you can specify options and is listed in hierarchical order:
This allows you to provide processing options unique to a specific file. And since the .*B2H OPTION statement "looks" like a Script/VS comment, you can leave it in the source file without harm. See "Controlling B2H using statements within the source file" for further information.
The following attributes on BookMaster's :DOCPROF statement are also recognized as B2H options: TOC=, HEADNUM=, BODYHD0=, BODYHD1=, FBC= and QRESET=.
The syntax for this was shown previously
If you will be using B2H extensively, you may wish to customize it to reflect your personal requirements. Here are some suggested steps for customization:
Step 1 - Place B2H into the active execution path (PC only)
To run B2H from within any directory on your workstation, ensure that the directory in which B2H resides is among those searched for commands.
Include the directory name within the PATH environment variable of your shell, which is usually defined within your profile (e.g. /etc/profile and/or $HOME/.profile). You can also temporarily alter your path by assigning a new value to this environment variable and EXPORTing it (Korn shell).
Alternatively, within a directory which is already within your current path (e.g. $HOME/bin), you can place a symbolic link to the directory where you keep B2H, e.g. $HOME/b2h:
(~/bin) ln -s ../b2h/b2h b2h (~/bin)With this alternate approach, there is no need to alter the environment or execute a modified profile.
Include the directory in your PATH statement defined within CONFIG.SYS. Reboot after adding the directory to your PATH statement.
Include the directory in your PATH statement defined within AUTOEXEC.BAT. Reboot after adding the directory to your PATH statement.
Step 2 - Specify the location of the system files (PC only)
To more easily run B2H from different directories on AIX, OS/2, Windows 95 and Windows NT, place the system profile, symbol table and help file into a common directory and set the "B2HPATH" environment variable to point to the directory. (Multiple directories can be specified and searched, just separate the directory names with semi-colons.)
B2H follows these steps to locate these files:
Note: B2H will also follow the above steps when attempting to locate user profiles or symbol tables.
Step 3 - Update the B2H profile
If you wish to change the value of one or more B2H options, it's best to create a user profile and add the appropriate options to it and then add a USERPROF= statement to the system profile to point to your user profile. By not updating the system profile, you will not lose your customizations when you install an update to B2H itself -- all you need do is re-add the USERPROF= statement to the system profile.
You can also override these values using any of the methods described in "Specifying B2H options".
Options whose values are commonly changed:
DESTSYS= IMBFTEXT= FOOTER= IMBFT= HEADER= IMBPATH= HTML= IMGPATH=
Refer to "Available B2H Options" for a list of all available options.
Step 4 - Update the B2H symbol file
If you have custom symbols, commands, macros or tags for which you want to provide specialized definitions, it's best to create a user symbol file, add the appropriate definitions to it and then add a USERSYM= statement to the system or user profile to point to your user symbol file. By not updating the system symbol file, you will not lose your customizations when you install an update to B2H itself.
Step 5 - Set up Header and Footer files
Use these if you want each output HTML file to contain similar information at the beginning and/or end of the file. A sample footer file containing the standard IBM Home page navigational links is provided as part of the B2H package.
You can have multiple header and footer files. See the description of the HEADER= and FOOTER= options in "Available B2H Options" for more information.
Tip: If you customize the header and footer files, it's best to rename them to something else and use the new names with the HEADER= and FOOTER= options in the profile file. Otherwise you may lose your customization if you install an update to B2H itself.
Step 6 - Set default mast head
If you want a common mast head image displayed at the top of your files, set the MASTIMG= and MASTALT= options in your profile.
The profile is one of two B2H control files (the symbol table is the other). It contains the options that control how B2H operates.
A system profile is provided as part of the B2H package. Any desired updates can be made either to the system profile or you can create user profiles and add one or more USERPROF= options to the system profile to point to the user profile(s).
You can always override option values using any of the methods described in "Specifying B2H options".
| Format of a profile record |
|---|
[(platform)] option=value [ ... optionx=valuex ] |
The option's value must be specified immediately after the equal-sign (no blanks allowed), e.g. MSGLEVEL=WARNING.
If the value contains a blank, then the entire value must be enclosed in either single-quote or double-quote characters:
ABSTRACT='How to play the piano'
Blank records or records with an asterisk in column one are considered comments and ignored.
Many B2H options allow you to specify the name of a file. The syntax of the file must satisfy the naming convention of the platform for which the option is applicable. For example, if specifying the name of the physical output file and running B2H on OS/2, the filename must conform to OS/2 naming conventions, e.g.
OUTPUTP=c:\pubs\abc.htm
If specifying a file using VM naming conventions, you will need to enclose the file in single or double-quotes, e.g.
OUTPUTP='ABC HTML A'
You can specify that a physical record be applicable to certain platform(s) by indicating the platform name(s) within parentheses as the first item on the record.
If multiple conditions are specified, all must be true for the record to be used.
Valid platform names:
AIX | Signifies the AIX platform |
CMS | Signifies the CMS (VM/ESA) platform |
HPFS | Signifies the OS/2 platform using the HPFS file system |
OS2 | Signifies the OS/2 platform using the FAT file system |
PC | Signifies the AIX, OS/2 (both FAT and HPFS), Windows 95 or Windows NT platforms |
WIN95 | Signifies the Windows 95 platform |
WINNT | Signifies the Windows NT platform |
(CURR=OS2) ... use if running on OS/2 (FAT) (OS2) ... same as above (CURR= assumed if omitted) (DEST=AIX) ... use if AIX is the destination platform (CURR=CMS DEST=AIX) ... if on CMS and AIX is the destinationAnother example: Define the IMBFT option differently based on platform
(AIX) IMBFT=script (CMS) IMBFT=SCRIPT (HPFS) IMBFT=script (OS2) IMBFT=scr (WIN95) IMBFT=scr (WINNT) IMBFT=scr
If no parenthesed platform name is specified, the record is applicable on all platforms.
For information on how B2H determines the current platform on which it's running, see "How B2H determines the current platform".
Figure 2. B2H options - Overview
Destination system
DESTSYS={ AIX | HPFS | OS2 | VM | WIN95 | WINNT }
Input File Characteristics
EXPDATE=[ yyyymmdd | text ]
REVDATE=[ yyyymmdd | text ]
SOURCE='{SCRIPT|FLAT },[pre],[blanksub]'
SYMCHARS='ccc...ccc'
Table-of-Contents, Indexing & Sectioning
BODYHD0='text'
BODYHD1='text'
FBC={ YES | NO }
FIGLIST={ YES | NO }
FTSEP={ YES | NO }
HEADNUM={ YES | NO | num | *num }
INDEX={ YES | NO } {INDEX|NOINDEX}
INDEXSORT.SPEC='x[-y] ... x[-y]'
INDEXSORT.NUM='x[-y] ... x[-y]'
INDEXSORT.LETTER='x[-y] ... x[-y]'
INDEXTOC={ YES | NO | number | 50 }
INDEXTOCTAG='ts,te,ss,se,ns,ne,as,ae'
PTOC={ NO | num | *num | 4 }
TLIST={ YES | NO }
TOC={ YES | NO | num | *num }
TOCC={ YES | NO }
TOCINDENT={ YES | NO }
TOCSUPPRESS={ 0 | number }
Hyperlinking within the file
FNLINK={ NO | TO | FROM | BOTH }
FTLINK={ YES | NO }
TOCRET={ NO | TOC | PTOC | PTOCx }
File Locations, Names and Format
IMBFT={ script | ext } (AIX)
IMBFT={ script | ext } (HPFS)
IMBFT={ scr | ext } (OS/2)
IMBFT={ SCRIPT | ft } (VM)
IMBFT={ scr | ext } (WIN95)
IMBFT={ scr | ext } (WINNT)
IMBFTEXT='{YES|NO}, {ASIS|LC|UC}, ft=ext ...'
IMBPATH={ CLEAR | path[;path;...;path] }
IMGPATH='path'
OUTPUTFM={ A | disk }
OUTPUTL='logical-output-file'
OUTPUTL83={ YES | NO }
OUTPUTLCASE={ ASIS | LC | UC }
OUTPUTP='physical-output-file'
OUTPUTP83={ YES | NO }
OUTPUTPCASE={ ASIS | LC | UC }
PARTDIGITS='{2|num}, {DEC|HEX|ALPHA}'
PARTDIR[.x[-y]]='physical-directory,logical-directory'
PARTNAME.x='[physical-file-name],[logical-file-name]'
Artwork & Graphics
ARTLINKIMG={ B2HLINK.GIF | image.ext }
ARTSHOW={ VIEW | LINK | NONE }
ARTTYPE={ GIF | imagetype }
Controlling DVCF sectioning DVCF='cond1 cond2 ... condx' SYSVAR='0 file' SYSVAR='1 cond1 2 cond2 ... 9 cond9'
HTML file's content & structure
ABSTRACT='text'
ANNOT={ YES | NO }
AUTOPART='{NO|YES|num|*num} [LEN=value] {IMBED|NOIMBED}{SETUP|NOSETUP}'
BODYTAG='text'
CENTERTAG={ YES | NO }
COMMENT={ 'text' | CLEAR }
COMMENTHEAD='text'
CONTACT='text'
DLFMT={ DL | TABLE }
DLTAG.x='ls,le,ts,te,ds,de'
FIGCAPLOC={ BEFORE | AFTER }
FOOTER={ NO | file }
GLTAG.x='ls,le,ts,te,ds,de'
H3ADDONS={ YES | NO }
H3TABLE={ COMPLEX | SIMPLE }
HEADER={ NO | file }
HRTAG.x={ <HR> | tag }
HTML={ 2 | 3 }
HTMLEXT={ html | ext } (AIX)
HTMLEXT={ html | ext } (HPFS)
HTMLEXT={ htm | ext } (OS/2)
HTMLEXT={ htm | ext } (VM)
HTMLEXT={ htm | ext } (WIN95)
HTMLEXT={ htm | ext } (WINNT)
HTMPEXT={ html | ext } (AIX)
HTMPEXT={ html | ext } (HPFS)
HTMPEXT={ htm | ext } (OS/2)
HTMPEXT={ HTM | ext } (VM)
HTMPEXT={ htm | ext } (WIN95)
HTMPEXT={ htm | ext } (WINNT)
INDEXTAG='ls,le,ts,te,is,ie'
LINEWIDTH={ 78 | number }
LIREF={ NO | ID | NUM }
MASTALT='alternate text'
MASTIMG='file.ext, { ALL | FIRST }'
META={ YES | NO }
METAKEYS='key1 key2 ... keyx'
NOTELTAG.x='ls,le,is,ie'
OLTAG.x='ls,le,is,ie'
OWNER='text'
PARTLINK={ YES | NO }
PARTLINK.x='text | CLEAR'
REVTAG='revtext,erevtext'
REVTAG.id='revtext,erevtext'
SHADE.name=rrggbb
SLTAG.x='ls,le,is,ie'
SYSVAR='A { YES | NO }'
TABLE2='fl,fm,fr,fv,fhn,fhh,gutl,gutr'
TFIGLISTTAG.x='ls,le,is,ie'
TOCTAG='ls,le,ts,te'
TOPHEAD={ 1 | 2 | 3 | 4 | 5 | 6 | NO }
TITLE='text'
ULTAG.x='ls,le,is,ie.'
XEDITG={ YES | NO }
Question & Answer
QRESET={ NO | 0 | 1 | ... | 19 | 20 }
QUESTION=TEXT
QUESTION='FORM,[method],url-of-cgi,[answer-action],[optdata]'
Miscellaneous
ALARM={ YES | NO | number | 5 }
B2HREQ={ YES | NO }
DEFTEXT.name='text'
DOCDESC='file'
DOCDESC.id='file'
IMBEDID={ YES | NO }
LOG={ NO | YES | file }
LTGT={ ASIS | CONVERT }
MSGLEVEL={ INFO | WARNING | ERROR }
PROCACT='sit=action sit2=action2 ... sitx=actionx'
PSC='process1 process2 ... processx'
SHOWLINES={ NO | num }
SYSVAR='W file'
TAGCHECK={ YES | NO }
USERPROF=file
USERSYM=file
|
ABSTRACT='Murphy''s Laws'causes the following to be generated:
<META HTTP-EQUIV="abstract" CONTENT="Murphy's Laws">
| YES | The audible alarm is always sounded |
| NO | The audible alarm is never sounded |
| number | The audible alarm is sounded only this many times; warning or error messages after this number are issued silently |
| YES | Process annotations |
| NO | Do not process annotations (default) |
Note: The B2HLINK.GIF file is supplied within the B2H ZIPBIN file.
| VIEW | The HTML "IMG SRC=" will be generated to cause the image to be loaded immediately at browse time |
| LINK | A link will be provided to the graphic, but the user must select it to see the image (the text defined for the DEFTEXT.ARTLINK option will be shown as the text for the link) |
| NONE | Ignore the :ARTWORK tag. |
| YES | If specified, then only the .*B2H OPTION format is allowed and the .*OPTION format is ignored |
| NO | If specified, then either the .*B2H OPTION or .*OPTION formats may be used |
COMMENTHEAD='&b2hiall converted by &b2hsig (&b2hplat) &b2huser
on &date at &time'
CONTACT='doe@vnet.ibm.com'causes the following to be generated:
<META HTTP-EQUIV="contact" CONTENT="doe@vnet.ibm.com">
Figure 3. DEFTEXT.name= values
| Option | Default value | Where used |
|---|---|---|
| DEFTEXT.ABBREV | "List of Abbreviations" | Default text for :ABBREV tag |
| DEFTEXT.ABSTRACT | "Abstract" | Default text for :ABSTRACT tag |
| DEFTEXT.APPENDIX | "Appendix" | Default text for :APPENDIX tag |
| DEFTEXT.ARTLINK | "View figure." | Text to show for a graphic link when ARTSHOW=LINK |
| DEFTEXT.BIBLIOG | "Bibliography" | Default text for :BIBLIOG tag |
| DEFTEXT.COPYR | "© Copyright &b2hcopyr. &b2hcoprext" | Default text used in conjunction with the COPYR= attribute on either the :GDOC or :USERDOC tag. |
| DEFTEXT.DAYS | "Mon Tue Wed Thu Fri Sat Sun" | Days-of-the-week for use with RFC 822 date conversions, such as for EXPDATE= and REVDATE=. |
| DEFTEXT.FIGLIST | "Figures" | Default text for :FIGLIST tag |
| DEFTEXT.FIGURE | "Figure" | Default text used with the figure number in conjunction with the :FIGCAP tag |
| DEFTEXT.FOOTNOTES | "Footnotes" | Default text used to indicate the beginning of the footnotes |
| DEFTEXT.GLOSSARY | "Glossary" | Default text for :GLOSSARY tag |
| DEFTEXT.HTMLCMTL | "<!-- " | Left or beginning portion of an HTML comment |
| DEFTEXT.HTMLCMTR | " -->" | Right or ending portion of an HTML comment |
| DEFTEXT.HTMLHEAD | "<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML &b2hhtml//EN">" | The first physical record of an HTML output file |
| DEFTEXT.IBMCOPYR | "<B>© Copyright International Business Machines Corporation &b2hibmcopyr.. All rights reserved. &b2hcoprext.</B> <BR>Note to U.S. government Users -- Documentation related to restricted rights -- Use, duplication or disclosure is subject to restrictions set forth in GSA ADP Schedule contract with IBM Corp." | Default text used in conjunction with the IBMCOPYR= attribute on the :USERDOC tag. |
| DEFTEXT.INDEX | "Index" | Default text for :INDEX tag |
| DEFTEXT.INDEX0 | "Special Characters" | Used as a header within the sorted index |
| DEFTEXT.INDEX1 | "Numerics" | Used as a header within the sorted index |
| DEFTEXT.INDEX2 | "See also" | Used within the sorted index |
| DEFTEXT.INDEX3 | "See" | Used within the sorted index |
| DEFTEXT.LEGEND | "Legend" | Default text for :LEGEND tag |
| DEFTEXT.MONTHS | "Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec" | Months-of-the-year for use with RFC 822 date conversions, such as for EXPDATE= and REVDATE=. |
| DEFTEXT.NOTE | "Note" | Default text for :NOTE tag |
| DEFTEXT.NOTEL | "Notes" | Default text for :NOTEL tag |
| DEFTEXT.NT | "Note" | Default text for :NT tag |
| DEFTEXT.PREFACE | "Preface" | Default text for :PREFACE tag |
| DEFTEXT.PTOC | "Partial Table-of-Contents" | Default text to identify a partial table-of-contents |
| DEFTEXT.PTOCLT | "(Go to main Table-of-Contents)" | Default text for a PTOC's hyperlink back to the main table-of-contents (see TOCRET=PTOCx options for more info) |
| DEFTEXT.QANSREF | "the answer to question" | Default text used in conjunction with the :ANSREF tag. |
| DEFTEXT.QQREF | "question" | Default text used in conjunction with the :QREF tag. |
| DEFTEXT.SAFETY | "Safety" | Default text for :SAFETY tag |
| DEFTEXT.SCHEDACTHD | "Activities" | Default text for :SCHEDULE ACTHD= |
| DEFTEXT.SOA | "Summary of Amendments" | Default text for :SOA tag |
| DEFTEXT.SPOT1 | "Ref #" | Default text at the location of a :SPOT tag if the XREFTEXT attribute is omitted. |
| DEFTEXT.SPOT2 | " reference #" | Default text at the location of a :SPOTREF tag if the XREFTEXT attribute is omitted from the :SPOT tag itself. |
| DEFTEXT.T2XREF | "the appropriate section" | Text to show for a forward cross-reference link within an HTML 2 table (for more info, see "Table support with HTML Release 2") |
| DEFTEXT.TABLE | "Table" | Default text used with the table number in conjunction with the :TCAP tag |
| DEFTEXT.TLIST | "Tables" | Default text for :TLIST tag |
| DEFTEXT.TOC | "Table of Contents" | Default text for the :TOC tag |
Note: If the destination system is DOS/Windows, you should still specify "OS2".
For information on how B2H determines the current platform on which it's running, see "How B2H determines the current platform". See also "Cross-Platform considerations".
| DL | Map to HTML's standard definition-list tags (e.g. <DL>) This is the default. |
| TABLE | Map to a two-column unframed table. Available only when generating HTML 3 output. |
| x | Used for: |
| 0 | HTML tags for a non-compact list when DLFMT=DL |
| 1 | HTML tags for a compact list (e.g. :DL COMPACT) when DLFMT=DL |
| 2 | HTML tags for a non-compact list when DLFMT=TABLE |
| 3 | HTML tags for a compact list (e.g. :DL COMPACT) when DLFMT=TABLE |
HTML tag values:
| ls | List start |
| le | List end |
| ts | Text start |
| te | Text end |
| ds | Definition start |
| de | Definition end |
DLTAG.0='<DL>,</DL>,<P><DT>,,<DD>,'
DLTAG.1='<DL COMPACT>,</DL>,<DT>,,<DD>,'
DLTAG.2='<TABLE CELLPADDING=3>,</TABLE>,<TR VALIGN=TOP><TD><P>,</TD>,
<TD><P>,</TD></TR>'
DLTAG.3='<TABLE CELLPADDING=3>,</TABLE>,<TR VALIGN=TOP><TD>,</TD>,
<TD>,</TD></TR>'
| id | The value specified for ID= on the :DOCDESC tag. If omitted, this definition applies to all :DOCDESC tags. |
| file | The HTML file containing this document |
This: DVCF='sport wagon truck' Is equivalent to: SYSVAR='1 sport 2 wagon 3 truck'
Example: An input file with a date/time stamp of "1996-05-03 12:34:56" and EXPDATE=19960727, the following is generated:
<META HTTP-EQUIV="expires" CONTENT="Sat, 27 Jul 1996 12:34:56">Allows the server to generate an HTTP response header if expiration date information is requested.
| BEFORE | The figure's caption (and any description) is placed before the figure. Since the caption is the "anchor" for any hyperlinks to the figure, this is the preferred location. |
| AFTER | The figure's caption (and any description) is placed after the figure. This is how GML and BookMaster work, but causes hyperlinks to jump to the bottom of the figure. |
| NO | Do not generate hyperlinks |
| TO | Generate hyperlink from footnote usage to definition |
| FROM | Generate hyperlink from footnote definition to it's usage |
| BOTH | Generate hyperlinks both ways |
| x | Used for: |
| 0 | HTML tags for a non-compact list |
| 1 | HTML tags for a compact list (e.g. :GL COMPACT) |
HTML tag values:
| ls | List start |
| le | List end |
| ts | Text start |
| te | Text end |
| ds | Definition start |
| de | Definition end |
GLTAG.0='<DL>,</DL>,<P><DT>,,<DD>,' GLTAG.1='<DL COMPACT>,</DL>,<DT>,,<DD>,'
Note: At the time of this writing, the IBM Web Explorer did not support
the HTML 3 WIDTH= parameter.
Default: H3ADDONS=YES
| x | Tag used for: |
| 1 | :ARTWORK RULE |
| 2 | :FIG when FRAME= value is not NONE (not used when creating HTML 3 output) |
| 3 | To precede an :H1 in the text |
| 4 | :MSGL and :CODEL when STYLE=RULE specified |
| 5 | (Reserved) |
| 6 | Preceding the Table-of-Contents |
| 7 | To precede an :H0 in the Table-of-Contents |
| 8 | To end the Table-of-Contents |
| 9 | Preceding the list of footnotes |
| 10 | Preceding a :LEN tag if SEP=RULE specified by the :LERS tag |
Note: In most cases, it is recommended that the DESTSYS= option be used, since it will set this option appropriately.
Note: This option is ignored and a warning message issued if specified on a .*B2H OPTION statement within the source file.
See also "Cross-Platform considerations".
Note: In most cases, it is recommended that the DESTSYS= option be used, since it will set this option appropriately.
Note: This option is ignored and a warning message issued if specified on a .*B2H OPTION statement within the source file.
See also "Cross-Platform considerations".
| YES | Insert comment records |
| NO | Do not insert comment records (default) |
The following markup formats are supported by this option:
.im (fn ft) .namefile name=nid cms='fn ft' .im nid .dd abc fn ft .im abc
yesno | Whether extended filetype processing should be done
| ||||||
case | How should the "case" of the resultant file be handled?
| ||||||
ft=ext | Allows you to "map" a specific filetype to a specific extension. This is almost always required if you are running on an OS/2 FAT system since a VM filetype can be up to eight characters, but the OS/2 FAT extension is limited to three characters. Multiple mappings can be defined, each specified as "ft=ext", such as "manual=man", "report=rpt", "listing=lst", etc. For example:
If: IMBFTEXT='YES,LC,REPORT1=RP1 REPORT2=RP2'
IMBFT=script
Then: .im (abc report1) maps to: .im abc.rp1
.im (abc report2) maps to: .im abc.rp2
.im (abc sample) maps to: .im abc.sample
.im (abc) maps to: .im abc.script
.im abc maps to: .im abc.script
|
x | A single character or a 2-digit hexadecimal code |
y | Specifies that a range of characters is being defined. If specified, the hex value of "y" must "exceed" that of "x". If omitted, only the "x" character is defined. |
Notes:
INDEXSORT.SPEC='00-FF' INDEXSORT.NUM='0-9' INDEXSORT.LETTER='A-Z'
INDEXSORT.SPEC='F5-05' (not allowed) INDEXSORT.SPEC='F5-FF 00-05' (OK)
See "Ensuring the index is sorted appropriately" for information on when the INDEXSORT option is typically used.
| ls | Start tag for a common level of indices |
| le | End tag for a common level of indices |
| ts | Start tag for a specific reference within a level |
| te | End tag for a specific reference within a level |
| is | Start tag for identifying the first letter of a block of indices |
| ie | End tag for identifying the first letter of a block of indices |
| YES | Always generate an index TOC if an index is created |
| NO | Never generate an index TOC |
| number | If the number of entries in the index equals or exceeds this value, then build an index TOC. Otherwise, do not build an index TOC. |
| ts | Tag for the beginning of the index TOC |
| te | Tag for the end of the index TOC |
| ss | Start tag for the "Special Characters" index TOC entry |
| se | End tag for the "Special Characters" index TOC entry |
| ns | Start tag for the "Numerics" index TOC entry |
| ne | End tag for the "Numerics" index TOC entry |
| as | Start tag for an alphabetic-letter index TOC entry |
| ae | End tag for an alphabetic-letter index TOC entry |
| .CE | If CENTERTAG=NO, used to determine the number of leading blanks |
| .SX | To determine center and right-justification spacing |
| .TABRACK | For correctly spacing the tab stops |
| :LBLBOX | Used to draw the box header and trailer (HTML 2 only) |
| :QUALIF | Used to draw the qualification box header and trailer |
| :SCREEN | Used if the WIDTH= option is omitted to correctly draw the screen border |
| :TABLE | If HTML=2, used to correctly build the table using a monospaced font |
| NO | All list-item references are ignored |
| ID | The ID name for ":LI ID=name" is italicized and inserted at both the beginning of the list item and also when referenced using ":LIREF REFID=name" |
| NUM | Same as above, except that for ordered lists (:OL), no text is inserted at the list item definition and the item's number is used at the reference point (this is how BookMaster works). If the user's web browser does not use a numeric numbering scheme (which can occur for deeply nested ordered-lists), you may need to specify LIREF=ID |
METAKEYS='do re mi'causes the following to be generated:
<META HTTP-EQUIV="keywords" CONTENT="do re mi">
| x | Used for: |
| 0 | HTML tags for a non-compact list |
| 1 | HTML tags for a compact list (e.g. :NOTEL COMPACT) |
HTML tag values:
| ls | List start |
| le | List end |
| is | List item start |
| ie | List item end |
NOTELTAG.0='<OL>,</OL>,<P><LI>,' NOTELTAG.1='<OL COMPACT>,</OL>,<LI>,'
| x | Used for: |
| 0 | HTML tags for a non-compact list |
| 1 | HTML tags for a compact list (e.g. :OL COMPACT) |
HTML tag values:
| ls | List start |
| le | List end |
| is | List item start |
| ie | List item end |
OLTAG.0='<OL>,</OL>,<P><LI>,' OLTAG.1='<OL COMPACT>,</OL>,<LI>,'
See also "Cross-Platform considerations".
| YES | Files must honor 8.3 names (e.g. CMS, OS/2 with FAT, Windows 95 and Windows NT) |
| NO | Not necessary to honor 8.3 names (e.g. AIX, OS/2 with HPFS) |
See also "Cross-Platform considerations".
| ASIS | Leave the file names "as-is" |
| LC | Explicitly lower-case the file names |
| UC | Explicitly upper-case the file names |
See also "Cross-Platform considerations".
If the output HTML file is being split, then all output files will be placed into the same location, either the specified directory (AIX, OS/2, Windows 95 or Windows NT) or the specified mini-disk (VM).
See also "Cross-Platform considerations".
| YES | Files must honor 8.3 names (e.g. OS/2 with FAT, Windows 95 and Windows NT) |
| NO | Not necessary to honor 8.3 names (e.g. AIX, OS/2 with HPFS) |
See also "Cross-Platform considerations".
| ASIS | Leave the file names "as-is" |
| LC | Explicitly lower-case the file names |
| UC | Explicitly upper-case the file names |
See also "Cross-Platform considerations".
OWNER='John Doe'causes the following to be generated:
<META HTTP-EQUIV="owner" CONTENT="Joe Doe">
The second parameter specifies the type of numbering to use.
| DEC | Decimal (base 10) numbering using the digits 0-9 (this is the default) |
| HEX | Hexadecimal (base 16) numbering using the digits 0-9,A-F |
| ALPHA | Alphanumeric (base 36) numbering using the digits 0-9,A-Z |
The following syntaxes are accepted:
Notes:
"x" is a numeric value from 1 to 6 or 11 to 16.
Values 1 to 6 are used if an index is not being generated:
| 1 | Text to insert at the top of the first output HTML file. No default text is provided for this value. |
| 2 | Text to insert at the bottom of the first output HTML file. The default text contains hyperlinks to the top-of-page and to the next page. |
| 3 | Text to insert at the top of the middle (not the first, but not the last) output HTML file. No default text is provided for this value. |
| 4 | Text to insert at the bottom of each middle (not the first, but not the last) output HTML file. The default text contains hyperlinks to the top-of-page, previous page, next page and to the table-of-contents. |
| 5 | Text to insert at the top of the last output HTML file. No default text is provided for this value. |
| 6 | Text to insert at the bottom of the last output HTML file. The default text contains hyperlinks to the top-of-page, previous page and to the table-of-contents. |
Values 11 to 16 are used if an index is being generated:
| 11 | Text to insert at the top of the first output HTML file. No default text is provided for this value. |
| 12 | Text to insert at the bottom of the first output HTML file. The default text contains hyperlinks to the top-of-page, next page and to the index. |
| 13 | Text to insert at the top of the middle (not the first, but not the last) output HTML file. No default text is provided for this value. |
| 14 | Text to insert at the bottom of each middle (not the first, but not the last) output HTML file. The default text contains hyperlinks to the top-of-page, previous page, next page, table-of-contents and to the index. |
| 15 | Text to insert at the top of the last output HTML file. No default text is provided for this value. |
| 16 | Text to insert at the bottom of the last output HTML file. The default text contains hyperlinks to the top-of-page, previous page, table-of-contents and to the index. |
Appendix B. "&variables pre-defined by B2H" lists the &variables which are provided with the intent of their being used within a PARTLINK.x= definition.
To facilitate entering long strings of text, you can specify each option as many times as desired, the values are accumulated. Specifying a value of CLEAR erases all text for a given option.
PARTNAME.4='PROJDEF HTML A,projdef.htm'This specifies that the fourth output file should be physically created as "PROJDEF HTML A" and logically known as "projdef.htm". See "Specifying the location and file names when splitting the HTML output" for more information.
Notes:
| IGNORE | Ignore the situation completely, no message issued, the return code (RC) is not updated |
| INFO | Issue an info-only type message, RC not updated |
| WARNING | Issue a warning message (RC set to 4 if not already higher) |
| ERROR | Issue an error message (RC set to 8 if not already higher), continue execution |
| TERM | Terminate B2H (RC set to 8) |
The situations you can control:
| NOENDTAG | The end-tag for certain BookMaster/GML tags were not found (e.g. :TITLE with no :ETITLE, :TABLE with no :ETABLE) |
| NOIMBED | A file being imbedded can not be found |
| NOPER | A BookMaster/GML tag is missing it's terminating period |
| NOXREF | The target of a cross-reference tag can not be found (e.g. :FIG ID=abc. not found for a :FIGREF REFID=abc.) |
| UNKTAG | An unknown BookMaster/GML tag was encountered |
Initial settings:
PROCACT='NOENDTAG=WARNING NOIMBED=ERROR NOPER=WARNING' PROCACT='NOXREF=ERROR UNKTAG=WARNING'
In addition to what is specified here, B2H also adds either the
"HTML2" or "HTML3" process,
corresponding to the HTML level being generated. This allows you to
include/exclude text based on HTML level.
Default: PSC='CHAR HTML'
plus either HTML2 or HTML3
Note: QRESET=1 is assumed if FBC=YES is specified.
| NO | Questions are numbered sequentially from the beginning of the document to the end |
| 0 | Reset question numbering at each head level 0 (:H0) |
| 1 | Reset question numbering at head levels 0 and 1 (:H0 and :H1) |
| 2 | Reset question numbering at head levels 0 through 2 |
| · | · |
| 20 | Reset question numbering at head levels 0 through 20 |
| {TEXT|FORM} | Controls whether Question & Answer tags are converted to blocks
of text (which is what BookMaster does) or HTML FORMs
| ||||||
| method | If generating HTML forms, this defines the HTTP method for form
input, e.g. <FORM METHOD=xxx>.
| ||||||
| url-of-CGI | If generating HTML forms, this defines the URL for the CGI
program to verify the answers,
e.g. <FORM ACTION="url-of-CGI">.
Default: '' (none) | ||||||
| answer-action | If generating HTML forms, this defines how the answers
are handled (obtained from the ANS= or ANSID= attributes on the
:QUESTION, :BLANK,
:MATCH or :QITEM tags)
| ||||||
| optdata | If generating HTML forms,
this specifies any optional data to insert
into a hidden field for each question, like this:
<INPUT TYPE=HIDDEN NAME=OPTDATA VALUE="...."> Often used to pass information to the CGI about where to find a question's answer, such as the name of the answer file or a database name. Default: '' (none) |
Example: An input file with a date/time stamp of "1996-05-03 12:34:56" and REVDATE=19960727, the following is generated:
<META HTTP-EQUIV="review" CONTENT="Sat, 27 Jul 1996 12:34:56">Allows the server to generate an HTTP response header if review date information is requested.
:revision id=abc run=yes char="!". .rc 1 !The REVTAG option allows you to specify the text to insert when the active :REV and :EREV tags or the .RC command is encountered, such as:
:rev refid=abc. :erev refid=abc. .rc 1 on .rc 1 offThe REVTAG option can be specified with or without the "id" qualifier. If "id" is omitted, the text is used for all active :REV/:EREV tags and .RC x ON/OFF commands. If "id" is specified, the text is used only for those active :REV/:EREV tags with REFID=id, or .RC x ON/OFF where x matches "id". (The &b2hrevchar symbol contains the currently-active revision code character in case you wish to include it in the text.)
| revtext | Text and/or HTML tag(s) to insert for a :REV tag or .RC x ON command |
| erevtext | Text and/or HTML tag(s) to insert for a :EREV tag or .RC x OFF command |
SECURITY='public'causes the following to be generated:
<META HTTP-EQUIV="security" CONTENT="public">
Figure 4. Default SHADE.name= option values
| Option: | HTML generated: | Shows as: |
|---|---|---|
| SHADE.XLIGHT=DADADA | BGCOLOR=#DADADA | Extra-Light Gray |
| SHADE.LIGHT=B0B0B0 | BGCOLOR=#B0B0B0 | Light Gray |
| SHADE.MEDIUM=8C8C8C | BGCOLOR=#8C8C8C | Medium Gray |
| SHADE.DARK=6E6E6E | BGCOLOR=#6E6E6E | Dark Gray |
| SHADE.XDARK=585858 | BGCOLOR=#585858 | Extra-Dark Gray |
| SHADE.YES=B0B0B0 | BGCOLOR=#B0B0B0 | Light Gray |
| SHADE.SCREEN=B0B0B0 | BGCOLOR=#B0B0B0 | Light Gray |
Note: "SHADE.SCREEN=" specifies the shading to use for the :SCREEN tag if SHADE=SCREEN is specified on the :DOCPROF tag.
| x | Used for: |
| 0 | HTML tags for a non-compact list |
| 1 | HTML tags for a compact list (e.g. :SL COMPACT) |
HTML tag values:
| ls | List start |
| le | List end |
| is | List item start |
| ie | List item end |
SLTAG.0='<DL>,</DL>,<DD><P>,' SLTAG.1='<DL COMPACT>,</DL>,<DD>,'
If the input is a 'flat' file, additional processing options are available.
| PRE | The entire file is enclosed within <PRE></PRE>. (This is the default) |
| NOPRE | No <PRE> and </PRE> tags are inserted into the text
Careful! If you specify this and do not specify anything for blanksub, the browser may format the entire file into one big paragraph! |
| num | If this many columns at the start of an input record are blank, the record is enclosed in <PRE></PRE>, otherwise no additional <PRE></PRE> tags are inserted. |
| NO | Blank records are written "as-is" (default) |
| YES | A <P> tag is substituted for a blank record |
| text | Replace a blank record with this text |
| CHAR | Value and Meaning | ||||
|---|---|---|---|---|---|
| A | Controls the processing of annotation text marked up
using the :ANNOT. and :EANNOT. tags.
See also the ANNOT= option.
| ||||
| W | The file where extended cross-reference information should be
written. (See also "Cross-referencing multi-volume documents")
If specified, this should be the last parameter
specified for this SYSVAR option. If a filetype or extension is
specified, it is ignored.
If SYSVAR='W book1' is specified, the file created is: book1.b2hxrefs (AIX) BOOK1.B2X (OS/2) BOOK1 B2HXREFS (VM) BOOK1.B2X (WIN95) BOOK1.B2X (WINNT) If SYSVAR='W projug', then: projug.b2hxrefs (AIX) PROJUG.B2X (OS/2) PROJUG B2HXREFS (VM) PROJUG.B2X (WIN95) PROJUG.B2X (WINNT) And if SYSVAR='W acmea.abc', then: acmea.b2hxrefs (AIX) ACMEA.B2X (OS/2) ACMEA B2HXREFS (VM) ACMEA.B2X (WIN95) ACMEA.B2X (WINNT) Note: On AIX, OS/2, Windows 95 or Windows NT, if a path is specifed, the file is placed into that directory; else the file is placed into the working directory. On VM/ESA, the file is placed on the disk specified by the OUTPUTFM= option. | ||||
| 0 | DVCF conditions file; can be set to the name of a
file(10)
that contains symbols definitions for DVCF conditions. If specified,
this should be the last parameter specified for this SYSVAR
option.
file (AIX) file.ext (OS/2) fn ft fm (VM) file.ext (WIN95) file.ext (WINNT)This is the best method if you have a lot of conditions to set and you frequently set them in the same combination. If your file of condition names were named sysvars.def, you would specify: SYSVAR='0 sysvars.def'and the file would contain this markup to set the conditions true: .setdvcf sport on .setdvcf truck onor this to set the conditions false: .setdvcf sport off .setdvcf truck offThis is the SETDVCF macro, which generates a symbol and allows you to set DVCF conditions on or off. | ||||
| 1-9 | DVCF conditions. Each of the nine variables be set to an individual
condition name. If you want to set the WAGON and
SPORT conditions to true:
SYSVAR='1 WAGON 2 SPORT'See also the DVCF= option. |
| fl | Frame: left edge character |
| fm | Frame: middle junction character |
| fr | Frame: right edge character |
| fv | Frame: Vertical character |
| fhn | Frame: Horizontal character - normal data cell |
| fhh | Frame: Horizontal character - header/footer cell |
| gutl | Cell gutter string - left |
| gutr | Cell gutter string - right |
Note: If you are using B2H in conjunction with a web server to convert documents to HTML in "real-time", you can improve performance slightly by specifying TAGCHECK=NO.
| x | Used for: |
| 0 | HTML tags when Folio-By-Chapter is not in effect (FBC=NO) |
| 1 | HTML tags when Folio-By-Chapter is in effect (FBC=YES) |
HTML tag values:
| ls | List start |
| le | List end |
| is | Item start |
| ie | Item end |
TFIGLISTTAG.0='<OL>,</OL>,<LI>,</LI>' TFIGLISTTAG.1='<P>,<P>,,<BR>'
The different PTOCx values specify whether a PTOC should also contain a hyperlink back to the main TOC, and if so, the appearance and position of the hyperlink
If omitted, zero is assumed meaning that a TOC will be generated if
requested and it contains at least one entry.
Default: TOCSUPPRESS=0
| ls | Start tag for a common level of headers (e.g. :H1.) |
| le | End tag for a common level of headers (e.g. :H1.) |
| is | Start tag for a specific header in the list |
| ie | End tag for a specific header in the list |
This top-of-physical-file title can be very useful for:
| x | Used for: |
| 0 | HTML tags for a non-compact list |
| 1 | HTML tags for a compact list (e.g. :UL COMPACT) |
HTML tag values:
| ls | List start |
| le | List end |
| is | List item start |
| ie | List item end |
ULTAG.0='<UL>,</UL>,<P><LI>,' ULTAG.1='<UL COMPACT>,</UL>,<LI>,'
The symbol table is one of two control files for B2H (the profile is the other). A symbol table defines:
A system symbol table is provided as part of the B2H package. Any desired updates can be made either to the system symbol table or you can create user symbol tables and add one or more USERSYM= options to the profile to point to the user symbol table(s).
The general format of a symbol table record is:
| Format of a symbol table record |
|---|
[(platform)] :stmttype. name parm1=value1 [ ... parmx=valuex ] |
A parameter's value must be specified immediately after the equal-sign (no blanks allowed). If the parameter's value is a string, the string must be enclosed using a delimiter character (any character not appearing in the string may be used as the delimiter). For example:
V='Document Number:' V="Murphy's Law" V=/Bugs Bunny says "What's Up, Doc?"/
Physical records with an asterisk in column 1 or records that are completely blank are considered comments and ignored. Comments may be placed on the definition record itself by preceding the comment with two dashes (--).
You can specify that a record is applicable to only a certain platform by specifying the platform's name within parentheses as the first item on the record. For more information, see "Platform-specific definitions"
A logical definition can be split into multiple physical records. If the logical statement continues onto the next physical record, place a comma at the end of the current physical record (prior to any comments) to indicate that the statement continues onto the next physical record.
This: :TAG. CIT V='<CITE>' TV='<CITE>' -- a comment
is the same as: :TAG. CIT V='<CITE>', -- a comment
TV='<CITE>'
The continuation comma may not be specified in the middle
of a delimited string.
The :SYM. statement defines replacement text for a
symbol (sometimes called an "&symbol" or
"&variable").
For example: &date &colon &rbrk
Figure 5. Specifying an '&symbol'
[(platform)] :SYM. symbol [... symbol ] V='text' |
B2H also dynamically assigns &symbols when it encounters GML's .SE command, and BookMaster's .NAMEIT, .NAMECTR and .GETW macros.
The :CMD. statement defines replacement text for a
Script/VS control word or BookMaster/GML macro. (These are the "dot" commands.)
For example: .cp .pa .se
Figure 6. Specifying a Script/VS control word and/or BookMaster/GML macro
[(platform)] :CMD. name [... name ] V='text' [ TV='text' ] |
Note: If a value of =NO is specified, it means that this command is NOT supported within an HTML 2 table. B2H will issue a warning message and ignore the command.
Note: This parameter is ignored if HTML Release 3 output is being created (HTML=3 specified).
The following special values may be specified as replacement text:
&text | If specified, it is dynamically replaced by any text following the control word or macro in the input source document. For example: If the definition was: :CMD. ABC V='<B>&text</B>' and source contained: .abc How are you? the HTML output will be: <B>How are you?</B> |
=IGNORE | Ignore the entire source line |
=IGNOREW | Same as =IGNORE except a Warning message is also issued |
=INTERNAL | The command or macro is handled by a routine within the program itself. (This is provided strictly for documentation purposes and is an easy way to show which tags are handled internally.) |
The :TAG. statement defines a BookMaster or GML tag.
For example: :p. :h1. :table.
Figure 7. Specifying a BookMaster/GML tag
[(platform)] :TAG. name [... name] IT=x VAT=x ATT=x SE=x V='te xt' [TV='text'] |
Note: If a value of =NO is specified, it means that this tag is NOT supported within an HTML 2 table. B2H will issue a warning message and ignore the tag.
Note: This parameter is ignored if HTML Release 3 output is being created (HTML=3 specified).
The following special values may be specified as replacement text:
&text | If specified, it is dynamically replaced by any "immediate" text following the tag on the logical line from the input source document. |
&textall | If specified, it is dynamically replaced by any "immediate" text following the tag on the physical line from the input source document. Using "&text": If the definition was: :TAG. ABC V='<B>&text</B>' and source contained: :abc.How are you?:hp1.I am fine!:ehp1. the HTML output will be: <B>How are you?</B><I>I am fine!</I> Using "&textall": If the definition was: :TAG. ABC V='<B>&textall</B>' and source contained: :abc.How are you?:hp1.I am fine!:ehp1. the HTML output will be: <B>How are you?<I>I am fine!</I></B> |
=IGNORE | The tag, from the leading colon to the trailing period, is ignored. Any immediate text is retained. |
=IGNOREW | Same as =IGNORE except a Warning message is also issued |
=IGNOREALL | Same as =IGNORE, except that both the tag and any immediate text is ignored |
=IGNOREALLW | Same as =IGNOREALL except a Warning message is also issued |
=INTERNAL | The tag is handled by a routine within the program itself. (This is provided strictly for documentation purposes and is an easy way to show which tags are handled internally.) |
:IGNORE. | Similar in function to =IGNORE, except that the tag and all following source lines to the :EIGNORE. end-tag are ignored |
:IGNOREW. | Same as :IGNORE., except that a warning message is also issured |
:EIGNORE. | The end-tag for :IGNORE. and :IGNOREW. |
The :XLATE. statement allows the translation of single-byte values to other values. Useful if source documents have "hard-coded" special characters for unique purposes, such as line drawings, diagrams or country-specific national language characters (see also "National Language Support (NLS) considerations").
Figure 8. Specifying a character translation
Translate a single-byte character to another single-byte character: [(platform)] :XLATE. from1 to1 [ ... fromx tox ] Translate a single-byte character to a string: [(platform)] :XLATE. from V='string' |
Example, to translate all X'34' characters to X'5D' and all "number signs" (#) to X'24':
:XLATE. 34 5D # 24
Second example, translate all X'93' characters to an HTML entity name.
:XLATE. 93 V='&lbrk;'
You can include statements within the source file to influence how B2H performs the conversion. You can specify B2H options, provide explicit HTML text to be passed directly to the output, indicate where the output file should be "split", and other functions.
Two statement has two acceptable syntaxes:
1. .*B2H type [ options ] 2. .*type [ options ]Since the statements "look" like Script/VS comments (they start with a period-asterisk), you can leave them in the source file without harm.
The first syntax is preferred and explicitly identifies that the statement is intended for use by B2H. The second syntax has a less-obvious intent and might cause confusion between B2H and other programs which also "look" at your source. If the B2HREQ=YES option is specified, only the first syntax is recognized and the second syntax is ignored.
The following statement types are available:
Force a break of the output HTML file:
.*B2H BREAK [ physical-file ], [ logical-file ]
Provide explicit HTML text:
.*B2H HTML ...html-text...
Specify B2H options:
.*B2H OPTION option=value [ option2=value2 ... optionx=valuex ]
|
Notes:
Example:
:p.You can download it from my homepage at :psc proc=html. .*b2h html <A HREF="http://www.abc.com/myhome"> .*b2h html http://www.abc.com/myhome</A> :epsc. :psc xproc=html. :xph.http&colon.//www.abc.com/myhome:exph. :epsc.
Notes:
DESTSYS= OUTPUTFM= OUTPUTP=
HTMLEXT= OUTPUTL= OUTPUTP83=
HTMPEXT= OUTPUTL83= OUTPUTPCASE=
OUTPUTLCASE= SOURCE=
Examples:
.*B2H OPTION imbpath='' title="ABC Project User's Guide" .*B2H OPTION toc=*3 tocret=toc fnlink=both .*B2H OPTION header=no footer=no
See the beginning of the BookMaster source for this document for additional examples.
B2H inserts the document's title into the output HTML file in the following places:
What determines the document's title?
B2H uses the following steps to determine the document's title:
Explicit HTML statements to support specialized requirements can be included in the source file by using the .*B2H HTML statement. Since it "looks" like a Script/VS comment, you can leave it in the source file without harm. The syntax is:
.*B2H HTML ...HTML statement...See "Controlling B2H using statements within the source file" for further information about this feature.
In BookMaster, the :PSC tag allows you to control which text in your document is processed for a particular type of output device. It allows you to say, "do this only when formatting my document for this particular processing class."
For example,
:psc proc=char. :p.this text is printed or displayed only when printing on a character device. :epsc.
B2H supports the :PSC tag, and in addition to any "process" names defined using the PSC= option, B2H defines two process names you can test: HTML, and either HTML2 or HTML3.
Here are some examples:
:psc proc=html. :p.Include me ONLY when converting this text to HTML (either HTML 2 or HTML 3) :epsc. :psc xproc=html. :p.Do NOT include me when converting this text to HTML :epsc. :psc proc=html3. :p.Include me ONLY when converting this text to HTML 3 :epsc.
See the source for this User's Guide for additional examples.
B2H supports breaking the output HTML file into multiple physical files. This is useful for large source files, since it allows the reader to retrieve only those sections which are of interest -- reducing document load time. If requested, B2H will also dynamically insert next/previous hyperlinks into the output HTML files to aid in navigation.
The first output HTML file part is named "normally". Subsequent parts have a numeric suffix attached to the filename (e.g. abc.htm, abc02.htm, abc03.htm, abc04.htm, etc) (12) The number of digits in the suffix is controlled by the PARTDIGITS= option (default is two digits).
If the OUTPUTP= option (and/or the OUTPUTFM= option, if running on VM) is specified to direct the output file to a specific location, all output file parts are written to the same location. (See "Specifying the location and file names when splitting the HTML output" for how to override this behavior.)
The location within the source file where a break is to occur is specified using any combination of the following methods:
The effect of the AUTOPART= option:
AUTOPART=NO | The output is a single file. Any .*B2H BREAK statements within the source are ignored. This is the default. | ||||||
AUTOPART=YES | The output is split into multiple files only when a .*B2H BREAK statement is encountered. | ||||||
AUTOPART=num | The output is split into multiple files with each break ocurring when a header at the specified level is encountered. (Example: if AUTOPART=1 is specified, each :H1. causes a break.) If a .*B2H BREAK statement is encountered, it too will cause a break. The heading level specified for num should be the most-significant level heading used in the source document. | ||||||
AUTOPART=*num | The output is split into multiple files with each break ocurring when a header from :H0. to the specified level is encountered. (Example: if AUTOPART=*2 is specified, each :H0., :H1. and :H2. causes a break.) If a .*B2H BREAK statement is encountered, it too will cause a break. | ||||||
AUTOPART=LEN=value | Specifies that a separate output file may also occur when a :LEN tag is encountered
| ||||||
AUTOPART=IMBED | The output is split into multiple files with each break ocurring when a file is imbedded using the .im or .'im macro. | ||||||
AUTOPART=SETUP | The output is split when a file is imbedded using the .setup macro. |
If multiple values are specified for AUTOPART=, you must
enclose them in either single or double-quote characters.
Example: AUTOPART='0 IMBED LEN=SEP'
For an example, try processing this document using AUTOPART=1 and view the result.
If you split the output file, there are some other B2H options you should consider to make document navigation easier for the user:
TOC=YES
This ensures that a table-of-contents is generated and and that links are created from the table-of-contents to each section header
TOCRET=
This controls whether each section header should link back to a table-of-contents
PARTLINK={ YES | NO }
PARTLINK=YES requests B2H to automatically insert hyperlink text into the output HTML files for jumping to the previous-page/next-page/table-of-contents. The actual text inserted is defined by the PARTLINK.x= option.
PARTLINK=NO specifies that B2H should not automatically insert hyperlink text into the output HTML files for jumping to the previous-page/next-page/table-of-contents. However, you can use the "&b2hparttop" symbol within a header file and the "&b2hpartbot" symbol within a footer file to allow custom placement of the hyperlink text for navigation. See Appendix B. "&variables pre-defined by B2H" for more information on these two symbols.
PARTLINK.x=
This specifies the content of the hyperlink text and the location within each HTML output file where it should be placed.
By default, hyperlink text is inserted at the bottom of each HTML file for linking to the previous page, next page, the table-of-contents and the index (if an index is generated). No default hyperlink text is inserted at the top of each HTML file.
For more information about the above options, see "Available B2H Options".
As mentioned previously, when splitting the output HTML file, the first output HTML file part is named "normally" and subsequent parts have a numeric suffix attached to the filename (e.g. abc.htm, abc02.htm, abc03.htm, abc04.htm, etc). The physical and logical location of the split files are the same as the main output file. This behavior will satisfy the vast majority of situations.
(The following discussion is intended for advanced users)
In special circumstances, you may want to explicitly specify the location and/or name for one or more of the "split" files. You can do this using any of the following methods:
.*B2H BREAK physical-file, logical-file
PARTNAME.4='physical-file,logical-file'which specifies the physical and logical file for the fourth output file. See the PARTNAME option for details on the syntax.
Notes:
This capability is intended for advanced users and should be used with caution!
If you are running B2H on a platform different than what your web server uses (e.g. you are running B2H on VM and then downloading the HTML output to an OS/2 server), you should be aware of some file naming considerations.
B2H keeps track of two algorithms for file naming: the physical name(s) created on the current platform, and the logical name(s) used by the HTML HREF= parameter (which must match the physical name when the HTML file is handled by the server). If the destination platform ("destsys") specified by the B2H DESTSYS= option is the same as the current platform ("currsys"), then the two sets of file names are equivalent. But if the "currsys" platform is not the same as the "destsys" platform, the file names may be different.
B2H sets the default "currsys" values based on the current platform and the default "destsys" values based on the DESTSYS= option, but you can override any of the values using the appropriate option:
Here's an example: if you convert "xxx.script" on AIX with DESTSYS=OS2, the default physical output file is "xxx.html" (because AIX supports long file names) and the logical name is "xxx.htm" (because OS/2 FAT does not support long file names). If you want to force the physical file extension to also be "htm", then just specify HTMPEXT=htm
Note: Some options (such as OUTPUTL83= and OUTPUTP83=) are really for controlling the default file names when creating multiple output files.
B2H does not do anything specific for National Language Support, but you can easily configure it to handle documents written in languages other than English.
If your document uses the appropriate &symbols for special characters (e.g. À, ë), than all should be fine as B2H will convert them to their HTML equivalent.
If you have documents with language-specific characters entered as a single character, you can use the :XLATE. symbol table statement to convert that single-character to a string. For example, if you determine that a document uses the X'A5' single-character for an umlaut, you can have B2H convert it to "¨" by specifying the following symbol table statement:
:XLATE. A5 V='¨'Note that the hex value for a specific character may be different on a mainframe (EBCDIC coding) than on a PC workstation (ASCII coding). Here's a hypothetical example of defining an umlaut translation based on the current platform:
(CMS) :XLATE. A5 V='¨' (PC) :XLATE. B7 V='¨'See "Translation of single-byte values" for more information on the :XLATE. statement.
If you determine that quite a few translation definitions are needed, you may find it simpler to place them in a user symbol table and then load the table as needed.
If your document is written in a language other than English and you have followed the items listed in the previous section, there may still be some English in the HTML output caused by the default text generated by various BookMaster tags, such as "Table of Contents" for the :TOC. tag and "Abstract" for the :ABSTRACT. tag.
B2H provides the DEFTEXT.name= option to allow you to specify the default text desired for various BookMaster tags and functions. For example, to have the default output be in Spanish for the above tags, you might specify:
DEFTEXT.ABSTRACT='Sumario' DEFTEXT.TOC='Tabla de Materias'Many other options can be modified to generate non-English text.
Once you have determined all the options that need to be specified to generate the appropriate text, you will probably want to place them in a user profile and then load the profile as needed.
If your document is written in a language other than English and also has an index, the index may be sorted incorrectly.
The first character of each index entry determines the section of the index into which the entry is placed. By default, if the first character is numeric ("0"-"9"), the entry is placed in the "Numerics" section; if the first character is a letter of the English alphabet ("A"-"Z"), the entry is placed into the section for that character; otherwise the entry is placed into the "Special Characters" section. If the document's language contains letters other than "A"-"Z", the index might contain a significant number of entries in the "Special Characters" section.
The INDEXSORT option allows you to change the rule. You could, for example, specify that the Á (A-acute) and Ì (I-grave) characters are "letters" and each should have their own section consisting of index entries whose first character is Á or Ì. The following is one way you might do it:
INDEXSORT.LETTER='Á Ì'See the INDEXSORT option for syntactical and usage information.
Once you have determined the INDEXSORT options needed, you will probably want to place them in a user profile and then load the profile as needed.
If you have done the previous three sections, then you probably have a user symbol table with a number of :XLATE. statements and a user profile with a variety of options defined to generate text in the desired language. Finally, add a USERSYM= option to the user profile to point to the user symbol table. Now all you have to do is to point to the user profile when invoking B2H and everything is loaded automatically.
Here's a hypothetical example (using VM naming conventions) for converting Spanish documents:
In the user profile: B2HSPAN PROFILE
DEFTEXT.ABSTRACT='Sumario'
DEFTEXT.DAYS='Dom Lun Mar Mie Jue Vie Sab'
DEFTEXT.GLOSSARY='Glosario'
" " "
DEFTEXT.TOC='Tabla de Materias'
PARTLINK.16='<A HREF="&b2htoc">Tabla de Materias</A> |'
USERSYM="B2HSPAN SYMBOL"
In the user symbol table: B2HSPAN SYMBOL
(CMS) :XLATE. A5 V='¨'
" " "
(PC) :XLATE. B7 V='¨'
Invoke B2H and load both files automatically:
B2H sample script ( USERPROF='B2HSPAN PROFILE'
This type of setup can be replicated for as many languages as desired.
B2H provides two methods for supporting the BookMaster Question and Answer tags (:QUESTION, :EQUESTION, :BLANK, :CHOICE, :MATCH, :QITEM, :ANSWER, :QREF and :ANSREF):
QUESTION='{TEXT|FORM},[method],url-of-cgi,[answer-action],[optdata]'
"Question and Answers (TEXT mode)" has examples of both text and HTML FORMs if this is the HTML version of this User's Guide; the non-HTML version contains only the text output.
If QUESTION=TEXT, the Question and Answer tags are converted to blocks of text and appear similar to the familiar BookMaster output. This is the default mode. See "Question and Answers (TEXT mode)" for an example of this.
If QUESTION=FORM, each :QUESTION/:EQUESTION block is converted to an HTML form. (See "Question and Answers (HTML FORM mode)" for an example.)
| FORM=FILLIN | Each :BLANK tag is converted to a TEXT input field |
| FORM=TF | True/False selectable using a RADIO button |
| FORM=MC | Each :CHOICE tag is converted to a CHECKBOX, multiple answers can be selected |
| FORM=MATCH | :CHOICE tags are shown as an ordered list and each :MATCH is converted to a TEXT input field |
| FORM=ORDER | Each :QITEM is converted to a TEXT input field |
| "Send Answer" | Submits form input |
| "Reset" | Resets input fields to defaults |
| "Help" | Submits form with value "help=Help" |
| id | The ID= attribute from the
:QUESTION tag
<INPUT TYPE=HIDDEN NAME=ID VALUE="ID-value"> |
| form | The FORM= attribute from the :QUESTION
tag (e.g. FILLIN)
<INPUT TYPE=HIDDEN NAME=FORM VALUE="FORM-value"> |
| dingbat | Either the question's number or the value from the
DINGBAT= attribute from the :QUESTION tag
<INPUT TYPE=HIDDEN NAME=DINGBAT VALUE="data"> |
| HIDDEN | An additional hidden field containing
the answer data is added to the form created for each question.
<INPUT TYPE=HIDDEN NAME=ANS VALUE="...."> The answer data is calculated from the :QUESTION, :BLANK, :MATCH and :QITEM tags. This is a blank-delimited list of values. ANSIDs are converted to choice numbers. | ||||||||
| file | An answer file of this name(10)
is generated with
each record containing the answer(s) to a specific question. It is assumed
that this file will be transferred to the server where it will
be used by the CGI program to verify the user's answer.
The format of each record (using a colon as the field delimiter) is:
form:id:dingbat:ans
| ||||||||
| NONE | No answer data will be written anyplace. The CGI program must define an alternative method of verifying the user input. |
A typical QUERY_STRING passed to the CGI program by a GET method might look like:
form=MC&id=boy&inp=4&inp=5&ans=4+5The CGI program (14) should compare each value of inp= to each word in the value of ans=.
Note: The order in which the answer is specified (in the ANS= or ANSID= attributes on the :QUESTION, :BLANK, :MATCH and :QITEM tags) must be the same as the order of the input fields, for a value-by-value comparison to work.
:QREF and :ANSREF tags are converted to HTML links. The :ANSWER tag just lists the answer values (as in BookMaster), but the "dingbat" (question number) on each :ANSWER tag is converted to a link back to the question.
The appearance of the Question and Answer tags is affected by the setting of the DLFMT= and DLTAG= options.
You can mark up your BookMaster files with link tags that specify the hypertext links you want BookManager to create within and between online documents. Hypertext links connect elements in one part of an online document to elements in another part of the same document or separate online document. For more information on this subject, see the chapter entitled "Tags for hypertext links in online documentation" in the BookMaster User's Guide.
For BookManager, the :DOCDESC tag is used to identify an external document and the :LDESC. tag describes the information you want BookManager to create a link to. For example:
:prolog.
:title.
Walden Systems User Guide
:etitle.
·
:docdesc id=prog
num='PRG-1234'
level='2'
title='Walden Systems Programmer Guide'.
:ldesc id=xyz1 docid=prog object=how2mod objtype=head.
·
:eprolog.
·
:p.First, you must :l lid=xyz1.modify the POND SCRIPT file:el..
·
:p.For further information, see the :cit docid=prog.Walden Systems
Programmer's Guide:ecit..
The :DOCDESC tag has little meaning in an HTML environment, so B2H ignores the tag and provides the DOCDESC.id= option for you to specify the name of the file containing the HTML version of the document. The id value in DOCDESC.id= must be the same as that specified for the ID= parameter on the :DOCDESC tag.
So, using the above example, you might specify:
B2H ... ( docdesc.prog='prg1234.htm'
The DOCDESC.id= option can be specified as many times as necessary. If the option is omitted for a particular document, then no interdocument links are generated.
If the id qualifier is omitted, then the specified HTML file is associated with all :DOCDESC tags. The following example points all interdocument links to one file:
B2H ... ( docdesc='prg1234.htm'
If your document is one book in a multivolume library, you may want to refer the reader to information in another volume of the library. Both BookMaster and B2H provide an extended cross-reference facility, allowing you to refer to information in any volume of the library. The BookMaster User's Guide contains detailed information on this facility.
The following steps lead you through the multivolume cross-referencing procedure. For this procedure, each item you refer to (heading, table, figure, and so on) must have an ID that is unique in the library. You use these IDs for your multivolume cross-references just as you would for cross-references in a single volume.
B2H book1 script ( sysvar='w book1'
file.b2hxrefs (AIX) file.B2X (OS/2) file B2HXREFS (VM) file.B2X (WIN95) file.B2X (WINNT)
:prolog. · .namefile name=b1stuff cms='book1 dsmrefs' .im b1stuff · :eprolog.
Note: Always use the "CMS" parameter specifying a filetype of "DSMREFS" on the .namefile macro. B2H recognizes that filetype as containing extended cross-referencing information and will "map" the file using the same naming convention used for SYSVAR W.
If your documents contain custom tags, commands, macros or symbols, they can be easily supported by defining them in a separate symbol table, and then causing B2H to load that symbol table using the USERSYM= option.
In most cases, the custom tag, command, macro or symbol can be supported using standard facilities available in a symbol table. If necessary, you can define that an external program be invoked to handle the custom markup.
You can request that an external program be invoked to custom process a command, macro or tag. Just specify the following for the appropriate value on a :CMD. or :TAG. statement in a user symbol file.
&PGM pgmname [ parm1 parm2 ... parmx. ]
Note: for technical reasons, the name of the program invoked will be in upper-case. If the platform you are using allows programs and files in both upper and lower-case, the name of the external program itself must be stored in upper-case.
The specified program is invoked by B2H as a function, like this:
string = pgmname(type,tagtext,parms,stext)
CMD | Invoked via a :CMD. definition (e.g. a command or macro) |
TAG | Invoked via a :TAG definition (e.g. a tag) |
Text to be inserted into the data stream is returned to B2H using either or both of two methods:
For an example, see the B2HUSER symbol table and program provided as part of the B2H package.
To indicate that a 'flat' file is being processed, you must specify:
SOURCE=FLAT
By default, the entire file is enclosed within a pair of "<PRE>" and "</PRE>" HTML tags causing the browser to switch to a mono-spaced font and display the file "as-is".
Two additional operands on the SOURCE= option allow specialized processing of 'flat' files. Many 'flat' files are simple paragraphs of text with a blank line between the paragraphs. For those files, try specifying SOURCE='FLAT,NOPRE,YES'. See the description of the SOURCE= option for other processing possibilities.
In addition to the SOURCE= option, you will probably want to specify at least two other options:
If TITLE= is not specified for a 'flat' file, the first non-blank line is used as the title
Example:
B2H PIANO HOW-TO ( TOC=NO TITLE='How to play the piano' SOURCE=FLAT
VM Example: Convert your PROFILE EXEC
B2H PROFILE EXEC A ( SOURCE=FLAT TOC=NO TITLE='My Profile Exec'
PC Example: Convert your C:\CONFIG.SYS
B2H C:\CONFIG.SYS ( SOURCE=FLAT TOC=NO TITLE='My Config.Sys'
B2H supports most commonly-used Script/VS (DCF), GML, and BookMaster commands, macros and tags. But there are some areas which you should be aware (the appendix contains support information for each specific command, macro and tag):
In addition, B2H also turns "on" the HTML process and either the HTML2 or HTML3 process (corresponding to the HTML level being generated). This allows you to include/exclude text based on HTML level (see also "Including/excluding HTML-oriented text").
Although the what's-not-supported list may seem large, it actually represents a very small percentage of the markup used in most documents.
HTML 2 does not support tables. And while HTML 3 does support them, the standards are somewhat in limbo. So some Web browsers do not yet support HTML 3 table tags (specifically IBM's Web Explorer prior to Release 1.03).
However, since tables are so common in BookMaster documents, B2H provides special built-in support. Most table options are handled, including dynamically changing the number of columns on a row-by-row basis.
Since HTML 2 does not support tables, B2H switches to a monospaced font and manually builds the table itself with the following restrictions:
The TABLE2= option allows you to specify the characters used for the frame, cell gutters, etc.
Because HTML 3 supports tables directly, B2H generates the appropriate <TABLE>, <TR>, <TH> and <TD> tags and leaves the actual formatting of the table to the user's Web browser.
Be aware that BookMaster's table support is more robust and flexible than that provided by HTML 3. Some BookMaster table features (such as text rotation) are not available in HTML 3. Other BookMaster table features are available, but restrictions apply.
HTML 3 cells may contain other tags, such as lists, figures, even cross-references and hyperlinks. However, a table-within-a-table is not supported.
Note: HTML 3 table and cell widths are determined dynamically by the browser. In most cases, this is fine. However, if you have a table which changes the number of columns on a row-by-row basis, you should be aware of the following items:
Horizontal and vertical cell alignment (HTML 3 only)
The H3TABLE= option specifies how BookMaster tables using both horizontal and vertical cell alignment should be handled when creating HTML 3 output. If H3TABLE=SIMPLE is specified, then the BookMaster's ARRANGE= table parameter is accepted, but the cells are laid out horizontally (this is how tables are handled when creating HTML 2 output).
If H3TABLE=COMPLEX (the default), then full horizontal and vertical cell alignment is supported and the appropriate HTML 3 ROWSPAN= and COLSPAN= cell options are generated.
Note: As mentioned previously, BookMaster's table support is more robust and flexible than that provided by HTML 3. Although HTML 3 can handle horizontal and vertical cell alignment, how you specify it is less flexible than what BookMaster allows, resulting in the following restrictions:
For example, BookMaster allows this:
:C 1.cell-1-data :C 3.cell-3-data :C 2.cell-2-data
But HTML 3 does not support it, so you will need to physically move the order of the data to:
:C 1.cell-1-data :C 2.cell-2-data :C 3.cell-3-dataB2H will issue a warning message if it detects out-of-order cell data.
This is OK: This is not: ARRANGE='1 2 3 4' ARRANGE='1 2 4 3'In the next example, although the cells in the second group are ascending left-to-right, they are out of sequence top-to-bottom (cell 5 is defined prior to cell 3).
This is OK: This is not: ARRANGE='1 2 2 3 3 4 4 4' ARRANGE='1 2 2 5 5 6 6 6' ARRANGE='1 5 6 3 3 7 8 9' ARRANGE='1 3 4 5 5 7 9 9'
The HTML 3 requirement that cell data be in ascending sequence may cause to you restructure your table definitions.
HTML 3 "add-on" enhancements
Since HTML 3 was announced, a number of additional tags or "add-ons" are being promoted by various interests. Many HTML 3-compliant browsers -- Netscape being the most notable -- already provide support for these add-ons.
One of these is WIDTH=, which provides the ability to specify the width of a table or individual cells. B2H's H3ADDONS= option specifies if B2H should utilize WIDTH= when generating table tags. If H3ADDONS=YES, the resultant table will more closely approximate the appearance of the BookMaster table when using a browser supporting the HTML 3 add-ons.
Since most Web browsers ignore HTML tags they do not recognize, H3ADDONS=YES is the default.
The following are examples of various GML and BookMaster markup. They are provided so you can compare how they look using BookMaster versus when converted to HTML and viewed by a Web browser. Of course, some of these constructs also appear earlier in this document.
Note: You are currently browsing the HTML 3 version of the User's Guide.
B2H provides options to specify which HTML tags should be used for any given list. If you don't like a list's default appearance, you can change it.
An ordered list using B2H's LIREF=NUM option (the default):
An ordered list using B2H's LIREF=ID option:
An un-ordered list:
A simple list:
List item number one
List item number two
Resume original list, final item
A definition list using B2H's DLFMT=DL option (the default):
A definition list using B2H's DLFMT=TABLE option (HTML 3 only):
Term | Definition | ||||
term1 | Definition for term1 | ||||
term2 | Definition for term2
| ||||
term3 | Definition for term3 |
There is a big difference in the appearance of the following tables between HTML 2 and HTML 3. This is described further in "Special information about tables".
A simple table with caption and no frame, defined with
:table cols='* 2* * *' frame=none.
Figure 10. This is the caption
| Head C1 | Head C2 | Head C3 | Head C4 |
|---|---|---|---|
| Row 1, Col 1 | Row 1, Col 2 of 4 | Row 1, Col 3 | Row 1, Col 4 |
| Row 2, Col 1 | Row 2, Col 2 | Row 2, Col 3 of 4 | Row 2, Col 4 |
Same as above, but with a frame, defined as
:table cols='* 2* * *'.
Figure 11. This is the caption
| Head C1 | Head C2 | Head C3 | Head C4 |
|---|---|---|---|
| Row 1, Col 1 | Row 1, Col 2 of 4 | Row 1, Col 3 | Row 1, Col 4 |
| Row 2, Col 1 | Row 2, Col 2 | Row 2, Col 3 of 4 | Row 2, Col 4 |
Same table, but adding a table description,
an ordered list in a cell and a table note
Figure 12. This is the caption
|
This is some table description text using the
:TDESC. tag
| |||
| Head C1 | Head C2 | Head C3 | Head C4 |
|---|---|---|---|
Row 1, Col 1
| Row 1, Col 2 of 4 | Row 1, Col 3 | Row 1, Col 4 |
| Note: This is a tnote | |||
| Row 2, Col 1 | Row 2, Col 2 | Row 2, Col 3 of 4 | Row 2, Col 4 |
A complex table with varying columns by row
Figure 13. Audit record display format
| Head C1 | Head C2 | Head C3 | Head C4 | Head C5 |
|---|---|---|---|---|
| aR1 C1 | aR1 C2 | aR1 C3 | aR1 C4 | aR1 C5 |
| Note: This is tnote text | ||||
| aR2 C1 | aR2 C2 | aR2 C3 | aR2 C4 | aR2 C5 |
| This is left-justified data for the single column | ||||
| This is the "quoted" data in cell one of two | ||||
| bR1 C1 | bR1 C2 | bR1 C3 | bR1 C4 | bR1 C5 |
| This is cell 1 of 3 (no data in cell 2) |
| This is cell 3 of 3 | ||
| Note: This is a second tnote | ||||
| cR1 C1 | cR1 C2 | cR1 C3 | cR1 C4 | cR1 C5 |
| Single column again (centered) | ||||
| dR1 C1 | dR1 C2 | dR1 C3 | dR1 C4 | dR1 C5 |
| This is right-justified data in a single column | ||||
| eR1 C1 | eR1 C2 | eR1 C3 | eR1 C4 | eR1 C5 |
| Foot C1 | Foot C2 | Foot C3 | Foot C4 | Foot C5 |
A table with both horizontal and vertical cells
defined like
:table
cols='* * 2* 2*'
align='c c l c'
valign='c c t'
arrange='1 2 3 3'
arrange='1 2 4 5'.
| Application | Location | Description | |
|---|---|---|---|
| Test Procedure | Frequency | ||
| Dial Cost Estimator | AMTOOLC | Return best phone number and estimated call cost | |
| Run D1, D2 and D3 transcripts | When database is refreshed or the application code changes | ||
| SERVQMF |
AMTOOL2
| Submit Service Manager QMF queries | |
| Submit APPLID canned query using ABCD as account ID | Weekly | ||
| CMRLIST | ADVTOOLS main server on CARVM8 | Build and load customer master list | |
| Submit AMCMRJOB | Nightly at 18:30 pm | ||
| PRTRANGE | AMTOOL2, MVSAP2 and MVSAP5 | Extract customer problem entry(ies) from the currently-active NOTIFY system | |
| Submit request for ATAP 16300 | Executed by Customer Assistance upon a processor switch | ||
The following table shows you how the default shading values appear (the appearance may vary based on your browser and display)
:tdef id=shade cols='* 3*'. :tdef id=xlight refid=shade shade='no xlight'. :tdef id=light refid=shade shade='no light'. :tdef id=medium refid=shade shade='no medium'. :tdef id=dark refid=shade shade='no dark'. :tdef id=xdark refid=shade shade='no xdark'. :table refid=shade alignh='l c'. :tcap.Default appearances for SHADE :thd.:c.Weight :c.Actual appearance:ethd. :row. :c.SHADE=NO :c.Some text with no shading :row refid=xlight. :c.SHADE=XLIGHT :c.Some sample text with extra-light shading :row refid=light. :c.SHADE=LIGHT :c.Some sample text with light shading · :etable.
Figure 14. Default appearances for SHADE
| Shade Type | Actual appearance |
|---|---|
| SHADE=NO | Some text with no shading |
| SHADE=XLIGHT | Some sample text with extra-light shading |
| SHADE=LIGHT | Some sample text with light shading |
| SHADE=MEDIUM | Some sample text with medium shading |
| SHADE=DARK | Some sample text with dark shading |
| SHADE=XDARK | Some sample text with extra-dark shading |
Figure with custom blue shading
.*B2H OPTION SHADE.LIGHT=C5FFFF
:fig shade=light.
:figcap.Example figure with light blue shading
This is a small figure illustrating
light blue background shading
:efig.
Figure 15. Example figure with light blue shading
This is a small figure illustrating
light blue background shading
|
Three columns, each with a hard-coded width of 8
Module Called Entry Name By PointIJK30276 IJK30111 IJKA9762
IJK30276 IJK30111 IJKA9762
IJK30276 IJK30111 IJKA9762
IJK30276 IJK30111 IJKA9762
Three columns, width specified as COLS='3i .5i 1i' and a :DIRSUB
Name Ext Dept/RoomDoe, John VC5 Pav 302
Richtmeyer, Gary VC5 Spectrum 3
This is a :dirsub. line
Descarte, Rene' VC5 Pav 1024
Doe, John VC5 Pav 302
Same as above, but with COMPACT
Name Ext Dept/RoomDoe, John VC5 Pav 302
Richtmeyer, Gary VC5 Spectrum 3
This is a :dirsub. line
Descarte, Rene' VC5 Pav 1024
Doe, John VC5 Pav 302
A single paragraph using the :NOTE tag
defined like
:note.This is a sample note
Note: This is a sample note
Multiple paragraphs using the
:NT/:ENT tags
defined like
:nt.This is the first paragraph. :p.And the last paragraph. :ent.
Note:
This is the first paragraph.And the last paragraph.
A list of notes using the
:NOTEL/:ENOTEL tags
defined like
:notel. :li.Note list item number 1 :li.Note list item number 2 :enotel.
Notes:
Example 1
:question form=fillin id=strb. The right hand side of a boat is called the :blank width=9p ans='starboard'. side. :equestion.
| 1. | The right hand side of a boat is called the ______________ side. |
Example 2
:question form=fillin dingbat='A.'. The right hand side of a boat is called the :blank width=9p ans='starboard'. side. :equestion.
| A. | The right hand side of a boat is called the ______________ side. |
Example 3
:question form=fillin id=sail2. The three edges of a fore-and-aft sail are the: :lines. :blank width=6p ans='foot'. :blank width=6p ans='leech'. :blank width=6p ans='luff'. :elines. :equestion.
| 2. |
The three edges of a fore-and-aft sail are the:
_________ _________ _________ |
:question form=tf id=yawl ans=F keep=6p. A :hp1.yawl:ehp1. is a sailboat with only one mast. :equestion.
| 3. | T F A yawl is a sailboat with only one mast. |
:question form=mc id=cpz ansid=cpzac keep=12p. After capsizing a small sailboat, the first thing you should do is :choice.uncleat all sheets. :choice.swim around the boat and hang on the centerboard :choice id=cpzac.account for everyone aboard. :equestion.
| 4. |
After capsizing a small sailboat, the first thing you should do is
|
:question form=match id=trm keep=20p. Match the following nautical terms with their correct meanings. :choice id=trmha.halyard :choice id=trmsh.sheet :choice id=trmji.jib :choice id=trmhd.head :match ansid=trmsh.line used to trim a sail :match ansid=trmhd.toilet :match ansid=trmha.line used to hoist and lower a sail :match ansid=trmji.triangular sail attached to the forestay of the foremost mast :equestion.
| 5. |
Match the following nautical terms with their correct meanings.
____ line used to trim a sail ____ toilet ____ line used to hoist and lower a sail ____ triangular sail attached to the forestay of the foremost mast |
:question form=order id=coast keep=18p compact. Place the following states in order from longest coastline to shortest. :qitem ans=4.Maine :qitem ans=2.Texas :qitem ans=3.North Carolina :qitem ans=1.California :qitem ans=6.Arizona :qitem ans=5.Connecticut :equestion.
| 6. |
Place the following states in order from longest coastline to shortest.
____ Maine ____ Texas ____ North Carolina ____ California ____ Arizona ____ Connecticut |
:p.These are answers to the sample questions starting with :qref refid=strb. :answer refid=strb. :answer refid=sail2. :answer refid=yawl. :answer refid=cpz. :answer refid=coast. :answer refid=trm.
These are answers to the sample questions starting with question 1.
| 1. | starboard |
| 2. | foot leech luff |
| 3. | F |
| 4. | 3 |
| 6. | 4, 2, 3, 1, 6, 5 |
| 5. | 2, 4, 1, 3 |
The following examples were generated using the B2H option:
.*B2H OPTION QUESTION='FORM,GET,,HIDDEN'
Example 1
:question form=fillin id=qtrb. The right hand side of a boat is called the :blank width=9p ans='starboard'. side. :equestion.
Example 2
:question form=fillin dingbat='A.'. The right hand side of a boat is called the :blank width=9p ans='starboard'. side. :equestion.
Example 3
:question form=fillin id=qail2. The three edges of a fore-and-aft sail are the: :lines. :blank width=6p ans='foot'. :blank width=6p ans='leech'. :blank width=6p ans='luff'. :elines. :equestion.
:question form=tf id=qawl ans=F keep=6p. A :hp1.yawl:ehp1. is a sailboat with only one mast. :equestion.
:question form=mc id=qpz ansid=qpzac keep=12p. After capsizing a small sailboat, the first thing you should do is :choice.uncleat all sheets. :choice.swim around the boat and hang on the centerboard :choice id=qpzac.account for everyone aboard. :equestion.
:question form=match id=qrm keep=20p. Match the following nautical terms with their correct meanings. :choice id=qrmha.halyard :choice id=qrmsh.sheet :choice id=qrmji.jib :choice id=qrmhd.head :match ansid=qrmsh.line used to trim a sail :match ansid=qrmhd.toilet :match ansid=qrmha.line used to hoist and lower a sail :match ansid=qrmji.triangular sail attached to the forestay of the foremost mast :equestion.
:question form=order id=qoast keep=18p compact. Place the following states in order from longest coastline to shortest. :qitem ans=4.Maine :qitem ans=2.Texas :qitem ans=3.North Carolina :qitem ans=1.California :qitem ans=6.Arizona :qitem ans=5.Connecticut :equestion.
:p.These are answers to the sample questions starting with :qref refid=qtrb. :answer refid=qtrb. :answer refid=qail2. :answer refid=qawl. :answer refid=qpz. :answer refid=qoast. :answer refid=qrm.
These are answers to the sample questions starting with question 7.
| 7. | starboard |
| 8. | foot leech luff |
| 9. | F |
| 10. | 3 |
| 12. | 4, 2, 3, 1, 6, 5 |
| 11. | 2, 4, 1, 3 |
Since ":DOCPROF SCREEN=SHADE." was specified, the following screen will be shaded if HTML 3 output is being generated.
Figure 16. This is the figure caption using the :figcap. tag. This is some text using the :figdesc. tag.
+--------------------------------------------------------------------------------+ |ADVTOOLS ----------------- Advantis Field Support Tools ---------------------- | | | | GENERAL Information | |_ 1 Getting Started ADVTOOLS Information on ADVTOOLS itself | |_ 2+ Advantis Itself ADVANTIS Sales Support; Marketing Programs; | | Configuration; Qualified Devices | |_ 3 QuickFind QUICKFIND Answers to SELECTED common questions | | | | PRODUCT Information | |_ 4+ Message Services MESSAGE EDI, Electronic Mailboxing, Email, IE, BBS | |_ 5+ Network Services NETWORK APPN, Dial, LAN Leased, Wireless, X.25 | |_ 6+ Information Svcs INFORMAT Information Providers, Software Mall | |_ 7+ Capacity Services CAPACITY Outsourcing (Ded Proc, Shared Capacity, RCS | |_ 8+ Cross-Product Svcs CROSS International, Custom Services (Sp. Bids) | | | | SUPPORT Information | |_ 9+ Customer Info CUSTOMER Billing, Customer Sat, Lists, Acct Profile | |_ 10+ Admin & HQ Support ADMIN Educ, Field Notes, Forms, Contracts, Pubs, | | All Helplogs, Orders, Processes, Reqm'ts | |_ 11+ Other Information OTHER Survey; SE College; VM Tools; Skills; ADVPW | | | |===> | |1=Help 2=FeedBack 3=Exit 4=Recent News 5= 6= | |7=QuickFind 8=Profile 9=FastPaths 10=MenuMap 11=Search All 12=Exit | +--------------------------------------------------------------------------------+ |
| This is the label for the box |
|---|
| This is verbiage for within the box. It is formatted normally. |
Using :TABDATA
:tabdata cols='w1 w1 w1 w1' char='~'
w1='&bul. SieMMMmens MM '.
&bul. Apple** ~&bul. DEC ~&bul. NET ~&bul. Novell**
&bul. Siemens** ~&bul. SSI ~&bul. SUN** ~&bul. 3COM**
&bul. BAY** ~&bul. NTI ~&bul. CISCO** ~&bul. etc.
:etabdata.
Results in:
* Apple** * DEC * NET * Novell** * Siemens** * SSI * SUN** * 3COM** * BAY** * NTI * CISCO** * etc.
Using .TABRACK
:lines. .tabrack 'Los Angeles, California' 'Adams Hilton' :hp1. Location&tab.Hotel&tab.Date :ehp1. Phoenix, Arizona&tab.Adams Hilton&tab.May 22-25, 1989 New York, New York&tab.Hilton&tab.Aug 21-26, 1989 Salt Lake City, Utah&tab.Hotel Utah&tab.Nov 15, 1990 :elines.Results in:
Location Hotel Date Phoenix, Arizona Adams Hilton May 22-25, 1989 New York, New York Hilton Aug 21-26, 1989 Salt Lake City, Utah Hotel Utah Nov 15, 1990
Some lines from CONFIG.SYS using :LINES
PROTSHELL=C:\OS2\PMSHELL.EXE SET USER_INI=C:\OS2\OS2.INI SET SYSTEM_INI=C:\OS2\OS2SYS.INI SET OS2_SHELL=C:\OS2\CMD.EXE SET AUTOSTART=PROGRAMS,TASKLIST,FOLDERS,LAUNCHPAD
Same lines, now using :XMP
PROTSHELL=C:\OS2\PMSHELL.EXE SET USER_INI=C:\OS2\OS2.INI SET SYSTEM_INI=C:\OS2\OS2SYS.INI SET OS2_SHELL=C:\OS2\CMD.EXE SET AUTOSTART=PROGRAMS,TASKLIST,FOLDERS,LAUNCHPAD
Only schedule date tables are supported, not schedule charts.
| Activities | Projected | Actual | |||
|---|---|---|---|---|---|
| Start | End | Start | End | ||
| Part 1 - Set up user ID | Moe | 09/08/96 | 09/12/96 |
09/08/96 | 09/12/96 |
| Part 1 - Project ABC cleanup | Curly | 09/12/96 10/01/96 | 09/15/96 10/15/96 |
09/12/96 | |
| Requirements/High Level Design | Larry | 09/12/96 | 09/15/96 |
09/12/96 | 09/14/96 |
| Design and Documentation | Shemp | 09/14/96 | 10/06/96 |
09/13/96 | 10/06/96 |
| Code/Test | Stan | 09/22/96 | 10/10/96 |
09/18/96 | |
| Design/Code Review | Ollie | 10/12/96 | 10/12/96 |
||
| Production Install | Buster | 10/12/96 | 10/19/96 |
||
A standard Message List with STYLE=RULE
A modified Message List
A standard Code List with COMPACT
0C1
Explanation: Occurs when an operation exception occurs.
Severity: The program is terminated.
Destination: Send the dump to the user.
0C4
Explanation: Occurs when an invalid address is referenced.
Severity: The program is terminated.
Destination: Send the dump to the user.
A modified Code List
*------------------* *------------------*
| Submitter using | 1 | |
| ADVTOOLS, | *------------------* Submitter's |
| INTOOLS, | | | E-mail |
| GETINFO, | | | location |
| INTERNET or | | *------------>| |
| other system | | | | |
*-----*------------* | | *------------------*
| | | ^ ^
1 | | | | |
| *-----------------* | 4 | |
| | | | |
| | *------------------* | |
V V | 3 V | 6
*-------------*----* 2 *-------------*----*
| *-------------------------->| |
| | | |
| HELPLOG | 5 | |
| |<------------------------->| Responder |
| Server Machine | | |
| | 6 | |
| |<--------------------------* |
*------------------* *------------------*
There are literally hundreds of Script/VS, GML and BookMaster symbols and over 300 are defined to B2H. All ISO 8859-1 characters are defined plus many other BookMaster symbols, so files written in languages other than English should display correctly if the proper &symbols are used (e.g. Äaut for Ä, é for é). In addition, the symbols used by XEDITG and CHARGES line-drawing tools are also defined.
If you need a special symbol which is not currently supported, you can:
| Some symbols appear correctly only when viewed using a WEB browser. | |||||
| Symbol | Value | Symbol | Value | Symbol | Value |
|---|---|---|---|---|---|
| &Aa | Á | &aa | á | Á | Á |
| á | á | &Ac | Â | &ac | â |
| Â | Â | â | â | âle | å |
| ´ | ´ | &Ad | V | &Ae | Ä |
| &ae | ä | Æ | Æ | æ | æ |
| &Ag | À | &ag | à | À | À |
| à | à | &Al | < | & | & |
| &and | ^ | &Ao | Å | &ao | å |
| &apos | ' | &Ar | > | Å | Å |
| å | å | &asterisk | * | &At | Ã |
| &at | ã | Ã | Ã | ã | ã |
| &atsign | @ | &Au | ^ | Ä | Ä |
| ä | ä | Äaut | Ä | äaut | ä |
| &aus | a | &Beta | B | &bin | B' |
| &blank | &brkbar | ¦ | ¦ | ¦ | |
| &bsl | \ | &bslash | \ | &bul | * |
| &bullet | * | &bxas | * | &bxbj | * |
| &bxcj | * | &bxcr | * | &bxde | * |
| &bxh | - | &bxle | * | &bxll | * |
| &bxlr | * | &bxri | * | &bxtj | * |
| &bxul | * | &bxur | * | &bxv | | |
| &caret | ^ | &Cc | Ç | &cc | ç |
| &cc | ç | Ç | Ç | ç | ç |
| &cdq | " | ¸ | ¸ | ¢ | ¢ |
| &char | ' | &colon | : | &comma | , |
| &concat | || | &copr | © | © | © |
| ©r | © | &csq | ' | ¤ | ¤ |
| ¤cy | ¤ | &darrow | V | &dash | - |
| &dbls | § | &dblxclam | !! | &dblxclm | !! |
| ° | ° | °ree | ° | &div | ÷ |
| &divid | ÷ | &divslash | / | &dollar | $ |
| &dot | . | &dotdot | .. | &Ea | É |
| &ea | é | É | É | é | é |
| &Eb | * | &ebin | ' | &Ec | Ê |
| &ec | ê | &echar | ' | Ê | Ê |
| ê | ê | êfl | ê | &Ee | Ë |
| &ee | ë | &Eg | È | &eg | è |
| &egml | :e | È | È | è | è |
| &ehex | ' | &El | * | &ellip | ... |
| &ellipsis | ... | &emdash | -- | &endash | - |
| &eq | = | &eqsym | = | &equals | = |
| &Er | * | &Et | * | Ð | Ð |
| Ð | Ð | &Eth | Ð | ð | ð |
| Ë | Ë | ë | ë | &female | ª |
| &fi | fi | &finespace | &fl | fl | |
| ½ | ½ | ¼ | ¼ | &frac18 | 1/8 |
| ¾ | ¾ | &frac38 | 3/8 | &frac58 | 5/8 |
| &frac78 | 7/8 | &ge | >= | &gesym | >= |
| &gml | : | &grave | ` | > | > |
| >sym | > | &hex | X' | &hyphen | - |
| &Ia | Í | &ia | í | Í | Í |
| í | í | &Ic | Î | &ic | î |
| Î | Î | î | î | &Ie | Ï |
| &ie | ï | ¡ | ¡ | &iff | <=> |
| &Ig | Ì | &ig | ì | Ì | Ì |
| ì | ì | &inve | ¡ | &invellip | · |
| ¿ | ¿ | Ï | Ï | ï | ï |
| &Ju | + | &lahead | < | « | « |
| &larrow | < | &lbrace | { | &lbracket | [ |
| &lbrc | { | &lbrk | [ | &lbullet | * |
| &ldarraw | <= | &le | <= | &lesym | <= |
| &Lh | - | &Ll | * | &lnot | ¬ |
| &lor | | | &lpar | ( | &lparen | ( |
| &Lr | * | &Lsterling | £ | < | < |
| <sym | < | &Lv | | | ¯ | ¯ |
| &male | º | &mdash | -- | µ | µ |
| · | · | &minus | - | &minusop | - |
| &mult | × |   | &ndash | - | |
| &ne | <> | &nesym | <> | ¬ | ¬ |
| ¬sym | ¬ | &Nt | Ñ | &nt | ñ |
| Ñ | Ñ | ñ | ñ | &numsign | # |
| &Oa | Ó | &oa | ó | Ó | Ó |
| ó | ó | &Oc | Ô | &oc | ô |
| Ô | Ô | ô | ô | &odq | " |
| &Oe | Ö | &oe | ö | &OELIG | OE |
| &oelig | oe | &Og | Ò | &og | ò |
| Ò | Ò | ò | ò | ª | ª |
| º | º | &Os | Ø | &os | ø |
| Ø | Ø | ø | ø | &osq | ' |
| &Ot | Õ | &ot | õ | Õ | Õ |
| õ | õ | Ö | Ö | ö | ö |
| öaut | ö | &ous | o | &par | ¶ |
| ¶ | ¶ | &per | . | &percent | % |
| &period | . | &plus | + | &plusend | + |
| &plusmin | ± | ± | ± | &plusop | + |
| &pm | ± | £ | £ | &quest | ? |
| &rahead | > | » | » | &rarrow | > |
| &rbl | &rbrace | } | &rbracket | ] | |
| &rbrc | } | &rbrk | ] | &rdarrow | => |
| ® | ® | ®tm | ® | &rpar | ) |
| &rparen | ) | &sdq | " | § | § |
| §ion | § | &semi | ; | ­ | |
| &slash | / | &slr | / | &ss | ß |
| &ssbl | &ssq | ' | &STAR | * | |
| ¹ | ¹ | ² | ² | ³ | ³ |
| ß | ß | &Td | * | &telephone | Tel. |
| Þ | Þ | &Thorn | Þ | þ | þ |
| &tilde | ~ | × | × | &Tl | * |
| &tm | (TM) | &Tr | * | &Tu | * |
| &Ua | Ú | &ua | ú | Ú | Ú |
| ú | ú | &uarrow | ^ | &Uc | Û |
| &uc | û | Û | Û | û | û |
| &Ue | Ü | &ue | ü | &ue | ü |
| &Ug | Ù | &ug | ù | Ù | Ù |
| ù | ù | &Ul | * | ¨ | ¨ |
| &Ur | * | &us | _ | Ü | Ü |
| ü | ü | üaut | ü | &vbar | | |
| &vellip | · | &xclam | ! | &xclm | ! |
| &Ya | Ý | &ya | ý | Ý | Ý |
| ý | ý | &ye | ÿ | ¥ | ¥ |
| ÿ | ÿ | ||||
These are the &symbol value attributes supported by B2H.
for more information on their usage,
see the Script/VS User's Guide.
Figure 18. Supported &symbol value attributes
| Value Attribute | Description |
|---|---|
| &E' | Verifies existence of a symbol. Returns either a "1" or "0" depending on whether or not the character string following &E' is a defined symbol. |
| &L' | Determines the length of a symbol value or the number of characters in any character string. |
| &T' | Analyzes the symbol type. Replaces the character string with an "N" if the value is numeric or null, or a "C" if the value contains nonnumeric data. |
| &U' | Converts lowercase characters to uppercase. |
| &V' | Returns the value of the symbol. Within B2H, &V'&name is equivalent to &name. |
| &W' | Returns the width of a character string. Within B2H, &W'&name is equivalent to &L'&name. |
Figure 19. Supported Script/VS control words
|
The "How?" column contains an "S" if the command is supported
via a System symbol table definition or an "I" if the command is
supported via a B2H internal routine.
| ||
| Command | How? | Comments (fully supported unless specified otherwise) |
|---|---|---|
| .BL | S | Mapped to new-paragraph |
| .BR | S | Mapped to new-line |
| .BX | S | Mapped to a horizontal-rule |
| .CB | S | Mapped to new-paragraph |
| .CE | I | Text is centered either by using monospaced leading blanks(16) or by using the HTML <CENTER> tag. The CENTERTAG= option (discussed in "Available B2H Options") specifies which technique is used. |
| .CP | S | Mapped to new-paragraph |
| .CS | I |
|
| .CT | S | Text included as-is. |
| .DD | I | Only the LIB option is recognized (whether explicitly specified or defaulted); if DD, DSN or TERM, the entire command is ignored. |
| .DM | I | Only the following two formats are supported:
.dm name /stmt1/stmt2/ ... /stmtx[/] .dm name on stmt1 stmt2 .... stmtx .dm off Parameters on the macro (e.g. ".name parm1 parm2") and referencing them within the macro (e.g. &*, &*0, &*1, &*2 ...) is also supported. Markup that includes/excludes files and/or text is NOT supported within a user macro. This includes, but is not limited to: .im, .setup, .cs, :psc, :annot and the various DVCF macros. |
| .EF | I |
|
| .EL | I | |
| .FN | I | .FN ON mapped to :FN.
.FN OFF mapped to :EFN. .FN LEADER places 16 dashes on a separate line |
| .FO | I | .FO OFF mapped to <PRE>
.FO ON mapped to </PRE> .FO CENTER is handled according to the CENTERTAG= option .FO LEFT and .FO RIGHT "terminate" a previous .FO command all other operands are ignored. |
| .H0, .H1, .H2, .H3, .H4, .H5 and .H6 | I | Mapped to their GML equivalent (:Hx.). |
| .IF | I | |
| .IM | I | Passing of positional tokens not supported. See also the IMBFTEXT= option for requesting extended processing of the filetype when using the ".im (fn ft)" format of this command. |
| .MG | I | |
| .PA | S | Mapped to double new-paragraph |
| I | ||
| .QU | I | |
| .RC | I | See the REVTAG= option for specifying the text to insert for marking revisions |
| .RV | I | |
| .SE | I | Formats supported:
.SE symname OFF .SE symname [=] 'string' .SE symname [=] INDEX string1 string2 .SE symname [=] SUBSTR string start stop .SE symname [=] arithmetic-expression |
| .SI | I | Mapped to :ARTWORK NAME=name. |
| .SK | I |
|
| .SP | I |
|
| .SX | I | Implemented using a monospaced font on a line whose width is specified using the LINEWIDTH= option |
| .TA | I |
|
| .TC | S | Mapped to :TOC. |
| .TD | I |
|
| .TH | I | |
| .TI | I |
|
| .TR | I |
|
| .TY | I |
|
| .UC | I |
|
| .UP | I |
|
| .US | I |
|
Control words not applicable or not supported; will be ignored
.AA, .AN, .AP, .AR, .BC, .BF, .BM, .CC, .CD, .CL, .CM, .DA, .DC, .DF, .DH, .DL, .DR, .DS, .DU, .DV, .EC, .EM, .ES, .FL, .FV, .GO, .GS, .HR, .HW, .HY, .IC, .IE, .IL, .IN, .IR, .IS, .IT, .IX, .KP, .LB, .LI, .LL, .LO, .LS, .LT, .LY, .MC, .ME, .MS, .NF, .NL, .OC, .OF, .OR, .PF, .PI, .PL, .PM, .PN, .PT, .PW, .PX, .RD, .RE, .RF, .RH, .RI, .RN, .SA, .SB, .SC, .SO, .SS, .SU, .SV, .TE, .TM, .TP, .TS, .TU, .UD, .UN, .UW, .VR, .WF, .WS and .WZ
Figure 20. Supported BookMaster and GML macros
|
The "How?" column contains an "S" if the macro is supported
via a System symbol table definition or an "I" if the macro is
supported via a B2H internal routine.
| ||
| Macro | How? | Comments (fully supported unless specified otherwise) |
|---|---|---|
| .CONFIG | I | |
| .GETW | I | All operands supported except GMLTYPE= and SCALE=. |
| .INWIDTH | I | |
| .NAMECTR | I | All functions supported, but the GMLTYPE, SIZE and CTRTYPE parameters are ignored |
| .NAMEFILE | I | In addition to the required NAME=, only the CMS= parameter is supported |
| .NAMEIT | I | All options supported except SIZE= |
| .SETDVCF | I | |
| .SETUP | I | |
| .TABRACK | I | The width of the line is determined by the value of the LINEWIDTH= option |
| .WHEN | I | |
| .usermacro | I | Macro defined previously using the .dm command. Parameters on the macro (e.g. .name parm1 parm2) and referencing them within the macro (e.g. &*, &*0, &*1, &*2 ...) is also supported. |
Macros not supported or not applicable; will be ignored
.BLOCK, .BOOKMARK, .CCPTOC, .CCTOC, .GETREF, .GETWMAX, .GETWSUM, .INCLUDE, .LAYOUT, .MOD, .MODSET, .MODTRAP, .NAMEEPS, .NAMEF, .NAMESTYL, .PGCHECK, .TABREAK and .USING
Figure 21. Supported BookMaster and GML tags
|
The "How?" column contains an "S" if the tag is supported
via a System symbol table definition or an "I" if the tag is
supported via a B2H internal routine.
| ||
| Tag | How? | Comments (fully supported unless specified otherwise) |
|---|---|---|
| :ABBREV. | I | |
| :ABSTRACT. | I | |
| :ADDRESS. | I | |
| :ALINE. | S | |
| :ANNOT. | I | (See also the ANNOT= or SYSVAR='A {YES|NO}' options) |
| :ANSREF | I | |
| :ANSWER | I | See also "Question and Answer tags" |
| :APL. | S | |
| :APPENDIX. | I | |
| :ARTWORK. | I | If RULE specified or NAME= omitted,
then the value for the HRTAG.1 option
(normally <HR>) is inserted.
(See also the ARTLINKIMG=, ARTSHOW= and ARTTYPE= options) If either CENTERTAG=YES or HTML=3 is specified, then the ALIGN=CENTER and ALIGN=RIGHT parameters are supported by enclosing the image reference with the <CENTER> ... </CENTER> HTML tags. |
| :ASMLIST. | S | |
| :ATTACH. | S | |
| :AUTHOR. | S | |
| :BACKM. | I | |
| :BIBLIOG. | I | |
| :BIN. | S | |
| :BINDNUM. | S | Displayed where defined, since HTML has no "draft title page" concept |
| :BLANK | I | See also "Question and Answer tags" |
| :BODY. | I | |
| :C. | I | |
| :CAUTION. | S | |
| :CGRAPHIC. | S | |
| :CHAR. | S | |
| :CHOICE | I | See also "Question and Answer tags" |
| :CIT. | I | |
| :CODE. | S | |
| :CODEL. | I | All options supported. STYLE=RULE causes the value specified for the HRTAG.4 option (normally a <HR>) to be inserted around each :CODE. block, all other style values generate a blank line. |
| :COPREXT. | I | |
| :COPRNOTE. | I | |
| :DANGER. | S | |
| :DATE. | I | |
| :DD. | I | |
| :DDHD. | I | |
| :DENTRY. | I | |
| :DIALDEF. | I | Both with and without ID= parameter |
| :DIALOG. | I | Mapped to HTML's <DL COMPACT> tag. |
| :DIRDEF. | I | Both with and without ID= parameter |
| :DIRECT. | I | Implemented using a monospaced font on a line 78 characters wide. REFID=, ALIGN= and COLS= supported. |
| :DIRHDR. | I | |
| :DIRSUB. | I | |
| :DL. | I | REFID= and COMPACT supported. |
| :DLDEF. | I | Both with and without ID= parameter |
| :DOCNUM. | S | |
| :DOCPROF. | I | Following parameters supported: BODYHD0=, BODYHD1=, FBC=, FTSEP=, HEADNUM=, QRESET= and TOC= |
| :DT. | I | |
| :DTHD. | I | |
| :FIG. | I | ID=, REFID=, FRAME= and CONCAT= supported.
When generating HTML 2 output, then if FRAME=NONE, the figure is preceded and followed by a blank line, otherwise the figure is preceded and followed by the value specified for the HRTAG.2 option (normally <HR>). When generating HTML 3, the figure is enclosed within a single-row, single-cell table (with BORDER turned on if FRAME is not NONE) |
| :FIGCAP. | I | |
| :FIGDEF. | I | Both with and without ID= parameter |
| :FIGDESC. | S | |
| :FIGREF. | I | |
| :FILENUM. | S | Displayed where defined, since HTML has no "back cover" concept |
| :FN. | I | All footnotes displayed at the end of the HTML file. (If the output HTML file is being broken into multiple output files, footnotes accumulated within that file are shown at the end of that particular file.) |
| :FNREF. | I | |
| :FRONTM. | I | |
| :GD. | I | |
| :GDG. | I | |
| :GDOC. | I | SEC= and COPYR= supported |
| :GL. | I | Only the COMPACT option is supported |
| :GLOSSARY. | I | |
| :GRPSEP. | S | |
| :GT. | I | |
| :H0., :H1., :H2., :H3., :H4., :H5., :H6., :H7., :H8., :H9., :H10., :H11., :H12., :H13., :H14., :H15., :H16., :H17., :H18., :H19. and :H20. | I | |
| :HDREF. | I | |
| :HEX. | S | |
| :HP0. | S | No HTML equivalent; will be ignored |
| :HP1. | S | Italics |
| :HP2. | S | Bold |
| :HP3. | S | Bold Italic |
| :HP4. | S | Monospaced font |
| :HP5. | S | Underlined |
| :HP6. | S | Underlined Italic |
| :HP7. | S | Underlined Bold |
| :HP8. | S | Underlined Bold Italic |
| :HP9. | S | Underlined monospaced font |
| :I1., :I2., :I3., :IH1., :IH2. and :IH3. | I | INCLUDE= and PRINT= operands are ignored, as is an entry with PG=END |
| :INDEX. | I | |
| :IREF. | I | INCLUDE= operand ignored |
| :L. | I | |
| :LBLBOX. | I | If generating HTML 2 output, the width of the box header and trailer line is defined by the value of the LINEWIDTH= option. For HTML 3, a single-cell, two-row table is generated. |
| :LDESC. | I | The DOCID= value points to the B2H
DOCDESC.id option instead of the
:DOCDESC tag.
For the OBJTYPE= parameter, the HEAD, BOOK, FIG, TABLE and SPOT values are supported; all others are ignored. See "Interdocument linking (BookManager tags)" for more information. |
| :LEDI. | I | |
| :LEN. | I | |
| :LERS. | I | If SEP=RULE specified, then the value for the HRTAG.10 option (normally <HR>) is inserted prior to each :LEN tag. |
| :LERSDEF. | I | Both with and without ID= parameter |
| :LI. | I | |
| :LIBRARY. | I | See also "Recognizing and displaying the document's title" |
| :LINES. | I | |
| :LIREF. | I | See the LIREF= option for controlling how this tag is handled |
| :LP. | S | |
| :LQ. | S | |
| :MATCH | I | See also "Question and Answer tags" |
| :MCDEF. | I | Both with and without ID= parameter |
| :MODULE. | S | |
| :MSG. | S | |
| :MSGL. | I | All options supported. STYLE=RULE causes the value specified for the HRTAG.4 option (normally a <HR>) to be inserted around each :CODE. block. All other style values generate a blank line. |
| :MSGNO. | S | |
| :MV. | S | |
| :NOTE. | I | |
| :NOTEL. | I | |
| :NOTICES. | S | |
| :NT. | I | |
| :NUMBYTES. | S | |
| :OL. | I | Only the COMPACT option is supported. |
| :ORESP. | S | |
| :P. | S | |
| :PARML. | S | Mapped to HTML's <DL> tag. Only the COMPACT option is supported. |
| :PARTNUM. | S | Displayed where defined, since HTML has no "back cover" concept |
| :PD. | S | Mapped to HTML's <DD> tag |
| :PK. | I | Nested :PK, including the DEF parameter, is supported |
| :PREFACE. | I | |
| :PRESP. | S | |
| :PROBD. | S | |
| :PRTLOC. | S | Displayed where defined, since HTML has no "back cover" concept |
| :PSC. | I | See additional comments in "Caveats and restrictions (what's supported and what's not!)". |
| :PT. | S | Mapped to HTML's <DT> tag |
| :PTOC. | I | |
| :PV. | S | |
| :Q. | S | |
| :QITEM | I | See also "Question and Answer tags" |
| :QREF | I | |
| :QUALIF. | I | The width of the qualification header and trailer line is defined by the value of the LINEWIDTH= option |
| :QUESTION | I | See also "Question and Answer tags"
KEEP=, COMPACT and LAYOUT= not supported |
| :RELEASE. | I | |
| :REV. | I | See the REVTAG= option for specifying the text to insert for marking revisions |
| :REVISION. | I | |
| :RK. | S | |
| :ROW. | I | REFID= and TEMP options supported |
| :SCHDATE. | I | |
| :SCHDEF. | I | Both with and without ID= parameter |
| :SCHEDULE. | I | Schedule tables are supported, but not schedule charts |
| :SCHI. | I | |
| :SCRDEF. | I | Both with and without ID= parameter |
| :SCREEN. | I | The width of the screen image is determined by the WIDTH= option, or, if omitted, the value of the LINEWIDTH= option |
| :SEVERITY. | S | |
| :SL. | I | Only the COMPACT option is supported. |
| :SOA. | I | |
| :SPOT. | I | ID= and XREFTEXT= supported. |
| :SPOTREF. | I | |
| :SPRESP. | S | |
| :SUB. | S | HTML does not define subscripts, so parentheses are used to simulate them |
| :SUP. | S | HTML does not define superscripts, so square brackets are used to simulate them |
| :SYNOPSIS. | S | |
| :SYS. | S | Mapped to HTML's <DT> tag. |
| :SYSACT. | S | |
| :TABDATA. | I | REFID=, CHAR=, COLS= and ALIGN= (including fill-character) supported |
| :TABDDEF. | I | Both with and without ID= parameter |
| :TABLE. | I | Implementation is dependent on the HTML release being generated. REFID=, ALIGN=, COLS=, CONCAT=, and CWIDTHS= supported. VALIGN= also supported if HTML=3. If HTML=2, the width of the table is defined by the value of the LINEWIDTH= option For more information, see "Special information about tables". |
| :TCAP. | I | |
| :TDEF. | I | Both with and without ID= parameter |
| :TDESC. | I | |
| :TFT. | I | |
| :THD. | I | |
| :TIPAGE. | S | |
| :TITLE. | I | STITLE= supported (see also "Recognizing and displaying the document's title") |
| :TITLEP. | I | See also "Recognizing and displaying the document's title" |
| :TLINE. | S | |
| :TNOTE. | I | |
| :TOC. | I | |
| :TOPIC. | I | See also "Recognizing and displaying the document's title" |
| :TP. | S | |
| :TREF. | I | |
| :UL. | I | Only the COMPACT option is supported. |
| :URESP. | S | |
| :USER. | S | Mapped to HTML's <DD> tag. |
| :USERDOC. | I | SEC=, COPYR= and IBMCOPYR= supported |
| :VENDOR. | S | Displayed where defined, since HTML has no "draft title page" concept |
| :VERSION. | I | |
| :VNHD. | S | |
| :VNOTICE. | I | |
| :VOLNUM. | S | |
| :WARNING. | S | |
| :XMP. | S | |
| :XPH. | S | |
| :XPL. | S | |
Not applicable or not supported; will be ignored
:ARTALT., :ARTDEF., :AUTOLIK., :CAUSE., :CC., :CGDEF., :CI., :CIREF., :CLETTER., :CMT., :COMPANY., :COMPL., :COVER., :CT., :DC., :DELIM., :FIGLIST., :FIGSEG., :FLE., :FRAGMENT., :FRAGREF., :FROM., :GRID., :GRIDAREA., :GRIDDEF., :GRIDSEG., :GROUP., :IBMX., :INIT., :IZIP., :KWD., :LEGEND., :LITDATA :LOC., :MAP., :MAPDEF., :MAPQFIX., :MARKDESC., :MARKLIST., :MARKNT., :MD., :MKACTION., :MKCLASS., :MKINDEX., :NAME., :NETID., :NITEM., :OPER., :OVERART., :OVERLAY., :PARTSASM., :PC., :PGMNUM., :PHONE., :PNINDEX., :PROLOG., :QT., :REF., :REPSEP., :RETKEY., :REVCW., :REVPF., :REVPP., :REVPT., :REVSLUG., :SAFETY., :SCHNOTE., :SEP., :SIG., :SNOTICE., :ST., :STEP., :STEPREF., :SUBJECT., :SYNDEF., :SYNNT., :SYNNTREF., :SYNTAX., :TCE0., :TCE1., :TCE2., :TCE3., :TCE4., :TCE5., :TCE6., :TCE7., :TCE8., :TCE9., :TCE10., :TCE11., :TCE12., :TCE13., :TCE14., :TCE15., :TCE16., :TCE17., :TCE18., :TCE19., :TCE20., :TLE., :TLIST., :TO., :TPCODE., :VAR., :XMPDEF.
In addition to the normal &variables provided by Script/VS, GML
and BookMaster, B2H also provides a number of special-use
&variables.
Most often used within header and footer files and in conjunction with
certain options, such as PARTLINK.x= and
COMMENT=.
| &variable | Contains |
|---|---|
| &b2hcoprext | Text specified for the :COPREXT tag (if any) |
| &b2hcopyr | Text specified for the COPYR= attribute (if any) on the :GDOC or :USERDOC tag |
| &b2hheadnum | Contains the header text of the most-recent
:Hnum. tag. The text specified for the
most-recent :H0. is stored in
&b2hhead0, :H1. is in
&b2hhead1, etc.
When an :Hx. tag is encountered, all "lower" symbols are cleared. For example, if an :H2. tag is encountered, the &b2hhead3 symbol is cleared, &b2hhead4 is cleared, &b2hhead5 is cleared, etc. |
| &b2hhtml | The HTML release level being generated. Contains either the number "2" or the number "3". |
| &b2hiall | The fully-qualified name of the input file
AIX: /path/subdir/hh1.h2.hhh3 OS/2: c:\dir\subdir\fname.ext CMS: fn ft fm WIN95: c:\dir\subdir\fname.ext WINNT: c:\dir\subdir\fname.ext |
| &b2hibmcopyr | Text specified for the IBMCOPYR= attribute (if any) on the :USERDOC tag |
| &b2hipath | The path of the input file (if appropriate)
AIX: /path/subdir/ OS/2: c:\dir\subdir\ CMS: (Null string) WIN95: c:\dir\subdir\ WINNT: c:\dir\subdir\ |
| &b2hifile | The non-path portion of the input file
AIX: hh1.h2.hhh3 OS/2: fname.ext CMS: fn ft WIN95: fname.ext WINNT: fname.ext |
| &b2hidate | The input file's date stamp in yyyy-mm-dd format |
| &b2hitime | The input file's time stamp in hh:mm:ss format |
| &b2holall | The fully-qualified name of the logical output file
AIX: /path/subdir/hh1.h2.hhh3 OS/2: c:\dir\subdir\fname.ext CMS: fn ft fm WIN95: c:\dir\subdir\fname.ext WINNT: c:\dir\subdir\fname.ext |
| &b2holpath | The path of the logical output file (if appropriate)
AIX: /path/subdir/ OS/2: c:\dir\subdir\ CMS: (Null string) WIN95: c:\dir\subdir\ WINNT: c:\dir\subdir\ |
| &b2holfile | The non-path portion of the logical output file
AIX: hh1.h2.hhh3 OS/2: fname.ext CMS: fn ft WIN95: fname.ext WINNT: fname.ext |
| &b2hopall | The fully-qualified name of the physical output file
AIX: /path/subdir/hh1.h2.hhh3 OS/2: c:\dir\subdir\fname.ext CMS: fn ft fm WIN95: c:\dir\subdir\fname.ext WINNT: c:\dir\subdir\fname.ext |
| &b2hoppath | The path of the physical output file (if appropriate)
AIX: /path/subdir/ OS/2: c:\dir\subdir\ CMS: (Null string) WIN95: c:\dir\subdir\ WINNT: c:\dir\subdir\ |
| &b2hopfile | The non-path portion of the physical output file
AIX: hh1.h2.hhh3 OS/2: fname.ext CMS: fn ft WIN95: fname.ext WINNT: fname.ext |
| &b2hparttop | The applicable next/prev links for the top of an HTML output file. Normally specified inside a user header file. If the output file is not being split, this is a null string. Otherwise, this contains either the value of PARTLINK.1, PARTLINK.3, PARTLINK.5, PARTLINK.11, PARTLINK.13 or PARTLINK.15, depending on the circumstances. |
| &b2hpartbot | The applicable next/prev links for the bottom of an HTML output file. Normally specified inside a user footer file. If the output file is not being split, this is a null string. Otherwise, this contains either the value of PARTLINK.2, PARTLINK.4, PARTLINK.6, PARTLINK.12, PARTLINK.14 or PARTLINK.16, depending on the circumstances. |
| &b2hplat | A string containing both the platform on which B2H was run and the destination platform with a dash separating the two. If the current platform and the destination platform are the same, then the string contains only a single value. |
| &b2hplatc | The name of the current platform on which B2H is running, e.g. AIX, HPFS, OS2, CMS, WIN95, WINNT |
| &b2hplatd | The name of the destination platform, as specified by the DESTSYS= option |
| &b2hrevchar | Contains the revision character identifying the .rc command or :revision tag currently in effect (if any) -- intended for use in conjunction with the REVTAG= option |
| &b2hsig | The name, release number and internal level of the B2H program itself |
| &b2huser | The user ID executing the B2H program.
AIX: (Null string) OS/2: (Null string) CMS: by USERID at NODE WIN95: (Null string) WINNT: (Null string) |
| Note: The following &variables are specifically intended for use within a PARTLINK.x= option, but can be used anywhere. | |
| &b2hbot | HTML label for the bottom of the current HTML file |
| &b2hidx | HTML file/label for the start of the index (if generated) |
| &b2hnext | HTML file/label for the next HTML file |
| &b2hprev | HTML file/label for the previous HTML file |
| &b2hthis | Name of the current HTML file |
| &b2htoc | HTML file/label for the start of the Table-of-Contents |
| &b2htop | HTML label for the top of the current HTML file |
(1) For example, this might be used to ensure that all files contain standardized navigational links.
(2) B2H may run on earlier versions of OS/2, but it has not been tested.
(3) The REXX Compiler run-time libraries are required if the compiled version of B2H is to be used.
(4) Windows 95 and Windows NT support requires IBM's ObjectREXX for Windows 95 and Windows NT. You can download it from the ObjectREXX home page at http://www2.hursley.ibm.com/orexx
(5) If you will be using B2H on VM only, you can discard B2H ZIPBIN.
(6) If you will be browsing the HTML output on a platform other than OS/2, you can tell B2H to customize it's output for that platform, like:
B2H fn ft fm ( DESTSYS=AIX B2H fn ft fm ( DESTSYS=VM B2H fn ft fm ( DESTSYS=WIN95 B2H fn ft fm ( DESTSYS=WINNT
(7) On AIX, you may need to specify the "-a" option when unzipping to remove the ctrl-M characters.
(8) Note that the left-parenthesis must be quoted to prevent the shell from interpreting it and causing an error.
(9) AUTOPART is not available if B2H is running as a CMS pipeline filter
(10) The syntax of the specified file must satisfy the naming convention for the platform on which you are running B2H. See "Specifying a file" for more information.
(11) Multiple "dot" commands can be defined by separating each command with semi-colons. For example: V='.ce line 1;.ce line 2'
(12) See "Specifying the location and file names when splitting the HTML output" for overriding the location and names given to each output HTML file part.
(13) See "Specifying the location and file names when splitting the HTML output" for overriding the location and name given to the output HTML file part created at this point.
(14) A sample CGI script is provided in the zip file that you can use as an example. QUEST.KSH is designed as a KORN shell to be run under AIX using IBM's Internet Connection Server.
(15) However, program syntax tags such as :PARML., :PK. and :PV. are supported
(16) The number of leading blanks is determined by the line width as specified by the LINEWIDTH= option.