SGML: Contents of Readme.doc file

Article ID: Q184658

The information in this article applies to:
  • Microsoft SGML Author for Word, versions 1.1, 1.2 on the following platforms: NT, Win95

SUMMARY

This article contains the contents of the Readme.doc file supplied with SGML Author 1.2 and 1.1 for Word. The Readme.doc is a Word document file that has supplemental information about installing and using SGML Author.

MORE INFORMATION

Microsoft SGML Author for Word Readme Contents

This Readme file contains the following topics:

  • Creating Your Declaration (DCL) File
  • Skeleton DTD
  • Locating Entity References
  • Answers to Common Questions
  • Creating Associations to the Root Element in the DTD
  • Files Installed by Setup

Creating Your Declaration (.DCL) File

Before you can start a new association file in SGML Author you must create a declaration file (.dcl). The declaration file contains your SGML declaration as well as the DOCTYPE declaration for your particular DTD. In your DOCTYPE statement in the .dcl file, you must reference the file that includes your Document Type Definition (DTD).

Included in your package are two example DCL/DTD pairs, Sample.dcl/Sample.dtd and Skeleton.dcl/Skeleton.dtd. The Sample.* pair uses the reference concrete syntax, while the Skeleton.* pair uses a variant syntax with NAMELEN set to 32. For more information about .dcl and .dtd files, see Chapter 3, "Overview of Creating Association Files" in the Microsoft SGML Author System Administrator's Guide, or see SGML Author online Help.

Skeleton DTD

Skeleton.dtd is an example of the most efficient way to write DTDs that model common structures in Word. The skeleton files (Skeleton.dtd and Skeleton.dcl) model:

  • Tables
  • Equations
  • Graphics
  • Characters above ANSI 127
  • ISO publishing characters
  • Declaration of a variant syntax

They are designed to be the starting point for any DTD you construct to work with SGML Author. We recommend that you start with Skeleton.dtd and delete any elements that you do not use (e.g. ISO equations), then expand the DTD by adding the content models that fit your particular application. For more information about Skeleton.dtd, see Appendix B of the Microsoft SGML Author System Administrator's Guide.

Locating Entity References

SGML Author supports translation of PUBLIC or PRIVATE entity references to SYSTEM references via the standard mechanism approved by SGML Open. Setup installs an "entity catalog" (Entm.cat) in your \Sgmlconv directory. This file tells the parser where on your system to find external entities referenced by the PUBLIC or PRIVATE keyword. For more information about the entity catalog, see Appendix B of the Microsoft SGML Author System Administrator's Guide.

When you start a new association file, the software parses your DTD before loading it into SGML Author. If the parser cannot find your entity references, an error message appears and the DTD is not loaded. This situation might occur for several reasons.

   Problem                                Solution
   ---------------------------------------------------------------------

   The entity catalog (Entm.cat)          Add the external entity
   doesn't include references to          references to Entm.cat.
   the external files.

   The external files are not             Correct the path in the
   located on the path specified          Entm.cat file, or move the
   in the entity catalog                  external files to the path
                                          specified.

   The parser cannot locate the           Open the Mstxtcnv.ini file,
   entity catalog itself.                 located in the Windows
                                          directory. Make sure that the
                                          "Entity Catalog" variable in
                                          the[SGML Author] section
                                          specifies the correct path to
                                          the Entm.cat file.

   The SYSTEM identifiers                 Correct the SYSTEM identifiers
   specify the wrong path for             in the Entm.cat file.
   the external files.

   The PUBLIC identifiers may             Check the spelling and syntax
   not match the reference in             of the PUBLIC identifiers in
   the DTD.                               the Entm.cat file. They must
                                          be a perfect case sensitive
                                          match.

NOTE: It is not required that you use the entity catalog to specify the location of entities. SGML Author can resolve SYSTEM identifiers directly from the DTD. However, to keep your files as portable as possible, we recommend that you put the SYSTEM identifiers in the Entm.cat file.

Answers to Common Questions

