Adding a heading to the steps element in a DITA topic

Report · Jan 16, 2010

Hello Framers,

I've been using unstructured FM for years, but I've only just started looking into structured FM. I am currently trying to adjust the sample DITA application that comes with FM 9 to our requirements. In the DITA task topic, the sample application adds frames from a reference page above and below the steps element. Both frames contain a line to visually separate the steps element from other elements in the topic. The upper frame also contains a heading for that element.

I don't like this approach at all. First of all, I don't want translatable text on the reference page. In addition, the heading should go to the side-head area. The EDD contains the following rules for the steps element:

Automatic insertions
Automatically insert child: step
    and nested child: cmd
Format rules for first paragraph in element
In all contexts.
    Use paragraph format: step.begin
Format rules for last paragraph in element
In all contexts.
    Basic properties
      Paragraph spacing
        Change space below by: +6pt
      Pagination properties
        Keep with previous: Yes
      Advanced properties
        Frame below element: StepsEnd

I was thinking about adding a prefix to the steps element, but in this case, the prefix is formatted as the first step with the step.begin paragraph style. Is it possible to define a formatting rule for the second paragraph in an element?

Thank you for any help

Susanne

Report · Jan 18, 2010

Hi Susanne,

There is not a way to specify formatting for a second paragraph. I'm not terribly familiar with the DITA app, though, so maybe there is an alternative that I'm not aware of.

Russ

Report · Jan 18, 2010

Susanne,

If you want the heading to be in the side head, then I think you do not want to use a prefix; one cannot set the prefix of a paragraph to be in the side head because the side head is a paragraph in itself. My guess is you should try to find an element BEFORE the steps element to hold the heading content. Like Russ, I am not that familiar with the DITA structure.

ON THE OTHER HAND, having said the above, I think there may be a way to do it with a prefix. Set the prefix of the first paragraph in the steps element, that is the first step, to the heading content and be sure to follow that content with a tab (I think it is /t). Then edit the step.begin paragraph format to spread across all columns, adjusting the indents so that the second line is NOT in the side head. But I am not sure what will happen with the numbering relative to the prefix. You may have to play around, or use another approach as suggested in the first paragraph.

Good luck,

Van

Report · Jan 20, 2010

So far no luck. Both options I tested solve one problem, but cause another one.

The manual says: "If a paragraph element with an autonumber also has a prefix or suffix, the prefix appears just after

the autonumber at the beginning of the paragraph." Therefore, if I add a prefix to the first step and work with a tab in the corresponding paragraph format, my prefix is numbered, but my first step has no number.

Adding a prefix to the entire steps element using before puts the prefix into a separate paragraph that is formatted correctly. But in this case my first step receives the same paragraph format as the subsequent steps. I would need to address the second paragraph which doesn't seem to be possible.

Any other ideas?

Report · Jan 21, 2010

Maybe it is time to rethink what you need to do.

Just because FrameMaker ships DITA with styles that put a frame above and below the steps element, does not mean that you have to do it also. You can delete it from the EDD.

If you need your steps to have a heading, then use the heading (or title) element in one of the containing elements higher up the hierarchy, such as the taskbody. I do not use DITA but my structure has a procedure element that is something like:

Procedure

Title

Intro

Step

.

The Title element contains the title or heading or the procedure. The Intro element contains introductory material for the procedure. Typically, the title is in the side head, which aligns with the first paragraph in the Intro. If there is no Intro element, then the title aligns with first Step element. This structure is simpler than the standard DITA structure, but my point is that the title of your procedure (or steps) need not be part of the steps element itself; my guess is that the DITA structure has a place for it higher up the hierarchy.

Report · Jan 23, 2010

It seems that what I want is forbidden in DITA 1.1, but will be allowed in DITA 1.2. See http://dita.xml.org/sites/dita.xml.org/files/Hackos-DITA-Europe-2009.pdf. I will probably have to wait a little while, but the new specification seems to be almost finished. So I will ignore the problem for now and wait until I know exactly what the new rules fot the steps element look like.