MML Reference manual errors in FM6

["Thomas Michanek" <thomas.michanek@xxxxxxxxx>]

*** This message is posted to the mailing list framers@omsys.com,
*** the News group comp.text.frame, and Adobe's User to User Forum
*** for FM (http://www.adobeforums.com/cgi-bin/webx.fcgi?.ee6b312)

MML Reference Manual errors in FM 6
===================================
Background: The FrameMaker distribution includes a number of 
  "Online Manuals" that are not delivered in print. In FM 5.x, these
  were available directly from the main online help screen, but in
  FM 6 they are only delivered as separate re-designed PDF files.
  They are intended for print-out, not for online reading.

I have now reviewed the MML Online Reference Manual for FM 6.
This manual contains deficiences similar to the MIF Reference manual,
but to a much lesser degree. Nevertheless, I want to point out and warn
FM users for the deficiences in this version, which apparently have not
been spotted by Adobe, before or after shipping the final release.

Even though MML is less used than MIF nowadays, we should expect and
demand a Reference manual to be correct, especially since the 5.5
version didn't contain the errors that the 6.0 version does.

These are the errors and deficiences I have found in the manual:

The <Include> statement is referred to as <!Include> (an extra '!'):
Page 6 & 7: "An <!Include> statement that names the MML include file..."
Page 11 (the definition): "<Include string>"

Some words in Courier font, including important MML keywords, are simply
missing from the text!! Examples:
* page 8: "For example, signals the beginning of a new section, while
           switches fonts. Case is not significant in statement names,
           so would work as well."
  Should be: "For example, <Section> signals the beginning of a new section,
              while <Family Times> switches fonts. Case is not significant
              in statement names, so <FaMiLy Times> would work as well."
* page 10: "You must put exactly one space between and char..."
  Should be: "You must put exactly one space between !DefineChar and char..."
* page 11: "If no <family> statement is provided, the default family is ."
  Should be: "If no <family> statement is provided, the default family is Times."
* page 14: "Ignored unless is specified. The default value is (an empty string)."
  Should be: "Ignored unless <AutoNumber Yes> is specified. The default value is
              "" (an empty string)."

Chapters/appendices are no longer numbered (as they were in 5.5), and
most references in the manual have been changed to reflect this. 
However, there are exceptions:
* page 12: "For examples of <!DefineFont> and its use, see , 'Samples.'"
  In 5.5, the cross-reaf read "see Appendix A, 'Samples.'" 
  NOTE the comma that still is there. Apparently, this cross-ref
  format has not been updated... The link works in the PDF, but how are
  you supposed to find the reference in print? (the intended format)

Incidentally, the font style used for all cross-references (links) is
italics for the entire cross-reference text. This is more consistent
than the MIF Reference manual, but still differs from all other
online manuals in FM 6. Not an error, but a strange inconsistency...

There are bad line breaks in the manual, that apparently are
hard-coded breaks left over from the 5.5 version that haven't been 
corrected in the new version. (page 9)


/Thomas, continuing to proof-read at no charge for Adobe
- - - - - - - - - - - - - - - - - - - - - - - - -
Thomas Michanek, [Michagon], Linkoping, Sweden
       FrameMaker/UNIX/MIF/scripting expert
EMAIL: mailto:Thomas.Michanek@telia.com
WWW:   http://go.to/framers , or go directly to:
       http://w1.133.telia.com/~u13304072/framers
       *  U P D A T E D   O N   J U N E   2 6  *
- - - - - - - - - - - - - - - - - - - - - - - - -
Join the "Free Framers" mailing list: send the
message "subscribe framers" to majordomo@omsys.com


** To unsubscribe, send a message to majordomo@omsys.com **
** with "unsubscribe framers" (no quotes) in the body.   **