TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Re: Poll: How do you differentiate commands, etc. in text?
Subject:Re: Poll: How do you differentiate commands, etc. in text? From:"Yves Barbion" <yves -dot- barbion -at- gmail -dot- com> To:"Diana Ost" <Diana -dot- Ost -at- msmcorp -dot- com> Date:Thu, 29 Jun 2006 11:46:56 +0200
If you are already using Information Mapping (IMAP), and maybe XML, you may
want to move to the Darwin Information Typing Architecture (DITA). The DITA
content model and DTD's have all the domain elements you need for this
purpose.
One example is the element named <uicontrol>. The (excellent) DITA reference
says the following about the usage of the <uicontrol> element:
"uicontrol
The user interface control (<uicontrol>) element represents a button, entry
field, menu item, or other object that allows the user to control the
interface. This could also include a menu or dialog. For example, use the <
uicontrol> element inside a <menucascade> element when the menu item is
nested, such as *File* --> *New* . This element is part of the DITA user
interface domain, a special set of DITA elements designed to document user
interface tasks, concepts and reference information.
*Example*
Press the *<uicontrol>*OK*</uicontrol>* button."
And DITA has many more of these domain elements, like: command name
(<cmdname>), user input (<userinput>), system output (<systemoutput>),
window title <wintitle>, shortcut, screen, ...
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList