= How do I alter the DITA menucascade separator for a custom element?> =

== Description ==

We have added two custom elements to our DITA DTDS, privcascade, based
on menucascade, and privilege, based on uicontrol. We want the
privcascades to have a period as a separator, whereas menucascade uses
the > separator.

I added text to character.xsl to process the privcascades, but they
keep coming out with whatever separator is specified for menucascade.
I can change the separator for menucascade in the character.xsl file,
so I think this is the file that controls this behavior.

Any ideas how to get !WebWorks to apply a different separator for
privcascades?


<<TableOfContents>>

== Details ==

The class attributes are as follows:

  {{{
+ topic/ph ui-d/uicontrol vm-d/privilege
+ topic/ph ui-d/menucascade vm-d/privcascade
}}}

The text from character.xls is:

  {{{#!cplusplus
<xsl:template match="*[contains(@class, ' vm-d/privilege ')]" mode="wwmode:character-prefix">
  <xsl:param name="ParamNode" select="." />

  <xsl:if test="($ParamNode/parent::*[contains(@class,' vm-d/privcascade ')]) and ($ParamNode/preceding-sibling::*[contains(@class, ' vm-d/privilege ')])">
    <xsl:variable name="VarBaseID">
      <xsl:call-template name="Generate-ID">
        <xsl:with-param name="ParamNode" select="$ParamNode" />
      </xsl:call-template>
    </xsl:variable>

    <!-- Use period as separator for privcascades -->
    <wwdoc:TextRun id="{$VarBaseID}sep">
      <wwdoc:Text value="." />
    </wwdoc:TextRun>
  </xsl:if>
</xsl:template>


<xsl:template match="*[contains(@class, ' ui-d/uicontrol ')]" mode="wwmode:character-prefix">
  <xsl:param name="ParamNode" select="." />

  <xsl:if test="($ParamNode/parent::*[contains(@class,' ui-d/menucascade ')]) and ($ParamNode/preceding-sibling::*[contains(@class, ' ui-d/uicontrol ')])">
    <xsl:variable name="VarBaseID">
      <xsl:call-template name="Generate-ID">
        <xsl:with-param name="ParamNode" select="$ParamNode" />
      </xsl:call-template>
    </xsl:variable>

    <wwdoc:TextRun id="{$VarBaseID}sep">
      <wwdoc:Text value=" &gt; " />
    </wwdoc:TextRun>
  </xsl:if>
</xsl:template>
}}}

== Response ==

Reviewing the class attributes:

  {{{
+ topic/ph ui-d/uicontrol vm-d/privilege
+ topic/ph ui-d/menucascade vm-d/privcascade
}}}

and the XSL code:

  {{{#!cplusplus
<xsl:template match="*[contains(@class, ' vm-d/privilege ')]"
              mode="wwmode:character-prefix">
  <xsl:param name="ParamNode" select="." />

  <xsl:if test="($ParamNode/parent::*[contains(@class,' vm-d/privcascade ')]) and ($ParamNode/preceding-sibling::*[contains(@class, ' vm-d/privilege ')])">
...

<xsl:template match="*[contains(@class, ' ui-d/uicontrol ')]"
              mode="wwmode:character-prefix">
  <xsl:param name="ParamNode" select="." />

  <xsl:if test="($ParamNode/parent::*[contains(@class,' ui-d/menucascade ')]) and ($ParamNode/preceding-sibling::*[contains(@class, ' ui-d/uicontrol ')])">
...
}}}

It looks like you maybe wanted to combine these two templates into a single match against ' ui-d/uicontrol '.

  {{{#!cplusplus
<xsl:template match="*[contains(@class, ' ui-d/uicontrol ')]" mode="wwmode:character-prefix">
  <xsl:param name="ParamNode" select="." />

  <xsl:choose>
    <xsl:when test="($ParamNode/parent::*[contains(@class,' ui-d/menucascade ')]) and ($ParamNode/preceding-sibling::*[contains(@class, ' ui-d/uicontrol ')])">
      <xsl:variable name="VarBaseID">
        <xsl:call-template name="Generate-ID">
          <xsl:with-param name="ParamNode" select="$ParamNode" />
        </xsl:call-template>
      </xsl:variable>

      <wwdoc:TextRun id="{$VarBaseID}sep">
        <wwdoc:Text value=" &gt; " />
      </wwdoc:TextRun>
    </xsl:when>

    <xsl:when test="($ParamNode/parent::*[contains(@class,' vm-d/privcascade ')]) and ($ParamNode/preceding-sibling::*[contains(@class, ' vm-d/privilege ')])">
      <xsl:variable name="VarBaseID">
        <xsl:call-template name="Generate-ID">
          <xsl:with-param name="ParamNode" select="$ParamNode" />
        </xsl:call-template>
      </xsl:variable>

      <!-- Use period as separator for privcascades -->
      <wwdoc:TextRun id="{$VarBaseID}sep">
        <wwdoc:Text value="." />
      </wwdoc:TextRun>
    </xsl:when>
  </xsl:choose>
</xsl:template>
}}}

