Copyright (c) 2001-2002 AT&T
B2H: Convert BookMaster, GML,
Script/VS and 'flat' files to HTML
User's Guide
Release 4.7
Gary Richtmeyer
grichtmeyer@att.com
AT&T Corporation
AT&T Labs
3405 W. Dr. Martin Luther King Jr. Blvd
Tampa, Florida 33607
Formatted on Monday, May 20, 2002 at 16:02:26
HTML 3 version generated by B2H R4.7 (390)
20 May 2002
Synopsis: B2H converts 'flat' files and files written in BookMaster, Generalized Markup Language (GML) and Script/VS into HTML format suitable for use in an Internet World-Wide-Web environment
B2H reads files written in BookMaster, Generalized Markup Language (GML), Script/VS, and even 'flat' files, and converts them into 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, Linux, MVS (OS/390), OS/2, VM/ESA, Windows 95/98/ME, Windows NT/2000/XP and Unix. On VM/ESA, B2H can run either as a stand-alone EXEC or as a CMS pipeline filter. On MVS, B2H can run either as a stand-alone program or as a MVS/BatchPipeWorks pipeline filter.
Details on the changes made for each B2H release are documented in Appendix E, "B2H release history".
Chapter 2. Obtaining and Installing B2H
Chapter 6. Caveats and restrictions (what's supported and what's not!)
Chapter 7. Troubleshooting and Frequently-Asked-Questions (FAQ)
Appendix A. Symbols, control words, macros and tags supported by B2H
Appendix B. &Symbols pre-defined by B2H
Appendix E. B2H release history
2-1. Suggested naming conventions if downloading individual files
2-2. FILE and DSN= defaults for system datasets under MVS
3-1. Specifying a dataset under MVS (OS/390)
5-1. Input/Output Naming Conventions
5-2. Using OUTPUTP= under MVS
5-3. Layout of the output HTML file
5-4. .*B2H statements
8-1. B2H options - Overview
8-2. Some coded character sets
8-3. DEFTEXT.name= values
8-4. MVSALLOC.name= values
8-5. Script-to-HTML mapping for the OLSEQ= option
8-6. SETUPTAG.tagname values
8-7. Default SHADE.name= option values
9-1. Specifying an '&symbol'
9-2. Specifying a Script/VS control word and/or BookMaster/GML macro
9-3. Specifying a BookMaster/GML tag
9-4. Specifying a character translation
10-1. Example: The caption for a simple table with no frame
10-2. Example: A simple table with a frame
10-3. Example: Same table with additional embellishments
10-4. Example: A complex table with varying columns by row
10-5. Default appearances for SHADE
10-6. Example: figure with light blue shading
10-7. Example: This is the figure caption using the :figcap. tag
A-1. Supported &symbols
A-2. System &symbols
A-3. Supported &symbol value attributes
A-4. Supported Script/VS control words
A-5. Supported BookMaster and GML macros
A-6. Supported BookMaster and GML tags
B2H reads files written in BookMaster, Generalized Markup Language (GML), Script/VS, and even 'flat' files, and converts them into HTML format suitable for use in an Internet World-Wide-Web environment.
B2H is a REXX program that runs under AIX, Linux, MVS (OS/390), OS/2, VM/ESA, Windows 95/98/ME, Windows NT/2000/XP and Unix. On VM/ESA, B2H can run either as a stand-alone EXEC or as a CMS pipeline filter. On MVS, B2H can run either as a stand-alone program or as an MVS/BatchPipeWorks 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 do not 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 Chapter 6, "Caveats and restrictions (what's supported and what's not!)".
B2H is written in REXX and requires that REXX be installed on the machine on which it is executed. Two different "flavors" of REXX can be used:
One of the following platforms on which to run B2H:
AIX support requires REXX to be installed. For IBM's Object REXX for AIX, check out the Object REXX home page at http://www2.hursley.ibm.com/orexx For Regina REXX, check out the Regina REXX home page at http://regina-rexx.sourceforge.net
Linux support requires REXX to be installed. For IBM's Object REXX for Linux., check out the Object REXX home page at http://www2.hursley.ibm.com/orexx For Regina REXX, check out the Regina REXX home page at http://regina-rexx.sourceforge.net
The REXX Compiler run-time libraries are required if the compiled version of B2H is to be used.
You can either use IBM's REXX provided with OS/2 or you can use Regina REXX. For Regina REXX, check out its home page at http://regina-rexx.sourceforge.net
The REXX Compiler run-time libraries are required if the compiled version of B2H is to be used.
Support for Windows 95/98/ME and Windows NT/2000/XP requires REXX to be installed.
For IBM's Object REXX for Windows 95/NT, check out the Object REXX home page at
http://www2.hursley.ibm.com/orexx
For Regina REXX, check out the Regina REXX home page at
http://regina-rexx.sourceforge.net
Support for Unix requires REXX to be installed.
For Regina REXX, check out the Regina REXX home page at
http://regina-rexx.sourceforge.net
No known restrictions
B2H is available on IBM's VM download page on the Internet at http://www.vm.ibm.com/download
On that site, you can download either of two files containing the B2H system: B2H.VMARC (a VMARC-type file) or B2H.ZIP (a "traditional" ZIP-type file). The VMARC file contains the "base" install files, plus the following: a copy of B2H compiled for VM; a copy of B2H compiled for MVS; a LIST3820 version of the B2H User's Guide; and a copy of the ZIP file itself. The ZIP file contains just the "base" install 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". Later, you may wish to do some customization to tailor B2H's operation to your environment and to take advantage of some of the more powerful B2H and HTML features.
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).
or
Caution:
If you must download the individual files:
If downloading individual files, the suggested naming convention is:
Figure 2-1. Suggested naming conventions if downloading individual files
|
For use on a workstation, it is recommended that you download
B2H ZIP and use one of the UNZIP-type programs to extract the files
as opposed to downloading individual files.
| |||
| VM/ESA | AIX, Linux and Unix | OS/2
(this is also the name contained within B2H ZIP) | Windows 95/98/ME and Windows NT/2000/XP |
|---|---|---|---|
| B2H ANNOUNCE | b2h.announce | B2H.ANN | B2H.ANN |
| B2H SEXEC (REXX source) | b2h.exec | B2H.CMD | B2H.CMD or B2H.REX |
| 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 |
chmod +x b2hname ./b2hname
Let's try some examples:
AIX, Linux and Unix | b2h file
|
OS/2 | B2H fn.ext
|
Windows 95/98/ME | REXX B2H fn.ext
|
Windows NT/2000/XP | REXX B2H fn.ext
|
AIX, Linux and Unix | b2h file '(' TOC=NO TITLE='My sample title' 5 |
OS/2 | B2H fn.ext ( TOC=NO TITLE='My sample title' |
Windows 95/98/ME | REXX B2H fn.ext ( TOC=NO TITLE='My sample title' |
Windows NT/2000/XP | REXX B2H fn.ext ( TOC=NO TITLE='My sample title' |
AIX, Linux and Unix | b2h c:\config.sys '(' SOURCE=FLAT TITLE='My config.sys' 5 |
OS/2 | B2H c:\config.sys ( SOURCE=FLAT TITLE='My config.sys' |
Windows 95/98/ME | REXX B2H c:\config.sys ( SOURCE=FLAT TITLE='My config.sys' |
Windows NT/2000/XP | REXX B2H c:\config.sys ( SOURCE=FLAT TITLE='My config.sys' |
AIX, Linux and Unix | b2h ? |
OS/2 | B2H ? |
Windows 95/98/ME | REXX B2H ? |
Windows NT/2000/XP | REXX B2H ? |
If desired, customize to your needs (see Chapter 4, "Customizing B2H").
Caution:
The files were created on a U.S. system. If uploading
to a non-U.S. system, be careful to ensure you use the correct
translate table. An incorrect translate table during upload can
often cause "Invalid character in program" error messages when
trying to execute B2H.
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).6 Then send the files to the TSO user ID doing the installation.
If you ordered the package from an internal IBM tools disk, have the files sent directly to your TSO user ID.
Two versions of the B2H program are available for MVS: B2H SEXEC is the REXX source code and B2H MVSCEXEC is the MVS REXX compiled version. (Note: if you retrieved just the ZIP file from the Internet, only the REXX source code (B2H.CMD) is provided within the ZIP file.) The compiled version runs much faster but requires the REXX compiler run-time libraries. The source code runs slower, but has no additional dependencies. Select the version that best meets your needs.
Determine the partitioned data set (PDS) to hold the B2H program.
Once placed, you can run B2H:
It is STRONGLY suggested that the implicit execution environment be established (the examples within this User's Guide assume that this has been done). For further information on explicit and implicit execution of REXX programs, see "TSO/E REXX/MVS Reference", order number SC28-1883, specifically the section entitled "Using SYSPROC and SYSEXEC for REXX Execs".
Example: assume the program has been loaded into the PDS userid.MYPGMS.EXEC(B2H)
When B2H starts, it looks for it's three system files: the system profile, the system symbol table and the help file. For each file, B2H first checks to see if a dataset has been preallocated to a particular FILE/DDcard. If not preallocated, B2H then attempts to locate the file using the default dataset name.
If you intend to preallocate the system files before invoking
B2H, then install the system files into the dataset names of
your choosing; if not, install the system files into the dataset
names shown in the following table.
Figure 2-2. FILE and DSN= defaults for system datasets under MVS
|
If you need to change these defaults, you must edit the REXX source.
(The default FILE/DDcard and dataset names are defined near the
beginning of the REXX source code.)
| ||
| File | Default FILE/DDcard | Default dataset name |
|---|---|---|
| B2H system profile | B2HPRO | 'B2H.PROFILE' |
| B2H system symbol table | B2HSYM | 'B2H.SYMBOLS' |
| B2H help file | B2HHELP | 'B2H.HELP' |
The remainder of the files in the B2H package are optional. These consist of such files as the User's Guide (in BookMaster source, LIST3820 and HTML formats) and various sample files. See 2.3.4, "Content of the B2H package" for the list of all files. Whether they should be received and saved is at your discretion.
The following examples assume that B2H can be implicitly invoked (the PDS in which it resides has been allocated to either SYSEXEC or SYSPROC) and that the system files have already been allocated similar to the following:
ALLOC FI(B2HPRO) DA(system-profile-dataset) SHR REUSE ALLOC FI(B2HSYM) DA(system-symbol-table-dataset) SHR REUSE ALLOC FI(B2HHELP) DA(system-helpfile-dataset) SHR REUSE
Convert files stored under your userid:
B2H test1.script Output: TEST1.HTML
B2H proj23.script(chap1) PROJ23.CHAP1.HTML
Convert files NOT stored under your userid:
B2H 'SYS3.ISO9000.SCRIPT' Output: 'SYS3.ISO9000.HTML'
B2H 'mvs1.org.text(guide)' 'MVS1.ORG.GUIDE.HTML'
Convert the sequential dataset allocated to 'DD1'
B2H DD:DD1
Convert the member 'MEM3A' from one of the datasets allocated to 'DD2'
B2H DD:DD2(MEM3A)
B2H filespec ( DESTSYS=AIX B2H filespec ( DESTSYS=LINUX B2H filespec ( DESTSYS=CMS B2H filespec ( DESTSYS=OS2 B2H filespec ( DESTSYS=WIN95 B2H filespec ( DESTSYS=WINNT B2H filespec ( DESTSYS=UNIXTransfer the HTML output file to the desired platform and point your web browser at it.
B2H filespec ( TOC=NO TITLE="My sample title"
B2H 'SYS1.PROCLIB(TSO)' ( SOURCE=FLAT TITLE="Member TSO"
B2H ?
If desired, customize to your needs (see Chapter 4, "Customizing B2H").
If you downloaded the ZIP file from the Internet directly onto your PC, unzip the file and upload the files to your VM user ID.
Caution:
The files were created on a U.S. system. If uploading
to a non-U.S. system, be careful to ensure you use the correct
translate table. An incorrect translate table during upload can
often cause "Invalid character in program" error messages when
trying to execute B2H.
If you ordered the package from an internal IBM tools disk, receive the files to a read/write disk (typically your A-disk). 6
Two versions of the B2H program are available for VM: B2H SEXEC is the REXX source code and B2H EXEC is the VM REXX compiled version. The compiled version runs much faster but requires the REXX compiler run-time libraries. The source code runs slower, but has no additional dependencies. Ensure that the filetype of the desired version is "EXEC".
Let's try some examples:
B2H fn ft fmIf you have a VM-based web browser, point it at the HTML output file "fn HTML A". For example: WWW file://fn.html
B2H fn ft fm ( DESTSYS=AIX B2H fn ft fm ( DESTSYS=LINUX B2H fn ft fm ( DESTSYS=MVS B2H fn ft fm ( DESTSYS=OS2 B2H fn ft fm ( DESTSYS=WIN95 B2H fn ft fm ( DESTSYS=WINNT B2H fn ft fm ( DESTSYS=UNIXTransfer the HTML output file to the desired platform and point your web browser at it.
B2H fn ft fm ( TOC=NO TITLE='My sample title'
B2H PROFILE EXEC ( SOURCE=FLAT TITLE="My Profile Exec"
If desired, customize B2H to your needs (see Chapter 4, "Customizing B2H").
The B2H "package" contains the following files:
| File | Also within the ZIP file? | Description |
|---|---|---|
| B2H ANNOUNCE | Yes (as B2H.ANN) | The announcement and installation instructions file |
| B2H EXEC | No | Main routine, compiled REXX for use on VM (compiled using the VM REXX Compiler R4.00) |
| B2H MVSCEXEC | No | Main routine, compiled REXX for use on MVS (compiled using the VM REXX Compiler R4.00 and converted to MVS-executable format) |
| B2H SEXEC | Yes (as B2H.CMD) | Main routine (REXX source) |
| B2H HELPCMS | Yes (as B2H.HLP) | Online help file |
| B2H NEWS | Yes (as B2H.NEW) | List of recent changes |
| B2H PROFILE | Yes (as B2H.PRO) | System profile |
| B2H SYMBOLS | Yes (as B2H.SYM) | System symbol definition file |
| B2HLINK GIFBIN | Yes (as B2HLINK.GIF) | Default graphic image for use with ARTSHOW=LINK option |
| B2H SCRIPT
B2HSETUP SCRIPT B2HINF SCRIPT B2HSYS SCRIPT B2HUSE SCRIPT B2HEXA SCRIPT B2HAPP SCRIPT B2HMSG SCRIPT | Yes (as B2Hxxx.SCT) | User's Guide (BookMaster source) |
| B2H LIST3820 | No | User's Guide (3820 print-ready) |
| B2H HTML | Yes (as B2H.HTM) | User's Guide (HTML 3 format) |
| B2HR2 HTML | Yes (as B2HR2.HTM) | User's Guide (HTML 2 format) |
| B2HIBM FOOTER | Yes (as B2HIBM.FOT) | Sample "footer" file containing standard IBM Home page linkages |
| B2HUSER EXEC | Yes (as B2HUSER.CMD) | Sample user exit |
| B2HUSER SYMBOLS | Yes (as B2HUSER.SYM) | Sample user symbol definitions (as distributed, allows B2H to support users of the BookHype HTML converter program) |
| B2H ZIP |
| Contains the above marked files to simplify downloading to a workstation |
At startup, B2H first determines under which REXX it is running (see also 2.1.1, "REXX"). B2H then 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.
A file's specification ("filespec") must satisfy
the naming convention of the platform for which the file is being
specified. For example, when running B2H on AIX, the
input filespec must conform to AIX naming conventions.
e.g. B2H /u/johndoe/project2/overview.script
Many B2H options allow you to specify a
filespec, which also must conform to the naming convention of the
appropriate platform. For example, if you run B2H on OS/2 and
explicitly specify the name of the physical output file, the output
filespec must conform to OS/2 naming conventions.
e.g. B2H ... ( OUTPUTP=c:\pubs\abc.htm
If specifying a file using VM/CMS naming conventions on a
B2H option, you must enclose it within single or
double-quotes since the name contains blanks
e.g. B2H ... ( OUTPUTP='ABC HTML A'
When specifying a dataset under MVS, you should follow normal TSO/E naming conventions: if enclosed in single-quotes, the dataset is used as-is, else it is preceded by your TSO/E prefix (normally your user ID). You can also identify the dataset by specifying the DD to which the dataset is allocated.
Figure 3-1 lists the various ways that any of the three datasets referenced in the following example can be specified:
B2H dataset1 ( OUTPUTP=dataset2 HEADER=dataset3
Figure 3-1. Specifying a dataset under MVS (OS/390)
| Value specified | Refers to |
|---|---|
| ABC.SCRIPT | userid.ABC.SCRIPT |
| 'ABC.SCRIPT' | ABC.SCRIPT |
| ABC.SCRIPT(MEM1) | Member MEM1 of userid.ABC.SCRIPT |
| 'ABC.SCRIPT(MEM1)' | Member MEM1 of ABC.SCRIPT |
| DD:ddname | The sequential dataset(s) allocated to ddname |
| DD:ddname(member) | Member member within the partition data set(s) allocated to ddname |
This assumes you have installed B2H according to the steps described in 2.3.1, "Installation on a PC (AIX, Linux, OS/2, Windows 95/98/ME, Windows NT/2000/XP and Unix)".
b2h file [ '(' option1=value1 ... optionx=valuex ] 7
Ensure that B2H can find its system files by either FILE/DDcard 8 or dataset name (see Installing the B2H system files and Step 2 - Specify the location of the system files for more information).
If installed to allow implicit execution: B2H inputfilespec [ ( option1=value1 ... optionx=valuex [)] ] If exlicit execution is required: EXEC PDSfilespec(B2H) 'inputfilespec [ ( option1=value1 ... optionx=valuex [)] ]' EXECSee 3.2.2, "Specifying a dataset under MVS (OS/390)" for specifying the inputfilespec.
Ensure that B2H can find its system files by either FILE/DDcard 9 or dataset name (see Installing the B2H system files and Step 2 - Specify the location of the system files for more information).
PIPE ... | REXX B2H [ ( option1=value1 ... optionx=valuex [)] ] | ...In order to invoke a B2H as a pipeline filter, you must allocate the file REXX to the partition data set containing the B2H program. Further information on invoking user-written pipeline filters is available in "IBM BatchPipes/MVS BatchPipeWorks Reference", order number GC28-1217.
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 |
You can use the PROCACT= option to control how B2H handles various processing situations (which also affects the return code).
B2H supports a wide variety of processing options (for a complete list, see 8.2, "Available B2H Options"). The 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:
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 workstation 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
To more easily run B2H from different directories on AIX, Linux, OS/2, Windows 95/98/ME, Windows NT/2000/XP or Unix, 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 also follows the above steps when attempting to locate user profiles or symbol tables.
When B2H starts, it looks for it's three system files: the system profile, the system symbol table and the help file. For each file, B2H first checks to see if a dataset has been preallocated to a particular FILE or DDcard. If not preallocated, B2H attempts to locate the file using the default dataset name.
See Figure 2-2 for a list of the system files and their default FILE/DDcard and dataset names.
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 3.11, "Specifying B2H options".
Options whose values are commonly changed:
BODYTAG= HEADER= IMBPATH= DESTSYS= HTML= IMGPATH= DLFMT= IMBEDID= LOG= FOOTER= IMBFT= GLFMT= IMBFTEXT=
Refer to 8.2, "Available B2H Options" for a list of all available options.
Step 4 - Update the B2H symbol file
If you have custom symbols, control words, 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 8.2, "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. 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.
Step 7 - Customize the generated HTML
Using the default options, the HTML markup generated by B2H should satisfy most people. However, if you have special needs, facilities are available by which you can customize the generated HTML markup:
The SOURCE= option specifies the format of the input file.
It does not matter to B2H whether your documents are written using BookMaster markup or Generalized Markup Language (GML) markup because BookMaster and GML tags do not conflict with each other and the processing rules are the same. When SOURCE=SCRIPT is specified (the default value), B2H treats the input simply as a "script"-type document.
BookMaster tags and processing rules are described fully in IBM BookMaster User's Guide, order number SC34-5009. GML tags and processing rules are described fully in IBM Document Composition Facility Generalized Markup Language Starter Set Reference, order number SH20-9187.
Script/VS control words (e.g. .br, .cp) may be freely intermixed within your text and markup. Although GML and BookMaster have restrictions on which Script/VS control words may be used, B2H makes no such distinction and will process whatever is present in your source document.
The use of a control word separator (normally a semi-colon unless changed using .DC) is supported, but only if a Script/VS control word starts in column one.
This is OK:
.br;This sentence starts on a new line
.sk;.sk;Text after two line skips
The following is treated as a single line of text:
Vocal music is best sung acapella;.br
Documents written using only Script/VS control words tend to be more difficult to convert to HTML. Whereas GML and BookMaster tags describe a document's content and therefore convert fairly easily to HTML's content-oriented language, Script/VS control words are precise formatting directives specifying exactly how the output document is to appear on a particular output device. HTML does not provide this level of formatting granularity.
Depending on how your document is written and the control words used, it may convert correctly using SOURCE=SCRIPT as described previously in 5.1.1, "Converting BookMaster and GML files (SOURCE=SCRIPT)". It is suggested that you try this approach first.
If the HTML output is not acceptable, it may be because the processing rules for "pure" Script/VS documents are slightly different than for BookMaster or GML. These rules are described fully in IBM Document Composition Facility Script/VS Language Reference Guide, order number SH35-0070. To tell B2H to use these processing rules, specify SOURCE=SCRIPTONLY. This causes the following changes.
If the HTML output is still not acceptable, you will need to either edit the HTML output to get what you want or update your input source.
To indicate that a 'flat' file is being processed, just 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".
Because many 'flat' files are simple paragraphs of text with a blank line between the paragraphs, two additional operands on the SOURCE= option allow specialized processing. For these types of 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 normally also specify TITLE='text' since no BookMaster, GML or Script/VS markup will be present for B2H to recognize as the title. If TITLE= is not specified for a 'flat' file, the first non-blank line is used as the title.
Example:
B2H PIANO HOW-TO ( TITLE='How to play the piano' SOURCE=FLAT
VM Example: Convert your PROFILE EXEC
B2H PROFILE EXEC A ( SOURCE=FLAT TITLE='My Profile Exec'
PC Example: Convert your C:\CONFIG.SYS
B2H C:\CONFIG.SYS ( SOURCE=FLAT TITLE='My Config.Sys'
MVS Example: Convert a member from SYS1.PROCLIB:
B2H 'SYS1.PROCLIB(TSO)' ( SOURCE=FLAT TITLE='This is SYS1.PROCLIB(TSO)'
B2H keeps track of two algorithms for the output file: the physical file name created on the current platform and the logical file name used by the HTML HREF= parameter (which must match the physical name when the HTML file is handled by the server). This is discussed in more detail in 5.3, "Cross-Platform considerations".
In most situations, you will not need to specify these names as B2H will determine them based on the input file and the platform(s) involved. But if you wish to specify them, use the OUTPUTP= option to specify the physical file name and the OUTPUTL= option to specify the logical file name.
When might you want to specify the output file names?
The following table contains examples of the relationship between
the input and output file names.
Figure 5-1. Input/Output Naming Conventions
|
The "2nd File" value refers to the file name used when
"splitting" the output HTML file. See 5.9, "Splitting the output HTML file into multiple files"
for more information.
| ||||
| Input File | Value specified for OUTPUTP= | 1st Physical File
2nd Physical File | Value specified for OUTPUTL= | 1st Logical File
2nd Logical File |
|---|---|---|---|---|
| On AIX, Linux, OS/2 HPFS, UNIX | ||||
| abc.script | (none) | abc.html
abc02.html | (none) | abc.html
abc02.html |
| abc.script | def.html | def.html
def02.html | (none) | def.html
def02.html |
| abc.script | def.html | def.html
def02.html | xyz.html | xyz.html
xyz02.html |
| abc.longerthan.script | (none) | abc.longerthan.html
abc.longerthan02.html | (none) | abc.longerthan.html
abc.longerthan02.html |
| abc.longerthan.script | def.twothree.html | def.twothree.html
def.twothree02.html | (none) | def.twothree.html
def.twothree02.html |
| abc.longerthan.script | def.twothree.html | def.twothree.html
def.twothree02.html | xyz.twothree.html | xyz.twothree.html
xyz.twothree02.html |
| On OS/2 FAT, Windows 9x/ME, Windows NT/2000 | ||||
| abc.scr | (none) | abc.htm
abc02.htm | (none) | abc.htm
abc02.htm |
| abc.scr | defghij.htm | defghij.htm
defghi02.htm | (none) | defghij.htm
defghi02.htm |
| abc.scr | defghij.htm | defghij.htm
defghi02.htm | xyz.htm | xyz.htm
xyz02.htm |
| On MVS | ||||
| ABC.DEF.SCRIPT | (none) | ABC.DEF.HTML
ABC.DEF02.HTML | (none) | abc.def.html
abc.def02.html |
| ABC.DEF.SCRIPT | DEF.TWOTHREE.HTML | DEF.TWOTHREE.HTML
DEF.TWOTHR02.HTML | (none) | def.twothree.html
def.twothr02.html |
| ABC.DEF.SCRIPT | DEF.TWOTHREE.HTML | DEF.TWOTHREE.HTML
DEF.TWOTHR02.HTML | xyz.twothree.html | xyz.twothree.html
xyz.twothr02.html |
| ABC.DEF.SCRIPT(MEM5) | (none) | ABC.DEF.MEM5.HTML
ABC.DEF.MEM502.HTML | (none) | abc.def.mem5.html
abc.def.mem502.html |
| ABC.DEF.SCRIPT(MEM5) | ABC.XYZ.HTML | ABC.XYZ.HTML
ABC.XYZ02.HTML | (none) | abc.xyz.html
abc.xyz02.html |
| ABC.DEF.SCRIPT(MEM5) | ABC.XYZ.HTML | ABC.XYZ.HTML
ABC.XYZ02.HTML | def.xyz.html | def.xyz.html
def.xyz02.html |
| ABC.DEF.SCRIPT | ONE.TWO(MEM5) | ONE.TWO(MEM5)
ONE.TWO(MEM502) | (none) | one.two(mem5)
one.two(mem502) |
| ABC.DEF.SCRIPT | ONE.TWO(MEM5) | ONE.TWO(MEM5)
ONE.TWO(MEM502) | abc.xyz.html | abc.xyz.html
abc.xyz02.html |
| On VM | ||||
| ABC SCRIPT A | (none) | ABC HTML A
ABC02 HTML A | (none) | abc.html
abc02.html |
| ABC SCRIPT A | DEFGHIJ HTML B | DEFGHIJ HTML B
DEFGHI02 HTML B | (none) | defghij.html
defghi02.html |
| ABC SCRIPT A | DEFGHIJ HTML B | DEFGHIJ HTML B
DEFGHI02 HTML B | xyz.html | xyz.html
xyz02.html |
Just as the input file can be specified either by dataset name or by DD, the physical output file can also be specified either by dataset name or by DD (see 3.2.2, "Specifying a dataset under MVS (OS/390)").
By default, B2H creates one or more sequential output files when converting a source document.
Under MVS, you can instead have B2H create one or more
members in a partitioned data set (PDS). To do this, just ensure
that the OUTPUTP= option references both a dataset name
and an initial member name.
(See also 3.2.2, "Specifying a dataset under MVS (OS/390)".)
Here are the different ways to do it:
Figure 5-2. Using OUTPUTP= under MVS
| Specified | Output dataset | Initial member | Comments |
|---|---|---|---|
| B2H ... ( OUTPUTP=PROJ1.HTML(MEM1) | PROJ1.HTML | MEM1 | When the dataset name is explicitly specified like this, then if the dataset exists prior to invoking B2H, the member(s) will be added to it; if the dataset does not exist prior to invoking B2H, the dataset will be created. (See the MVSALLOC= option for how to specify the allocation values.) |
| ALLOC FI(DD1) DA(PROJ1.HTML(MEM1))
B2H ... ( OUTPUTP=DD:DD1 | PROJ1.HTML | MEM1 | |
| ALLOC FI(DD1) DA(PROJ1.HTML)
B2H ... ( OUTPUTP=DD:DD1(MEM1) | PROJ1.HTML | MEM1 | |
| ALLOC FI(DD1) DA(PROJ1.HTML(MEM1))
B2H ... ( OUTPUTP=DD:DD1(MEM2) | PROJ1.HTML | MEM2 | Note that the member name specified for OUTPUTP= overrides the member name on the file allocation |
If you are running OpenEdition, you may wish to have the output file(s) placed into an HFS directory. This can be easily done using the following three-step process:
For example: if we assume that into the temporary PDS, B2H created the MYDOC, MYDOC02 and MYDOC03 members, then OPUTX would copy those members as /usr/htmlfiles/mydoc.html, /usr/htmlfiles/mydoc02.html and /usr/htmlfiles/mydoc03.html.
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 a Linux 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 current platform ("currsys") is the same as the destination platform ("destsys") specified by the B2H DESTSYS= option, 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 "currsys"-related values based on the current platform and the "destsys"-related values based on the DESTSYS= option, but you can override any of these values using the appropriate option:
Here's an example: if you convert "project1.script" on AIX with DESTSYS=OS2, the default physical output file is "project.html" (because AIX supports long file names) and the logical name is "project1.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
You have considerable control over the layout and content of the
output HTML. Each output HTML file consists of three major
sections: the header, the body and the footer.
Figure 5-3. Layout of the output HTML file
| Record(s) | Obtained from where? | |
|---|---|---|
| Header section of the HTML file | ||
| 1. | File content identifier | DEFTEXT.HTMLHEAD= and HTMLDOCID.htmlrel= options |
| 2. | <HTML><HEAD> | Generated by B2H |
| 3. | <TITLE>title</TITLE> | Document's title (see 5.6, "Recognizing and displaying the document's title") |
| 4. | B2H identifier (optional) | COMMENTHEAD= option |
| 5. | User comment records(s) (optional) | COMMENT= option(s) |
| 6. | Various meta-type records (optional)
| Controlled by META= option
|
| 7. | Any other records to include in the header section (optional) | HEADREC= and HEADREC.x= option(s) |
| 8. | </HEAD> | Generated by B2H |
| Body section of the HTML file | ||
| 1. | <BODY> statement | BODYTAG= option |
| 2. | Mast head image (optional) | MASTHEAD= and MASTALT= options |
| 3. | User header records (optional) | HEADER= option(s) |
| 4. | <Hx>title</Hx>
(optional top-of-page title) | TOPHEAD= option |
| 5. | Top-of-page navigation links if splitting the HTML output (optional) | SPLITLINK= and SPLITLINK.x options |
| 6. | The text of the document itself | Input file |
| Footer section of the HTML file | ||
| 1. | List of footnotes | Any footnotes accumulated within the current physical file |
| 2. | Bottom-of-page navigation links if splitting the HTML output (optional) | SPLITLINK= and SPLITLINK.x options |
| 3. | User footer records (optional) | FOOTER= option(s) |
| 4. | </BODY></HTML> | Generated by B2H |
You can include statements within the source file to influence how B2H performs the conversion. You can specify B2H options and symbol table definitions, provide explicit HTML text to be passed directly to the output, indicate where the output file should be "split", and other functions.
The statement has two acceptable syntaxes:
If the B2HREQ=YES option is specified (the default value), this is the only syntax that B2H recognizes.
The following statement types are available:
Provide explicit HTML text: .*B2H [(env)] HTML ...html-text...Issue a message .*B2H [(env)] MSG type [ identifier ], message-textSpecify B2H options: .*B2H [(env)] OPTION option=value [ option2=value2 ... optionx=valuex ]Specify B2H a symbol table definition: .*B2H [(env)] SYMBOL symbol-table-statementForce a split of the output HTML file: .*B2H [(env)] SPLIT [ physical-file ], [ logical-file ] |
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.
See 8.1.1, "Environment-specific definitions" for further information on specifying the desired selection criteria.
| INFO | The message is for "informational" purposes only. The return code is not altered. |
| WARNING | The message describes a warning. The return code is set to 4, if not already higher. |
| ERROR | The message describes an error condition. The return code is set to 8, if not already higher. |
| TERM | The message describes a termination condition. The return code is set to 8 and B2H is immediately terminated. |
Examples:
.*B2H MSG info, This is an info-type message .*B2H MSG warning 980, A warning message
Notes:
.se mytitle = 'How To Play The Piano' :title.&mytitle .*B2H option title='&mytitle' .nameit symbol=revcode text='v11' .nameit symbol=revcolor text='red' .*B2H option revtag.&revcode='<font color=&revcolor>,</font>'
DESTSYS= OUTPUTFM= OUTPUTP= HTMLEXT= OUTPUTL= OUTPUTP83= HTMPEXT= OUTPUTL83= OUTPUTPCASE= LOG= 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 .*B2H (pc) OPTION imbft=sct
See the beginning of the BookMaster source for this document for additional examples.
Notes:
Examples:
.*B2H SYMBOL :tag. HP1 IT=N VAT=N ATT=N SE=Y V='<font color="red">' .*B2H SYMBOL :tag. EHP1 IT=N VAT=N ATT=N SE=Y V='</font>'
Notes:
B2H inserts the document's title into the output HTML file:
What determines 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 5.5, "Controlling B2H using statements within the source file" for further information about this feature.
BookMaster's :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 also defines the generic "HTML" process to signify that HTML output is being generated. Additional process names are also defined based on the specific type of HTML being generated (see the HTML= option).
| Process | When set |
| HTML | Always (signifies that HTML is being generated) |
| HTML2 | HTML 2 is being generated |
| HTML2+ | HTML 2 (or higher) is being generated |
| HTML3 | HTML 3 is being generated |
| HTML3+ | HTML 3 (or higher) is being generated |
| HTML4 | HTML 4 is being generated |
| HTML4+ | HTML 4 (or higher) is being generated |
Here are some examples:
:psc proc=html. :p.Include me ONLY when converting this text to HTML :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. :psc proc=html4. :p.Include me ONLY when converting this text to HTML 4 :epsc. :psc proc='html2 html3'. :p.Include me ONLY when converting this text to HTML 2 or HTML 3 :epsc. :psc proc='html3+'. :p.Include me ONLY when converting this text to HTML 3 or higher. :epsc.
See the source for this User's Guide for additional examples.
B2H sets Script/VS's &$LDEV (logical output device) and &$PDEV (physical output device) symbols to the same value specified for the HTML= option (e.g. HTML2, HTML3, HTML4). By examining either of these symbols, you can determine whether HTML is being generated and act appropriately.
Example 1: Insert a sentence if HTML 3 is being generated
.if &$LDEV = HTML3 .th Add this sentence if generating HTML3 output
Example 2: Imbed a file if HTML (any release) is being generated
.se temp = SUBSTR &$LDEV 1 4 .if &temp = HTML .th .im htmlonly
B2H supports "splitting" the output HTML into multiple physical files. This is useful for large source documents, 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.
Note: Splitting the output HTML file is not available if SOURCE=FLAT is specified or if B2H is running as a pipeline filter.
The first output HTML file part is named "normally" (e.g. abc.htm). Subsequent parts have a suffix attached to the filename (e.g. abc02.htm, abc03.htm, abc04.htm, etc) 10 The number and type of digits in the suffix is controlled by the SPLITDIGITS= option (default is two decimal 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 5.9.2, "Specifying the location and file names when splitting the HTML output" for overriding this behavior.)
The location within the source document where a split is to occur is specified using any combination of the following methods:
The effect of the AUTOSPLIT= option:
AUTOSPLIT=NO | The output is a single file. Any .*B2H SPLIT statements within the source are ignored. This is the default. | ||||||
AUTOSPLIT=YES | The output is split into multiple files only when a .*B2H SPLIT statement is encountered. | ||||||
AUTOSPLIT=num | The output is split into multiple files with each split ocurring when an :Hx header at the specified level is encountered. (Example: if AUTOSPLIT=1 is specified, each :H1. causes a split.) If a .*B2H SPLIT statement is encountered, it too will cause a split. The heading level specified for num should be the most-significant level heading used in the source document. | ||||||
AUTOSPLIT=*num | The output is split into multiple files with each split ocurring when a header from :H0. to the specified level is encountered. (Example: if AUTOSPLIT=*2 is specified, each :H0., :H1. and :H2. causes a split.) If a .*B2H SPLIT statement is encountered, it too will cause a split. | ||||||
AUTOSPLIT=LEN=value | Specifies that a separate output file may also occur when a :LEN tag is encountered
| ||||||
AUTOSPLIT=BYPASS=num | If splitting the output by :Hx or :LEN LEHD=x, this attribute allows you to specify how many :Hx or :LEN LEHD=x tags to bypass after a more significant header before splitting takes place. If omitted, BYPASS=0 is assumed. For example, the amount of text occuring between an :H0 and it's first :H1 is usually minimal, so it is often desirable to include the first :H1 in the same file as the :H0. Specifying AUTOSPLIT="*1 BYPASS=1" allows you to split the file at each :H0 and each :H1 except that the file is NOT split at the first :H1 after an :H0. A more general example should illustrate the principle: assume AUTOSPLIT="*2 BYPASS=1" :H0
:H1
:H2
(split)
:H2
(split)
:H2
(split)
:H1
:H2
(split)
:H2
(split)
:H0
:H1
:H2
(split)
:H2
| ||||||
AUTOSPLIT=IMBED | The output is split into multiple files with each split ocurring when a file is imbedded using the .im or .'im macro. | ||||||
AUTOSPLIT=SETUP | The output is split when a file is imbedded using the .setup macro. |
If multiple values are specified for
AUTOSPLIT=,
you must enclose them in either single or double-quote characters.
Example: AUTOSPLIT='0 IMBED LEN=SEP'
Example: AUTOSPLIT='*2 BYPASS=1'
For an example, try processing this document using AUTOSPLIT='*1 BYPASS=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 |
SPLITLINK={YES|NO} | SPLITLINK=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 SPLITLINK.x= options. SPLITLINK=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, "&Symbols pre-defined by B2H" for more information on these two symbols. |
SPLITLINK.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 8.2, "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 SPLIT physical-file, logical-file
SPLITNAME.4='physical-file,logical-file'which specifies the physical and logical file for the fourth output file. See the SPLITNAME= option for details on the syntax.
Both the SPLITDIR.x= and SPLITNAME.x= options allow you to name the output files on either a static or dynamic basis.
.*B2H OPTION SPLITNAME.NEXT='CMDBEG.HTM,cmdbeg.htm'
:H1.The BEGIN command
(discussion of the BEGIN command)
.
.
.*B2H OPTION SPLITNAME.NEXT='CMDLOGO.HTM,cmdlogo.htm'
:H1.The LOGOFF command
(discussion of the LOGOFF command)
.
.
This technique allows you to name the output file associated with
the following text, regardless of what actually causes the file to
be split. Plus, if you insert a new section between the BEGIN
section and the LOGOFF section, the names of the associated split
files remain the same.
Notes:
.*B2H (PC) OPTION SPLITNAME.NEXT='CMDBEG.HTM,cmdbeg.htm'
.*B2H (CMS) OPTION SPLITNAME.NEXT='CMDBEG HTM,cmdbeg.htm'
:H1.The BEGIN command
(discussion of the BEGIN command)
.
.
.*B2H (PC) OPTION SPLITNAME.NEXT='CMDLOGO.HTM,cmdlogo.htm'
.*B2H (CMS) OPTION SPLITNAME.NEXT='CMDLOGO HTM,cmdlogo.htm'
:H1.The LOGOFF command
(discussion of the LOGOFF command)
.
.
This capability is intended for advanced users and should be used with caution!
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. You can also use the CHARSET= option to specify the language of the coded character set.
If you have documents with language-specific characters entered as a single character, you can use the :XLATEO. 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:
:XLATEO. A5 V='¨'Note that the hex value for a specific character may be different on a mainframe (EBCDIC encoding) than on a PC workstation (ASCII encoding). Here's a hypothetical example of defining an umlaut translation based on the current platform:
(CMS) :XLATEO. A5 V='¨' (MVS) :XLATEO. A5 V='¨' (PC) :XLATEO. B7 V='¨'See 9.2.4, "Translation of single-byte values" for more information on the :XLATEO. 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 :XLATEO. 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'
SPLITLINK.16='<A HREF="&b2htoc">Tabla de Materias</A> |'
USERSYM="B2HSPAN SYMBOL"
In the user symbol table: B2HSPAN SYMBOL
(CMS) :XLATEO. A5 V='¨'
" " "
(PC) :XLATEO. 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]'
10.6, "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 10.6, "Question and Answers (TEXT mode)" for an example of this.
If QUESTION=FORM, each :QUESTION/:EQUESTION block is converted to an HTML form. (See 10.7, "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 name15 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 12 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.b2hxrefs (LINUX) userid.file.B2HXREFS (MVS) file.B2X (OS/2) file B2HXREFS (VM) file.B2X (WIN95) file.B2X (WINNT) file.b2hxrefs (UNIX)
: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 the filetype as containing extended cross-referencing information and will "map" the file using the same naming convention used for SYSVAR W.
Note: if running on a PC platform, you should specify IBMFTEXT='YES,LC' to ensure that the "DSMREFS" filetype is mapped appropriately when the .im macro is processed.
If your documents contain custom tags, control words, 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 control word, macro or tag. Just specify the following for the appropriate value on a :CMD. or :TAG. statement in a user symbol file.
:CMD. mytag V='&PGM pgmname [ parm1 parm2 ... parmx. ]' :TAG. mytag V='&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 control word or macro) |
TAG | Invoked via a :TAG definition (e.g. a tag) |
Text line(s) returned by the external program can consist of any or all of the following: normal text, Script/VS control words, GML and/or BookMaster tags, .*B2H statements, HTML markup, etc. The 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.
B2H supports most commonly-used Script/VS (DCF), GML, and BookMaster control words, macros and tags (Appendix A, "Symbols, control words, macros and tags supported by B2H" contains support information for each specific control word, macro and tag). But there are some areas which you should be aware:
Although the what's-not-supported list may seem large, it actually represents a very small percentage of the markup used in most documents.
Support for HTML tables was introduced in HTML 3 and most modern browsers support HTML 3.
However, there are still some people using old or unconventional browsers that understand only HTML 2 (specifically IBM's Web Explorer prior to Release 1.03). Since tables are so common in BookMaster documents, B2H provides special built-in support when generating HTML 2 output. 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 and higher 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. Some BookMaster table features (such as text rotation) are not available in HTML. Other BookMaster table features are available, but restrictions apply.
HTML table 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 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, please be aware of the following items:
Specifying horizontal and vertical cell alignment
As mentioned previously, BookMaster's table support is more robust and flexible than that provided by HTML. Although HTML 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 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 requirement that cell data be in ascending sequence may cause to you restructure your table definitions.
The following is a synopsis of commonly-occuring problems and questions.
| Q1: | "When using my browser to view the HTML created by B2H, most of the links work fine. But some links just jump to the TOP of the file instead of to the named anchor within the file. Why is this happening?" |
| A1: | This is a browser problem. Some older browsers mistakenly ignore
a link's "anchor" if the anchor has no text
(e.g. <A NAME="ABC"></A> as opposed to
<A NAME="ABC">this is some text</A>).
This causes the browser to jump to the top of the page instead of to
the anchor itself. Common occurances of this problem include
bottom-of-file links, links for index references and certain links
for :SPOT.
If your browser exhibits this behavior, you can use B2H's undocumented ANCHORTEXT= option to specify a text string to be used whenever a link's anchor would otherwise be null. ANCHORTEXT=' ' has worked well for some people. Link anchors that would normally be empty would now be <A NAME="ABC"> </A>. This will generally circumvent the browser problem, but note that extra blanks may now appear in your text. |
| Q2: | "Why aren't revision codes showing when I browse my document?" |
| A2: | Although B2H recognizes the
:REV/:EREV tags and .rc
control word, HTML itself doesn't provide the ability to show a
revision character. So you must tell B2H what HTML to
generate for identifying revised text. The REVTAG= option
allows you to do just that.
One technique that works well is to display the revised text in color (the technique used by this user's guide). The following example, using BookMaster's :REV/:EREV tags, illustrates how to display revised text in green (assuming your browser understands the <FONT COLOR=#rrggbb> tag). .*B2H option revtag.v2='<font color="#00FF00">,</font>' :revision id=v2 char='%' run=yes. Version 1 uses method A and :rev refid=v2. Version 2 uses method B. :erev refid=v2. So be sure to specify the correct version.Which results in: Version 1 uses method A and <font color="#00FF00"> Version 2 uses method B. </font> So be sure to specify the correct version. And looks like this: "Version 1 uses method A and Version 2 uses method B. So be sure to specify what you want." Here's the same example using the ".RC" control word: .*B2H option revtag.1='<font color="#00FF00">,</font>' .rc 1 | Version 1 uses method A and .rc 1 on Version 2 uses method B. .rc 1 off So be sure to specify the correct version. |
| Q3: | "An .*OPTION record in the source (it's used by another program) is causing B2H to generate error messages. How can I make B2H ignore this record?" |
| A3: | Some documents contain .*OPTION statements for use by other programs -- print preprocessors are a common example. If you don't want the record inspected for B2H options, ensure that B2HREQ=YES is specified (the default value). This is described in more detail in 5.5, "Controlling B2H using statements within the source file". |
| Q4: | "How do I include text so that it appears ONLY when my document is converted to HTML?" |
| A4: | There are two ways to accomplish this:
|
| Q5: | "How can I change the HTML tags generated by B2H?" |
| A5: | Depends on what you want to change:
|
| Q6: | "In a BookMaster table, my script creates two vertical cells in
a single row by specifying multiple occurances of the
:C tag, like this:
:table cols='* *'. :row. :c 1.Cell 1A :c 1.Cell 1B :c 2.next horizontal cellBut B2H is not generating the two vertically-stacked cells. Why not? (I'm also getting an error message about out-of-sequence table cells)" |
| A6: | You are generating rows with vertically-aligned cells without using the :TABLE tag's ARRANGE= attribute to describe the layout. (Whether this is a "good" markup practice is a different discussion!) B2H does not support the idiom of not using ARRANGE= for vertically arranging cells. The error message is because B2H detected two definitions for the same cell. |
| Q7: | "I'm trying to override some of the attributes coded on my document's :DOCPROF tag, but :DOCPROF is overriding the B2H options regardless of whether they are on the command line or in a profile. How can I override the :DOCPROF attributes?" |
| A7: | 3.11, "Specifying B2H options" documents the hierarchy of how options are handled. But the bottom line is that statements within the document itself always override any B2H command-line or profile options. If you include a .*B2H OPTION statement within your document after the :DOCPROF tag, that will do it. |
| Q8: | "I know I can use the LOG= option to save the console messages to disk. But can I tell B2H to NOT display the messages on the terminal itself?" |
| A8: | Yes. During a conversion, B2H generates messages showing the status of the conversion. The LOG= option specifies if you want a copy of these messages saved to a disk file. The QUIET and NOISY options control whether the messages are displayed on the terminal. See QUIET and NOISY options for more information. |
| Q9: | "I have an XEDITG line drawing (inside an :XMP/:EXMP) that contains nice graphic arrows and box characters when I print it on the mainframe. But when I view the HTML output using a browser, there's no graphic characters, just asterisks and plus signs. Why?" |
| A9: | This is a World-Wide-Web limitation. Web browsers display text
using the characters defined in various code pages (the most common
being ISO-Latin-1). None of the available code pages contain the
drawing characters, such as box corners, intersections and arrows.
So B2H defines these characters (via the system symbol table)
as asterisks and plus signs as the best approximation.
Your alternatives are:
|
| Q10: | "My document has a number of syntax diagrams and although they format OK, they don't include the box corners, intersections and arrow characters that show when I print the document on the mainframe. Is this something I can customize?" |
| A10: | This is similar to 7.0.9, "FAQ 9: XEDITG line drawing characters don't look right". None of the standard code
pages available via web browsers contain drawing characters, such as
box corners, intersections and arrows. So B2H generates
asterisks, plus signs and greater-than/less-than characters as the
best approximation.
The actual characters used in a syntax diagram are specified using the appropriate DEFTEXT= option. For each part of a syntax diagram, you can specify the character(s) you desire, including plain text, HTML symbols, even GIF files. Note that if you display a GIF, the GIF's vertical/horizontal size must be a multiple of a character's vertical/horizontal size in the current font, otherwise alignment problems may occur. Additionally, if you have a monospaced font that contains the drawing characters you need, you can use the SETUPTAG= option to load the font and then use DEFTEXT to reference the the appropriate character. Assume you have a font called "courierx" that contains the top-left and top-right box characters at positions 192 and 193, respectively. The following options show how the font could be loaded and the appropriate characters referenced: SETUPTAG.SYNTAX='<font face="courierx">','</font>' DEFTEXT._UPPERLEFT='À',1 DEFTEXT._UPPERRIGHT='Á',1 |
| Q11: | "I see that B2H's HTML= option allows me to specify HTML 4. Does this mean that B2H will generate HTML 4 tags?" |
| A11: | The vast majority of HTML 4-only tags are not needed to support
the conversion process. But, if you specify HTML=4,
B2H will generate a few tags that are exclusive to HTML 4
(such as
<SPAN STYLE="font-size:xx%">
to provide enhanced support for the SCALE= attribute).
In addition, since B2H allows you to specify profile options and symbol table entries based on the HTML level, you can specify HTML 4-specific items yourself. For example, you might want to define the table-of-contents layout using HTML specific to the HTML level being generated -- something like this: (HTML=2) TOCTAG=" ... HTML 2 markup for a TOC ... " (HTML=3) TOCTAG=" ... HTML 3 markup for a TOC ... " (HTML=4) TOCTAG=" ... HTML 4 markup for a TOC ... " |
| Q12: | "We're getting error messages from IBM's AIX REXX while B2H is processing an index entry (e.g. :ih1, :ih2, :ih3). Some of our index references are fine, whereas others are incorrect." |
| A12: | B2H uses the three index levels (i1, i2 and i3) combined together as the index's "pointer" (technically speaking, it's the "tail" of a stemmed variable). On most platforms, REXX does not limit the length of this pointer; but using IBM's REXX on AIX, the length can not exceed 240 characters. There's nothing that B2H can do about this restriction. When running on AIX using IBM's REXX and converting a document with extremely long index levels, you may have to update the index level text. |
| Q13: | "How do I use Cascading Style Sheets (CSS) within B2H? I would like some definitions to affect all aspects of the document and other definitions to be used specifically, e.g. :hp3 to display red text on a yellow background using the Arial font. Is this possible?" |
| A13: | Yes. CSS enables you to control almost any aspect of a page's
appearance. Without going into the details of how CSS works, in
essence you place the CSS definitions into the header section of the
HTML file. Each definition specifies a selector and
it's associated properties. Any text associated with the
selector is displayed using the specified properties.
For example, the following HTML segment uses CSS to define the color and font-size properties for all H1 and H2 elements: <HEAD>
<STYLE TYPE="text/css">
H1 { font-size: x-large; color: red }
H2 { font-size: large; color: blue }
</STYLE>
</HEAD>
<BODY>
To cause :HP3 to display text using specific properties, first define a CSS selector (using a name of your choice) with the desired properties. Then update the B2H symbol table definition for :HP3 to reference the CSS selector (normally using <SPAN>). The following example puts it all together. To simplify this example, the HEADREC= option (which inserts records into the header section of an output HTML file) and the symbol table updates are included within the source file: .*----- do the CSS definitions -----
.*b2h option headrec.text='<style type="text/css">'
.*b2h option headrec.text='H1 { font-size: x-large; color: red }'
.*b2h option headrec.text='H2 { font-size: large; color: blue }'
.*b2h option headrec.text='.app1 { background-color: yellow; color: red;'
.*b2h option headrec.text=' font-family: arial, helvetica }'
.*b2h option headrec.text='</style>'
.*----- update the :HP3/:EHP3 symbol table definitions -----
.*b2h symbol :TAG. HP3 IT=N VAT=N ATT=N SE=Y V='<span class="app1">'
.*b2h symbol :TAG. EHP3 IT=N VAT=N ATT=N SE=Y V='</span>'
:h1.Start the CSS example (this line in red)
:p.Text in :hp1.(italic):ehp1. mode.
:p.Text in :hp2.(bold):ehp2. mode.
:p.Text in :hp3.(red on yellow):ehp3. mode.
:p.Text in :hp4.(monospaced):ehp4. mode.
p.s. Here's a productivity tip: if you have a quite a few CSS statements, including them individually can get bulky. CSS allows you to place the definitions into a separate file (called an "external style sheet") and then link it into the document using HTML's <LINK> tag within the header section, like so: <HEAD> <link rel="stylesheet" type="text/css" href="filespec"> </HEAD> <BODY> If we place the following CSS statements into the file "common.css": H1 { font-size: x-large; color: red }
H2 { font-size: large; color: blue }
.app1 { background-color: yellow; color: red;
font-family: arial, helvetica }
Then the following would cause the CSS records to be loaded dynamically
at browse time:
.*b2h option headrec.text='<link rel="stylesheet" type="text/css" href="common.css">' |
| Q14: | "My document contains a sentence like this:
For more information, go to http://www.acme.com When the document is printed, I want the website URL to be listed "as-is", but when the document is converted to HTML, I want the URL to be a hyperlink so the user can click on it. How do I do that?" |
| A14: | This is easy to do based on the techniques described
in 5.8, "Including/excluding text when converting to HTML".
Solution using BookMaster tags: For more information, go to :psc proc=html. .*b2h html <a href="http://www.acme.com">http://www.acme.com</a> :epsc. :psc xproc=html. http://www.acme.com :epsc.It's often easier and simpler to have a macro for this rather than coding all those lines each time. This User's Guide uses the "website" macro for just this reason and it looks like this: .dm website on :psc proc=html. .*B2H HTML <A HREF="http://&*">http://&*</A> :epsc. :psc xproc=html. http://&* :epsc. .dm offYour example can now be written like this: For more information, go to .website www.acme.com Solution using Script/VS control words: For more information, go to .se temp = SUBSTR &$LDEV 1 4 .if &temp = HTML .th .*b2h html <a href="http://www.acme.com">http://www.acme.com</a> .el http://www.acme.comAs before, you may wish to use a macro to do the work for you. .dm website on .se temp = SUBSTR &$LDEV 1 4 .if &temp = HTML .th .*B2H HTML <A HREF="http://">http://&*</A> .el http://&* .dm offYour example would be written the same as before: For more information, go to .website www.acme.com |
| Q15: | "The source records for my document contain line numbers in colums 73 to 80 and those line numbers are showing up in the output. Is there a way to have B2H ignore line numbers?" |
| A15: | Yes, see the LINENUM= option.
In your specific case, try:
B2H ... ( LINENUM=73-80 |
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 3.11, "Specifying B2H options".
Many B2H options allow you to specify a file. See 3.2, "Specifying a file" for platform considerations when specifying the file.
| Format of a profile record |
|---|
[(env)] option=value [ ... optionx=valuex ] |
You can specify that a physical record be applicable only for certain environments by indicating the criteria within parentheses as the first item on the record.
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 |
LINUX | Signifies the Linux platform |
MVS | Signifies the MVS (OS/390) platform |
OS2 | Signifies the OS/2 platform using the FAT file system |
PC | Signifies the AIX, Linux, OS/2 (both FAT and HPFS), Windows 95/98/ME, Windows NT/2000/XP or UNIX platforms |
WIN95 | Signifies Windows 95/98/ME |
WINNT | Signifies Windows NT/2000/XP |
UNIX | Signifies the Unix platform |
Valid release values:
2 | HTML 2 is being generated |
2+ | HTML 2 (or higher) is being generated |
3 | HTML 3 is being generated |
3+ | HTML 3 (or higher) is being generated |
4 | HTML 4 is being generated |
4+ | HTML 4 (or higher) is being generated |
If multiple conditions are specified, all must be true for the record to be used.
Example:
(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 destination (HTML=4) ... use only if creating HTML 4 output (DEST=CMS HTML=2) ... use if creating HTML 2 for VM/CMSAnother example: Define the IMBFT option differently based on platform
(AIX) IMBFT=script (CMS) IMBFT=SCRIPT (HPFS) IMBFT=script (LINUX) IMBFT=script (OS2) IMBFT=scr (WIN95) IMBFT=scr (WINNT) IMBFT=scr (UNIX) IMBFT=script
If no parenthesed criteria is specified, the record is applicable in all environments.
For information on how B2H determines the current platform on which it's running, see 3.1, "How B2H determines the current platform".
Figure 8-1. B2H options - Overview
Destination system
DESTSYS={ AIX | HPFS | LINUX | MVS | OS2 | VM | WIN95 | WINNT | UNIX }
Input File Characteristics
EXPDATE=[yyyymmdd | {+|-}ddd | text]
LINENUM={ NO | BEGIN | END | startcol-endcol }
REVDATE=[yyyymmdd | {+|-}ddd | text]
SOURCE='{ SCRIPT | SCRIPTONLY | FLAT },[pre],[blanksub]'
SYMCHARS='ccc...ccc'
Table-of-Contents, Indexing & Sectioning
APPHD1='text'
APPHD1X='text'
BODYHD0='text'
BODYHD0X='text'
BODYHD1='text'
BODYHD1X='text'
FBC={ YES | NO }
FIGLIST={ YES | NO }
FTSEP={ YES | NO }
HEADNUM={ YES | NO | num | *num }
INDEX={ YES | NO } {INDEX|NOINDEX}
INDEXREFLINK={ YES | NO }
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 }
TOCTAG='ls,le,ts,te,ts,te'
Hyperlinking within the file
FNLINK={ NO | TO | FROM | BOTH }
FTLINK={ YES | NO }
TOCRET={ NO | TOC | PTOC | PTOCx }
File Locations, Names and Format
HTMLEXT={ html | ext } (AIX)
HTMLEXT={ html | ext } (HPFS)
HTMLEXT={ html | ext } (LINUX)
HTMLEXT={ HTML | ext } (MVS)
HTMLEXT={ htm | ext } (OS/2)
HTMLEXT={ html | ext } (VM)
HTMLEXT={ htm | ext } (WIN95)
HTMLEXT={ htm | ext } (WINNT)
HTMLEXT={ html | ext } (UNIX)
HTMPEXT={ html | ext } (AIX)
HTMPEXT={ html | ext } (HPFS)
HTMPEXT={ html | ext } (LINUX)
HTMPEXT={ HTML | ext } (MVS)
HTMPEXT={ htm | ext } (OS/2)
HTMPEXT={ HTML | ext } (VM)
HTMPEXT={ htm | ext } (WIN95)
HTMPEXT={ htm | ext } (WINNT)
HTMPEXT={ html | ext } (UNIX)
IMBFT={ script | ext } (AIX)
IMBFT={ script | ext } (HPFS)
IMBFT={ script | ext } (LINUX)
IMBFT=(not applicable) (MVS)
IMBFT={ scr | ext } (OS/2)
IMBFT={ SCRIPT | ft } (VM)
IMBFT={ scr | ext } (WIN95)
IMBFT={ scr | ext } (WINNT)
IMBFT={ script | ext } (UNIX)
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'
OUTPUTP={ 'physical-output-file' | DD:ddname | DD:ddname(member) } (MVS only)
OUTPUTP83={ YES | NO }
OUTPUTPCASE={ ASIS | LC | UC }
SPLITDIGITS='{2|num}, {DEC|HEX|ALPHA|LALPHA}'
SPLITDIR[.x[-y]]='physical-directory,logical-directory'
SPLITDIR.NEXT='physical-directory,logical-directory'
SPLITNAME.x='[physical-file-name],[logical-file-name]'
SPLITNAME.NEXT='[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 }
AUTOSPLIT='{ NO | YES | num | *num }
[ LEN=value ]
[ BYPASS={ 0 | num } ]
{ IMBED | NOIMBED }
{ SETUP | NOSETUP }'
BODYTAG='text'
BORDERTAG={ BORDER="1" | tag }
BORDERTAG.x=tag
CENTERTAG={ YES | NO }
CHARSET='text'
COMMENT={ 'text' | CLEAR }
COMMENTHEAD='text'
CONTACT='text'
DEFTEXT.name='text'
DEFTEXT.name='text',[width]
DIALOG='[LABEL] [FONT] [COLOR]'
DIALOGTAG.x='ts,te,fs,fe,cs,ce'
DLFMT={ DL | TABLE }
DLTAG.x='ls,le,ts,te,ds,de'
FIGCAPLOC={ BEFORE | AFTER }
FNTAG='cs,ce,ls,le,lcs,lce,lts,lte,ts,te'
FONTTAG='fonttext,efonttext,[PROP|NOPROP]'
FONTTAG.name='fonttext,efonttext,[PROP|NOPROP]'
FOOTER={ NO | file }
FOOTER={ NO | file | DD:ddname | DD:ddname(member) } (MVS only)
GLFMT={ DL | TABLE }
GLTAG.x='ls,le,ts,te,ds,ds2,de,gs,ge'
HEADER={ NO | file }
HEADER={ NO | file | DD:ddname | DD:ddname(member) } (MVS only)
HEADREC=CLEAR
HEADREC.FILE=file
HEADREC.TEXT='text'
HRTAG={ <HR> | tag }
HRTAG.x=tag
HTAG='hs,he,ss,sr'
HTAG.x='hs,he,ss,sr'
HTML={ 2 | 3 | 4 }
HTMLATT.tagname='attributes'
HTMLDOCID.htmlrel='text'
INDEXTAG='ls,le,ts,te,is,ie'
LINES={ PRE | BR }
LINEWIDTH={ 78 | number }
LIREF={ NO | ID | ACTUAL }
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'
OLSEQ='sequence codes'
OWNER='text'
REVTAG='revtext,erevtext,[PROP|NOPROP]'
REVTAG.id='revtext,erevtext,[PROP|NOPROP]'
SETUPTAG.tagname='beforetext','aftertext'
SHADE.name=rrggbb
SLTAG.x='ls,le,is,ie'
SPLITLINK={ YES | NO }
SPLITLINK.x='text | CLEAR'
SYNFONT={ YES | NO }
SYSVAR='A { YES | NO }'
TABLE2='fl,fm,fr,fv,fhn,fhh,gutl,gutr'
TFIGLISTTAG.x='ls,le,is,ie'
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 }
DOCDESC='file'
DOCDESC.id='file'
IMBEDID={ YES | NO }
LOG='{ NO | YES | file },{ CREATE | APPEND }'
LOG=STREAMx
LTGT={ ASIS | CONVERT }
MAXWIDTH={ NOSPLIT | number }
MSGLEVEL={ INFO | WARNING | ERROR }
MSGNUM={ YES | NO }
MVSALLOC.name='allocation-values'
PROCACT='sit=action sit2=action2 ... sitx=actionx'
PSC='process1 process2 ... processx'
QUIET | NOISY
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 ZIP 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. |
Note: For compatibility with older releases of B2H, an option name of AUTOPART= is recognized as an alias of AUTOSPLIT=.
Example: AUTOSPLIT=1
creates a separate HTML file for each :H1. tag
Example: AUTOSPLIT=*1
creates a separate HTML file each :H0. and :H1. tag.
Example: AUTOSPLIT=LEN=4
creates a separate HTML file
when a :LEN LEHD=4 tag is encountered
Example: AUTOSPLIT=IMBED
creates a separate HTML file
whenever a file is imbedded
Example: AUTOSPLIT='0 IMBED'
creates a separate HTML file
for each :H0. tag and whenever a file is imbedded
Default: AUTOSPLIT=NO
| 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 |
| x | Tag used for: |
| 1 | Used for :CODEL when STYLE=BOX |
| 2 | Used for :CODEL when STYLE=LBLBOX |
| 3 | Used for :FIG when FRAME=NONE is not specified |
| 4 | Used for :LBLBOX |
| 5 | Used for :MSGL when STYLE=BOX |
| 6 | Used for :MSGL when STYLE=LBLBOX |
| 7 | Used for :SCHDATE |
| 8 | Used for :SYNTAX when STYLE=BOX |
| 9 | Used for :SYNTAX when STYLE=LBLBOX |
| 10 | Used for :TABLE itself |
Note: This option is applicable only for HTML=3 (or higher).
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=text">If no value is specified (the default), no META statement is generated and the normal World Wide Web default of ISO-8859-1 is assumed. (See also 5.10, "National Language Support (NLS) considerations".)
Default: CHARSET=''
RFC 2070
contains the definitive list, but here are some of the character sets
for each of the Group 1, 2 and 3 languages.
14
Figure 8-2. Some coded character sets
| Language | Coded Character Set | charset=... | IBM CCSID |
|---|---|---|---|
| Albanian | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| Arabic | ISO/IEC 8859-6 | iso-8859-6 | 1089 |
| Bulgarian | Windows 1251 | windows-1251 | 1251 |
| Byelorussian | Windows 1251 | windows-1251 | 1251 |
| Catalan | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| Chinese (simplified) | GB | gb2312 | 1381 (5477 is also valid) |
| Chinese (traditional) | Big 5 | big5 | 950 |
| Croatian | ISO/IEC 8859-2 | iso-8859-2 | 912 |
| Czech | ISO/IEC 8859-2 | iso-8859-2 | 912 |
| Danish | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| Dutch | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| English | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| Estonian | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| Finnish | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| French | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| German | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| Greek | ISO/IEC 8859-7 | iso-8859-7 | 813 |
| Hebrew | ISO/IEC 8859-8 | iso-8859-8 | 916 |
| Hungarian | ISO/IEC 8859-2 | iso-8859-2 | 912 |
| Italian | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| Japanese | Shift JIS | x-sjis
(shift_jis is also used) | 943 (932, a subset of 943 from a character repertoire viewpoint, is also valid) |
| Korean | EUC Korean | euc-kr | 970 (A better solution is to use 970 for AIX/Linux/Unix, and 949 for OS/2 and Windows) |
| Latvian | Windows 1257 | windows-1257 | 1257 |
| Lithuanian | Windows 1257 | windows-1257 | 1257 |
| Macedonian | Windows 1251 | windows-1251 | 1251 |
| Norwegian | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| Polish | ISO/IEC 8859-2 | iso-8859-2 | 912 |
| Portuguese | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| Romanian | ISO/IEC 8859-2 | iso-8859-2 | 912 |
| Russian | Windows 1251 | windows-1251 | 1251 |
| Serbian (Cyrillic) | Windows 1251 | windows-1251 | 1251 |
| Serbian (Latin 2) | Windows 1250 | windows-1250 | 1250 |
| Slovakian | ISO/IEC 8859-2 | iso-8859-2 | 912 |
| Slovenian | ISO/IEC 8859-2 | iso-8859-2 | 912 |
| Spanish | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| Swedish | ISO/IEC 8859-1 | iso-8859-1 | 819 |
| Thai | IBM 874 | x-ibm-874 | 9066 |
| Turkish | ISO/IEC 8859-9 | iso-8859-9 | 920 |
| Ukrainian | Windows 1251 | windows-1251 | 1251 |
| Vietnamese | VISCII
UCS-2 UCS-4 | viscii
iso-10646-ucs-2 iso-10646-ucs-4 | TBD
1200 (growing) or 13488 (fixed) TBD |
If omitted, the following text is assumed (shown here on two lines):
COMMENTHEAD='&b2hiall converted by &b2hsig (&b2hplat) &b2huser
on &date at &time'
CONTACT='johndoe@acme.com'causes the following to be generated:
<META HTTP-EQUIV="contact" CONTENT="johndoe@acme.com">
Figure 8-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.ARTLABEL | "Figure figure not displayed." | This specifies the default "alternate text" for a graphic when ARTSHOW=LINK and no alternate text is specified on a BookMaster :ARTWORK tag, (such as :ARTWORK NAME=name LABEL="alternate text".). |
| 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.DIALSYS | "System" | Default prefix text for a Dialog's :SYS tag |
| DEFTEXT.DIALUSER | "User" | Default prefix text for a Dialog's :USER tag |
| DEFTEXT.DOCNUM | "Document Number" | Default prefix text for :DOCNUM tag |
| 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 &b2hhtmlid//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.IBMZALI | "<HR><B>IBM License Information</B><HR>" | Default text used in conjunction with the :IBMLPS tag when STYLE=IBMZALI specified on the :DOCPROF tag. |
| DEFTEXT.IBMZALP | "<HR><B>IBM Licensed Program Specifications</B><HR>" | Default text used in conjunction with the :IBMLPS tag when STYLE=IBMZALP specified (or defaulted) on the :DOCPROF tag. |
| DEFTEXT.INDEX | "Index" | Default text for :INDEX tag |
| DEFTEXT.INDEXENTRYL | "(" | When showing the references for a particular index entry, this precedes (to the left of) each reference identifier. |
| DEFTEXT.INDEXENTRYR | ")" | When showing the references for a particular index entry, this follows (to the right of) each reference identifier. |
| 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.LERSAUTH | "Authorization" | Default text for :LERS AUTH= and :LEDI AUTH. |
| DEFTEXT.LERSCOMMENTS | "Comments" | Default text for :LERS COMMENTS= and :LEDI COMMENTS. |
| DEFTEXT.LERSCONTEXT | "Context" | Default text for :LERS CONTEXT= and :LEDI CONTEXT. |
| DEFTEXT.LERSDEFAULTS | "Defaults" | Default text for :LERS DEFAULTS= and :LEDI DEFAULTS. |
| DEFTEXT.LERSERRCOND | "Error Conditions" | Default text for :LERS ERRCOND= and :LEDI ERRCON. |
| DEFTEXT.LERSEXAMPLES | "Examples" | Default text for :LERS EXAMPLES= and :LEDI EXAMPLES. |
| DEFTEXT.LERSFLAGS | "Flags" | Default text for :LERS FLAGS= and :LEDI FLAGS. |
| DEFTEXT.LERSFORMAT | "Format" | Default text for :LERS FORMAT= and :LEDI FORMAT. |
| DEFTEXT.LERSINTREP | "Internal Representation" | Default text for :LERS INTREP= and :LEDI INTREP. |
| DEFTEXT.LERSMESSAGES | "Messages" | Default text for :LERS MESSAGES= and :LEDI MESSAGES. |
| DEFTEXT.LERSOPTIONS | "Options" | Default text for :LERS OPTIONS= and :LEDI OPTIONS. |
| DEFTEXT.LERSOTHE | "" | Default text for :LERS OTHE= and :LEDI OTHE. |
| DEFTEXT.LERSPARMS | "Parameters" | Default text for :LERS PARMS= and :LEDI PARMS. |
| DEFTEXT.LERSPREREQS | "Prerequisites" | Default text for :LERS PREREQS= and :LEDI PREREQS. |
| DEFTEXT.LERSPROCESS | "Processing" | Default text for :LERS PROCESS= and :LEDI PROCESS. |
| DEFTEXT.LERSPURPOSE | "Purpose" | Default text for :LERS PURPOSE= and :LEDI PURPOSE. |
| DEFTEXT.LERSRELATED | "Related Information" | Default text for :LERS RELATED= and :LEDI RELATED. |
| DEFTEXT.LERSRESTRICT | "Restrictions" | Default text for :LERS RESTRICT= and :LEDI RESTRICT. |
| DEFTEXT.LERSRESULTS | "Results" | Default text for :LERSRESULTS= and :LEDI RESULTS. |
| DEFTEXT.LERSRETCODES | "Return Codes" | Default text for :LERS RETCODES= and :LEDI RETCODES. |
| DEFTEXT.LERSSYSENV | "System Environment" | Default text for :LERS SYSENV= and :LEDI SYSENV. |
| DEFTEXT.LERSUSAGE | "Usage" | Default text for :LERS USAGE= and :LEDI USAGE. |
| DEFTEXT.LERSVERSION | "Version" | Default text for :LERS VERSION= and :LEDI VERSION. |
| DEFTEXT.MCDEST | "Destination" | Default text for :MSGL DEST= and :DEST. |
| DEFTEXT.MCMODULE | "Module" | Default text for :MSGL MODULE= and :MODULE. |
| DEFTEXT.MCNUMBYTES | "Number of Error Bytes" | Default text for :MSGL NUMBYTES= and :NUMBYTES. |
| DEFTEXT.MCORESP | "Operator Response" | Default text for :MSGL ORESP= and :ORESP. |
| DEFTEXT.MCPRESP | "Programmer Response" | Default text for :MSGL PRESP= and :PRESP. |
| DEFTEXT.MCPROBD | "Problem Determination" | Default text for :MSGL PROBD= and :PROBD. |
| DEFTEXT.MCSEVERITY | "Severity" | Default text for :MSGL SEVERITY= and :SEVERITY. |
| DEFTEXT.MCSPRESP | "System Programmer Response" | Default text for :MSGL SPRESP= and :SPRESP. |
| DEFTEXT.MCSYSACT | "System Action" | Default text for :MSGL SYSACT= and :SYSACT. |
| DEFTEXT.MCURESP | "User Response" | Default text for :MSGL URESP= and :URESP. |
| DEFTEXT.MCXPL | "Explanation" | Default text for :MSGL XPL= and :XPL. |
| 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.SYNNT | "Note:" | Default text when listing a syntax diagram's notes specified using :SYNNT. |
| DEFTEXT.T2XREF | "the appropriate section" | Text to show for a forward cross-reference link within an HTML 2 table (for more info, see 6.1.1, "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 |
| DEFTEXT.VOLNUM | "Volume" | Default prefix text for :VOLNUM tag |
| DEFTEXT.WARRASIS | "This program is provided "As Is" as specified in the IBM license." | Default text for SUBJECT=ASIS attribute on the :WARRANTY tag |
| DEFTEXT.WARRFULL | "This program is warranted as specified in the IBM license. <p>Licensed Program Specifications may be updated from time to time and such updates may constitute a change in specifications.<p>For Distributed Systems License Option (DSLO) Licenses, warranty service, if any, will be provided only through the Basic License location. <p>Following the discontinuance of all program services, this program will be provided "As Is" as specified in the IBM license." | Default text for SUBJECT=FULL attribute on the :WARRANTY tag |
| DEFTEXT.WARRNODSLO | "This program is warranted as specified in the IBM license. <p>Licensed Program Specifications may be updated from time to time and such updates may constitute a change in specifications. <p>Following the discontinuance of all program services, this program will be provided "As Is" as specified in the IBM license." | Default text for SUBJECT=NODSLO attribute on the :WARRANTY tag |
| The following values are used for drawing syntax diagrams
The syntax for the DEFTEXT option is slightly different when specifying syntax diagram characters. DEFTEXT.name='text',[width]The optional value specifies the "width" (the number of characters) that is shown by the specified text. If you omit the width value, it defaults to the length of the text string. If you specify a text string whose displayed width is different than the length of the text string itself, make sure you specify the width value. For example: DEFTEXT._CROSS='+' DEFTEXT._CROSS='+',1For more information and an example, see 7.0.10, "FAQ 10: Syntax diagram characters don't look right". | ||
| DEFTEXT._CROSS | '+',1 | Line crossing |
| DEFTEXT._DASH | '-',1 | Line dash |
| DEFTEXT._END | '><',2 | End of syntax diagram |
| DEFTEXT._FRAGMENT_END | '|',1 | End of fragment diagram |
| DEFTEXT._FRAGMENT_START | '|',1 | Start of fragment diagram |
| DEFTEXT._FRAGREF_END | '|',1 | End of fragment reference |
| DEFTEXT._FRAGREF_START | '|',1 | Start of fragment reference |
| DEFTEXT._LOWERLEFT | '+',1 | Bottom left corner |
| DEFTEXT._LOWERRIGHT | '+',1 | Bottom right corner |
| DEFTEXT._MIDDLE | '>',1 | Middle of syntax diagram |
| DEFTEXT._MIDDLELEFT | '|',1 | Left side |
| DEFTEXT._MIDDLERIGHT | '|',1 | Right side |
| DEFTEXT._REPSEPJOINL | 'V',1 | The point where the repeating separator joins the base line on the left side |
| DEFTEXT._REPSEPJOINR | '+',1 | The point where the repeating separator joins the base line on the right side |
| DEFTEXT._REPSEPLEFT | '<-',2 | Left part of repeating separator |
| DEFTEXT._REPSEPRIGHT | '--<',3 | Right part of repeating separator |
| DEFTEXT._START | '>>',2 | Start of syntax diagram |
| DEFTEXT._TEEDOWN | '+',1 | Downward-pointing T |
| DEFTEXT._TEELEFT | '|',1 | Leftward-pointing T |
| DEFTEXT._TEERIGHT | '|',1 | Rightward-pointing T |
| DEFTEXT._TEEUP | '+',1 | Upward-pointing T |
| DEFTEXT._UPPERLEFT | '+',1 | Top left corner |
| DEFTEXT._UPPERRIGHT | '+',1 | Top right corner |
Note: If the destination system is DOS, you should specify "OS2".
For information on how B2H determines the current platform on which it's running, see 3.1, "How B2H determines the current platform". See also 5.3, "Cross-Platform considerations".
| LABEL | Places "System" and "User" labels in front of system and user text. |
| FONT | User text is displayed using the HTML font-type tags specified for the "fs" and "fe" values of the DIALOGTAG= option. |
| COLOR | User text is displayed using the HTML color-type tags specified for the "cs" and "ce" values of the DIALOGTAG= option. |
Example: DIALOG='FONT'
DIALOG='LABEL COLOR'
| x | Used for: |
| 0 | HTML tags for the :SYS tag |
| 1 | HTML tags for the :USER tag |
HTML tag values:
| ts | "Normal" text start |
| te | "Normal" text end |
| fs | "Font" text start ("FONT" specified within DIALOG=) |
| fe | "Font" text end |
| ss | Colored text start ("COLOR" specified within DIALOG=) |
| se | Colored text end |
DIALOGTAG.0='<TT>,</TT>,<B>,</B>,<FONT COLOR="BLUE">,</FONT>' DIALOGTAG.1=''
| DL | Map to HTML's standard definition-list tags (e.g. <DL>) |
| TABLE | Map to a two-column unframed table. Available only when generating HTML 3 (or higher) 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">Default: source file date + two years
| 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 |
HTML tag values:
| cs | Start of footnote's callout |
| ce | End of footnote's callout |
| ls | Footnote list start |
| le | Footnote list end |
| lcs | Start of footnote's callout in the footnote list |
| lce | End of footnote's callout in the footnote list |
| lts | Start of a footnote's text in the footnote list |
| lte | End of a footnote's text in the footnote list |
| ts | Tag to start the list of footnotes |
| te | Tag to end the list of footnotes |
FNTAG='<SUP>,</SUP>,<DL COMPACT>,</DL>,<P><DT><SUP>,
</SUP></DT>,<DD>,</DD>,<HR>,'
.df one type ('sonoran sans serif' 6 ) codepage T1GI0395
.df two type ('sonoran sans serif' 7 ) codepage T1GI0395
.br;Base line in default font
.bf one
.br;This line in font "one" as a test
.pf
.br;Base line in default font
.bf two
.br;This line in font "two" as a test
.pf
.br;Base line in default font
The FONTTAG option effectively replaces the .DF control word and allows you to specify the text to use when a specified font is started or stopped.
FONTTAG can be specified with or without the name qualifier. If name is omitted, the text is used to start/stop any font. If name is specified, the text is used only when the specified font is started or stopped.
| fonttext | Text and/or HTML tag(s) to insert for a .BF name control word |
| efonttext | Text and/or HTML tag(s) to insert for a .PF control word |
| PROP | When displaying an HTML table, many web browsers reset any font characteristics and display a cell's text in a default font. "PROP" specifies that if B2H generates an HTML table, all active font definition text should be "propagated" into each table cell. This is the default value if omitted. |
| NOPROP | This specifies that active font definition text should NOT be "propagated" into each table cell. |
Using the previous example, if you wanted font "one" to be shown in bold and font "two" to be blue italic in the Arial font, you could specify:
FONTTAG.one='<B>,</B>' FONTTAG.two='<FONT FACE="Arial" COLOR="BLUE"><I>,</I></FONT>'
| DL | Map to HTML's standard definition-list tags (e.g. <DL>) |
| TABLE | Map to a two-column unframed table. Available only when generating HTML 3 (or higher) output. |
| x | Used for: |
| 0 | HTML tags for a non-compact list when GLFMT=DL |
| 1 | HTML tags for a compact list (e.g. :GL COMPACT) when GLFMT=DL |
| 2 | HTML tags for a non-compact list when GLFMT=TABLE |
| 3 | HTML tags for a compact list (e.g. :GL COMPACT) when GLFMT=TABLE |
HTML tag values:
| ls | List start |
| le | List end |
| ts | Glossary Term start |
| te | Glossary Term end |
| ds | Glossary Definition start (first :GD after a :GT) |
| ds2 | Glossary Definition start (subsequent :GDs after a :GT, e.g. when using :GDG) |
| de | Glossary Definition end |
| gs | Group Separator (:GRPSEP) start |
| ge | Group Separator (:GRPSEP) end |
GLTAG.0='<DL>,</DL>,<P><DT>,,<DD>,<DD>,,
<P><DT><FONT SIZE="+2"><STRONG>,</STRONG></FONT><P>'
GLTAG.1='<DL COMPACT>,</DL>,<DT>,,<DD>,<DD>,,
<P><DT><FONT SIZE="+2"><STRONG>,</STRONG></FONT><P>'
GLTAG.2='<TABLE CELLPADDING="3">,</TABLE>,<TR VALIGN=TOP><TD><P>,</TD>,
<TD><P>,<P>,</TD></TR>,
<TR><TD COLSPAN="2"><FONT SIZE="+2"><STRONG><P>,
<P></STRONG></FONT><P></TD></TR>'
GLTAG.3='<TABLE CELLPADDING="3">,</TABLE>,<TR VALIGN="TOP"><TD>,</TD>,
<TD>,<BR>,</TD></TR>,
<TR><TD COLSPAN="2"><FONT SIZE="+2"><STRONG>,
</STRONG></FONT></TD></TR>'
This option is typically used to insert JavaScript code into the header portion of an HTML file.
Example:
HEADREC.TEXT='<script language="JavaScript">' HEADREC.TEXT='<!-- Hide JavaScript' HEADREC.FILE=animate.js HEADREC.TEXT='// end hiding -->' HEADREC.TEXT='</script>'
| x | Tag used for: |
| 1 | :ARTWORK RULE |
| 2 | :FIG when FRAME= value is not NONE (not used when creating HTML 3 or higher output) |
| 3 | (No longer used, see the HTAG= option) |
| 4 | :MSGL and :CODEL when STYLE=RULE specified |
| 5 | To precede and follow a syntax diagram defined using :SYNTAX STYLE=RULES |
| 6 | (No longer used, see the TOCTAG= option) |
| 7 | To precede an :H0 in the Table-of-Contents |
| 8 | (No longer used, see the TOCTAG= option) |
| 9 | (No longer used, see the FNTAG= option) |
| 10 | Preceding a :LEN tag if SEP=RULE specified by the :LERS tag |
| hs | Header start |
| he | Header end |
| ss | If specified, the next source line is inspected and if the left-most text matches this value (case is ignored), then the text is replaced by the value specified for "sr" |
| sr | The text to replace "ss" |
Default:
HTAG='<P><I><B>,: </B></I> ,:P.,' HTAG.0='<HR><H1>,</H1>' HTAG.1='<HR><H1>,</H1>' HTAG.2='<HR><H2>,</H2>' HTAG.3='<P><H3>,</H3>' HTAG.4='<P><H4>,</H4>'
For example, an HTML table cell would normally be generated like:
<TD>
But if HTMLATT.TD='class="abc"' were specified,
the table cell would be generated like this:
<TD class="abc">
The following values for "tagname" are available:
If HTML=2, then the value of HTMLDOCID.2 is used, if HTML=3, then the value of HTMLDOCID.3 is used, etc. The &b2hhtmlid symbol contains the appropriate value of this option for the HTML release being generated.
Example: HTML=3 HTMLDOCID.3='3.1'
causes the following DTD to be generated::
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3.1//EN">
Default:
HTMLDOCID.2='2' HTMLDOCID.3='3.2' HTMLDOCID.4='4'
Note: In most cases, it is recommended that the DESTSYS= option be used, since it will set this option appropriately.
See also 5.3, "Cross-Platform considerations".
Note: In most cases, it is recommended that the DESTSYS= option be used, since it will set this option appropriately.
See also 5.3, "Cross-Platform considerations".
| YES | Insert comment records |
| NO | Do not insert comment records (default) |
This option is not applicable when running on MVS as there are specific rules as to how imbedded files are retrieved. (See the Script/VS User's Guide for further information on how imbedded files are handled under MVS.)
Default: IMBFT=script (AIX)
Default: IMBFT=script (HPFS)
Default: IMBFT=script (LINUX)
Default: IMBFT=scr (OS/2)
Default: IMBFT=SCRIPT (VM)
Default: IMBFT=scr (WIN95)
Default: IMBFT=scr (WINNT)
Default: IMBFT=script (UNIX)
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 name 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
|
The markup for an index entry is usually coded by the author such that the index points to the location of the index entry markup within the source document. This causes B2H to generate a hyperlink from the index to the location of the index entry markup.
However, if the author specifies the PG='text' attribute on the :Ix tag (or if the fourth term of the index entry is specified on the .PI control word), then the index simply displays the provided reference text and, by default, B2H will not generate a hyperlink since the location of the index entry markup is irrelevant. But if you want B2H to generate a hyperlink even when reference text is provided, specify INDEXREFLINK=YES.
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 5.10.3, "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 |
| NO | The source lines do not contain line numbers (this is the default) |
| BEGIN | The first "word" of each source line is checked and if the value is numeric, the word is discarded |
| END | The last "word" of each source line is checked and if the value is numeric, the word is discarded |
| startcol-endcol | The text within the specified starting and ending columns of each source line are checked and if the value is numeric (blanks are allowed), the text is removed |
| PRE | The text should be displayed using a monospaced font by generating HTML "<PRE>" and "</PRE>" tags. Any tab characters within the text will be displayed correctly. This is the default. |
| BR | The text should be displayed using the current font (normally a proportional font) and a new line forced using HTML's "<BR>" tag at the end of each record. Any tab characters within the text will generally be lost since the user's browser will reformat the text. |
| .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 to correctly draw the screen border if the WIDTH= option is omitted |
| :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" |
| ACTUAL | Same as above, except that for ordered lists
(:OL), the item's indice
is used at the reference point (this is how BookMaster works).
If the user's web browser generates only numeric indices for an
ordered list, you will need to specify either: OLSEQ=N
to force B2H to generate only numeric indices, or
LIREF=ID to use the reference name as the
indice.
Note: For backwards compatability with previous releases of B2H, LIREF=NUM is accepted as a synonym of LIREF=ACTUAL. |
To save log records to a disk file:
| YES | Log records are saved to "b2h.log" if on MVS or a PC, or "B2H LOG" if on VM. |
| file | Log records are saved to the specified file.
Example: LOG='mydoc.b2h' Example: LOG='MYDOC B2HLOG A' If the name contains an asterisk (*), the asterisk is dynamically
replaced with the filename of the input file.
|
The second parameter specifies what to do if the disk file
already exists. CREATE (the default) means to erase the
existing log file and create a new one; APPEND means to
append the log records to the existing file.
Example: LOG='monday.log'
Example: LOG='batch.log,append'
If B2H is running as a Pipeline filter, you can specify
LOG=STREAMx which means that the log records
should be written to the pipeline output stream "x".
Example: LOG=STREAM1
METAKEYS='do re mi'causes the following to be generated:
<META HTTP-EQUIV="keywords" CONTENT="do re mi">
Figure 8-4. MVSALLOC.name= values
| Option | Default value | Where used |
|---|---|---|
| MVSALLOC.ANSFILE | "DSORG(PS) LRECL(1024) RECFM(V) TRACKS SPACE(5,5) RELEASE" | The answer file for Question/Answers. See the QUESTION= option for further information. |
| MVSALLOC.LOG | "DSORG(PS) LRECL(1024) RECFM(V) TRACKS SPACE(5,5) RELEASE" | Disk copy of the console log. See the LOG= option for further information. |
| MVSALLOC.OUTPUTPO | "DSORG(PS) LRECL(1024) RECFM(V) TRACKS SPACE(5,5) RELEASE DIR(10)" | The output HTML file if creating a partitioned data set |
| MVSALLOC.OUTPUTPS | "DSORG(PS) LRECL(1024) RECFM(V) TRACKS SPACE(5,5) RELEASE" | The output HTML file if creating a sequential data set; if multiple sequential output files are created, this applies to each output file |
| MVSALLOC.SYSVARW | "DSORG(PS) LRECL(1024) RECFM(V) TRACKS SPACE(5,5) RELEASE" | The output file written if SYSVAR='W filespec' specified |
| MVSALLOC.TEMP | "DSORG(PS) LRECL(1024) RECFM(V) TRACKS SPACE(5,5) RELEASE" | B2H's temporary work file |
| MVSALLOC.TRACE | "DSORG(PS) LRECL(1024) RECFM(V) CYLINDERS SPACE(5,5) RELEASE" | B2H's internal trace file (for system support use) |
| 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>,'
Figure 8-5. Script-to-HTML mapping for the OLSEQ= option
| Value | BookMaster creates: | B2H generates: | HTML creates: |
|---|---|---|---|
| N | 1. 2. 3. 4. ... | <OL TYPE="1"> | 1. 2. 3. 4. ... |
| n | 1) 2) 3) 4) ... | <OL TYPE="1"> | 1. 2. 3. 4. ... |
| A | A. B. C. D. ... | <OL TYPE="A"> | A. B. C. D. ... |
| a | a) b) c) d) ... | <OL TYPE="a"> | a. b. c. d. ... |
| x | a. b. c. d. ... | <OL TYPE="a"> | a. b. c. d. ... |
| R | I. II. III. IV. ... | <OL TYPE="I"> | I. II. III. IV. ... |
| r | i) ii) iii) iv) ... | <OL TYPE="i"> | i. ii. iii. iv. ... |
| y | i. ii. iii. iv. ... | <OL TYPE="i"> | i. ii. iii. iv. ... |
| 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>,'
For information on how this value is used, see 5.2, "Specifying the output file" and 5.3, "Cross-Platform considerations".
| YES | Files must honor 8.3 names (e.g. CMS, OS/2 with FAT, Windows 95/98/ME and Windows NT/2000/XP) |
| NO | Not necessary to honor 8.3 names (e.g. AIX, Linux, UNIX, OS/2 with HPFS) |
See also 5.3, "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 5.3, "Cross-Platform considerations".
When running on MVS, the dataset may be referenced by dataset name or by DD name. (See 5.2.2, "Output file considerations under MVS" for more information.)
For information on how this value is used, see 5.2, "Specifying the output file" and 5.3, "Cross-Platform considerations". See also 3.2, "Specifying a file".
| YES | Files must honor 8.3 names (e.g. OS/2 with FAT, Windows 95/98/ME and Windows NT/2000/XP) |
| NO | Not necessary to honor 8.3 names (e.g. AIX, Linux, UNIX, OS/2 with HPFS) |
See also 5.3, "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 5.3, "Cross-Platform considerations".
OWNER='John Doe'causes the following to be generated:
<META HTTP-EQUIV="owner" CONTENT="Joe Doe">
The situations you can control:
| NOENDTAG | The end-tag for certain BookMaster/GML tags was not found (e.g. :TITLE with no :ETITLE, :TABLE with no :ETABLE) |
| NOIMBED | A file being imbedded can not be found |
| NOINDEX | The INDEX or INDEX=YES option was specified, but the :INDEX tag was not encountered in the source |
| 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.) |
| UNKOPT | An unknown B2H option (or BookMaster option on the :DOCPROF tag) was encountered |
| UNKSYM | An unknown B2H symbol table record was encountered |
| UNKTAG | An unknown BookMaster/GML tag was encountered |
The actions you can specify:
| IGNORE | Ignore the situation completely, no message issued, the return code (RC) is not updated |
| INFO | Issue an information-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) |
Initial settings:
PROCACT='NOENDTAG=WARNING NOIMBED=ERROR NOINDEX=WARNING' PROCACT='NOPER=WARNING NOXREF=ERROR UNKOPT=TERM UNKSYM=TERM' PROCACT='UNKTAG=WARNING'
In addition to what is specified here, B2H also adds additional process names based on the HTML release being generated. See 5.8, "Including/excluding text when converting to HTML" for more information.
Default: PSC='CHAR HTML' plus one or more of: HTML2, HTML2+, HTML3, HTML3+, HTML4 or HTML4+
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) |
| NOISY | Display messages on the terminal |
| QUIET | Do not display messages on the terminal |
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">Default: source file date + one year
: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 control word 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 control words. 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 control word |
| erevtext | Text and/or HTML tag(s) to insert for a :EREV tag or .RC x OFF control word |
| PROP | When displaying an HTML table, many web browsers reset any font characteristics (including color) and display a cell's text in a default font. "PROP" specifies that if B2H generates an HTML table, all active start-revision/end-revision text should be "propagated" into each table cell. This is the default value if omitted. |
| NOPROP | This specifies that active start-revision/end-revision text should NOT be "propagated" into each table cell. |
See Chapter 7, "Troubleshooting and Frequently-Asked-Questions (FAQ)" for examples of using this capability.
SECURITY='public'causes the following to be generated:
<META HTTP-EQUIV="security" CONTENT="public">
Figure 8-6. SETUPTAG.tagname values
| Option | Description |
|---|---|
| SETUPTAG.ADDRESS | Text to precede the :ADDRESS. tag and to follow the :EADDRESS. tag (used within the title page). |
| SETUPTAG.ANNOT | Text to precede the :ANNOT. tag and to follow the :EANNOT. tag. |
| SETUPTAG.APPENDIX | Text to precede and follow the :APPENDIX. tag. |
| SETUPTAG.CGRAPHIC | Text to precede the :CGRAPHIC. tag and to follow the :ECGRAPHIC. tag. |
| SETUPTAG.CIT | Text to precede the :CIT. tag and to follow the :ECIT. tag. |
| SETUPTAG.CODEL | Text to precede the :CODEL. tag and to follow the :ECODEL. tag. |
| SETUPTAG.DIALOG | Text to precede the :DIALOG. tag and to follow the :EDIALOG. tag. |
| SETUPTAG.DIRECT | Text to precede the :DIRECT. tag and to follow the :EDIRECT. tag. |
| SETUPTAG.FIG | Text to precede the :FIG. tag and to follow the :EFIG. tag. |
| SETUPTAG.FIGLIST | Text to precede and follow the :FIGLIST. tag (which generates the list of figures). |
| SETUPTAG.FN | Text to precede and follow the list of footnotes generated at the end of each physical HTML output file. |
| SETUPTAG.Hx | Text to precede and follow the appropriate :Hx tag. |
| SETUPTAG.INDEX | Text to precede and follow the :INDEX. tag |
| SETUPTAG.LBLBOX | Text to precede the :LBLBOX. tag and to follow the :ELBLBOX. tag. |
| SETUPTAG.LERS | Text to precede the :LERS. tag and to follow the :ELERS. tag. |
| SETUPTAG.LINES | Text to precede the :LINES. tag and to follow the :ELINES. tag. |
| SETUPTAG.LITDATA | Text to precede the :LITDATA. tag and to follow the :ELITDATA. tag. |
| SETUPTAG.MSGL | Text to precede the :MSGL. tag and to follow the :EMSGL. tag. |
| SETUPTAG.NOTEL | Text to precede the :NOTEL. tag and to follow the :ENOTEL. tag. |
| SETUPTAG.NT | Text to precede the :NT. tag and to follow the :ENT. tag. |
| SETUPTAG.PK | Text to precede the :PK. tag and to follow the :EPK. tag. |
| SETUPTAG.PTOC | Text to precede and follow the :PTOC. tag (which generates a partial table of contents). |
| SETUPTAG.QUALIF | Text to precede the :QUALIF. tag and to follow the :EQUALIF. tag. |
| SETUPTAG.QUESTION | Text to precede the :QUESTION. tag and to follow the :EQUESTION. tag. |
| SETUPTAG.SCHDATE | Text to precede and follow the :SCHDATE. tag (which generates a schedule chart). |
| SETUPTAG.SCREEN | Text to precede the :SCREEN. tag and to follow the :ESCREEN. tag. |
| SETUPTAG.SYNTAX | Text to precede the :SYNTAX. tag and to follow the :ESYNTAX. tag. |
| SETUPTAG.TABDATA | Text to precede the :TABDATA. tag and to follow the :ETABDATA. tag. |
| SETUPTAG.TABLE | Text to precede the :TABLE. tag and to follow the :ETABLE. tag. The before/after text is also propagated into each table cell. |
| SETUPTAG.TIPAGE | Text to precede and follow the :TIPAGE. tag (which generates the title page). |
| SETUPTAG.TLIST | Text to precede and follow the :TLIST. tag (which generates the list of tables). |
| SETUPTAG.TOC | Text to precede and follow the :TOC. tag (which generates the table of contents). |
| SETUPTAG.XMP | Text to precede the :XMP. tag and to follow the :EXMP. tag. |
Example 1: Cause the title page to be centered
SETUPTAG.TIPAGE='<center>','</center>'
Example 2: Enable a specific monospaced font for all syntax diagrams. (For a more detailed description, see 7.0.10, "FAQ 10: Syntax diagram characters don't look right")
SETUPTAG.SYNTAX='<font face="courier">','</font>' Then this source: :SYNTAX ... (... the specification of the diagram ...) :ESYNTAX. Generates this HTML: <font face="courier"><PRE> (... the syntax diagram itself ...) </PRE></font>
Default values:
Figure 8-7. 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 the SHADE=SCREEN attribute 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 |
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 |
| LALPHA | Alphanumeric (base 36) numbering using the digits 0-9,a-z |
Note: For compatibility with older releases of B2H, an option name of PARTDIGITS= is recognized as an alias of SPLITDIGITS=.
The following syntaxes are accepted:
See 5.9.2, "Specifying the location and file names when splitting the HTML output" for more information.
Notes:
Note: For compatibility with older releases of B2H, an option name of PARTLINK= is recognized as an alias of SPLITLINK=.
Default: SPLITLINK=YES
"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, "&Symbols pre-defined by B2H" lists the &variables which are provided with the intent of their being used within a SPLITLINK.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.
Note: For compatibility with older releases of B2H, an option name of PARTLINK.x= is recognized as an alias of SPLITLINK.x=.
SPLITNAME.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".
SPLITNAME.NEXT='DOITNOW HTML A,doitnow.htm'This specifies that the next output file (whenever and wherever it occurs), should be physically created as "PROJDEF HTML A" and logically known as "projdef.htm". This form of the option is normally included on a .*B2H OPTION statement within the source file.
Notes:
| 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 5.13, "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.b2hxrefs (LINUX) userid.BOOK1.B2HXREFS (MVS) BOOK1.B2X (OS/2) BOOK1 B2HXREFS (VM) BOOK1.B2X (WIN95) BOOK1.B2X (WINNT) book1.b2hxrefs (UNIX) If SYSVAR='W projug', then: projug.b2hxrefs (AIX) projug.b2hxrefs (LINUX) userid.PROJUG.B2HXREFS (MVS) PROJUG.B2X (OS/2) PROJUG B2HXREFS (VM) PROJUG.B2X (WIN95) PROJUG.B2X (WINNT) projug.b2hxrefs (UNIX) And if SYSVAR='W acmea.abc', then: acmea.b2hxrefs (AIX) acmea.b2hxrefs (LINUX) userid.ACMEA.B2HXREFS (MVS) ACMEA.B2X (OS/2) ACMEA B2HXREFS (VM) ACMEA.B2X (WIN95) ACMEA.B2X (WINNT) acmea.b2hxrefs (UNIX) Note: On AIX, Linux, OS/2, Windows 95/98/ME, Windows NT/2000/XP or UNIX, 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
file15 that contains symbols definitions for DVCF
conditions. If specified, this should be the last
parameter specified for this SYSVAR option.
file (AIX) file (LINUX) filespec (MVS) file.ext (OS/2) fn ft fm (VM) file.ext (WIN95) file.ext (WINNT) file (UNIX)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 itself 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 |
| ts | Tag to start the Table-Of-Contents |
| te | Tag to end the Table-Of-Contents |
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).
You can also include symbol table definitions within the source file itself. See 5.5, "Controlling B2H using statements within the source file" for more information on this technique.
The general format of a symbol table record is:
| Format of a symbol table record |
|---|
[(env)] :statementtype. name parm1=value1 [ ... parmx=valuex ] |
V='Document Number:' V="Murphy's Law" V=/Bugs Bunny says "What's Up, Doc?"/
A logical definition can be split into multiple physical records by placing 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 9-1. Specifying an '&symbol'
[(env)] :SYM. symbol [ symbol2 ... symbolx ] V='text' |
B2H also dynamically assigns &symbols when it encounters GML's .SE control word, and BookMaster's .NAMEIT, .NAMECTR and .GETW macros. In addition, B2H defines some &symbols for it's own use. These are described in Appendix B, "&Symbols pre-defined by B2H".
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 9-2. Specifying a Script/VS control word and/or BookMaster/GML macro
[(env)] :CMD. name [... name ] V='text' [ TV='text' ] |
Note: If a value of =NO is specified, it means that this markup is NOT supported within an HTML 2 table. B2H will issue a warning message and ignore the markup.
Note: This parameter is ignored if HTML 3 or higher is being generated.
The following special values may be specified as replacement text:
&PGM | Invoke an external program to process this control word or macro. See 5.15, "Invoking an external program" for additional information. |
&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 9-3. Specifying a BookMaster/GML tag
[(env)] :TAG. name [... name] IT=x VAT=x ATT=x SE=x V='text' [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 3 or higher is being generated.
The following special values may be specified as replacement text:
&PGM | Invoke an external program to process this tag. See 5.15, "Invoking an external program" for additional information. |
&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 :XLATEI. statement allows the translation of single-byte values to other values within input records. The :XLATEO. statement works similarly, except that it applies to HTML output records. A single-byte character can be translated to either another single-byte character or to a string.
These statements are 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 5.10, "National Language Support (NLS) considerations").
Figure 9-4. Specifying a character translation
For input records:
[(env)] :XLATEI. from to [ from2 to2 ... fromx tox ]
For output HTML records:
[(env)] :XLATEO. from to [ from2 to2 ... fromx tox ]
|
| c | A single character |
| hh | A 2-character hexadecimal code |
| V='text string' | The text string to replace the source character. Any text can be provided here, including HTML, normal text, even BookMaster tags and commands. |
Example 1: On each input record, translate all X'34' characters to X'5D' and all "number signs" (#) to X'24':
:XLATEI. 34 5D # 24
Example 2: On each input record, translate all X'93' characters to an HTML entity name.
:XLATEI. 93 V='&lbrk;'
Example 3: On each output HTML record, translate all X'AA' characters to a green exclamation point:
:XLATEO. AA V='<font color="#00FF00">!</font>'
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 do not like a list's default appearance, you can change it.
An ordered list using B2H's LIREF=ACTUAL option (the default):
:ol. :li.List item number one :li.List item number two :ol compact. :li id=ltst2b.Nested compact ordered list: item one :li.item two :eol. :li.Maybe loop back to step :liref refid=ltst2b. :li.Resume original list, final item :eol.Results in:
Same ordered list using B2H's LIREF=ID option:
An un-ordered list:
:ul. :li.List item number one :li.List item number two :ul compact. :li.Nested compact un-ordered list: item one :li.item two :eul. :li.Resume original list, final item :eul.Results in:
A simple list:
:sl. :li.List item number one :li.List item number two :sl compact. :li.Nested compact simple list: item one :li.item two :esl. :li.Resume original list, final item :esl.Results in:
List item number one
List item number two
Resume original list, final item
A definition list using B2H's DLFMT=DL option (the default):
:dl termhi=3 tsize=4m. :dthd.Term :ddhd.Definition :dt.term1 :dd.Definition for term1 :dt.term2 :dd.Definition for term2 :dl tsize=4m compact. :dt.term2a :dd.Nested compact definition list: text for term2a :dt.term2b :dd.Definition for term2b :edl. :dt.term3 :dd.Definition for term3 :edl.Results in:
Same definition list using B2H's DLFMT=TABLE option (HTML 3 or higher only):
Term | Definition | ||||
term1 | Definition for term1 | ||||
term2 | Definition for term2
| ||||
term3 | Definition for term3 |
A glossary list using B2H's DLFMT=DL option (the default):
:gl. :gt.binding edge :gd.The edge of a page to be bound, stapled, or drilled. Defined with the BIND option of the SCRIPT command. :gt.boldface :gd.A heavy-faced type :grpsep.C :gt.caption :gd.Text accompanying and describing an illustration :grpsep.T :gt.troglodyte :gdg. :gd.A prehistoric cave dweller :gd.A person who is still using index cards :gd.A computer nerd who keeps saying :q.I'll take a byte out of that!:eq. :gt.Zebra :gd.A striped animal from Africa :egl.Results in:
Same glossary list using B2H's GLFMT=TABLE option (HTML 3 or higher only):
binding edge | The edge of a page to be bound, stapled, or drilled. Defined with the BIND option of the SCRIPT command. |
boldface | A heavy-faced type |
C | |
caption | Text accompanying and describing an illustration |
T | |
troglodyte | (1) A prehistoric cave dweller
|
Zebra | A striped animal from Africa |
There is a big difference in the appearance of the following tables between HTML 2 and HTML 3. This is described further in 6.1, "Special information about tables".
A simple table with caption and no frame, defined with
:table cols='* 2* * *' frame=none.
Figure 10-1. Example: The caption for a simple table with no frame
| 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 10-2. Example: A simple table with a frame
| 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 10-3. Example: Same table with additional embellishments
|
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 10-4. Example: A complex table with varying columns by row
| 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. :tcap.Default appearances for SHADE :thd.:c.Shade Type :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 10-5. 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 10-6. 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
:direct layout=2 cols='8 8 8'. :dirhdr.Module Called Entry :dirhdr.Name By Point :dentry.IJK30276 IJK30111 IJKA9762 :dentry. IJK30276 IJK30111 IJKA9762 :dentry.IJK30276 IJK30111 IJKA9762 :dentry. IJK30276 IJK30111 IJKA9762 :edirect.
Module Called Entry Name By Point IJK30276 IJK30111 IJKA9762 IJK30276 IJK30111 IJKA9762 IJK30276 IJK30111 IJKA9762 IJK30276 IJK30111 IJKA9762
Three columns, width specified as COLS='3i .5i 1i' and a :DIRSUB
:direct cols='3i .5i 1i'. :dirhdr. Name Ext 'Dept/Room' :dentry.'Doe, Alice' VC5 'Pav 301' :dentry.'Doe, John' VC5 'Pav 302' :dentry.'Doe, Ken' VC5 'Pav 312' :dentry.'Doe, Mary' VC5 'Pav 312' :dentry.'Richtmeyer, Gary' VC5 'Spectrum 3046' :dentry.'Smith, John' VC1 'Pav 324' :dentry.'Smith, Mary' VC2 'Pav 322' :dentry.'Smith, Tom' VC3 'Pav 202' :dirsub.This is a &colon.dirsub. line :dentry.'Descarte, Rene' VC5 'Pav 1024' :dentry. 'Doe, Jane' VA1 'Pav 234' :dentry. 'Doe, John' VC5 'Pav 302' :edirect.
Name Ext Dept/Room Doe, Alice VC5 Pav 301 Doe, John VC5 Pav 302 Doe, Ken VC5 Pav 312 Doe, Mary VC5 Pav 312 Richtmeyer, Gary VC5 Spectrum 3 Smith, John VC1 Pav 324 Smith, Mary VC2 Pav 322 Smith, Tom VC3 Pav 202 This is a :dirsub. line Descarte, Rene VC5 Pav 1024 Doe, Jane VA1 Pav 234 Doe, John VC5 Pav 302
Same as above, but with COMPACT
Name Ext Dept/Room Doe, Alice VC5 Pav 301 Doe, John VC5 Pav 302 Doe, Ken VC5 Pav 312 Doe, Mary VC5 Pav 312 Richtmeyer, Gary VC5 Spectrum 3 Smith, John VC1 Pav 324 Smith, Mary VC2 Pav 322 Smith, Tom VC3 Pav 202 This is a :dirsub. line Descarte, Rene VC5 Pav 1024 Doe, Jane VA1 Pav 234 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 the 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 the 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 (or higher) output is being generated.
Figure 10-7. Example: 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 | +--------------------------------------------------------------------------------+ |
:lblbox.This is the label for the box This is verbiage for within the box. It is formatted normally. :elblbox.
| 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 (using LINES=PRE, the default):
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
Same records, but now processed using LINES=BR):
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.
:schedule start='09/96' end='12/98' dateform='mm/dd/yy'
listid=sch009 legend=yes scale='0.8'
frame=box actsize='15' chart=no
shade=yes split=yes width=column cmtsize=6.
·
·
:eschedule.
:schdate listref=sch009
width=column actsize='15' cmtsize='6'
split=yes scale='0.8' frame=box.
Results in:
| 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 |
||
:msgl style=rule. :msgno.ABC123 :msg.This is a test message :msgno.ABC124 :msg.This is another test message :severity.4 :probd.Problem determination text goes here :msgno.ABC125 :msg.This is yet another test message :emsgl.
| ABC123 | This is a test message |
| ABC124 | This is another test message |
Severity: 4
Problem Determination: Problem determination text goes here
| ABC125 | This is yet another test message |
:msgl compact style=box xpl='Cause'
uresp='Recovery' spresp='Administrative Action' tsize=6m.
:msgno.DJI7832E
:msg.This message is issued when no data set of the
name :mv.xxxxxxxx:emv. is found.
:xpl.The processor could not locate
the data set named :mv.xxxxxxxx:emv..
:severity.8
:probd.You would appear to have a problem!
:uresp.Look for the data set.
:oresp.Do not mount the lost data set.
:presp.Help the user look for the data set.
:sysact.The system goes and does something
else while everyone looks for the data set.
·
·
:emsgl.
|
|
:codel compact. :code.0C1 :xpl.Occurs when an operation exception occurs. :severity.The program is terminated. :dest.Send the dump to the user. :code.0C4 :xpl.Occurs when an invalid address is referenced. :severity.The program is terminated. :dest.Send the dump to the user. :ecodel.
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.
:codel compact style=box xpl='Cause' dest='Do what?'. :code.0C1 :xpl.Occurs when an operation exception occurs. :severity.The program is terminated. :dest.Send the dump to the user. :code.0C4 :xpl.Occurs when an invalid address is referenced. :severity.The program is terminated. :dest.Send the dump to the user. :ecodel.
| 0C1 |
| 0C4 |
:dialog tsize=5p
user=You
sys=Mythical
keep=all.
:sys.MYTHICAL IS READY FOR YOU.
ARE YOU READY FOR MYTHICAL?
:user.yes
:sys.THEN PROCEED.
:user.now what do i do?
:sys.WHAT DO YOU EXPECT A MYTHICAL PROGRAM TO DO?
:user.very little
:sys.THAT'S EXACTLY WHAT THIS PROGRAM DOES!
END.
:edialog.
Results in:
| Mythical |
MYTHICAL IS READY FOR YOU. ARE YOU READY FOR MYTHICAL? |
| You |
yes |
| Mythical |
THEN PROCEED. |
| You |
now what do i do? |
| Mythical |
WHAT DO YOU EXPECT A MYTHICAL PROGRAM TO DO? |
| You |
very little |
| Mythical |
THAT'S EXACTLY WHAT THIS PROGRAM DOES! END. |
*------------------* *------------------*
| 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 | |
| |<--------------------------* |
*------------------* *------------------*
:syntax style=lblbox.Sample syntax diagram
:kwd.ERASE
:group choice.
:kwd.FORM
:kwd.PROC
:kwd.QUERY
:kwd.TABLE
:egroup.
:group.
:repsep.&comma.
:var.name
:egroup.
:group composite opt.
:delim.(
:kwd.CONFIRM
:oper.=
:group choice.
:kwd def.YES
:kwd.NO
:kwd.LOCAL
:var.yyyymmdd
:egroup.
:egroup.
:esyntax.
| Sample syntax diagram (using :SYNFONT=NO) |
|---|
<-,-----<
>>--ERASE--+-FORM--+--V-name--+--+-------------------------+--><
| | | |
|-PROC--| | +-YES------+ |
| | | | | |
|-QUERY-| +--(CONFIRM=+-NO-------+--+
| | | |
+-TABLE-+ |-LOCAL----|
| |
+-yyyymmdd-+
|
The accuracy of the appearance of the following syntax diagram is dependent on your browser.
| Sample syntax diagram (using :SYNFONT=YES) |
|---|
<-,-----<
>>--ERASE--+-FORM--+--V-name--+--+-------------------------+--><
| | | |
|-PROC--| | +-YES------+ |
| | | | | |
|-QUERY-| +--(CONFIRM=+-NO-------+--+
| | | |
+-TABLE-+ |-LOCAL----|
| |
+-yyyymmdd-+
|
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,
simply define it in a user symbol table and point B2H to it
using the USERSYM= option.
Figure A-1. Supported &symbols
| 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 | " | &cdqf | » | &cdqg | " |
| ¸ | ¸ | ¢ | ¢ | &char | ' |
| &colon | : | &comma | , | &concat | || |
| &copr | © | © | © | ©r | © |
| &csq | ' | &csqg | ' | ¤ | ¤ |
| ¤cy | ¤ | &darrow | V | &dash | - |
| &dbls | § | &dblxclam | !! | &dblxclm | !! |
| ° | ° | °ree | ° | &div | ÷ |
|
÷
| ÷ | &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 | |
|
&florin
| ƒ | ½ | ½ | ¼ | ¼ |
| &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 | º | &mathast | * |
| &mdash | -- | µ | µ | · | · |
| &minus | - | &minusop | - | &mult | × |
|   | &ndash | - | &ne | <> | |
| &nesym | <> | ¬ | ¬ | ¬sym | ¬ |
| &Nt | Ñ | &nt | ñ | Ñ | Ñ |
| ñ | ñ | &numsign | # | &Oa | Ó |
| &oa | ó | Ó | Ó | ó | ó |
| &Oc | Ô | &oc | ô | Ô | Ô |
| ô | ô | &odq | " | &odqf | « |
| &odqg | " | &Oe | Ö | &oe | ö |
| &OElig | OE | &oelig | oe | &Og | Ò |
| &og | ò | Ò | Ò | ò | ò |
| ª | ª | º | º | &Os | Ø |
| &os | ø | Ø | Ø | ø | ø |
| &osq | ' | &osqg | ' | &Ot | Õ |
| &ot | õ | Õ | Õ | õ | õ |
| Ö | Ö | ö | ö | öaut | ö |
| &ous | o | &par | ¶ | ¶ | ¶ |
| &per | . | &percent | % | &period | . |
| &plus | + | &plusend | + | &plusmin | ± |
| ± | ± | &plusop | + | &pm | ± |
| £ | £ | &prime | ' | &quest | ? |
| &rahead | > | » | » | &rarrow | > |
| &rbl | &rbrace | } | &rbracket | ] | |
| &rbrc | } | &rbrk | ] | &rdarrow | => |
| ® | ® | ®tm | ® | &rpar | ) |
| &rparen | ) | &sdq | " | § | § |
| §ion | § | &semi | ; | ­ | |
| &slash | / | &slr | / | &ss | ß |
| &ssbl | &ssq | ' | &STAR | * | |
| &sub0 | 0 | &sub1 | 1 | &sub2 | 2 |
| &sub3 | 3 | &sub4 | 4 | &sub5 | 5 |
| &sub6 | 6 | &sub7 | 7 | &sub8 | 8 |
| &sub9 | 9 | &sup0 | 0 | ¹ | 1 |
| ² | 2 | ³ | 3 | &sup4 | 4 |
| &sup5 | 5 | &sup6 | 6 | &sup7 | 7 |
| &sup8 | 8 | &sup9 | 9 | ß | ß |
| &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 | ÿ | ¥ | ¥ | ÿ | ÿ |
The following "system-type" symbols, set by Script/VS, GML
and Bookmaster, are also set by B2H to allow user-written
macros and other markup to execute under B2H without
modification as much as possible.
| Symbol | Description | Value |
|---|---|---|
| Date and Time | ||
| &SYSYEAR | Year of the century | 00-99 |
| &SYSMONTH | Month of the year | 01-12 |
| &SYSDAYOFM | Day of the month | 01-31 |
| &SYSDAYOFW | Day of the week | 1-7 ("1" is Sunday) |
| &SYSDAYOFY | Day of the year | 001-366 |
| &SYSHOUR | Hour of the day | 00-23 |
| &SYSMINUTE | Minute of the hour | 00-59 |
| &SYSSECOND | Second of the minute | 00-59 |
| &$YEAR | Four-digit year | yyyy |
| Output Device Characteristics | ||
| &$LDEV | Logical output device | HTMLx (e.g. HTML2, HTML3, HTML4) |
| &$OUT | Output destination | FILE |
| &$PDEV | Physical output device | HTMLx (e.g. HTML2, HTML3, HTML4) |
| SCRIPT Command Options | ||
| &$ASCI | ASCII output being generated | 0 (no) or 1 (yes) |
| &$DCF | Current SCRIPT/VS (or in this case, B2H) release level | Release 4.7 |
| &$INDX | Index requested? | 0 (no) or 1 (yes) |
| &$LIB | Macro library available | 0 |
| &$PARM | Command options | Any options passed to B2H on the command line |
| &$PASS | Current pass number | 1 (always) |
| &$PSNO | Number of formatting passes requested | 1 (always) |
| &$SYS | Environment | Name of current platform (see also the description of &b2hplatc) |
| &$TWO | TWOPASS specified? | 0 (always) |
| SCRIPT/VS Formatter Parameters | ||
| &$CW | Control word separator | Set by .DC (defaults to ';') |
| &$EGML | GML end-tag delimiter | Set by .DC (defaults to ':E') |
| &$FNAM | Current input file name | File name of the input file |
| &$GML | GML tag delimiter | Set by .DC (defaults to ':') |
| &$PN | Page number | 1 (always) |
| &$RB | Required blank | |
| &$TAB | Tab character | |
| Miscellaneous system symbols | ||
| &$IXB | A single blank | |
| &$IXI | A null string | |
| &$MCS | A single period ('.') | |
These are the &symbol value attributes supported by
B2H. For more information on their usage, see the
Script/VS User's Guide.
Figure A-3. 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. |
| &X' | Converts a hexadecimal notation (may be the value of another symbol) to a character string using the character coding of the platform on which B2H is currently running (ASCII if running on a PC, EBCDIC if running on a mainframe). The &$ASCI symbol is set to 1 (one) if running on an ASCII platform, otherwise the symbol is set to 0 (zero). |
Figure A-4. Supported Script/VS control words
|
The "How?" column contains an "S" if the control word is
supported via a Symbol table definition or an "I" if the
control word is supported via a B2H internal routine.
| |||
| Control Word | How? | Comments | Related B2H options |
|---|---|---|---|
| ...label | I | Both with and without a blank prior to the label name | |
| .AN | I | ||
| .BF | I | Begins the specified font. | FONTTAG= |
| .BL | S | Mapped to new-paragraph. When SOURCE=SCRIPT, a .BL is automatically generated and executed whenever a blank line is processed. | |
| .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 blanks17 or by using the HTML <CENTER> tag. The CENTERTAG= option specifies which technique is used. | CENTERTAG= and LINEWIDTH= |
| .CP | S | Mapped to new-paragraph | |
| .CS | I |
| |
| .CT | S | Text included as-is. | |
| .DC | I | Only the CW and GML operands are supported. For GML, if less than two values are specified or if "OFF" is specified for either of the first two values, error message 456 is issued and the control word is ignored. | |
| .DD | I | The LIB operand (whether explicitly specified or defaulted) is supported on all platforms. On MVS, the DD and DSN operands are also supported. If the TERM operand is specified, the entire control word 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. | |
| .DV | I | ||
| .EF | I | The CLOSE option is supported. | |
| .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 control word all other operands are ignored. | CENTERTAG= |
| .GO | I | Branching only to a label later in the
file is supported.
".GO" control words branching to a label
earlier in the file are ignored.
See additional comments in Chapter 6, "Caveats and restrictions (what's supported and what's not!)".
The alternate formats ".GOTO label" and ".GO TO label" are also recognized. | |
| .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. | IMBFTEXT= |
| .LB | I | ||
| .LI | I | ||
| .MG | I | ||
| .NF | I | ||
| .OR | I | ||
| .PA | S | Mapped to double new-paragraph | |
| .PF | I | Restores the previous font. | FONTTAG= |
| .PI | I | Only index terms 1 to 4 are used. The REF, ORDER, START, END and KEY attributes are ignored. | INDEXREFLINK= and DEFTEXT= (DEFTEXT.INDEXENTRYL= and DEFTEXT.INDEXENTRYR=) |
| .PP | S | ||
| I | |||
| .QU | I | ||
| .RC | I | Formats supported:
.RC n c .RC n ON .RC n OFF .RC n ON/OFF | REVTAG= |
| .RE | I | See the description of .SA for which values are saved/restored. | |
| .RV | I | ||
| .SA | I | The status of the following control words are saved: .CE, .DC, .FO, .TI, .TR, .UC, .UP and .US | |
| .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 | ||
| .SU | I | The "ON" and "OFF" operands are supported, all others are treated as if "ON". | |
| .SX | I | Implemented using a monospaced font on a line whose width is specified using the LINEWIDTH= option | LINEWIDTH= |
| .TC | S | Mapped to :TOC. | |
| .TD | I | ||
| .TH | I | ||
| .TI | I |
| See the :XLATEI. symbol table statement in 9.2.4, "Translation of single-byte values" |
| .TR | I |
| See the :XLATEO. symbol table statement in 9.2.4, "Translation of single-byte values" |
| .TY | I | ||
| .UC | I | ||
| .UP | I | ||
| .US | I | ||
Control words not applicable or not supported; will be ignored
.AA, .AP, .AR, .BC, .BM, .CC, .CD, .CL, .CM, .DA, .DF, .DH, .DL, .DR, .DS, .DU, .EC, .EM, .ES, .FL, .FV, .GR, .GS, .HR, .HW, .HY, .IC, .IE, .IL, .IN, .IR, .IS, .IT, .IX, .KP, .LL, .LO, .LS, .LT, .LY, .MC, .ME, .MS, .NL, .NV, .OC, .OF, .PL, .PM, .PN, .PT, .PW, .PX, .RD, .RF, .RH, .RI, .RN, .SB, .SC, .SD, .SO, .SS, .SV, .TA, .TE, .TM, .TP, .TS, .TU, .UD, .UN, .UW, .VR, .WF, .WS and .WZ
Figure A-5. Supported BookMaster and GML macros
|
The "How?" column contains an "S" if the macro is
supported via a Symbol table definition or an "I" if the macro
is supported via a B2H internal routine.
| ||
| Macro | How? | Comments |
|---|---|---|
| .CONFIG | I | |
| .GETW | I | All operands supported except GMLTYPE= and SCALE=. |
| .INWIDTH | I | |
| .NAMECTR | I | All functions supported, but the GMLTYPE=, SIZE= and CTRTYPE= operands are ignored |
| .NAMEFILE | I | In addition to the required NAME=, the CMS=, TSOFULL= and TSOPART= operands are supported |
| .NAMEIT | I | All operands 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 control word. 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 A-6. Supported BookMaster and GML tags
|
The "How?" column contains an "S" if the tag is supported
via a Symbol table definition or an "I" if the tag is supported
via a B2H internal routine.
| |||
| Tag | How? | Comments (fully supported unless specified otherwise) | Related B2H options |
|---|---|---|---|
| :ABBREV. | I | Attributes supported: ID= | DEFTEXT= (DEFTEXT.ABBREV=) |
| :ABSTRACT. | I | Attributes supported: ID= | DEFTEXT= (DEFTEXT.ABSTRACT=) |
| :ADDRESS. | I |
| SETUPTAG= |
| :ALINE. | S | ||
| :ANNOT. | I |
| ANNOT=, SETUPTAG= and SYSVAR='A value' |
| :ANSREF | I | Attributes supported: FORM= and REFID= | DEFTEXT= (DEFTEXT.QANSREF=) |
| :ANSWER | I | Attributes supported: REFID=
See also 5.11, "Question and Answer tags" | |
| :APL. | S | ||
| :APPENDIX. | I |
| APPHD1=, APPHD1X=, DEFTEXT= (DEFTEXT.APPENDIX=) and SETUPTAG= |
| :ARTALT. | I | The comments for :ARTWORK apply equally to this tag also. | |
| :ARTDEF. | I | Both with and without ID= attribute | |
| :ARTWORK. | I | Attributes supported:
ALIGN=,
LABEL=,
NAME=,
REFID=,
RULE and
RUNIN
If RULE specified or NAME= omitted, then the value for the HRTAG.1= option (normally <HR>) is inserted. If CENTERTAG=YES and HTML=3 or HTML=4 is specified, then the ALIGN=CENTER and ALIGN=RIGHT attributes are also supported by enclosing the image reference with the <CENTER> and </CENTER> HTML tags. | ARTLINKIMG=, ARTSHOW=, ARTTYPE= and HRTAG= |
| :ASMLIST. | S | ||
| :ATTACH. | S | ||
| :AUTHOR. | I | Attributes supported: TEXT= | |
| :BACKM. | I | ||
| :BIBLIOG. | I | Attributes supported: ID= | DEFTEXT= (DEFTEXT.BIBLIOG=) |
| :BIN. | S | ||
| :BINDNUM. | I | Displayed as part of the title page, since HTML has no "back cover" concept | |
| :BLANK | I | Attributes supported:
ANS= and WIDTH=
See also 5.11, "Question and Answer tags" | |
| :BODY. | I | ||
| :C. | I | ||
| :CAUTION. | S | ||
| :CGDEF. | I | Both with and without ID= attribute | |
| :CGRAPHIC. | I | Attributes supported: SCALE= and REFID= | |
| :CHAR. | S | ||
| :CHOICE | I | Attributes supported: ID=
See also 5.11, "Question and Answer tags" | |
| :CIT. | I | Attributes supported: DOCID= | SETUPTAG= |
| :CODE. | I | ||
| :CODEL. | I | Attributes supported:
COMPACT,
DEST=,
MODULE=,
NUMBYTES=,
ORESP=,
PRESP=,
PROBD=,
REFID=
SCALE=,
SEVERITY=,
SPRESP=,
STYLE=,
SYSACT=,
URESP= and
XPL=
STYLE=RULE causes the value specified for the HRTAG.4= option (normally a <HR>) to be inserted around each :CODE. block. | BORDERTAG=, DEFTEXT= (DEFTEXT.MCxxx), HRTAG= and SETUPTAG= |
| :COPREXT. | I | ||
| :COPRNOTE. | I | ||
| :DANGER. | S | ||
| :DATE. | I | ||
| :DD. | I | ||
| :DDHD. | I | ||
| :DELIM. | I | Attributes supported: OPT and REQ | |
| :DENTRY. | I | ||
| :DEST. | I | DEFTEXT= (DEFTEXT.MCDEST=) | |
| :DIALDEF. | I | Both with and without ID= attribute | |
| :DIALOG. | I | Attributes supported:
REFID=,
SCALE=,
SYS= and
USER=
For HTML 2 output, this is mapped to HTML's <DL COMPACT> tag; otherwise an HTML table is created. | DIALOG= 18, DIALOGTAG= and SETUPTAG= |
| :DIRDEF. | I | Both with and without ID= attribute | |
| :DIRECT. | I | Attributes supported:
ALIGN=,
CHUNK,
COLS=,
COMPACT,
EXPAND,
REFID= and
SCALE=
Implemented using a monospaced font on a line 78 characters wide. | SETUPTAG= |
| :DIRHDR. | I | ||
| :DIRSUB. | I | ||
| :DL. | I | Attributes supported: COMPACT, REFID= and TERMHI= | DLFMT= and DLTAG= |
| :DLDEF. | I | Both with and without ID= attribute | |
| :DOCNUM. | I | Attributes supported: LEVEL= | DEFTEXT= (DEFTEXT.DOCNUM=) |
| :DOCPROF. | I | Attributes supported: APPHD1=, APPHD1X=, BODYHD0=, BODYHD0X=, BODYHD1=, BODYHD1X=, DIALOG=, FBC=, FTSEP=, HEADNUM=, OLSEQ=, PTOC=, QRESET=, SCREEN= and TOC= | All supported attributes are also available as individual B2H options. |
| :DT. | I | ||
| :DTHD. | I | ||
| :FIG. | I | Attributes supported:
CONCAT=,
FRAME=,
ID=,
REFID=,
SCALE=,
SHADE= and
WIDTH=PAGE
When generating HTML 2: 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 or higher: the figure is enclosed within a single-row, single-cell table (with BORDER turned on if FRAME=NONE is not specified) | BORDERTAG=, DEFTEXT= (DEFTEXT.FIGURE=), FIGCAPLOC=, HRTAG=, SETUPTAG= and SHADE= |
| :FIGCAP. | I | ||
| :FIGDEF. | I | Both with and without ID= attribute | |
| :FIGDESC. | S | ||
| :FIGLIST. | I | Attributes supported: ID= | DEFTEXT= (DEFTEXT.FIGLIST=), FBC= 18, FTLINK=, FTSEP= 18, SETUPTAG= and TFIGLISTTAG= |
| :FIGREF. | I | Attributes supported: FORM= and REFID= | |
| :FILENUM. | I | Displayed as part of the title page, since HTML has no "back cover" concept | |
| :FN. | I | Attributes supported:
CALLOUT= and ID=
All footnotes are displayed at the end of the HTML file. (If the output HTML file is being "split" into multiple output files, footnotes accumulated within each file are shown at the end of that file.) | DEFTEXT= (DEFTEXT.FOOTNOTES=), FNLINK=, FNTAG=, HRTAG= and SETUPTAG= |
| :FNREF. | I | Attributes supported: FORM= and REFID= | |
| :FRAGMENT. | I | ||
| :FRAGREF. | I | Attributes supported: OPT and REQ | |
| :FRONTM. | I | ||
| :GD. | I | ||
| :GDG. | I | ||
| :GDOC. | I | Attributes supported: COPYR= and SEC= | |
| :GL. | I | Attributes supported: COMPACT | GLFMT= and GLTAG= |
| :GLOSSARY. | I | Attributes supported: ID= | DEFTEXT= (DEFTEXT.GLOSSARY=) |
| :GROUP. | I | Attributes supported: CHOICE, COMPOSITE, DEF, OPT, REQ and SEQ | |
| :GRPSEP. | S | ||
| :GT. | I | ||
| :H0., :H1., :H2., :H3., :H4. ... :H18., :H19. and :H20. | I | Attributes supported:
ID=,
NUM= and
REF=
If BookManager's RES= attribute is encountered, an HTML "anchor" is also generated using the exact same name as that specified for the RESID attribute. | BODYHD0= 18, BODYHD0X= 18, BODYHD1= 18, BODYHD1X= 18, FBC= 18, HEADNUM= 18, HTAG=, PTOC= 18, SETUPTAG= and TOC= 18 |
| :HDREF. | I | Attributes supported: FORM= and REFID= | |
| :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 | |
| :IH1. | I | Attributes supported: CIX1=, CIX2= ... CIX9=, ID=, SEE= and SEEID= | |
| :IH2. | I | Attributes supported: ID=, REFID=, SEE= and SEEID= | |
| :IH3. | I | Attributes supported: ID= and REFID= | INDEXREFLINK= and DEFTEXT= (DEFTEXT.INDEXENTRYL= and DEFTEXT.INDEXENTRYR=) |
| :I1. | I | Attributes supported: CIX1=, CIX2= ... CIX9=, ID= and PG= (PG=END causes the tag to be ignored). | |
| :I2.-:I3. | I | Attributes supported: ID=, PG= (PG=END causes the tag to be ignored) and REFID=. | INDEXREFLINK= and DEFTEXT= (DEFTEXT.INDEXENTRYL= and DEFTEXT.INDEXENTRYR=) |
| :IBMLPS. | I | Attributes supported: COPYR= and SEC= | |
| :INDEX. | I | Attributes supported: ID= | DEFTEXT= (DEFTEXT.INDEXxxx=), INDEX=, INDEXTAG=, INDEXTOC= and INDEXTOCTAG= |
| :IREF. | I | Attributes supported: PG= (PG=END causes the tag to be ignored) and REFID= | |
| :KWD. | I | Attributes supported: DEF, OPT and REQ | |
| :L. | I | Attributes supported:
LID=
See 5.12, "Interdocument linking (BookManager tags)" for more information. | |
| :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 or higher, a single-cell, two-row table is generated. | BORDERTAG=, LINEWIDTH= and SETUPTAG= |
| :LDESC. | I | Attributes supported:
DOCID=,
OBJECT= and
OBJTYPE=
For the OBJTYPE= attribute, the HEAD, BOOK, FIG, TABLE and SPOT values are supported; all others are ignored. The DOCID= attribute points to the B2H DOCDESC= option, not the :DOCDESC tag. See 5.12, "Interdocument linking (BookManager tags)" for more information. | DOCDESC= |
| :LEDI. | I | Attributes supported: ID=, TEXT= and all the category-related attributes. | DEFTEXT= (DEFTEXT.LERSxxxx) |
| :LEGEND. | I | Attributes supported: ID= | DEFTEXT= (DEFTEXT.LEGEND=) |
| :LEN. | I | Attributes supported: ID= | HRTAG= |
| :LERS. | I | Attributes supported:
LEDIHD=,
LEHD=,
REFID=,
SEP=
and all the category-related attributes.
If SEP=RULE attribute specified, then the value for the HRTAG.10= option (normally <HR>) is inserted prior to each :LEN tag. | DEFTEXT= (DEFTEXT.LERSxxxx=), HRTAG= and SETUPTAG= |
| :LERSDEF. | I | Both with and without ID= attribute | |
| :LI. | I | Attributes supported: ID= | |
| :LIBRARY. | I | See also 5.6, "Recognizing and displaying the document's title". | TITLE= |
| :LINES. | I |
| LINES= and SETUPTAG= |
| :LIREF. | I | Attributes supported: FORM= and REFID= | LIREF= |
| :LITDATA | I | Attributes supported: NAME= | SETUPTAG= |
| :LP. | S | ||
| :LQ. | S | ||
| :MATCH. | I | Attributes supported:
ANSID=
See also 5.11, "Question and Answer tags" | |
| :MCDEF. | I | Both with and without ID= attribute | |
| :MD. | S | ||
| :MODULE. | I | DEFTEXT= (DEFTEXT.MCMODULE) | |
| :MSG. | I | ||
| :MSGL. | I | Attributes supported:
COMPACT,
DEST=,
MODULE=,
NUMBYTES=,
ORESP=,
PRESP=,
PROBD=,
REFID=
SCALE=
SEVERITY=,
SPRESP=,
STYLE=,
SYSACT=,
URESP= and
XPL=
STYLE=RULE causes the value specified for the HRTAG.4= option (normally a <HR>) to be inserted around each :MSG. block. | BORDERTAG=, DEFTEXT= (DEFTEXT.MCxxx), HRTAG= and SETUPTAG= |
| :MSGNO. | I | ||
| :MV. | S | ||
| :NOTE. | I | Attributes supported: TEXT= | DEFTEXT= (DEFTEXT.NOTE=) |
| :NOTEL. | I | Attributes supported: COMPACT and TEXT= | DEFTEXT= (DEFTEXT.NOTEL=), NOTELTAG= and SETUPTAG= |
| :NOTICES. | S | ||
| :NT. | I | Attributes supported: TEXT= | DEFTEXT= (DEFTEXT.NT=) and SETUPTAG= |
| :NUMBYTES. | I | DEFTEXT= (DEFTEXT.MCNUMBYTES) | |
| :OL. | I | Attributes supported: COMPACT | OLSEQ= 18, OLTAG= |
| :OPER. | I | Attributes supported: DEF, OPT and REQ | |
| :ORESP. | I | DEFTEXT= (DEFTEXT.MCORESP) | |
| :P. | S | ||
| :PARML. | S | Attributes supported: COMPACT.
Mapped to HTML's <DL> tag. | |
| :PARTNUM. | I | Displayed as part of the title page, since HTML has no "back cover" concept | |
| :PD. | S | Mapped to HTML's <DD> tag | |
| :PGMNUM | I | ||
| :PK. | I | Attributes supported: DEF | SETUPTAG= |
| :PREFACE. | I | Attributes supported: ID= | DEFTEXT= (DEFTEXT.PREFACE=) |
| :PRESP. | I |
| DEFTEXT= (DEFTEXT.MCPRESP) |
| :PROBD. | I | DEFTEXT= (DEFTEXT.MCPROBD) | |
| :PRTLOC. | I | Displayed as part of the title page, since HTML has no "back cover" concept | |
| :PSC. | I | Attributes supported:
OMIT=,
PROC= and
XPROC=
See additional comments in Chapter 6, "Caveats and restrictions (what's supported and what's not!)". | HTML= and PSC= |
| :PT. | S | Mapped to HTML's <DT> tag | |
| :PTOC. | I | Attributes supported:
LEVELS=
The tag is ignored if the MANUAL attribute is specified. | DEFTEXT= (DEFTEXT.PTOCxx=), PTOC= 18, SETUPTAG=, TOCC=, TOCINDENT=, TOCSUPPRESS= and TOCTAG= |
| :PV. | S | ||
| :Q. | S | ||
| :QITEM. | I | Attributes supported: ANS= | See also 5.11, "Question and Answer tags" |
| :QREF. | I | Attributes supported: FORM= and REFID= | |
| :QUALIF. | I | The width of the qualification header and trailer line is defined by the value of the LINEWIDTH= option. | LINEWIDTH= and SETUPTAG= |
| :QUESTION | I | Attributes supported:
DINGBAT=,
FORM= and
ID=
See also 5.11, "Question and Answer tags". | DEFTEXT= (DEFTEXT.QQREF=), QRESET= 18, QUESTION= and SETUPTAG= |
| :RELEASE. | I | ||
| :REPSEP. | I | Attributes supported: OPT and REQ | |
| :REV. | I | Attributes supported: REFID= | REVTAG= |
| :REVISION. | I | Attributes supported: CHAR=, ID= and RUN= | REVTAG= |
| :RK. | S | ||
| :ROW. | I | Attributes supported: REFID= and TEMP | |
| :SAFETY. | I | Attributes supported: ID= | DEFTEXT= (DEFTEXT.SAFETY=) |
| :SCHDATE. | I | Attributes supported: ACTHD=, CMTHD=, CMTSIZE=, LISTREF= and SCALE= | BORDERTAG= and SETUPTAG= |
| :SCHDEF. | I | Both with and without ID= attribute | |
| :SCHEDULE. | I | Attributes supported:
ACTHD=,
CMTHD=,
CMTSIZE=,
LISTREF= and
REFID=
Schedule tables are supported, but not schedule charts | DEFTEXT= (DEFTEXT.SCHEDACTHD=) |
| :SCHI. | I | Attributes supported: CMT= | |
| :SCRDEF. | I | Both with and without ID= attribute | |
| :SCREEN. | I | Attributes supported:
REFID=,
SCALE= and
WIDTH=
The width of the screen image is determined by the WIDTH= attribute, or, if omitted, the value of the LINEWIDTH= option. | LINEWIDTH=, SETUPTAG= and SHADE= 18 |
| :SEP. | I | Attributes supported: OPT and REQ | |
| :SEVERITY. | I | DEFTEXT= (DEFTEXT.MCSEVERITY) | |
| :SL. | I | Attributes supported: COMPACT | SLTAG= |
| :SOA. | I | Attributes supported: ID= | DEFTEXT= (DEFTEXT.SOA=) |
| :SPOT. | I | Attributes supported: ID= and XREFTEXT= | DEFTEXT= (DEFTEXT.SPOTx=) |
| :SPOTREF. | I | Attributes supported: FORM= and REFID= | |
| :SPRESP. | I | DEFTEXT= (DEFTEXT.MCSPRESP) | |
| :SUB. | S | ||
| :SUP. | S | ||
| :SYNDEF. | I | Both with and without ID= attribute | |
| :SYNNT. | I | Attributes supported: ID= and CALLOUT= | DEFTEXT= (DEFTEXT.SYNNT=) |
| :SYNNTREF. | I | Attributes supported: REFID= | |
| :SYNOPSIS. | S | ||
| :SYNTAX. | I | Attributes supported: REFID=, SCALE=, STYLE= and VIEW= | BORDERTAG=, DEFTEXT= (DEFTEXT._xxx=), HRTAG=, SETUPTAG= and SYNFONT= |
| :SYS. | I | ||
| :SYSACT. | I | DEFTEXT= (DEFTEXT.MCSYSACT) | |
| :TABDATA. | I | Attributes supported: ALIGN= (including fill-character), CHAR=, COLS=, REFID=, SCALE= and W1=, W2=, ... W9= | SETUPTAG= |
| :TABDDEF. | I | Both with and without ID= attribute | |
| :TABLE. | I | Attributes supported:
ALIGN=,
ARRANGE=,
COLS=,
CONCAT=,
CWIDTHS=,
FRAME=,
HP=,
ID=,
REFID=,
SCALE=,
SHADE=,
VALIGN= (if generating HTML 3 or higher) and
WIDTH=PAGE
Implementation is dependent on the HTML release being generated. If HTML=2, the width of the table is defined by the value of the LINEWIDTH= option. For more information, see 6.1, "Special information about tables". | BORDERTAG=, DEFTEXT= (DEFTEXT.TABLE), LINEWIDTH=, SETUPTAG=, SHADE=, and TABLE2= |
| :TCAP. | I | ||
| :TDEF. | I | Both with and without ID= attribute | |
| :TDESC. | I | ||
| :TFT. | I | Attributes supported: REFID= and TEMP | |
| :THD. | I | Attributes supported: REFID= and TEMP | |
| :TIPAGE. | I | SETUPTAG= | |
| :TITLE. | I | Attributes supported: STITLE=
See also 5.6, "Recognizing and displaying the document's title". | TITLE= |
| :TITLEP. | I | Attributes supported: STITLE=
See also 5.6, "Recognizing and displaying the document's title". | TITLE= |
| :TLINE. | S | ||
| :TLIST. | I | Attributes supported: ID= | DEFTEXT= (DEFTEXT.TLIST), FBC= 18, FTLINK=, FTSEP= 18, SETUPTAG=, TFIGLISTTAG= and TLIST= |
| :TNOTE. | I | Attributes supported: TEXT= | |
| :TOC. | I |
| DEFTEXT= (DEFTEXT.TOC), HRTAG=, SETUPTAG=, TOCC=, TOCINDENT=, TOCRET=, TOCSUPPRESS= and TOCTAG= |
| :TOPIC. | I | See also 5.6, "Recognizing and displaying the document's title". | TITLE= |
| :TP. | S | ||
| :TREF. | I | Attributes supported: FORM= and REFID= | |
| :UL. | I | Attributes supported: COMPACT | ULTAG= |
| :URESP. | I | DEFTEXT= (DEFTEXT.MCURESP) | |
| :USER. | I | ||
| :USERDOC. | I | Attributes supported: COPYR=, IBMCOPYR and SEC= | |
| :VAR. | I | Attributes supported: DEF, OPT and REQ | |
| :VENDOR. | I | Displayed as part of the title page, since HTML has no "back cover" concept | |
| :VERSION. | I | ||
| :VNHD. | S | ||
| :VNOTICE. | I | ||
| :VOLNUM. | I | DEFTEXT= (DEFTEXT.VOLNUM=) | |
| :WARNING. | S | ||
| :WARRANTY | I | Attributes supported: SUBJECT=, | |
| :XMP. | S | Attributes supported: REFID= and SCALE= | SETUPTAG= |
| :XMPDEF. | I | Both with and without ID= attribute | |
| :XPH. | S | ||
| :XPL. | I | DEFTEXT= (DEFTEXT.MCXPL) | |
Not applicable or not supported; will be ignored
:AUTOLIK., :CAUSE., :CC. :CI., :CIREF., :CLETTER., :CMT., :COMPANY., :COMPL., :COVER., :CT., :DC., :DF., :DFDEF., :F., :FIGSEG., :FLE., :FROM., :GRID., :GRIDAREA., :GRIDDEF., :GRIDSEG., :IBMX., :INIT., :IZIP., :LOC., :MAP., :MAPDEF., :MAPQFIX., :MARKDESC., :MARKLIST., :MARKNT., :MKACTION., :MKCLASS., :MKINDEX., :NAME., :NETID., :NITEM., :OVERART., :OVERLAY., :PARTSASM., :PC., :PHONE., :PNINDEX., :PROLOG., :QT., :REF., :RETKEY., :REVCW., :REVPF., :REVPP., :REVPT., :REVSLUG., :SCHNOTE., :SEP., :SIG., :SNOTICE., :ST., :STEP., :STEPREF., :SUBJECT., :TCE0., :TCE1., :TCE2., :TCE3., :TCE4., :TCE5., :TCE6., :TCE7., :TCE8., :TCE9., :TCE10., :TCE11., :TCE12., :TCE13., :TCE14., :TCE15., :TCE16., :TCE17., :TCE18., :TCE19., :TCE20., :TLE., :TO., :TPCODE.
In addition to the normal &symbols provided by Script/VS, GML
and BookMaster, B2H also provides a number of special-use
&symbols. These are most often used within header and footer
files and in conjunction with certain options, such as
SPLITLINK.x=
and COMMENT=.
| &symbol | 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 as specified by the HTML= option. Contains the number 2, 3 or 4. |
| &b2hhtmlid | The appropriate value of the HTMLDOCID= option for the HTML release being generated. |
| &b2hiall | The fully-qualified name of the input file
AIX: /path/subdir/hh1.h2.hhh3 CMS: fn ft fm LINUX: /path/subdir/hh1.h2.hhh3 MVS: userid.h1.h2.h3 userid.h1.h2.h3(member) OS/2: c:\dir\subdir\fname.ext WIN95: c:\dir\subdir\fname.ext WINNT: c:\dir\subdir\fname.ext UNIX: /path/subdir/hh1.h2.hhh3 |
| &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/ CMS: (Null string) LINUX: /path/subdir/ MVS: (Null string) OS/2: c:\dir\subdir\ WIN95: c:\dir\subdir\ WINNT: c:\dir\subdir\ UNIX: /path/subdir/ |
| &b2hifile | The non-path portion of the input file
AIX: hh1.h2.hhh3 CMS: fn ft LINUX: hh1.h2.hhh3 MVS: userid.h1.h2.h3 userid.h1.h2.h3(member) OS/2: fname.ext WIN95: fname.ext WINNT: fname.ext UNIX: hh1.h2.hhh3 |
| &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 CMS: fn ft fm LINUX: /path/subdir/hh1.h2.hhh3 MVS: userid.h1.h2.h3 OS/2: c:\dir\subdir\fname.ext WIN95: c:\dir\subdir\fname.ext WINNT: c:\dir\subdir\fname.ext UNIX: /path/subdir/hh1.h2.hhh3 |
| &b2holpath | The path of the logical output file (if appropriate)
AIX: /path/subdir/ CMS: (Null string) LINUX: /path/subdir/ MVS: (Null string) OS/2: c:\dir\subdir\ WIN95: c:\dir\subdir\ WINNT: c:\dir\subdir\ UNIX: /path/subdir/ |
| &b2holfile | The non-path portion of the logical output file
AIX: hh1.h2.hhh3 CMS: fn ft LINUX: hh1.h2.hhh3 MVS: userid.h1.h2.h3 OS/2: fname.ext WIN95: fname.ext WINNT: fname.ext UNIX: hh1.h2.hhh3 |
| &b2hopall | The fully-qualified name of the physical output file
AIX: /path/subdir/hh1.h2.hhh3 CMS: fn ft fm LINUX: /path/subdir/hh1.h2.hhh3 MVS: userid.h1.h2.h3 OS/2: c:\dir\subdir\fname.ext WIN95: c:\dir\subdir\fname.ext WINNT: c:\dir\subdir\fname.ext UNIX: /path/subdir/hh1.h2.hhh3 |
| &b2hoppath | The path of the physical output file (if appropriate)
AIX: /path/subdir/ CMS: (Null string) LINUX: /path/subdir/ MVS: (Null string) OS/2: c:\dir\subdir\ WIN95: c:\dir\subdir\ WINNT: c:\dir\subdir\ UNIX: /path/subdir/ |
| &b2hopfile | The non-path portion of the physical output file
AIX: hh1.h2.hhh3 CMS: fn ft LINUX: hh1.h2.hhh3 MVS: userid.h1.h2.h3 OS/2: fname.ext WIN95: fname.ext WINNT: fname.ext UNIX: hh1.h2.hhh3 |
| &b2hparttop | The applicable next/prev links for the top of an HTML output file. Normally referenced 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 SPLITLINK.1, SPLITLINK.3, SPLITLINK.5, SPLITLINK.11, SPLITLINK.13 or SPLITLINK.15, depending on the circumstances. |
| &b2hpartbot | The applicable next/prev links for the bottom of an HTML output file. Normally referenced 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 SPLITLINK.2, SPLITLINK.4, SPLITLINK.6, SPLITLINK.12, SPLITLINK.14 or SPLITLINK.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, CMS, HPFS, Linux, MVS, OS2, WIN95, WINNT, UNIX |
| &b2hplatd | The name of the destination platform, as specified by the DESTSYS= option |
| &b2hrevchar | Contains the revision character identifying the .rc control word 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) CMS: BY userid AT node LINUX: (Null string) MVS: BY userid AT node OS/2: (Null string) WIN95: (Null string) WINNT: (Null string) UNIX: (Null string) |
| Note: The following &symbols are specifically intended to be referenced within a SPLITLINK.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 |
| &b2hptoc | HTML file/label for the start of the most-recent Partial Table-of-Contents (PTOC). Equivalent to &b2htoc if no PTOC yet encountered. |
| &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 |
During a conversion, B2H generates many messages relative to the conversion. The QUIET and NOISY options specify if the messages are displayed on the console and the LOG= option specifies if the messages are written to a disk file. Whether the message numbers are included with the message is specified by the MSGNUM= option (MSGNUM=YES is the default).
If a message refers to a specific record in a source file, two additional lines are also displayed. For example (assuming MSGNUM=YES):
B2H455 WARNING: No tag-ending period found <-- message B2H455 WARNING: :li this is item one <-- source line B2H455 WARNING: (in line 351 of projdoc.script) <-- source line location
| B2H100 | CurrSys=sys, DestSys=sys, Input=file |
| B2H101 | PhysicalOut=file, LogicalOut=file |
| B2H102 | PhysicalOut=file, file2, ... |
| B2H103 | LogicalOut=file, file2, ... |
| B2H104 | Beginning pass x of y (description) |
| B2H105 | Conversion started: yyyy-mm-dd hh:mm:ss |
| B2H106 | Conversion completed in nn.nn seconds |
| B2H107 | Highest RC=rc |
| B2H108 | Setting options using text |
| B2H109 | Setting symbol table entry using text |
| B2H112 | Tracing: routine routine2 ... |
| B2H114 | Generating the index ... |
| B2H115 | INDEX requested, but :INDEX tag not found! |
| B2H118 | SPLITDIGITS=num too small, dynamically increasing to SPLITDIGITS=num |
| B2H120 | value is an unknown AUTOSPLIT option! |
| B2H121 | value not an ascending range for option |
| B2H122 | SYSVAR 'A' value not YES or NO! |
| B2H123 | option is an unknown option |
| B2H124 | option option can not be set from within a source file unless prior to the first non-comment record of the main input file (file)! |
| B2H125 | value is an invalid value for option |
| B2H126 | option not available when HTML=2 |
| B2H128 | Output stream "x" not defined for LOG=STREAMx |
| B2H151 | Unknown symbol table record |
| B2H152 | Unknown symbol table statement |
| B2H160 | Loading file ... |
| B2H161 | file(recno): record |
| B2H162 | Debug data: text |
| B2H200 | Environment type env unknown! |
| B2H300 | file not found! |
| B2H301 | Unable to create file |
| B2H302 | Reading file ... |
| B2H303 | ..Imbedding file ... |
| B2H304 | num lines read from file |
| B2H306 | num lines written to file |
| B2H310 | ..Reading line num from file ... |
| B2H312 | Adding lines from file |
| B2H313 | desc DD=ddname not allocated and unable to locate DSN=dataset-name |
| B2H314 | DD ddname not allocated |
| B2H315 | DD ddname not DSORG={PS|PO} |
| B2H316 | Member member not found in dataset(s) allocated to DD ddname |
| B2H317 | RC=rc optdesc writing to dataset RECORD=record |
| B2H318 | RC=rc allocating DD=ddname Command=alloc-cmd |
| B2H401 | Not a valid SCRIPT/VS control word |
| B2H403 | tag not a valid BookMaster/GML tag |
| B2H411 | tag (in record num of file) never ended |
| B2H412 | Missing :ETITLE. or :ETITLEP. tag! |
| B2H413 | tag found outside of a tag-group |
| B2H414 | tag out of sequence |
| B2H415 | tag already in effect |
| B2H416 | No tag outstanding! |
| B2H417 | :SCHEDULE LISTID=id not defined prior to :SCHDATE |
| B2H418 | Out-of-sequence .CONFIG |
| B2H431 | Number of columns not specified! Assuming COLS='*'. |
| B2H432 | Out-of-sequence table cell detected |
| B2H433 | Out-of-sequence ARRANGE cell layout detected |
| B2H434 | tag not supported in a table |
| B2H440 | Reference not found, following ignored: tag |
| B2H451 | Invalid "control-word" condition |
| B2H452 | Invalid or missing category! |
| B2H453 | Invalid syntax in tag |
| B2H454 | Invalid arithmetic expression! .SE string Expression resolves to: expression |
| B2H455 | No tag-ending period found |
| B2H456 | Syntax error detected in the following: tag string |
| B2H457 | xx is an invalid hex value. |
| B2H458 | type is an invalid GMLTYPE value. |
| B2H459 | "Backward GoTo" not supported |
| B2H460 | Label "label" not found! |
| B2H461 | DD "ddname" not pre-allocated! |
| B2H462 | Conflicting attributes! |
| B2H463 | Syntax note reference not defined |
| B2H481 | +++code message |
| B2H482 | data |
| B2H483 | message |
| B2H484 | Text for tag being bypassed! |
| B2H485 | markup has no HTML equivalent! |
For detailed release information, including fixes, see the
B2H NEWS file included with the B2H package.
New or enhanced support of BookMaster/GML/Script markup:
B2H-specific updates:
New or updated B2H options:
(For information on all B2H options, see 8.2, "Available B2H Options")
Updates to the User's Guide:
System profile updates:
System symbol table updates:
E.1 Updates for B2H Release 4.7
HTMLATT.tagname='text' (more tagname values)
New or enhanced support of BookMaster/GML/Script markup:
B2H-specific updates:
New or updated B2H options: (For information on all B2H options, see 8.2, "Available B2H Options")
BORDERTAG='tag' (new option) BORDERTAG.x='tag' (new option) HRTAG.x='tag' (HRTAG.4 now used)
Updates to the User's Guide:
System profile updates:
System symbol table updates:
New or enhanced support of BookMaster/GML/Script markup:
B2H-specific updates:
New or updated B2H options: (For information on all B2H options, see 8.2, "Available B2H Options")
DEFTEXT.name='text' (new names)
FONTTAG='fonttext,efonttext,[PROP|NOPROP]' (new option)
H3ADDONS={ NO | YES } (removed - obsolete)
H3TABLE={ COMPLEX | SIMPLE } (removed - obsolete)
INDEXREFLINK={ NO | YES } (new option)
LINENUM={ NO | BEGIN | END | scol-ecol } (new option)
PROCACT='...' (additional operand)
Updates to the User's Guide:
System profile updates:
System symbol table updates:
New or enhanced support of BookMaster/GML/Script markup:
B2H-specific updates:
New or updated B2H options: (For information on all B2H options, see 8.2, "Available B2H Options")
Updates to the User's Guide:
System profile updates:
System symbol table updates:
New or enhanced support of BookMaster/GML/Script markup:
B2H-specific updates:
New or updated B2H options: (For information on all B2H options, see 8.2, "Available B2H Options")
Updates to the User's Guide:
System profile updates:
System symbol table updates:
New or enhanced support of BookMaster/GML/Script markup:
B2H-specific updates:
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML xxx//EN">
The new &b2hhtmlid symbol is defined to contain the appropriate value of this option for the HTML release being generated.
New or updated B2H options: (For information on all B2H options, see 8.2, "Available B2H Options")
APPHD1='text' (new option)
APPHD1X='text' (new option)
AUTOSPLIT= ... (was "AUTOPART=")
DEFTEXT.name='text' (additional names)
DEFTEXT.name='text',[width] (new operand)
DIALOG='[LABEL] [FONT] [COLOR]' (new option)
DIALOGTAG.x='ts,te,fs,fe,cs,cs' (new option)
FNTAG='cs,ce,ls,le,lcs,lce,lts,lte,ts,te' (new option)
HEADREC.num='text' (new option)
HRTAG='text' (no "x" required)
HRTAG.x='text' (new "x" values)
HTAG='hs,he,ss,sr' (new option)
HTAG.num='hs,he,ss,sr' (new option)
HTML={ 2 | 3 | 4 } (new operand)
HTMLDOCID.htmlrel='text' (new option)
REVTAG='revtext,erevtext,[PROP|NOPROP]' (new operand)
SETUPTAG.tagname='beforetext','aftertext' (new option)
SPLITDIGITS= ... (was "PARTDIGITS=")
SPLITDIR= ... (was "PARTDIR=")
SPLITDIR.NEXT= ... (new operand)
SPLITLINK= ... (was "PARTLINK=")
SPLITLINK.x= ... (was "PARTLINK.x=")
SPLITNAME.x= ... (was "PARTNAME.x=")
SPLITNAME.NEXT= ... (new operand)
TOCTAG='ls,le,ie,ie,ts,te' (new operands)
Updates to the User's Guide:
System profile updates:
System symbol table updates:
New or enhanced support of BookMaster/GML/Script markup:
B2H-specific updates:
New or updated B2H options: (For information on all B2H options, see 8.2, "Available B2H Options")
DESTSYS={AIX|HPFS|LINUX|MVS|OS2|VM|WIN95|WINNT} (new operand)
LIREF={ NO | ID | ACTUAL } (new operand)
OLSEQ='sequence codes' (new option)
Updates to the User's Guide:
System profile updates:
System symbol table updates:
New or enhanced support of BookMaster/GML/Script markup:
B2H-specific updates:
New or updated B2H options: (For information on all B2H options, see 8.2, "Available B2H Options")
B2HREQ={ YES | NO } (new default)
CHARSET='coded-character-set-name'
DEFTEXT.name='text' (new names) (R4.0 & R4.01)
DESTSYS=VM (new default for VM/CMS)
HRTAG.x='tag' (new operand) (R4.01)
HTMLEXT=html (new default for VM/CMS)
HTMPEXT=HTML (new default for VM/CMS)
MVSALLOC.name='ALLOC-command-operands'
OUTPUTP=physical-output-file (new operands for MVS) (R4.01)
PROCACT='NOINDEX=action ...' (new situation)
SYNFONT={ YES | NO } (R4.02)
Updates to the User's Guide:
System profile updates:
System symbol table updates:
ALLOC FI(B2HPRO) DA(system-profile-dataset) SHR REUSE ALLOC FI(B2HSYM) DA(system-symbol-table-dataset) SHR REUSE ALLOC FI(B2HHELP) DA(system-helpfile-dataset) SHR REUSE
ALLOC FI(B2HPRO) DA(system-profile-dataset) SHR REUSE ALLOC FI(B2HSYM) DA(system-symbol-table-dataset) SHR REUSE