Comparison of DITA support in FrameMaker and XMetaL

1. Comparing DITA support in
XMetaL and FrameMaker
Simon Bate
Scriptorium Publishing
www.scriptorium.com

2. Agenda
Authoring
Conditional processing
Generating output
Cross-references and conrefs
Map files
Specialization
Consider your needs

3. About the presenter
Based in Research Triangle, North Carolina
Senior Technical Consultant at Scriptorium
30+ years experience in Technical Publications
Long-time FrameMaker user
Instructor for Scriptorium classes:
XMetaL DITA
XSL in Publications

4. A note about Scriptorium
Affiliated with Adobe as Adobe Authorized
Training Center
Affiliated with JustSystems as a Certified
Services Partner
Nonetheless, I think you'll find this
presentation quite candid about each tool's
strengths and weaknesses.

5. Questions
Please ask questions.
I may defer some questions to the end of
the presentation.

6. FrameMaker highlights
High-quality print/PDF output
Formatting control is built in
Ability to quot;tweakquot; formatting, such as page
breaks
WYSIWYG for print/PDF

7. XMetaL highlights
Ability to edit XML directly
Integration with DITA Open Toolkit
Not WYSIWYG for print
Specialization support
DITA 1.1 support

9. XMetaL Authoring highlights
Code (quot;plain textquot;) view
Structure view (block only)
Format-neutral WYSIOO presentation
No invalid content allowed
Elements grouped by type (Insert menu)

11. FrameMaker authoring
highlights
WYSIWYG for print/PDF
Structure view is complete
Document window/structure view
combination
Invalid content allowed

12. Conditional processing in
FrameMaker
Traditional FrameMaker conditions
In 8.0, allows expressions
FM information is saved in XML output
But the information is not DITA
Use attributes
Special > Filter by attributes

13. ditaval files
FrameMaker:
only when using DITA Open Toolkit
XMetaL:
hidden by conditional
GUI
Use Export to create
ditaval file

14. Generating output in XMetaL
Open Toolkit
RenderX for PDF via Open Toolkit
HTML-based help

15. Generating output in
FrameMaker
PDF
Open Toolkit (install plug-in)
FrameMaker book from DITA map
HTML-based help

16. Cross-references in
FrameMaker
FrameMaker <fm-xref> element
Only reference a selected set of elements
Creates active links in PDF files
DITA <xref> elements
Can reference any element in any topic
Can contain alternate text (not just the title)
Does not create active links in PDF files

17. Cross-references in XMetaL
Insert > Link
Cross-reference
File reference
Web link
Can change text in
<xref> element
Converted correctly
in Open Toolkit

18. conrefs in XMetaL

19. conrefs in FrameMaker

20. Map files in FrameMaker

21. Map files in XMetaL

22. Specialization
XMetaL
Many hooks for specialization
FrameMaker
Nothing built-in
Could modify EDD

23. Which has better DITA support?
For print/PDF output: FrameMaker
For DITA authoring: XMetaL
For print WYSIWYG: FrameMaker
For output-neutral formatting: XMetaL
No clear winner.

24. How important is print
publishing?
It's much easier to produce high-end print/
PDF from FrameMaker.
Print/PDF publishing through Open Toolkit
is not satisfactory.
WYSIWYG presentation in FrameMaker is a
plus for print-centric workflows.
WYSIOO presentation in XMetaL is a plus
for authoring without focusing on print.

25. How much control should
authors have?
Because FrameMaker combines authoring
and publishing, authors have more control
Can create and publish with invalid content
XMetaL enables DITA authoring; separates
out publishing
Does not allow invalid content in normal
authoring.
Think workflow and sharing topics

26. Do you need cross-browser,
cross-platform help?
HTMLHelp (CHM)
Not cross-platform
XMetaL and FrameMaker (3rd-party or OT)
XHTML-based Help
FrameMaker and 3rd-party converters
Eclipse Help
XMetaL and FrameMaker (via OT)
Requires Eclipse infrastructure

