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.
Subject:RE: Annotating HTML - Edit From:"Partridge, Robert" <Robert -dot- Partridge -at- au -dot- unisys -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 28 Mar 2006 12:52:37 +1000
Hi Jeff,
If what Bonnie says is true, then I've seen many examples of annotated
code where the HTML itself is split into small sections. These are often
separated from the text of the document by putting them in grey boxes or
somesuch, then the paragraphs describing the HTML surround them. The
code is sometimes repeated at the end of the description or in an
appendix to get the uninterrupted version. So... The code itself isn't
annotated, it's just put into meaningful chunks. You often see this kind
of thing on web sites describing HTML. You might get some ideas from
tutorial sites like www.webmonkey.com.
Rob
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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