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: API layout/presentation for XML API reference guide
Subject:RE: API layout/presentation for XML API reference guide From:Matthew Horn <mhorn -at- macromedia -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 4 Feb 2003 11:50:51 -0500
>>My primary goal is to present the XML schemas, etc.
One idea that we use is to output the schema doc in an HTML page using a tool like XML Spy. You can get a free trial and check it out for yourself. The document uses DHTML to allow dynamic linking between elements, properties, and subelements.
HTH,
Matthew J. Horn
Sr. Technical Writer
< m a c r o m e d i a >
-----Original Message-----
From: Pyle, Suzanne
To: TECHWR-L
Sent: 2/3/2003 9:51 AM
Subject: API layout/presentation for XML API reference guide
Does anyone have some suggestions for effectively putting together an
API
reference guide for XML? Would you present the material pretty much the
way
you might document Java APIs or some other language? I've been trying to
find good samples but haven't been able to find anything. My primary
goal is
to present the XML schemas, etc. in an efficient manner that will make
searching for components, etc. pretty easy. Any ideas are much
appreciated!
Buy or upgrade to RoboHelp X3 today and receive the WebHelp
Merge Module for FREE ($299 value). RoboHelp X3's all-new
features include conditional text, completely re-engineered
printed documentation output, Context-sensitive Help Toolkit,
single-source layouts, and more!
Order online today at http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