27. Transition issues
Current unstructured FrameMaker users
will find structured FrameMaker easier than
XMetaL (mostly).
Developer types may prefer XMetaL.
FrameMaker includes conversion utility.
(Of course, you could convert in
FrameMaker and then use the converted
content in another XML tool.)

28. Do you need to specialize?
You will have to implement FrameMaker
support yourself.
XMetaL supports use of specialized DTDs.

29. Graphics
Many more formats supported in
FrameMaker.
In XMetaL, PDF output with EPS images
requires Acrobat Distiller.
Callouts a problem in either:
Layers in graphic file?
FrameMaker callouts are flattened on
export to XML.

30. Attributes
Attributes Inspector (XMetaL) is easier to
use than Attributes Editor (FrameMaker).
But...attributes show up in FrameMaker
structure view and not in XMetaL structure
view.

31. Summary
Your priorities will dictate which tool is a
better fit for your organization.
Each application has significant strengths
and weaknesses.
Authoring paradigms are significantly
different.

32. Resources
DITA @ OASIS
http://www.oasis-open.org/committees/
tc_home.php?wg_abbrev=dita
White papers
Available on CD at our booth
www.scriptorium.com/papers.html
Please leave a business card or your email
address if you want the handouts.

33. Contact information
Simon Bate
Scriptorium Publishing Services
www.scriptorium.com
sbate@scriptorium.com
919 481-2701 x106

34. Questions

35. Comparing DITA support in
XMetaL and FrameMaker
Simon Bate
Scriptorium Publishing
www.scriptorium.com
Scriptorium Publishing Services, Inc.
Copyright © 2000. All rights reserved.
Page 1

36. Agenda
Authoring
Conditional processing
Generating output
Cross-references and conrefs
Map files
Specialization
Consider your needs
2

37. About the presenter
Based in Research Triangle, North Carolina
Senior Technical Consultant at Scriptorium
30+ years experience in Technical Publications
Long-time FrameMaker user
Instructor for Scriptorium classes:
XMetaL DITA
XSL in Publications
3

38. A note about Scriptorium
Affiliated with Adobe as Adobe Authorized
Training Center
Affiliated with JustSystems as a Certified
Services Partner
Nonetheless, I think you'll find this
presentation quite candid about each tool's
strengths and weaknesses.
4
quot;Full disclosure...quot;

39. Questions
Please ask questions.
I may defer some questions to the end of
the presentation.
5

40. FrameMaker highlights
High-quality print/PDF output
Formatting control is built in
Ability to quot;tweakquot; formatting, such as page
breaks
WYSIWYG for print/PDF
6
Version 8.0
Large user base (among technical publications)

41. XMetaL highlights
Ability to edit XML directly
Integration with DITA Open Toolkit
Not WYSIWYG for print
Specialization support
DITA 1.1 support
7
Version 5.1
XML (content) editor

42. 8
Menus
Toolbars
Content
Views
Structure view
Element and Attributes
Insert menu to insert grouped elements.

43. XMetaL Authoring highlights
Code (quot;plain textquot;) view
Structure view (block only)
Format-neutral WYSIOO presentation
No invalid content allowed
Elements grouped by type (Insert menu)
9
Code view allows you to create invalid structure.
quot;Smart Insertquot; works on insert and paste.

44. 10

45. FrameMaker authoring
highlights
WYSIWYG for print/PDF
Structure view is complete
Document window/structure view
combination
Invalid content allowed
11

46. Conditional processing in
FrameMaker
Traditional FrameMaker conditions
In 8.0, allows expressions
FM information is saved in XML output
But the information is not DITA
Use attributes
Special > Filter by attributes
12

47. ditaval files
FrameMaker:
only when using DITA Open Toolkit
XMetaL:
hidden by conditional
GUI
Use Export to create
ditaval file
13

48. Generating output in XMetaL
Open Toolkit
RenderX for PDF via Open Toolkit
HTML-based help
14
Conditions selected at generate time.
HTML-based help includes CHM and Eclipse.

49. Generating output in
FrameMaker
PDF
Open Toolkit (install plug-in)
FrameMaker book from DITA map
HTML-based help
15