This is going to be very sensitive to your input DITA document structure.  Can you provide an example source snippet?

== Example XML ==

Example XML from Teresa:

  {{{#!cplusplus
<?xml version="1.0" encoding="UTF-16"?>
<!DOCTYPE task PUBLIC "-//VMWARE//DTD DITA Task//EN" "vmbase.dtd">
<task id="task_234B9121E3464C929CAEDFD9726B9B37">
  <title>Privilege</title>
  <shortdesc id="shortdesc_FB3D51318F964BA184C22869FCB9BCDE">
    This topic tests the appearance of the privilege element, a VMware DTD addition. My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
      <privilege>FirstPriv</privilege>
      <privilege>secondpriv</privilege>
      <privilege>thirdpriv</privilege>
      <privilege>fourthpriv</privilege>
      <privilege>fifthPriv</privilege>
      <privilege>6thpriv</privilege>
      <privilege>7th priv</privilege>
      <privilege>8th priv</privilege>
      <privilege>9th priv</privilege>
      <privilege>10th and final priv</privilege>
    </privcascade>
  </shortdesc>
  <taskbody>
    <prereq id="prereq_ED0EC891FE304EE58B3283B39AC320D3">
      <p id="p_1B504D7E562546ED9D4D0DC4577BD8A1">
        My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
          <privilege>FirstPriv</privilege>
          <privilege>secondpriv</privilege>
          <privilege>thirdpriv</privilege>
          <privilege>fourthpriv</privilege>
          <privilege>fifthPriv</privilege>
          <privilege>6thpriv</privilege>
          <privilege>7th priv</privilege>
          <privilege>8th priv</privilege>
          <privilege>9th priv</privilege>
          <privilege>10th and final priv</privilege>
        </privcascade>
      </p>
      <p id="p_790BC7B7BB254E538B19E00C867F8411">My prereq. </p>
    </prereq>
    <context id="context_38DBFDF82EC04DDE911AE836ECC8F6D4">
      <p id="p_986B8242D41341E7810788F609325162">
        My context. Privs in context. My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
          <privilege>FirstPriv</privilege>
          <privilege>secondpriv</privilege>
          <privilege>thirdpriv</privilege>
          <privilege>fourthpriv</privilege>
          <privilege>fifthPriv</privilege>
          <privilege>6thpriv</privilege>
          <privilege>7th priv</privilege>
          <privilege>8th priv</privilege>
          <privilege>9th priv</privilege>
          <privilege>10th and final priv</privilege>
        </privcascade>
      </p>
    </context>
    <steps id="steps_11F2401887CC4056BEF34AA72B0458BF">
      <step id="step_E9F5D1F79D6240EB9DE7F27343B8E300">
        <cmd>
          My step. Privs in step My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
            <privilege>FirstPriv</privilege>
            <privilege>secondpriv</privilege>
            <privilege>thirdpriv</privilege>
            <privilege>fourthpriv</privilege>
            <privilege>fifthPriv</privilege>
            <privilege>6thpriv</privilege>
            <privilege>7th priv</privilege>
            <privilege>8th priv</privilege>
            <privilege>9th priv</privilege>
            <privilege>10th and final priv</privilege>
          </privcascade>
        </cmd>
        <substeps id="substeps_C4C5226146C04CBDA38C7CAE8267AC7A">
          <substep id="substep_971B6A0FCA6E4A95866FF8A18C1A982A">
            <cmd>
              My substep. Privs in substep. My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
                <privilege>FirstPriv</privilege>
                <privilege>secondpriv</privilege>
                <privilege>thirdpriv</privilege>
                <privilege>fourthpriv</privilege>
                <privilege>fifthPriv</privilege>
                <privilege>6thpriv</privilege>
                <privilege>7th priv</privilege>
                <privilege>8th priv</privilege>
                <privilege>9th priv</privilege>
                <privilege>10th and final priv</privilege>
              </privcascade>
            </cmd>
            <info>
              substep info. My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
                <privilege>FirstPriv</privilege>
                <privilege>secondpriv</privilege>
                <privilege>thirdpriv</privilege>
                <privilege>fourthpriv</privilege>
                <privilege>fifthPriv</privilege>
                <privilege>6thpriv</privilege>
                <privilege>7th priv</privilege>
                <privilege>8th priv</privilege>
                <privilege>9th priv</privilege>
                <privilege>10th and final priv</privilege>
              </privcascade>
            </info>
            <stepresult>
              substep result. My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
                <privilege>FirstPriv</privilege>
                <privilege>secondpriv</privilege>
                <privilege>thirdpriv</privilege>
                <privilege>fourthpriv</privilege>
                <privilege>fifthPriv</privilege>
                <privilege>6thpriv</privilege>
                <privilege>7th priv</privilege>
                <privilege>8th priv</privilege>
                <privilege>9th priv</privilege>
                <privilege>10th and final priv</privilege>
              </privcascade>
            </stepresult>
          </substep>
        </substeps>
        <info>
          step info. My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
            <privilege>FirstPriv</privilege>
            <privilege>secondpriv</privilege>
            <privilege>thirdpriv</privilege>
            <privilege>fourthpriv</privilege>
            <privilege>fifthPriv</privilege>
            <privilege>6thpriv</privilege>
            <privilege>7th priv</privilege>
            <privilege>8th priv</privilege>
            <privilege>9th priv</privilege>
            <privilege>10th and final priv</privilege>
          </privcascade>
        </info>
        <stepxmp>
          step example. My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
            <privilege>FirstPriv</privilege>
            <privilege>secondpriv</privilege>
            <privilege>thirdpriv</privilege>
            <privilege>fourthpriv</privilege>
            <privilege>fifthPriv</privilege>
            <privilege>6thpriv</privilege>
            <privilege>7th priv</privilege>
            <privilege>8th priv</privilege>
            <privilege>9th priv</privilege>
            <privilege>10th and final priv</privilege>
          </privcascade>
        </stepxmp>
        <stepresult>
          Step result. Privs in step result. My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
            <privilege>FirstPriv</privilege>
            <privilege>secondpriv</privilege>
            <privilege>thirdpriv</privilege>
            <privilege>fourthpriv</privilege>
            <privilege>fifthPriv</privilege>
            <privilege>6thpriv</privilege>
            <privilege>7th priv</privilege>
            <privilege>8th priv</privilege>
            <privilege>9th priv</privilege>
            <privilege>10th and final priv</privilege>
          </privcascade>
        </stepresult>
      </step>
    </steps>
    <result id="result_EAF10472326D492293CD55D5E2262D17">
      <p id="p_EF24751196C743669A8048C49225042E">
        My task result. My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
          <privilege>FirstPriv</privilege>
          <privilege>secondpriv</privilege>
          <privilege>thirdpriv</privilege>
          <privilege>fourthpriv</privilege>
          <privilege>fifthPriv</privilege>
          <privilege>6thpriv</privilege>
          <privilege>7th priv</privilege>
          <privilege>8th priv</privilege>
          <privilege>9th priv</privilege>
          <privilege>10th and final priv</privilege>
        </privcascade>
      </p>
    </result>
    <example id="example_5855756EAA19495A9D89D5DEE2E5F95B">
      <title>My Example</title>Privs in example. My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
        <privilege>FirstPriv</privilege>
        <privilege>secondpriv</privilege>
        <privilege>thirdpriv</privilege>
        <privilege>fourthpriv</privilege>
        <privilege>fifthPriv</privilege>
        <privilege>6thpriv</privilege>
        <privilege>7th priv</privilege>
        <privilege>8th priv</privilege>
        <privilege>9th priv</privilege>
        <privilege>10th and final priv</privilege>
      </privcascade>
    </example>
    <postreq id="postreq_98718917D2D9420A84900FD40BE496E1">
      <p id="p_B10564619848475C9A0C6DCCA7F3A56C">
        My post req. My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
          <privilege>FirstPriv</privilege>
          <privilege>secondpriv</privilege>
          <privilege>thirdpriv</privilege>
          <privilege>fourthpriv</privilege>
          <privilege>fifthPriv</privilege>
          <privilege>6thpriv</privilege>
          <privilege>7th priv</privilege>
          <privilege>8th priv</privilege>
          <privilege>9th priv</privilege>
          <privilege>10th and final priv</privilege>
        </privcascade>
      </p>
    </postreq>
  </taskbody>
</task>
}}}

