Conference vaxuum::online_bookbuilding

17.0. "Alternate version of ONLINE_CLEANUP" by CHUCKM::MURRAY (Chuck Murray) Wed Oct 12 1988 18:06

I tested the version of ONLINE_CLEANUP.COM mentioned in 16.0.  A few
observations:

1. It requires that VAX BLISS be installed on your system. (The 
procedure creates a BLISS source file, compiles and links it, 
uses the executable image to process the files in the profile you
specify, then deletes the BLISS source file.) The documentation group's 
REORG cluster at TTB doesn't have BLISS installed.  (I tested it on the 
Rdb/VMS development group's NOVA/BANZAI cluster.)

2. The log file created when I tested it seemed incomplete (or at least 
not very informative).
(The log file is supposed to tell you what the procedure did and what
further corrections or modifications you need to make. My procedure does
this in a .DAT file.)

3. The procedure does not correctly handle a common error resulting from 
the behavior of the Runoff (DSR) to SDML converter program used by the
Graphic Services group and probably by some other groups as well.
The DSR-to-SDML converter globally added <P> tags at the end of various 
<END...> tags. For example:

     <ENDLIST><P>
     <ENDNOTE><P>
     <ENDFIGURE><P>

Now, if what follows the <P> tag in these cases is a paragraph of text,
then the <P> is proper. However, if almost any other tag follows -- and
things like <HEADn>, <NOTE>, etc. often do -- then the <P> is improper
and should be flagged as such. The procedure does not include these improper 
uses as erroneous uses of <P>.

4. The procedure adds four forms of the <figure_file> tag when none
appears [this is good]; however, if there are one or more <figure_file>
tags already present, it doesn't add one for the VOILA destination
[necessary for online use].


I've modified the original "all-DCL" version (i.e., no BLISS program
involved). I'm indebted to John Georges and Vinnie Russo for their work
in writing and testing the "all-DCL" original version. My version is 
*much* slower than the BLISS approach (say, 30-60+ minutes, versus a 
minute or so for the BLISS approach). However, since "cleanup" for online 
is a one-shot process for a book, I didn't regard fast performance as 
a big deal.

My version:

	- doesn't require BLISS or any other compiler. However, you could work
          around this by running the BLISS-version .COM file on a system
          that has BLISS, copy the .EXE file to your directory, then
          run the ONLINE_CLEANUP mentioned in 16.0 specifying anything
          for the third parameter: for example --
               @ONLINE_CLEANUP 1234PRO.SDML [SMITH.REF] BLAH

 	- creates an output file with the file type .DAT containing
          information you need to know (example: processing 9999PRO.SDML
          produces ONLINE_CLEANUP_9999PRO.DAT)

        - correctly handles the cases where <P> tags follow <END...> tags
          on the same line

        - correctly handles <P> tags immediately following <HEADn> tags on 
          the same line: for example, <head2>(Creating Foobars)<p>
          (These instances are another result of the DSR-to_SDML converter
          program. I don't know whether the BLISS version handles these.)

        - adds the line "<figure_file>(VOILA\xxxxxx\nn)" after each
          <figure> tag. (You then have to do the right thing in terms
          of number of tags, ZK art numbers, figure space, etc.)

A version of my procedure is in REORG::USER2:[MURRAY]ONLINE_CLEANUP.COM.
Copy it to your directory. The format for invoking it is:
          
        $ @ONLINE_CLEANUP profile-name.SDML directory-name
     or $ SUBMIT/NOLOG/PARAM=(profile_name.SDML,directory-name) ONLINE_CLEANUP

The .SDML is required on the profile name. The directory-name refers to 
where the .SDML files for the manual reside. You must have the profile and
all the files specified in <ELEMENT> tags in the directory specified.
(My procedure does not check files specified with <INCLUDE> tags; I
don't know if the version mentioned in 16.0 does.)
*** Read the comments at the start of my ONLINE_CLEANUP.COM file for more
information before running it. ***

Incidentally, all versions/flavors of the procedure assume you've been 
pretty sensible in your SDML coding -- e.g., they often assume tags start 
in the first position on the line. If you've been doing syntactically legal 
but wacky stuff like the following, you can probably forget about using 
any procedure:

and that's all. <head2>(Next Topic)<p> Now for something
else: <list>(unnumbered)
<le>Bullet one
<le>Bullet two
              <endlist><p><note>Pay special attention to 
this.
 <endnote>

    I tried to copy the command file, but got a protection error message.
    Is the ONLINE_CLEANUP.COM still available?
    
    Thanks

Re: < Note 17.1 by DEMON::CARRIG >

I just checked the protections on the file and the directory, and
made a minor change. I think the file should have been readable
(copyable, etc.) before; and if it wasn't, it should be now.