The limitations of FrameMaker’s native text inset functionality are well documented. Issues such as the manipulation of repurposed text, the tracking of content used in multiple locations, and even the position of a topic within a document hierarchy are especially relevant when working in Structured FrameMaker.
This presentation examines methods for managing repurposed content in Structured FrameMaker without implementing a Content Management System, and compares the solutions offered by three commercially available plugins: StructureSnippets and DITA-FMx from Leximation (www.leximation.com), and InsetPlus from West Street Consulting (www.weststreetconsulting.com).
Beyond Boundaries: Leveraging No-Code Solutions for Industry Innovation
Managing repurposed content in structured FrameMaker
1. Andy Lewis | Owner
iG5 Authoring Tools
Technical Communication UK, September 2010
andy@ig5authoringtools.com
www.ig5authoringtools.com
2. Who’s That Handsome Chap?
10+ years’ experience
RADVISION
Verint Systems
iG5 Authoring Tools
Articles in Communicator
LinkedIn http://il.linkedin.com/in/andylewis2003
Twitter http://twitter.com/andytelaviv
Extending FrameMaker
2
3. Introduction
We will discuss and compare
StructureSnippets and DITA-FMx from Leximation
(www.leximation.com)
InsetPlus from West Street Consulting
(www.weststreetconsulting.com)
Extending FrameMaker
3
4. Overview
Plugin Functionality
StructureSnippets Basic inset functionality for structured environments
P create, insert, wrap, store, manage
O access source, update, maintain links
InsetPlus Advanced inset functionality for structured environments
P access source, update, maintain links
P basic CMS features: track and locate, store
O DITA support
DITA-FMx Full DITA functionality for structured environments
P support for the DITA 1.1 specification
P create topics and DITA maps, track and locate, update
P search by text or element within topics
P Auto-prolog
Extending FrameMaker
4
6. StructureSnippets Operations
Create and store
Store in a local folder or at a remote location on a shared server
Manage and insert
Insert by
selecting the entry name from a dialog box
using the specified shortcut keystrokes
selecting the name from the context (right-click or popup) menu
Wrap
Report conflicts with EDD-defined structure
Extending FrameMaker
6
9. InsetPlus Basics
Store source content insets in document or book
Colour content insets in container document
Update single/multiple insets
Nested inset support
Edit in source and update container
Edit in container and update source
Track inset use
Extending FrameMaker
9
10. InsetPlus – Inserting a Text Inset
1. Insert TextInset element
in container document
2. Right-click the TextInset
element in the structure
view
3. Select InsetPlus – Edit
Inset Element
4. View and select
modules
Extending FrameMaker
10
14. InsetPlus – Editing and Updating
Edit inset content in source and update container
document (Jump to Inset Source)
Edit inset content in container document and update
source (Preferences > General > Disallow editing within reference inset
elements and then More Inset Commands > Update Inset Source)
Nested insets (More Inset Commands > Update Inset Reference And
Nested Insets)
Extending FrameMaker
14
15. InsetPlus – Source Module Tracking
See where source modules are
used
Enable in Preferences
In container select Update All
Reference Insets > Do source
module tracking updates
On source select More Inset
Commands > Report Source
Module Usage
Warning: Source tracking
works best in when source and
reference files are static
Extending FrameMaker
15
16. DITA-FMx—Overview
A set of plug-ins and structure applications that enable
you to create and edit DITA XML files in FrameMaker
Jointly produced by
Leximation (www.leximation.com)
Silicon Publishing (www.siliconpublishing.com)
Extending FrameMaker
16
17. DITA-FMx Vital Statistics
DITA-FMx 1.1.08 (October 2009)
Supports DITA 1.1 and FrameMaker versions 7.2, 8.0 and 9
$185 (individual), $2775 (site of up to 25 users)
Upgrade from 1.0 is free
DITA-FMx 1.0
Supports DITA 1.0 and FrameMaker versions 7.2 and 8.0
$185 (individual), $2775 (site of up to 25 users)
Upgrade to 1.1 is free
DITA-FMx 0.0
Supports DITA 1.0 and FrameMaker versions 7.1 and 7.2
Free
Limited feature set (e.g. no DITA map support)
DITA-FMx-FrameMaker version 8.0 comparison at http://www.leximation.com/dita-
fmx/featurecomparison.php
Extending FrameMaker
17
18. DITA-FMx Basics
Creating topics
Building a DITA map
A logical entity representing hierarchical relationship between
topics, including sub-maps (“mini-maps”)
Generating a “workbook”
Intermediate step between map and final FrameMaker book
Not intended for publishing
Contains all XML files in map (.dita, .xml)
Used for book-level processing (e.g. variables, xrefs, spell check,
search)
Creating FrameMaker books for publication
Extending FrameMaker
18
19. DITA-FMx—Where Used
Generates a report listing all files that reference the
selected element or current topic
Locate by topic or element (requires ID)
Search in DITA map or folder
Extending FrameMaker
19
20. DITA-FMx—Search in Files
Search for content in files
Search within a folder (and sub-folders) or in files
referenced by a DITA map
Search criteria can be a mix of
textual content
element name
attribute name
attribute value
Extending FrameMaker
20
21. DITA-FMx—Auto-Prolog
Specify certain prolog data to automatically add or
update on file creation and file save
Use as search criteria
Extending FrameMaker
21
22. Summary
Plugin Vendor Functionality Cost ($)
Structure Leximation Basic inset functionality for structured 40/600
Snippets environments—create, store, manage
InsetPlus West Street Consulting Advanced inset functionality for Free
structured environments—access
source, update, maintain links, basic
CMS features: track and locate, store
DITA-FMx Leximation Support for the DITA 1.1 specification 185/2775
and functionality—create topics and
DITA maps, track and locate, update,
search within topics, auto-prolog
Extending FrameMaker
22
23. There is a further option …
DITAToo by iG5 Authoring Tools
andy@ig5authoringtools.com
Extending FrameMaker
23