== Simplified Example XML ==

Here's the smallest possible example of what we're trying to match against:

  {{{#!cplusplus
<p id="p_1B504D7E562546ED9D4D0DC4577BD8A1">
  My single priv: <privilege>My single priv</privilege>. My priv cascade: <privcascade>
    <privilege>FirstPriv</privilege>
    <privilege>secondpriv</privilege>
    <privilege>thirdpriv</privilege>
    <privilege>fourthpriv</privilege>
    <privilege>fifthPriv</privilege>
    <privilege>6thpriv</privilege>
    <privilege>7th priv</privilege>
    <privilege>8th priv</privilege>
    <privilege>9th priv</privilege>
    <privilege>10th and final priv</privilege>
  </privcascade>
</p>
}}}

Okay, so reviewing the class definition:

  {{{
+ topic/ph ui-d/uicontrol vm-d/privilege
}}}

and the match expressions:

  {{{
<xsl:template match="*[contains(@class, ' vm-d/privilege ')]" mode="wwmode:character-prefix">
  ...

<xsl:template match="*[contains(@class, ' ui-d/uicontrol ')]" mode="wwmode:character-prefix">
  ...
}}}

This is occurring because XSL is giving priority to the last match with the same priority.  In this case, these two match expressions have the same "complexity", so they receive the same match priority.  From there, the last match wins.

So, you can either move your ' vm-d/privilege ' match after your ' ui-d/uicontrol ' match or set explicit priority attributes on the match templates.

== Aside ==

This problem can also be solved/addressed in the '''default.wwconfig''' by using similar match expressions and emitting '''<wwdoc:Number>''' segments for these different class types.