dita — archive

[JoAnn Hackos]

 MHonArc v2.5.0b2 -->

























dita message






[Date Prev]
 | [Thread Prev]
 | [Thread Next]
 | [Date Next]

--

[Date Index]
 | [Thread Index]
 | [List Home]








Subject: RE: [dita] Keywords in DITA (example)




From: "JoAnn Hackos" <joann.hackos@comtech-serv.com>
To: "Esrig, Bruce \(Bruce\)" <esrig@lucent.com>,"Don Day" <dond@us.ibm.com>,"Paul Prescod" <paul.prescod@blastradius.com>
Date: Wed, 9 Mar 2005 12:53:43 -0700









I don' t understand the <term> element.  Can 
that now be used? Is there processing avialable?
 
JoAnn 
JoAnn T. Hackos, PhD
President
Comtech Services, 
Inc.
710 Kipling Street, Suite 400
Denver, CO 80215
303-232-7586
joann.hackos@comtech-serv.com
http://www.comtech-serv.com 
 




From: Esrig, Bruce (Bruce) 
[mailto:esrig@lucent.com]
Sent: Wednesday, March 09, 2005 12:40 
PM
To: JoAnn Hackos; Don Day; Paul Prescod
Cc: 
dita@lists.oasis-open.org
Subject: RE: [dita] Keywords in DITA 
(example)



Yes, a 
good example would help ... anyone want to buy a snow shovel (see example) 
?
 
Here 
goes,
 
Bruce
 
=============
 
First 
the hierarchy.
 
Keyword archetype.
  - 
keyword-as-description
      o existing 
keyword element, in the sense defined by HTML/Docbook
      o existing indexterm 
element
  
- keyword-as-content
      o 
wintitle
      o 
widgettype
      o 
widgetname
 
Now 
some markup.
 

<task id="snowShovelInventory-task" 
xml:lang="en-us">
<title>Checking the inventory of snow 
shovels</title>
<taskbody>
    <context><p>Check 
whether snow shovels are available before running out to buy 
one.</p></context>
    <steps>

    <p>The <wintitle>Inventory 
Window</wintitle>
    provides a count of items given 
the name of the item.

    The 
<widgetname>Item</widgetname> field contains the name of an 
item.
    The 
<widgetname>Count</widgetname> field states how many items with that 
name
    are in stock according to the 
inventory records.</p>
 
    <step><cmd>Access the 
<wintitle>Inventory 
Window</wintitle>.</cmd></step>
    <step><cmd>Enter 
<userinput>snow shovel</userinput> in the
                        
<widgetname>Item</widgetname> field and click on
                        
<widgetname>Update</widgetname>.</cmd></step>
    <step><cmd>Look at 
the <widgetname>Count</widgetname> field
                         
to find out how many snow shovels are in 
stock.</cmd></step>
    </steps>
</taskbody>
<related-links>
    <link 
href="../concepts/snowShovel.xml" format="xml" 
type="concept">
        <linktext>Snow 
shovel</linktext></link>

  
  <link href="../reference/inventoryWindow.xml" format="xml" 
type="reference">
       
 <linktext>Inventory 
window</linktext></link>
</related-links>
</task>
 
<concept id="snowShovel-concept" 
xml:lang="en-us">
<prolog><metadata>
    <keywords>
        
<keyword>snow</keyword>
        
<keyword>tool</keyword>
        
<indexterm>tools
             <indexterm>snow 
shovel</indexterm></indexterm>
    
</keywords></metadata></prolog>
<title>Snow 
shovel</title>
<conbody>
    <p>A <indexterm>snow 
shovel</indexterm> snow shovel is used to clear the driveway and 
sidewalk of snow in the winter.
    A good snow shovel 
has a straight, wide <term>scoop</term> and a strong 
<term>handle</term>.
  
  To help snow come off the scoop, spray the scoop with cooking 
spray.</p>

</conbody>
<related-links>

    <link 
href="../tasks/snowShovelInventory.xml" format="xml" 
type="task">
        <linktext>Snow 
shovel 
inventory</linktext></link>
</related-links>
</concept>
 
<reference 
id="inventoryWindow-reference" xml:lang="en-us">




<prolog><metadata>
    <keywords>

        
<indexterm>windows
             <indexterm>Inventory 
Window</indexterm></indexterm>

        
<indexterm>fields
             <indexterm>Item</indexterm></indexterm>

        
<indexterm>fields
             <indexterm>Count</indexterm></indexterm>
    
</keywords></metadata></prolog>
<title>Inventory window</title>
<refbody><refsyn>
    <p>The <wintitle>Inventory 
Window</wintitle>
    provides a count of items given 
the name of the item.

    The 
<widgetname>Item</widgetname> field contains the name of an 
item.
    The 
<widgetname>Count</widgetname> field states how many items with that 
name
    are in stock according to the 
inventory records.</p>

</refsyn></refbody>

</reference>