OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

docbook message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Repeatable segmentedlist?


The product we are documenting is an old command-driven application with a
GUI added on top.  Whenever we provide instructions to the user, we try to
provide both the relevant command and the menupaths through the GUI.  We
have hundreds, if not thousands, of instructions like the following:

"From within the ANSYS program, you can use either of the following:
Command(s):
    /FILNAME
GUI:
    Utility Menu> File> Change Jobname"

Each command can potentially have several menupaths, and many of these
"lists" document several commands at once.  So we also have:

Command(s):
    CMD1
GUI:
    Path1.1
    Path1.2
    Path1.3
Command(s):
    CMD2
GUI:
    Path 2.1
    Path 2.2

Right now, we've been tagging these as <variablelist>:

<variablelist>
 <varlistentry><term>Command(s):</term><listitem><para><command>/FILNAME
</command></para></listitem></varlistentry>
 <varlistentry><term>GUI:</term><listitem><para><guimenu>etc.
</guimenu></para></listitem></varlistentry>

It would be nice if we could use <segmentedlist> instead of <variablelist>
and set up a "master" <segmentedlist> that includes the segtitles, and all
other lists of this type pull the segtitles from that list, as in:

<segmentedlist id="commands_gui">
  <segtitle>Command(s)</segtitle>
  <segtitle>GUI</segtitle>
  <seglistitem>...</seglistitem>
  <seglistitem>...</seglistitem>
</segmentedlist>

<segmentedlist segtitleref="commands_gui">
  <seglistitem>
    <seg><command>/FILNAME</command></seg>
    <seg><guimenu>Utility Menu&gt; File&gt; Change Jobname</guimenu></seg>
  </seglistitem>
</segmentedlist>

As I see it, this is a relatively minor DTD change (add the 'segtitleref'
attribute, make segitle optional) and it makes the <segmentedlist> much more
useful.  Does anybody have any thoughts on this matter, or any suggestions
on other ways I could more easily mark up this sort of repeating pattern?

Jeff Beal
Tools Specialist
ANSYS, Inc.
(724) 514-3150


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]