Skip to main content
mattl84896954
Known Participant
Jul 3, 2018 4:21 PM UTC
Answered

Hazard Statement with Framemaker DITA

I am looking at using the Hazard Statement elements as part of the DITA framework. I like the idea of assigning the applicable attribute type (danger, caution, warning) and having the banner change automatically. For example, when you chose type: danger, it pulls up a red banner with a warning symbol.

Here is my question, where and how to I change how this banner looks? I like the idea of having the banner populate by simply assigning the type attribute, but I would like to change the color, symbol and placement of text. I can't for the life of my figure out where Framemaker keeps or pulls this graphic from.

I know I could use the hazardsymbol element and insert my own symbol, but this takes away from the functionality of having DITA "lock down" which symbol goes with which type of hazard statement.

Please see attached example.

This topic is closed to new replies. Start a new post to keep the conversation going.
vinayakrishnabhat
vinayakrishnabhatCorrect answer
Inspiring
Jul 18, 2018 4:19 AM UTC

Wow, that is nested - but found it! We currently do have a separate set of templates in a Mercurial versioning system.

One last question and I think I can call this thread "answered". Do I have to update the Reference page for each .FM file?

Here would be the list:

  • concept.template.fm
  • ditabase.template.fm
  • generalTask.template.fm
  • glossentry.template.fm
  • glossgroup.template.fm
  • map.template.fm
  • reference.template.fm
  • task.template.fm
  • topic.template.fm

It's not the end of the world - could always copy and paste, but might as well as if Reference Pages can be shared/linked.


Depends on your requirement. If you are going to use all of these XML types, then it is better to configure all template files. If you are just going to use concept and task (where the warnings are normally used), then you can configure only these files. Proceed as per your requirement.

Thanks,

Vinay

18 replies

mattl84896954
Known Participant
Jul 20, 2018 9:17 PM UTC

I think I'm ready to throw in the towel with trying to create customized Hazard Statement objects.

While I know where to create/edit Reference Page items, when I try to use a them (in this case a the graphic), I get the message "Cannot display some imported graphics. The images will appear as a gray box."

This only shows when I try to create a topic based on the Template File. I tried both SVG and JPG.

Very frustrating!

Translate
ScottPrentice
Inspiring
Jul 20, 2018 9:24 PM UTC

Hi Matti...

Not trying to push my tool (DITA-FMx), but did want to mention that with the last update I added some very cool support for hazardstatement authoring and publishing. I worked with some customers to make sure it was actually useful and usable. It's not trivial to switch to DITA-FMx, but it'll give you nice hazardstatement support plus many other nice features. Here's the documentation on the new feature ..

     http://docs.leximation.com/dita-fmx/2.0/?ditafmx_hazardstatements.html

Cheers,

...scott

Translate
mattl84896954
Known Participant
Jul 20, 2018 9:30 PM UTC

Hi Scott,

Appreciate it! I'd love to try out DITA-FMx, but I was hoping I could get it to work within just FrameMaker, even if only in one topic. I could then demonstrate to stakeholders that there are efficiencies in using both this element and maybe your plugin. I'll read up on your documentation! Cheers.

Translate
Jul 14, 2018 10:09 AM UTC

Take a look at the reference pages.

Translate
mattl84896954
Known Participant
Jul 16, 2018 4:07 PM UTC

OMG thank you! I can't believe I could not find any documentation about Reference Pages. This should be what I need.

For some reason when I make changes to the Reference Page in document the changes don't stay after I save. I suspect this page resides in a linked template file somewhere.

Translate
vinayakrishnabhat
Inspiring
Jul 17, 2018 12:42 PM UTC

Hi Matt,

Yes, you have to change the reference page in the templates located in the Framemaker structure folder of C drive. For example, for FM 2017 version, the templates are located at:

C:\Program Files (x86)\Adobe\Adobe FrameMaker 2017\Structure\xml\DITA_1.2\app\technicalContent\template

The path may vary based on the versions. Before making any changes to these template files, make sure you take a backup of the original files.

Translate