dita support in framemaker and xmetal
DESCRIPTION
Comparison of DITA support in FrameMaker and XMetaLTRANSCRIPT
Comparing DITA support in XMetaL and FrameMaker
Simon BateScriptorium Publishingwww.scriptorium.com
Agenda
Authoring Conditional processingGenerating outputCross-references and conrefsMap filesSpecializationConsider your needs
About the presenter
Based in Research Triangle, North CarolinaSenior Technical Consultant at Scriptorium30+ years experience in Technical PublicationsLong-time FrameMaker userInstructor for Scriptorium classes:
XMetaL DITA XSL in Publications
A note about Scriptorium
Affiliated with Adobe as Adobe Authorized Training CenterAffiliated with JustSystems as a Certified Services PartnerNonetheless, I think you'll find this presentation quite candid about each tool's strengths and weaknesses.
Questions
Please ask questions.I may defer some questions to the end of the presentation.
FrameMaker highlights
High-quality print/PDF outputFormatting control is built inAbility to "tweak" formatting, such as page breaksWYSIWYG for print/PDF
XMetaL highlights
Ability to edit XML directlyIntegration with DITA Open ToolkitNot WYSIWYG for printSpecialization supportDITA 1.1 support
XMetaL Authoring highlights
Code ("plain text") viewStructure view (block only)Format-neutral WYSIOO presentationNo invalid content allowedElements grouped by type (Insert menu)
FrameMaker authoring highlights
WYSIWYG for print/PDFStructure view is completeDocument window/structure view combinationInvalid content allowed
Conditional processing in FrameMaker
Traditional FrameMaker conditions In 8.0, allows expressionsFM information is saved in XML outputBut the information is not DITA
Use attributesSpecial > Filter by attributes
ditaval files
FrameMaker: only when using DITA Open Toolkit
XMetaL: hidden by conditional GUIUse Export to createditaval file
Generating output in XMetaL
Open ToolkitRenderX for PDF via Open ToolkitHTML-based help
Generating output in FrameMaker
PDFOpen Toolkit (install plug-in)FrameMaker book from DITA mapHTML-based help
Cross-references in FrameMaker
FrameMaker <fm-xref> elementOnly reference a selected set of elementsCreates active links in PDF files
DITA <xref> elementsCan reference any element in any topicCan contain alternate text (not just the title)Does not create active links in PDF files
Cross-references in XMetaL
Insert > LinkCross-referenceFile referenceWeb link
Can change text in <xref> elementConverted correctly in Open Toolkit
conrefs in XMetaL
conrefs in FrameMaker
Map files in FrameMaker
Map files in XMetaL
Specialization
XMetaLMany hooks for specialization
FrameMakerNothing built-inCould modify EDD
Which has better DITA support?
For print/PDF output: FrameMakerFor DITA authoring: XMetaLFor print WYSIWYG: FrameMakerFor output-neutral formatting: XMetaL
No clear winner.
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.
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
Do you need cross-browser, cross-platform help?
HTMLHelp (CHM)Not cross-platformXMetaL and FrameMaker (3rd-party or OT)
XHTML-based HelpFrameMaker and 3rd-party converters
Eclipse HelpXMetaL and FrameMaker (via OT)Requires Eclipse infrastructure
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.)
Do you need to specialize?
You will have to implement FrameMaker support yourself.XMetaL supports use of specialized DTDs.
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.
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.
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.
Resources
DITA @ OASIShttp://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita
White papersAvailable on CD at our boothwww.scriptorium.com/papers.html
Please leave a business card or your email address if you want the handouts.
Questions
Scriptorium Publishing Services, Inc.Copyright © 2000. All rights reserved.
Page 1
Comparing DITA support in XMetaL and FrameMaker
Simon BateScriptorium Publishingwww.scriptorium.com
2
Agenda
Authoring Conditional processingGenerating outputCross-references and conrefsMap filesSpecializationConsider your needs
3
About the presenter
Based in Research Triangle, North CarolinaSenior Technical Consultant at Scriptorium30+ years experience in Technical PublicationsLong-time FrameMaker user
Instructor for Scriptorium classes:XMetaL DITA XSL in Publications
4
A note about Scriptorium
Affiliated with Adobe as Adobe Authorized Training CenterAffiliated with JustSystems as a Certified Services PartnerNonetheless, I think you'll find this presentation quite candid about each tool's strengths and weaknesses.
"Full disclosure..."
5
Questions
Please ask questions.I may defer some questions to the end of the presentation.
6
FrameMaker highlights
High-quality print/PDF outputFormatting control is built inAbility to "tweak" formatting, such as page breaksWYSIWYG for print/PDF
Version 8.0
Large user base (among technical publications)
7
XMetaL highlights
Ability to edit XML directlyIntegration with DITA Open ToolkitNot WYSIWYG for printSpecialization supportDITA 1.1 support
Version 5.1
XML (content) editor
8
Menus
Toolbars
Content
Views
Structure view
Element and Attributes
Insert menu to insert grouped elements.
9
XMetaL Authoring highlights
Code ("plain text") viewStructure view (block only)Format-neutral WYSIOO presentationNo invalid content allowedElements grouped by type (Insert menu)
Code view allows you to create invalid structure.
"Smart Insert" works on insert and paste.
10
11
FrameMaker authoring highlights
WYSIWYG for print/PDFStructure view is completeDocument window/structure view combinationInvalid content allowed
12
Conditional processing in FrameMaker
Traditional FrameMaker conditions In 8.0, allows expressionsFM information is saved in XML outputBut the information is not DITA
Use attributesSpecial > Filter by attributes
13
ditaval files
FrameMaker: only when using DITA Open Toolkit
XMetaL: hidden by conditional GUIUse Export to createditaval file
14
Generating output in XMetaL
Open ToolkitRenderX for PDF via Open ToolkitHTML-based help
Conditions selected at generate time.
HTML-based help includes CHM and Eclipse.
15
Generating output in FrameMaker
PDFOpen Toolkit (install plug-in)FrameMaker book from DITA mapHTML-based help
16
Cross-references in FrameMaker
FrameMaker <fm-xref> elementOnly reference a selected set of elementsCreates active links in PDF files
DITA <xref> elementsCan reference any element in any topicCan contain alternate text (not just the title)Does not create active links in PDF files
fm-xref references topic, param, and related-links elements.
17
Cross-references in XMetaL
Insert > LinkCross-referenceFile referenceWeb link
Can change text in <xref> elementConverted correctly in Open Toolkit
18
conrefs in XMetaL
19
conrefs in FrameMaker
Can't move a conref using structure view.
20
Map files in FrameMaker
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.
21
Map files in XMetaL
All control over maps is through small menu.
Confusing.
CTRL keys don't work in Map.
22
Specialization
XMetaLMany hooks for specialization
FrameMakerNothing built-inCould modify EDD
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.
23
Which has better DITA support?
For print/PDF output: FrameMakerFor DITA authoring: XMetaLFor print WYSIWYG: FrameMakerFor 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
Some issues here deal with publishing workflow.
26
Do you need cross-browser, cross-platform help?
HTMLHelp (CHM)Not cross-platformXMetaL and FrameMaker (3rd-party or OT)
XHTML-based HelpFrameMaker and 3rd-party converters
Eclipse HelpXMetaL 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.)
With FM there's still the issue with the Enter key.
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.
Callouts:
You want to be able to localize the text.
FrameMaker "flattening" means conversion to GIF.
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.
Call attention selection of elements/attributes in XMetaL.
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 @ OASIShttp://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita
White papersAvailable on CD at our boothwww.scriptorium.com/papers.html
Please leave a business card or your email address if you want the handouts.
34
Questions