Following are the most common questions asked about Microsoft SGML Author. Please scan this list before you call Microsoft Product Support Services.

   Q: How can I verify that my installation is working and converting
      properly?

   A: Included in your package are three ready-to-use examples of
      documents, templates, and association files (.dta) so you can begin
      using SGML Author's converter. We recommend that you start with the
      included sample files located in the \Sample subdirectory. Here are
      steps you can take to ensure that SGML Author is performing
      conversions properly:

      1. In Word for Windows, choose Open from the File menu, and then
         select the Sample.doc document located in the \Sample
         subdirectory.

      2. Click the OK button. If you are prompted for an initialization
         file, select  Sample.ini and then the click the OK button. Choose
         Save As SGML from the File menu. The Save As SGML macro will now
         perform a number of tasks:

         - Asks you if you want to save the Word document prior to
           conversion. If you click Yes, the macro saves the document.

         - Asks you for the association (*.dta) file used during the
           conversion. Click Sample.dta and then click the OK button.

         - Converts the document based on the association file.

         - Opens and displays the feedback file.

      3. At completion of this task, the macro will display a dialog box
         stating that "Your document converted without any modifications."
         The Sample feedback file should appear without any annotations,
         indicating that there were no problems with the conversion.

   Q: Why do I get an error when I try to open an instance containing
      graphics?

   A: SGML Author requires that you save graphics using pathnames and
      filenames which follow the 8.3 filenaming convention.  If you have
      trouble roundtripping or opening SGML instances containing graphics,
      check to make sure that the graphics files are not located in a
      pathname or filename containing spaces.

   Q: Why does my feedback (*.fbk) file contain annotations for Inference
      Parser Errors like:

         - Could not find external document type "DOC"

           -or-

         - No definition for DOC document type; "DOC O O ANY" assumed

           -or-

         - Possible attributes treated as data because none were defined

   A: Check the Path statement in your entity catalog (Entm.cat) and verify
      that it points to the location where SGML Author is installed. You
      can open and edit the entity catalog with any text editor.  If the
      Path statement in your entity catalog file is correct, make sure that
      your .dtd and .dcl files are located in the same directory as the
      association file (*.dta) you are using.

   Q: How can I open an SGML instance in Word for Windows and view the
      marked-up form instead of converting it to a Word document?

   A: You can open an SGML instance in Word and view the markup as plain
      text by selecting Open from the File menu in Word. In the Confirm
      Conversions dialog box, select Text Only. Word opens the SGML
      instance as a plain text file.  If you are not prompted for a file
      conversion type, make sure the Confirm Conversions checkbox is
      checked in the "General" tab in the Options dialog under the Tools
      menu item.

   Q: Why does the content for my header and footer change when I convert
      SGML Author 1.0 files to SGML Author 1.2?

   A: When SGML Author converts 1.0 files to version 1.2, paragraph marks
      are removed from headers and footers. All other content remains
      intact.

   Q: After conversions from SGML Author 1.0 to version 1.2, SGML Author
      says there are template changes even if the template hasn't changed.

   A: The amount of whitespace in AutoText entries varies from SGML Author
      version 1.0 to 1.2. When SGML Author looks for template changes, this
      whitespace appears as a change in the template.

   Q: I don't get what I expect from my custom document properties.

   A: When defining custom document properties, don't use any special
      characters such as curly brackets or backslashes ({} \). The RTF that
      is created for special characters is not escaped properly and will
      not be understood by the RTF parser.

   Q: When I try to open an association file my system stops responding.

   A: SGML Author is not compatible with Word Mail, which runs in
      association with Microsoft Exchange. If you are running Exchange with
      Word Mail and your system stops responding, exit Exchange and then
      re-open the association file in SGML Author.

Creating an Association to the Root Element in the DTD

When building your association file, do not associate descriptors with the root element of your DTD. Although SGML Author allows you to associate descriptors to attributes of the Root, associating content to the root will create unpredictable results. (The Document Properties is an example of a descriptor that you might want to associate with attributes of the root element.)

To Install SGML Author

To install SGML Author from the CD provided, On the Start menu in Windows 95, or on the File menu in Windows NT click Run and type X:\Author\Setup.exe (where X is the CD-ROM drive designation) then follow the instructions that appear on your screen.

Files Installed by Setup

When you install SGML Author, Setup copies files to the hard disk as follows for Complete or Converter Only installation.

NOTE: These files are installed to a sub folder located in the "Program Files\Microsoft Office" folder unless noted.

DYNAMIC-LINK LIBRARIES

   Filename         Complete     Converter Only     Sub Folder
   ----------------------------------------------------------------

   Aveqn.dll          Yes             Yes           \Office
   Avmsw32c.dll       Yes             Yes           \Office
   Avsys.dll          Yes             Yes           \Office
   Avwrdapi.dll       Yes             Yes           \Office
   Backend.dll        Yes             Yes           \Office
   Msdb.dll           Yes             Yes           \Office
   Rtfsfr.dll         Yes             Yes           \Office
   Sgmlpars.dll       Yes             Yes           \Office
   Ctl3d32.dll        Yes             No            \Windows\System
   Msvcrt20.dll       Yes             No            \Windows\System

