Pages: 1
Print
Author Topic: Menucascade in the Short Description of a Task  (Read 4589 times)
kwag_myers
Member

Posts: 69


« on: November 11, 2010, 11:20:31 AM »

When I use the <menucascade> tag in the Short Description of a task topic the formatting doesn't carry into the Child Topic list. The "space>space" is omitted so that the UI Controls have no spacing in between.

Example: "Go to <menucascade><uicontrol>Tools</uicontrol><uicontrol>Options</uicontrol></menucascade> for this task." appears as "Go to ToolsOptions for this task."

Any known fixes?
Logged

XMetaL 6 Author in Windows 7 Home Premium
Derek Read
Program Manager (XMetaL)
Administrator
Member

Posts: 2621



WWW
« Reply #1 on: November 12, 2010, 01:48:59 PM »

I don't see this issue running XMetaL Author Enterprise 6.0.1.030. See screenshot of my editing views which uses your exact XML snippet. I've circled what I think are the spaces you are having issues with (?)

Worst case scenario that I can think of is that you have some other version that uses slightly different CSS for styling these views (which could be tweaked).

But perhaps you talking about something different? I'm not sure what you mean by this: "the formatting doesn't carry into the Child Topic list".

Perhaps it is best to include a sample file and maybe a screenshot pointing out exactly what you don't like.


* menuCascade.jpg (106.3 KB, 976x685 - viewed 625 times.)
Logged
kwag_myers
Member

Posts: 69


« Reply #2 on: November 15, 2010, 06:48:58 AM »

By "Child Topic List" I'm referring to the Web Output deliverable, which has a list of child topics and parent topics at the bottom of each topic (when applicable). Looking at the frame source of the HTML I see it tagged as:

<div>
<ul class="ullinks">
<li class="ulchildlink">

The <menucascade> appears correctly everywhere but the "class="ullinks", where the <span class="menucascade"><span class="uicontrol">Tools</span> &gt; <span class="uicontrol">... is missing.
Logged

XMetaL 6 Author in Windows 7 Home Premium
Derek Read
Program Manager (XMetaL)
Administrator
Member

Posts: 2621



WWW
« Reply #3 on: November 15, 2010, 12:24:49 PM »

I finally figured out what you're doing...

This seems to be a very specific issue inherent to the XHTML output produced by the DITA OT. All of the other formats that use that output, ie: anything that includes HTML as the primary content, including 'Multiple HTML', 'HTML Help (CHM)', 'WebHelp', 'Eclipse Content', 'Eclipse Help', 'JavaHelp', etc, will therefore inherit this same issue.

I can reproduce this with the following setup:

1. A map with this structure (the important part is that the task1.xml is referenced inside a nested topicref):
<map "map_1"><title>test map</title>
  <topicref format="dita" href="topic1.xml" navtitle="topic 1" scope="local">
    <topicref format="dita" href="task1.xml" navtitle="task 1" scope="local"/>
  </topicref>
</map>


2. The file task1.xml needs the following content in <shortdesc>:
<task id="task_1">
  <title>task 1</title>
  <shortdesc>Go to <menucascade><uicontrol>Tools</uicontrol><uicontrol>Options</uicontrol></menucascade> for this task.</shortdesc>
  <taskbody>
    <steps id="steps_1"><step id="step_1"><cmd>this is step 1</cmd></step></steps>
  </taskbody>
</task>


3. Generate output to any format that uses XHTML (as listed above).

4. Open the output file corresponding to topic1.xml (ie: topic1.html) it will contain the content from the <shortdesc> of task1.xml inside a section listing links related to this file, but it will not have been processed to include the separator text " > " between each of the <uicontrol> elements and so that content will appear to run together in the output.

Actual HTML Output:
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="task1.html">task 1</a></strong><br />
Go to ToolsOptions for this task.</li>
</ul>
</div>


Desired HTML Output:
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="task1.html">task 1</a></strong><br />
<span class="menucascade"><span class="uicontrol">Tools</span> &gt; <span class="uicontrol">Options</span></span> for this task.</li>
</ul>
</div>


Note that PDF outputs do handle this structure, so that tells me this is not done as part of the "topic merge" that the DITA Open Toolkit does, it occurs after that during the transformation to HTML (vs FO for PDF).

From what I can tell the DITA OT was simply not designed to take this into account for XHTML-based outputs. Extra processing will probably need to be added to discover this structure inside the <shortdesc> element and format it correctly for output.

If all browsers supported CSS "generated content" (using the pseudo-element ":before" and ":after" together with the "content" property) then there might be a simple CSS fix for this. However, I wouldn't consider such a CSS fix a "true" fix anyway as most people would probably prefer this text to "really be there" rather than included as generated text using CSS rules. The point is fairly mute anyway as at this point I don't believe many browsers have support for this type of CSS, so to really fix this I think the text needs to really be injected in there by the DITA OT.

I would suggest filing a bug with the DITA Open Toolkit Project here:
https://sourceforge.net/tracker/?group_id=132728&atid=725074

From what I can tell nobody has reported this issue yet. Searching for "uicontrol" turns up one unrelated issue there.

When you file this with the DITA OT project I would submit it in reference to the "XHTML transtype" which is the same as the "Multiple HTML" output in XMetaL (because the DITA OT itself does not include "WebHelp").
Logged
kwag_myers
Member

Posts: 69


« Reply #4 on: November 16, 2010, 07:12:42 AM »

Thanks. I want to do some experimentation before I submit a ticket. I seem to recall other tags not carrying over here (from another project). Just to satisfy my own curiosity.

For my current project, I took an inventory and found there were very few topics with this issue, so I just revised them by putting the "Go to..." as a prereq. Probably where it belongs anyway.
Logged

XMetaL 6 Author in Windows 7 Home Premium
kwag_myers
Member

Posts: 69


« Reply #5 on: November 22, 2010, 07:01:48 AM »

I would suggest filing a bug with the DITA Open Toolkit Project here:
https://sourceforge.net/tracker/?group_id=132728&atid=725074
I'm not getting along with the registration process, so I can't report this. I'll just stick with my work-around.
Logged

XMetaL 6 Author in Windows 7 Home Premium
Pages: 1
Print
Jump to: