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.
Below is an extract from some programmer-written documentation that I am
assigned to clean up. Notice that at the end of the third line it says
" and '<' for greater than". Yes, it uses the lessthan sign for greater
than. In defense of my colleague this is from the Java message spec.
He did not implement it this way.
What I've done is insert a footnote saying "This is not a misprint. '<'
really does mean 'greater than' here. See [URL to java documentation
page]
Is this the best way? I don't want to break the example flow, but I
don't want to lose the information or have people either miss it or
write it up as a bug in the documentation. I think a footnote works
well. What do you think?
Thanks,
Jessica Weissman
*****************************
The detail part of the choice type element contains a list of choices
separated by the pipe ( | ) character. Each choice consists of a
number, an equality operator (which may be '#' for equals and '<' for
greater than), and a format string.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-