50. Cross-references in
FrameMaker
FrameMaker <fm-xref> element
Only reference a selected set of elements
Creates active links in PDF files
DITA <xref> elements
Can reference any element in any topic
Can contain alternate text (not just the title)
Does not create active links in PDF files
16
fm-xref references topic, param, and related-links elements.

51. Cross-references in XMetaL
Insert > Link
Cross-reference
File reference
Web link
Can change text in
<xref> element
Converted correctly
in Open Toolkit
17

52. conrefs in XMetaL
18

53. conrefs in FrameMaker
19
Can't move a conref using structure view.

54. Map files in FrameMaker
20
Can work with map files
For print/PDF, you can create FM book file from DITA map.
Doesn't work on nested maps.
Map files are important if you're using DITA OT for output.

55. Map files in XMetaL
21
All control over maps is through small menu.
Confusing.
CTRL keys don't work in Map.

56. Specialization
XMetaL
Many hooks for specialization
FrameMaker
Nothing built-in
Could modify EDD
22
This comes from the way the two are implemented.
XMetaL is an editor that provides formatting as an
afterthought.
FrameMaker is an integrated editor and formatter.

57. Which has better DITA support?
For print/PDF output: FrameMaker
For DITA authoring: XMetaL
For print WYSIWYG: FrameMaker
For output-neutral formatting: XMetaL
No clear winner.
23

58. How important is print
publishing?
It's much easier to produce high-end print/
PDF from FrameMaker.
Print/PDF publishing through Open Toolkit
is not satisfactory.
WYSIWYG presentation in FrameMaker is a
plus for print-centric workflows.
WYSIOO presentation in XMetaL is a plus
for authoring without focusing on print.
24

59. How much control should
authors have?
Because FrameMaker combines authoring
and publishing, authors have more control
Can create and publish with invalid content
XMetaL enables DITA authoring; separates
out publishing
Does not allow invalid content in normal
authoring.
Think workflow and sharing topics
25
Some issues here deal with publishing workflow.

60. Do you need cross-browser,
cross-platform help?
HTMLHelp (CHM)
Not cross-platform
XMetaL and FrameMaker (3rd-party or OT)
XHTML-based Help
FrameMaker and 3rd-party converters
Eclipse Help
XMetaL and FrameMaker (via OT)
Requires Eclipse infrastructure
26

61. Transition issues
Current unstructured FrameMaker users
will find structured FrameMaker easier than
XMetaL (mostly).
Developer types may prefer XMetaL.
FrameMaker includes conversion utility.
(Of course, you could convert in
FrameMaker and then use the converted
content in another XML tool.)
27
With FM there's still the issue with the Enter key.

62. Do you need to specialize?
You will have to implement FrameMaker
support yourself.
XMetaL supports use of specialized DTDs.
28

63. Graphics
Many more formats supported in
FrameMaker.
In XMetaL, PDF output with EPS images
requires Acrobat Distiller.
Callouts a problem in either:
Layers in graphic file?
FrameMaker callouts are flattened on
export to XML.
29
Callouts:
You want to be able to localize the text.
FrameMaker quot;flatteningquot; means conversion to GIF.

64. Attributes
Attributes Inspector (XMetaL) is easier to
use than Attributes Editor (FrameMaker).
But...attributes show up in FrameMaker
structure view and not in XMetaL structure
view.
30
Call attention selection of elements/attributes in XMetaL.

65. Summary
Your priorities will dictate which tool is a
better fit for your organization.
Each application has significant strengths
and weaknesses.
Authoring paradigms are significantly
different.
31

66. Resources
DITA @ OASIS
http://www.oasis-open.org/committees/
tc_home.php?wg_abbrev=dita
White papers
Available on CD at our booth
www.scriptorium.com/papers.html
Please leave a business card or your email
address if you want the handouts.
32

67. Contact information
Simon Bate
Scriptorium Publishing Services
www.scriptorium.com
sbate@scriptorium.com
919 481-2701 x106
33

68. Questions
34