[Search for users]
[Overall Top Noters]
[List of all Conferences]
[Download this site]
| Title: | DOCUMENT T1.0 |
| Notice: | **New notesfile (DOCUMENT.NOTE) now available (see note 897)** |
| Moderator: | CLOSET::ADLER |
|
| Created: | Mon Feb 09 1987 |
| Last Modified: | Thu Oct 31 1991 |
| Last Successful Update: | Fri Jun 06 1997 |
| Number of topics: | 897 |
| Total number of notes: | 4397 |
42.0. "VAX DOCUMENT T1.0 Release Notes" by VAXUUM::OTTE () Mon Mar 02 1987 11:05
The following are the release notes for version T1.0 (Field Test) of
VAX DOCUMENT. Please read these notes before sending in either
documentation or software bug reports--it'll save a lot of typing
for all of us.
-Randy Otte VAX DOCUMENT Writer.
Note: The following file is placed on your system when DOCUMENT
T1.0 is installed as SYS$HELP:doc010.release_notes and also as
a HELP topic:
$ HELP DOCUMENT RELEASE NOTES
**********************************************************************
VAX DOCUMENT
Version T1.0 (Field Test) Release Notes
9-January-1987
This document contains the following.
o A list of all software and documentation items not
supplied for Field Test that will be present for
the Field Test Update.
o A list of all known software and documentation
errors.
1 Items not available for Field Test.
The following items are not available for Field Test
but will be provided for the Field Test Update.
1. The /LIST qualifier to the DOCUMENT commmand is not
implemented.
2. The /MASTER_INDEX qualifier to the DOCUMENT
commmand is not implemented.
3. The /KEEP qualifier is not fully implemented. By
default, the following files are kept:
.DVI_device, .LIS, .TEX
The following files are not kept:
.INX, .BRN, .INT_TEX
/KEEP=INT_TEX does not work.
Note: because DOCUMENT creates a number of
intermediate files during processing, users should
purge directories in which they do DOCUMENT work
frequently.
4. The CATALOG doctype and its tags are not
implemented.
5. The global <MARK_DELETION> tag is not implemented.
6. Support for the DEC Multinational Character Set for
all devices is not yet complete. Specifically, the
following are not yet supported:
o Accented multinational characters are not
converted to uppercase in text strings that are
automatically uppercased.
o The indexing software does not recognize
multinational characters in in index strings.
The strings will be converted to blanks.
o The monospaced fonts for code examples do not
contain the multinational characters.
VAX DOCUMENT Version T1.0 Release Notes 1
7. The LN03 laser printer does not have 30-point sans
serif (TRIUMVIRATE) fonts. These fonts will be
added for the FT update.
In addition, the publishing characters (bullet,
dagger, double dagger, en dash, em dash, trademark,
triangle, and registered mark) for most point sizes
are approximations of the correct point sizes.
8. The VAX DOCUMENT Users Guide Part 1 does not
contain the following for Field Test:
o Chapter 1, Introduction to VAX DOCUMENT
o Chapter 10, Creating the Front matter and Back
matter of a Book
o Chapter 11, Conditionalizing Text to Create
Alternate Ouput
o Chapter 12, Using Special Text Features
9. The VAX DOCUMENT Users Guide Part 2 does not
contain the following for Field Test:
o Chapter 3, Using the CATALOG Doctype
o Chapter 11, CATALOG Doctype Tag Reference
o Index for the VAX DOCUMENT Users Guide Part 2.
10.The VAX DOCUMENT Design Samples Manual does not
contain the following for Field Test:
o Chapter 3, The CATALOG Doctype
2 VAX DOCUMENT Version T1.0 Release Notes
2 Known Problems to be Corrected for Field Test Update
2.1 Software Bugs and Restrictions
These bugs will be fixed for the Field Test Update.
1. The use of the <INDEX_FILE> tag results in an extra
blank page of output at the end of the file. Note
that this occurs in the installation verification
procedure (IVP) test file.
2. In certain circumstances, DOCUMENT fails during
text formatting when the text formatter's memory
capacity is exceeded. This generally happens
in very large files that contain a large number
of full-page figures AND fairly long, multipage
tables.
3. If the text formatter fails to open an input file,
the DOCUMENT message displayed does not correctly
show the name of the file that cannot be opened.
If this error occurs, you can determine the name
of the file that caused the error by examining the
.LIS file.
4. If there are errors during the text formatting
phase, the intermediate output file is named .DVI,
and does not reflect the final output destination
of the file.
5. When either the DOCUMENT command /CONTENTS or
/INDEX qualifier is used, DOCUMENT processes these
files to create only a .TEX file; a final printable
file is not produced. To create these final files
you should use the following commands:
$ DOCUMENT/NOTAG filename_CONTENTS.TEX doctype destination
$ DOCUMENT/NOTAG filename_INDEX.TEX doctype destination
These commands will complete the processing for
your individual index or table of contents files.
VAX DOCUMENT Version T1.0 Release Notes 3
To completely process a file that contains the
<CONTENTS_FILE> and <INDEX_FILE> tags, you can use
the following commands:
$ DOCUMENT/NODEV/CONTENTS/INDEX filename doctype destination
$ DOCUMENT/NOTAG/NODEV filename_CONTENTS doctype destination
$ DOCUMENT/NOTAG/NODEV filename_INDEX doctype destination
$ DOCUMENT/NOTAG/NOTEXT filename doctype destination
6. When an index is generated using the DOCUMENT
command /INDEX qualilfier, any character-string
page prefixes of more than five characters will
be truncated to five characters in any index page
references.
7. General notes and restrictions on using the LN03
destination.
o Large documents that use many different
characters and many different fonts may fail
in one of several ways:
- the device converter may terminate, reporting
"too many fonts" or "too many glyphs."
- the LN03 may report controller error "3" if
there are too many fonts.
- the LN03 may report controller error "4" if
there is too much font information to fit in
the RAM cartridges mounted.
The general workaround is to divide the document
into smaller chunks. If the LN03 controller
errors occur and the printer does NOT contain
both RAM cartridges, the user may get around the
problem by inserting those cartridges.
4 VAX DOCUMENT Version T1.0 Release Notes
When these LN03 controller errors occur, the
user will generally receive printed output,
but those characters whose font data could not
be loaded will generally be replaced by other
characters in other fonts.
o The LN03 device converter does not yet recognize
non-numeric arguments for chapter and page
number. These command-line parameters could
be provided for the starting and ending page
numbers. This means the user cannot request,
for example, "Glossary-7" or "Part2-19". These
workarounds are available:
- Convert the whole document.
- For starting page: specify some preceding
page whose chapter and page numbers are
numeric, or do not provide starting page
number at all (to start at the beginning).
- For ending page: specify some following page
whose chapter and page numbers are numeric,
or specify "number of pages" instead of
ending page number, or don't provide ending
page number at all (to go to the end).
o The printed document is followed by a blank
page. The user may want to put these blank pages
back in the printer input tray.
o The largest page size currently supported is 8.5
inches by 11 inches.
8. General notes and restrictions on using the
POSTSCRIPT destination.
o The DEC Multinational Character Set is not
currently supported.
VAX DOCUMENT Version T1.0 Release Notes 5
o The CONTENTS_FILE and INDEX_FILE tags, which
are used to include separate contents and index
files into the same output file as the body
of the document, may process through earlier
components but will produce the "unrecognized
option" error within the device converter.
o The largest page size currently supported is 8.5
inches by 11 inches.
9. General notes and restrictions on using the LINE_
PRINTER, MAIL, and TERMINAL destinations:
o Revision bars are not yet supported.
o The CONTENTS_FILE and INDEX_FILE tags, which
are used to include separate contents and index
files into the same output file as the body
of the document, may process through earlier
components but will produce the "unrecognized
option" error within the device converter.
o The largest page size currently supported is 8.5
inches by 11 inches.
10.When a <PART_PAGE> tag follows a <CHAPTER> tag
in a source file and when the <PART_PAGE> is not
followed with one of the following:
- Chapter
- Appendix
- Software reference section with explicit
pagination
The indexing software will generate warning
messages about character string prefixes. The page
numbers in the index output file will be prefixed
with the number of the chapter preceding the part
page.
6 VAX DOCUMENT Version T1.0 Release Notes
11.SDMLLSE is not defined as a command symbol for
entering the LSEDIT environment. DOCUMENT users
access LSEDIT with the SDML environment using the
following command:
$ LSEDIT filename.GNC
The GNC extension is required to access the SDML
environment. To compile an SDML file from within
LSEDIT, use the following command:
COMPILE/REVIEW $ doctype destination
The dollar sign ($) indicates that the currently
displayed buffer should be processed through the
tag translator. If there are errors, the /REVIEW
qualifier causes SDMLLSE to split the screen and
display the errors in one window and the source
file in the other window.
The GOTO SOURCE command is not currently working to
move between the errors and the source file.
The CHANGE WINDOW command can be used to move
between the two windows as usual.
12.When a <P> tag follows a <SUBHEAD2> tag, the
text of the first word of the paragraph should
immediately follow the <P> tag. If there are
intervening spaces or carriage returns, an extra
blank space will appear before the paragraph text.
For example:
<SUBHEAD2>(Testing)
<P>
This text has extra whitespace before it.
<SUBHEAD2>(Testing)
<P>This text has no extra whitespace before it.
This coding might produce the following:
VAX DOCUMENT Version T1.0 Release Notes 7
Testing: This text has extra whitespace before it.
Testing: This text has no extra whitespace before it.
13.When searching for local or personal doctype
definition files (DOC$DESIGNS.DAT), DOCUMENT
determines whether there are local or personal
doctypes based on the current definition of
DOC$LOCAL_FORMATS or DOC$PERSONAL_FORMATS. These
logical names, if defined, must be defined as
process logical names. This restriction will be
removed.
14.Tag names entered within the context of the
<LITERAL> and <ENDLITERAL> tags are converted to
uppercase in the output file. For example,
<LITERAL> this is a <tagname> in literal text <ENDLITERAL>
produces:
this is a <TAGNAME> in literal text
The form:
<LITERAL>(this is a <TAGNAME> in literal text)
will produce the correct result.
2.2 Documentation Errors
These errors will be corrected for the Field Test
Update.
1. VAX DOCUMENT User's Guide Part 1
o Page 2-3.
The keyword GENERAL.TWOCOLS should be changed
to GENERAL.TWOCOL (no "s"). The keyword MIL_SPEC
should be changed to MILSPEC (no "_").
o Page 8-7.
8 VAX DOCUMENT Version T1.0 Release Notes
In Section 8.5.1 the following is given as a
code fragment:
<DEFINE_SYMBOL>(pug_date)
This code fragment should read:
<DEFINE_SYMBOL>(pug_date\Sept 18, 1954)
o Page 2-5.
The second interactive example at the bottom of
the page omits a doctype keyword. This example
should read:
$ DOCUMENT somefile GENERAL /BATCH=(AFTER=09:00,NOTIFY) LN03
Also, the last paragraph on that page should
have appended to it the following:
"The LOG file is automatically printed and then
deleted from your directory, so you do not
normally see it in the directory. If you want
to keep it to view it online, you must add the
/BATCH=(KEEP) qualifier to the command line.
If you want to keep the log file and not have
it printed automatically, you must use the
/BATCH=(KEEP,NOPRINT) qualifier."
o Page 6-4, 6-5.
The problem discussed in Section 6.2.4 applies
only to formal figures and examples which are
coded with the FLOAT argument. Tables do not
float. Section 6.2.4 should be replaced by the
following:
6.2.4 POSSIBLE PROBLEM WITH FLOATING EXAMPLES OR
FIGURES
VAX DOCUMENT Version T1.0 Release Notes 9
"Formal figures or examples when coded with
the FLOAT argument to the <FIGURE_ATTRIBUTE> or
<EXAMPLE_ATTRIBUTE> tags may be automatically
placed out of sequence in some rare occurences.
This problem occurs only when many examples or
figures are coded near each other in the source
file. If this problem occurs, try coding one
or more of them using the KEEP argument. This
should alleviate the problem."
The examples on Page 6-5 should be deleted.
o Page 7-2.
In the third element of the first bulleted
list "A symbol-value," the sentence fragment
"for text elements that have numeric-values
associated with them..." should be changed to:
"for text elements that have numeric or letter
values associated with them..."
o Page 7-4.
In Section 7.5.1 the second code fragment is
given as:
Chapter 4 Running the Program
This code would not be generated unless you
specified TEXT as a second argument to the
<REFERENCE> tag.
o Page 7-3.
The first bulleted list in Section 7.4 should
not include the <SECTION> tag. A Section of a
book is not considered a book element.
o Page 7-5, Table 7-1.
Delete SECTION from the list of Book Elements.
10 VAX DOCUMENT Version T1.0 Release Notes
o Page 7-6.
In Section 7.6, list item 2 states that you
should use the <BEGIN_PROFILE> and <END_PROFILE>
tags to construct a profile. <BEGIN_PROFILE>
should be changed to <PROFILE>, and <END_
PROFILE> should be changed to <ENDPROFILE>.
These tags are correctly shown on page 8-2.
o The description of the global <PREFACE> tag has
been inadvertantly omitted from Chapter 13 of
the User'S Guide, Part 1. This will be added for
the FT update. The following is a summary of the
use of this tag.
The <PREFACE> tag labels the beginning of a
book's preface. The format of the tag follows:
<PREFACE>(page-number\OPTIONAL)
where "page-number" is the page number on which
you wish the preface to begin. If you do not
specify a number, the default page on which to
begin the preface is Roman numeral five. The
page-number can be either a positive or negative
value.
This tag must be used in the context of a
<FRONT_MATTER> tag. The <PREFACE> tag requires
the terminating tag <ENDPREFACE>.
o Page 13-40.
In the example shown, the second line of the
example should read:
<DEFINITION_LIST_HEAD>(International Associations)
And not:
<SUBHEAD1>(International Associations).
o Page 13-51.
VAX DOCUMENT Version T1.0 Release Notes 11
The argument SMALL_BOLDCAPS listed under the
heading "arguments" should be changed to SMALL_
BOLD_CAPS as in the format statement for this
tag.
o Page 13-78.
In the description of the <FIGURE_FILE> tag, the
file-spec argument to the tag <FIGURE_FILE> may
be specified using the keyword SPACE when a file
may be processed for different output devices
and there is no graphic file for a given device.
For example:
<FIGURE>
<FIGURE_FILE>(LN03\DOC$TEST_FILES:SANTA.SIX\15)
<FIGURE_FILE>(LINE_PRINTER\SPACE\15\no line printer)
<FIGURE_FILE>(POSTSCRIPT\SPACE\15\no PostScript Graphic)
<ENDFIGURE>
This example illustrates the correct way to
specify that blank space should appear when
the file is processed using the LINE_PRINTER
or POSTSCRIPT destinations. The figure graphic
is included only when the output destination is
LN03.
o Page 13-94.
Under the heading "required terminator," the
word "None" should be replaced by "<ENDFRONT_
MATTER>."
o Page 13-169.
Item 5 should be deleted. The <ENDPART_PAGE>
tag always forces the text that follows to a new
page of output. Note that <ENDPART_PAGE> takes
an optional argument, RENUMBER, which indicates
that page numbering should be restarted at 1,
with the part page itself numbered 1. The first
page of text following the part page will be
numbered 3.
12 VAX DOCUMENT Version T1.0 Release Notes
o Page 13-221.
Under the heading "Examples" it says to see
the examples for the <FRONT_MATTER> tag. There
are no examples shown in the discussion of the
<FRONT_MATTER> tag.
2. VAX DOCUMENT User's Guide Part 2
o Page 7-1.
The second paragraph should note that the
MILSPEC doctype does not allow the use of part
pages.
o Page 16-106.
The description of the <SUBCOMMAND_SECTION_HEAD>
tag should be as follows:
- Under the heading "related tags," the tag
<SUBCOMMAND_SECTION_HEAD_HEAD> should be
deleted.
- Under the heading "restrictions," the text
should read:
This tag is valid only within the context of
the <SUBCOMMAND_SECTION> tag.
- Under the heading "required terminator,"
the tag <ENDSUBCOMMAND_SECTION_HEAD> should
be replaced with "None." since there is no
required terminator,
3. VAX DOCUMENT Design Samples
o Page 6-3.
The doctype keyword POCKET_REF given in the
informal table should be POCKET_REFERENCE.
o Chapter 13.
VAX DOCUMENT Version T1.0 Release Notes 13
The keyword MIL_SPEC as given as a valid doctype
and doctype keyword, this doctype keyword should
be MILSPEC.
4. VAX DOCUMENT Administrator's Guide
o Entire manual.
The field test copies of this book are reduced
by 10% when they are produced. This causes
the actual measured dimensions of the output
samples to be 90% of the dimensions stated in
the manual. For example, if a vertical space
is specified as 10 points, the space shown is
actually .90(10) or 9 points.
o Page 4-4.
The MANUAL doctype should be given as the
GENERAL doctype.
o Page 4-5.
The word MANUAL should be replaced with GENERAL.
o Page Parameters-59.
\codexamplefont{font-environment} should be
\def\codexamplefont{font-environment}
precodexamplevskip=dimension should be
\precodexamplevskip=dimension
o Tables B-1 (pages B-1 - B-4), B-2 (pages B-5 -
B-8), and C-4 (pages C-4 - C-15).
The data in these tables is not complete.
14 VAX DOCUMENT Version T1.0 Release Notes
| T.R | Title | User | Personal
Name | Date | Lines
|
|---|