AUTHOR EXECUTABLE & SUPPORT FILES

   Filename         Complete     Converter Only     Sub Folder
   -----------------------------------------------------------

   Avmscl32.dll       Yes             No            \Office
   Odapi.dll          Yes             No            \Office
   Sgml.exe           Yes             No            \Office

HELP FILES

   Filename         Complete     Converter Only     Sub Folder
   -----------------------------------------------------------------

   Pss.cnt            Yes             No            \Office
   Pss.gid            Yes             No            \Office
   Pss.hlp            Yes             No            \Office
   Sgml.cnt           Yes             No            \Office
   Sgml.gid           Yes             No            \Office
   Sgml.hlp           Yes             No            \Office
   Template.gid       Yes             Yes           \Office\Sgmlconv
   Template.hlp       Yes             Yes           \Office\Sgmlconv

CONVERTER & DYNAMIC-LINK LIBRARIES

   Filename         Complete     Converter Only     Sub Folder
   -----------------------------------------------------------------

   Sgmlconv.cnv       Yes             Yes           \Office\Sgmlconv
   Docschem.sch       Yes             Yes           \Office\Sgmlconv
   Ednatbl.sch        Yes             Yes           \Office\Sgmlconv
   Msoft.sch          Yes             Yes           \Office\Sgmlconv
   Mapcnv.exe         Yes             No            \Office\Sgmlconv
   Avsys16.dll        Yes             No            \Office\Sgmlconv
   Msdb16.dll         Yes             No            \Office\Sgmlconv
   Msoft16.sch        Yes             No            \Office\Sgmlconv
   Sgmlp16.dll        Yes             No            \Office\Sgmlconv
   Uni.cfg            Yes             No            \Office\Sgmlconv

ENTITY MANAGER CATALOG

   Filename         Complete     Converter Only     Sub Folder
   -----------------------------------------------------------------

   Entm.cat           Yes             Yes           \Office\Sgmlconv

CHARACTER CONVERSION FILES

   Filename         Complete     Converter Only     Sub Folder
   -----------------------------------------------------------------

   Rtfansi.ccf        Yes             Yes           \Office\Sgmlconv
   Wingding.ccf       Yes             Yes           \Office\Sgmlconv
   Winsym.ccf         Yes             Yes           \Office\Sgmlconv

PUBLIC ENTITY DTD FILES

   Filename         Complete     Converter Only     Sub Folder
   -----------------------------------------------------------------

   Table.dtd          Yes             Yes           \Office\Sgmlconv
   Equation.dtd       Yes             Yes           \Office\Sgmlconv

MESSAGE FILES

   Filename         Complete     Converter Only     Sub Folder
   -----------------------------------------------------------------

   _Averr.adc         Yes             Yes           \Office\Sgmlconv
   _Avmsg.adc         Yes             Yes           \Office\Sgmlconv
   _Avvdm.adc         Yes             Yes           \Office\Sgmlconv
   _Avwrn.adc         Yes             Yes           \Office\Sgmlconv

ISO CHARACTER SYMBOLS

   Filename         Complete     Converter Only     Sub Folder
   -----------------------------------------------------------------

   *.pub              Yes             Yes           \Office\Sgmlconv

ON-LINE DOCUMENTS

   Filename         Complete     Converter Only     Sub Folder
   -----------------------------------------------------------------

   Cgm.doc            Yes             Yes           \Office\Sgmlconv
   Readme.doc         Yes             Yes           \Office\Sgmlconv

FONT MAPPING

   Filename         Complete     Converter Only     Sub Folder
   -----------------------------------------------------------------

   Fmapdtd.txt        Yes             Yes           \Office\Sgmlconv

GRAPHICS IMPORT

   Filename         Complete     Converter Only     Sub Folder
   -----------------------------------------------------------------

   Update.dat         Yes             Yes           \Office\Sgmlconv

WORD ADD-IN LIBRARY

   Filename         Complete     Converter Only     Sub Folder
   ----------------------------------------------------------------

   Sgmllib.wll        Yes             Yes           \Office\Startup

