Repurposing Content in Structured FrameMaker Andy Lewis | Owner iG5 Authoring Tools Technical Communication UK, September 2010 andy@ig5authoringtoo ls.com www.ig5authoringtool
Dec 17, 2014
Repurposing Content in Structured FrameMaker
Andy Lewis | OwneriG5 Authoring Tools
Technical Communication UK, September 2010
Extending FrameMaker2
Who’s That Handsome Chap?10+ years’ experienceRADVISIONVerint SystemsiG5 Authoring Tools
Articles in CommunicatorLinkedIn http://il.linkedin.com/in/andylewis2003Twitter http://twitter.com/andytelaviv
Extending FrameMaker3
IntroductionWe will discuss and compareStructureSnippets and DITA-FMx from Leximation (
www.leximation.com)InsetPlus from West Street Consulting (
www.weststreetconsulting.com)
Extending FrameMaker4
OverviewPlugin Functionality
StructureSnippets Basic inset functionality for structured environmentsP create, insert, wrap, store, manageO 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, storeO DITA support
DITA-FMx Full DITA functionality for structured environmentsP support for the DITA 1.1 specification P create topics and DITA maps, track and locate, updateP search by text or element within topicsP Auto-prolog
Extending FrameMaker5
Structure Snippets Vital StatisticsFrameMaker versions 7, 8, 9 (version 1.02) $40 (individual), $600 (site)
Extending FrameMaker6
StructureSnippets OperationsCreate 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 boxusing the specified shortcut keystrokesselecting the name from the context (right-click or popup) menu
WrapReport conflicts with EDD-defined structure
Extending FrameMaker7
StructureSnippets Demonstration
Extending FrameMaker8
InsetPlus Vital StatisticsFrameMaker versions 7, 8, 9 (version 2.1) Free
Extending FrameMaker9
InsetPlus BasicsStore source content insets in document or bookColour content insets in container documentUpdate single/multiple insetsNested inset supportEdit in source and update container Edit in container and update source Track inset use
Extending FrameMaker10
InsetPlus – Inserting a Text Inset 1. Insert TextInset element
in container document2. Right-click the TextInset
element in the structure view
3. Select InsetPlus – Edit Inset Element
4. View and select modules
Extending FrameMaker11
InsetPlus – Colouring a Text Inset
Extending FrameMaker12
InsetPlus – Refreshing a Text Inset
Extending FrameMaker13
InsetPlus – Refreshing Multiple Insets
Extending FrameMaker14
InsetPlus – Editing and UpdatingEdit 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 FrameMaker15
See where source modules are used
Enable in PreferencesIn 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
InsetPlus – Source Module Tracking
Extending FrameMaker16
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)
DITA-FMx—Overview
Extending FrameMaker17
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
DITA-FMx Vital Statistics
Extending FrameMaker18
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 bookNot intended for publishingContains all XML files in map (.dita, .xml)Used for book-level processing (e.g. variables, xrefs, spell check,
search)Creating FrameMaker books for publication
DITA-FMx Basics
Extending FrameMaker19
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
DITA-FMx—Where Used
Extending FrameMaker20
Search for content in files Search within a folder (and sub-folders) or in files
referenced by a DITA mapSearch criteria can be a mix of
textual contentelement nameattribute nameattribute value
DITA-FMx—Search in Files
Extending FrameMaker21
Specify certain prolog data to automatically add or update on file creation and file save
Use as search criteria
DITA-FMx—Auto-Prolog
Extending FrameMaker22
SummaryPlugin Vendor Functionality Cost ($)
StructureSnippets
Leximation Basic inset functionality for structured environments—create, store, manage
40/600
InsetPlus West Street Consulting Advanced inset functionality for structured environments—access source, update, maintain links, basic CMS features: track and locate, store
Free
DITA-FMx Leximation Support for the DITA 1.1 specification and functionality—create topics and DITA maps, track and locate, update, search within topics, auto-prolog
185/2775