TURN THE RIGHT KEYS AND CONTENT FALLS INTO PLACE…€¦ · 05/10/2017 · Title: Adobe DITA World 2017 - Magda Caloian - Turn the right keys and content falls into place Author:

TURN THE RIGHT KEYS AND CONTENT FALLS INTO PLACE…Magda Caloian, FCT AG

11 Oct. 2017 | Adobe DITA World 2017

Turn the right keys and content falls into place…Agenda

• Intro and scope of the presentation

• Use cases

• Suggested architecture

• Walkthrough

• Advantages and lessons learned

• Contacts

© Copyright fct AG 2017 | www.fct.de | 11-Oct-17

http://cubezz.com/Buy-4505-DIY+Cylinder+3x3x3+Magic+Cube+White.html

Magda Caloian (@thinkDITA) | Adobe DITA World 2017

FCT AG – your partner in digital changeSoftware & Products for „Information Management for excellent Product Communication“


TIM Product family OEM components

TIM ONESmart editing tool for

Small and medium-sized companies TIM ENTERPRISEPublishing platform for technical

communication TIM DITAContent management system for

international cooperation

INFORMATION MANAGEMENT PORTALContent Delivery in digital age of Industry 4.0


TIM DITA


Turn the right keys and content falls into place…Intro and scope of the presentation


Twitter @thinkDITABlog think-dita.com

DITA-Anwender Bodensee (DITA Meetup Lake Constance)

Roadmap 2017:• Writing DITA sample projects• Design your DITA-OT output• Localization of DITA projects• DITA-Markdown roundtrip• "The Key must be free"• DITA tools battle• Tools for DITA localization and terminology• Upcoming conferences sneak peek• Top 10 DITA flops


https://twitter.com/thinkDITA



Scope of presentation:

• Generating certain information setsautomatically

• Example of architecture in TIM Info Manager

• Sample project with text from wikiHow

• Publishing to one FrameMaker file




This sample does not (yet) have:

• a complete info model

• a designed layout

• DITA-OT plugin


Turn the right keys and content falls into place…Use cases


• Covers

• Product illustrations grids

• Technical data sheets

• Troubleshooting tables


Turn the right keys and content falls into place…Use cases


Output PDFs

• With images in topics

• With images grid (folding)

• With troubleshooting topics

• With troubleshooting table

• With two products


Turn the right keys and content falls into place…Suggested architecture of a single-source project (I)


• Map

• Keymaps

• Graphics

• Topics

• Metadata and filter criteria


Turn the right keys and content falls into place…Suggested architecture of a single-source project (II)


• FrameMaker template:• Master pages• Reference pages• EDD• evtl. paragraph/ table catalog


Turn the right keys and content falls into place…Suggested architecture of a single-source project (III)


• Publication pipeline• Transformation stylesheets (XSLT)• DITA OT-Plugin• FrameScript, Structured app etc.


Turn the right keys and content falls into place…Suggested architecture of a single-source project (IV)


• Topic templates:• Covers• Grids• Tech data sheets• Troubleshooting

• Keymap templates

• Structure snippets:• List types• Table parts• Hazardstatement types• Keydefs for text• Keydefs for graphics


WALKTHROUGH: COVERS


Turn the right keys and content falls into place…Walkthrough: Covers


Map:• Cover topic template

with keyrefs• Keymaps

• Multiple versions• of cover topic?• just of keymaps?

Where does it fit in the “monkey wrench” context? (see Tom’s talk for the pun)




FrameMaker:

Cover module

+

texts keymap




FrameMaker template:master page + entry in reference page + EDD




FrameMaker output:


WALKTHROUGH: ILLUSTRATION GRIDS


Turn the right keys and content falls into place…Walkthrough: Illustration grids


Map:• Grid topic template

with empty frames• Keymap

• Multiple versions• of grid topic?• just of keymaps?




FM Grid module

+

FM graphics keymap

(with a separate

topicgroup)




FM template:master page(s) + entry in reference page + EDD

…




Some XSLT magic:

…




FM output:




FM task:

What happens in the topics?




FM output:

What happens in the topics?


WALKTHROUGH: TECHNICAL DATA SHEETS


Turn the right keys and content falls into place…Walkthrough: Technical data sheets


Map:

• Tech data topic template asplaceholder

• Keymaps




tech data keymap:




FM template:body master page + entry in reference page + define a table style




Some XSLT magic:




FM output:


WALKTHROUGH: TROUBLESHOOTING TABLE


Turn the right keys and content falls into place…Walkthrough: Troubleshooting tables


Map:

• Table(head) topic asplaceholder

• Troubleshooting topics

• Text keymap




FM troubleshooting topic:




FM template:body master page + entry in reference page + define a table style




Some XSLT magic:




FM output:


Turn the right keys and content falls into place…Lessons learned


• Know your goals and compromises

• Know your team

• Beware the exceptions to the newrules

• Set the guidelines

• Define neutral resourceshttps://www.fulcrumgallery.com/product-images/P611002-10/the-da-vinci-code-codex.jpg


Turn the right keys and content falls into place…Advantages


• Keeping topics neutral and ready forreuse

• All instruction sets are consistent

• Fast project updates

• With system integration, lets writersdo the writing

http://puzzle-pod.com/wp-content/uploads/2016/05/PUZZLE_POD_RENDER3A-e1464401643394.jpg


FCT AG | ContactThank you very much for your interest

Looking forward to hearing from you…


Fischer Computertechnik FCT AGHauptstraße 3078315 Radolfzell (Lake Constance)

Fon +49 (0) 77 38 / 92 94 - 0Fax +49 (0) 77 38 / 92 94 – 92Email [email protected] www.fct.de

Magda CaloianBusiness Consultant, DITA Expert

Email [email protected] Twitter @thinkDITABlog think-dita.com

Meetup https://www.meetup.com/de-DE/DITA-Anwender-Bodensee/

https://twitter.com/thinkDITA

https://www.meetup.com/de-DE/DITA-Anwender-Bodensee/

Documents

TURN THE RIGHT KEYS AND CONTENT FALLS INTO PLACE…€¦ · 05/10/2017 · Title: Adobe DITA World 2017 - Magda Caloian - Turn the right keys and content falls into place Author: