Skip to main content
Participant
January 9, 2020
Question

single-sourcing with automatic importing

  • January 9, 2020
  • 3 replies
  • 1084 views

(also posted to techshoret)

 

My apologies if I'm asking something trivial. I haven't used FrameMaker for a while and am not yet familiar with the most recent versions.

 

Problem statement: We have a User's Guide for a product that has multiple (~15) different flavors so we have that many guides. I would like to unify them into one guide with conditional text.

The basic format is the same for all flavors. The main difference lies in sections containing lists of parameters and their values; these change with each milestone of a flavor.

Whenever a product is built, the build process generates the relevant lists. These are then manually copied into the document for the specific flavor (a rather painful process). Each "flavor" requires several builds in the course of a year, so the tech writer needs to do all this around 50-60 times.

 

Engineering will provide me the information in whatever format I want (or so they say), and will place it in a drive that I can access. My plan is to import the data (File > Import > Object > Create from File) and link it so that when they change the data, it will be automatically updated in the Frame file.

 

What format should I ask for, and are there any tips on how to perform the import automatically?

I've tried importing from Word and Excel, but find it hard to implement the required fonts, sizes, etc. without having to edit the data afterwards.

 

Thanks!

 

Benzi

This topic has been closed for replies.

3 replies

Community Expert
January 10, 2020

Hi Rick,

 

Could I also assign paragraph formats for specific elements automatically? Or even tables?

How would I do this?

 

Best regards

 

Winfried

frameexpert
Community Expert
Community Expert
January 10, 2020

Hi Winfried,

 

In structured templates, you use the EDD (Element Definition Document) to apply formats based on element/attribute combinations. The whole EDD feature is pretty powerful in my opinion.

 

Rick

www.frameexpert.com
Community Expert
January 10, 2020

Hi Rick,

 

OK. I did not know that I could use the EDD for this.

When I have an unstructured file into which I import the XML as text inset, where is the location of the EDD stored?

I assume not in the XML file.

 

Best regards

 

Winfried

frameexpert
Community Expert
Community Expert
January 10, 2020

For things like parameter lists, etc., I prefer to get XML from the engineers. I create a structured FrameMaker template and possibly some XSLT stylesheets so I can ingest the content directly into FrameMaker. It doesn't matter if the rest of the FrameMaker content is unstructured; you can have a mix of structured and unstructured documents in your book. Or, you can simply remove the structure from the converted documents.

 

If you are interested in exploring this idea, please contact me offlist and I will be glad to take a look at what you have. There would be no cost to a first meeting. Thanks. rick at frameexpert dot com

www.frameexpert.com
Legend
January 10, 2020

Exactly. This sounds like a classic case for the import of XML-formatted data snippets. FrameMaker is built for this type of thing. It will require some customization, but it sounds like the return on investment would be quite rich.

 

Russ

Legend
January 10, 2020

I may be missing something significant about your process … but if it's a question of regularly updating text insets, and if these insets do not use tables or character-level formatting, have you considered mml? I've just run a very quick test that confirms I can use File > Insert file [by reference] to pull in an .mml file the same way as I'd usually pull in an .fm file. The tagged plain-text formatting ought to simple enough to generate, and because .mml includes style names you shouldn't need to do manual tweaking afterwards. [there's one limitation, though: .mml can only handle Bold and Italic. You can run find/replace on these afterwards, of course] And if you don't need to keep versions, you can just update each .mml file when required; next time you open the FrameMaker files, the insets will be updated.

Feel free to message me if you have questions. Big disclaimer, though – I'm still stuck on FM12, with no idea whether this old-style approach is available in more recent versions.