WORD TEMPLATES

   Filename       Complete   Converter Only   Sub Folder
   ------------------------------------------------------------------------

   Atasb.dot        Yes           No          \Office\Templates (Workgroup)
   Atasbprn.dot     Yes           No          \Office\Templates (Workgroup)
   Cals.dot         Yes           No          \Office\Templates (Workgroup)
   Calsprn.dot      Yes           No          \Office\Templates (Workgroup)
   Sample.dot       Yes           Yes         \Office\Templates (Workgroup)
   Samplprn.dot     Yes           Yes         \Office\Templates (Workgroup)

AIR TRANSPORTATION ASSOCIATION (ATA-100) SPECIFICATION

   Filename       Complete   Converter Only   Sub Folder
   -----------------------------------------------------------------

   Atasb.dcl         Yes          No          \Office\Sgmlconv\Atasb
   Atasb.doc         Yes          No          \Office\Sgmlconv\Atasb
   Atasb.dtd         Yes          No          \Office\Sgmlconv\Atasb
   Atasb.ini         Yes          No          \Office\Sgmlconv\Atasb
   Atasb.dta         Yes          No          \Office\Sgmlconv\Atasb

CONTINUOUS ACQUISITION AND LIFE-CYCLE SUPPORT

   Filename       Complete   Converter Only   Sub Folder
   ----------------------------------------------------------------

   Cals.dcl          Yes          No          \Office\Sgmlconv\Cals
   Calsdemo.doc      Yes          No          \Office\Sgmlconv\Cals
   Cals.dtd          Yes          No          \Office\Sgmlconv\Cals
   Cals.ini          Yes          No          \Office\Sgmlconv\Cals
   Cals.dta          Yes          No          \Office\Sgmlconv\Cals

SAMPLE AND SKELETON FILES

   Filename       Complete   Converter Only   Sub Folder
   ------------------------------------------------------------------

   Sample.dcl        Yes          Yes         \Office\Sgmlconv\Sample
   Sample.doc        Yes          Yes         \Office\Sgmlconv\Sample
   Sample.dtd        Yes          Yes         \Office\Sgmlconv\Sample
   Sample.ini        Yes          Yes         \Office\Sgmlconv\Sample
   Sample.dta        Yes          Yes         \Office\Sgmlconv\Sample
   Skeleton.dcl      Yes          Yes         \Office\Sgmlconv\Sample
   Skeleton.dtd      Yes          Yes         \Office\Sgmlconv\Sample

SETUP FILES

   Filename       Complete   Converter Only   Sub Folder
   -----------------------------------------------------------------

   Setup.exe         Yes          Yes         \Office\Sgmlconv\Setup
   Setup.ini         Yes          Yes         \Office\Sgmlconv\Setup
   Setup.tdf         Yes          Yes         \Office\Sgmlconv\Setup
   Mssetup.dll       Yes          Yes         \Office\Sgmlconv\Setup
   Sgml32.dll        Yes          Yes         \Office\Sgmlconv\Setup
   Acmesetup.hlp     Yes          Yes         \Office\Sgmlconv\Setup
   Sgml.inf          Yes          Yes         \Office\Sgmlconv\Setup
   Setup.stf         Yes          Yes         \Office\Sgmlconv\Setup
   Wwsetup.ttf       Yes          Yes         \Office\Sgmlconv\Setup

GRAPHICS FILTERS, FONTS AND HELP FILES

   The following files are located in one of the following folders
   depending on which operating system you have SMGL Author installed:

   Windows 95 and NT 4.0

      \Program Files\Common Files\Microsoft Shared\Grphflt

   Windows NT 3.51

      \Windows\Msapps\Grphflt

   Filename       Complete   Converter Only
   ----------------------------------------

   Cgmexp32.flt       Yes          Yes
   Cgmexp32.hlp       Yes          Yes
   Cgmimp32.flt       Yes          Yes
   Cgmimp32.hlp       Yes          Yes
   Cgmimp32.fnt       Yes          Yes
   Mstrif32.dll       Yes          Yes
   Trifim32.flt       Yes          Yes
   His_font.cfg       Yes          Yes

REFERENCES

SGML Author 1.2, 1.1 Readme.doc file

Additional query words: sgmlword sgmla kb_sgmlauthor

Keywords          : kbdta winword ntword kbsgml 
Version           : WINDOWS:1.1,1.2
Platform          : WINDOWS
Issue type        : kbinfo


Last Reviewed: February 13, 1999
© 1999 Microsoft Corporation. All rights reserved. Terms of Use.