re: Implementing a glossary

Subject: re: Implementing a glossary
From: Sean Hower <hokumhome -at- freehomepage -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 2 Nov 2005 07:07:14 -0800 (PST)



> I'm currently compiling a glossary to accompany
> our next software release. Once we have the
> content gathered, I need to figure out how to get
> this information out to the user.
> 1. There is no user guide.
> 2. There is a feature guide and a dev guide.
> 3. The content is context sensitive.
> 4. Project size.

This sounds like a job for XML! Because you are dealing with context-sensitive content that will be accessed by users who are already working online, you should be able to use login or other user information to filter an XML-based glossary similar to the one that I have on my Web site:

http://hokum.freehomepage.com/Content/Glossary/XMLGloss.html

This uses XML, XSL, JavaScript, and HTML. All definitions are located in a single XML file and the JavaScript filters out and displays selected definitions based on the glossary you click. There are even a handful of "duplicate" terms that have different definitions depending on which glossary you're viewing. You might consider something similar--filtering on the context instead.




********************************************
Sean Hower - tech writer
http://hokum.freehomepage.com


_____________________________________________________________
Create your own web site for FREE at http://www.freehomepage.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Try WebWorks ePublisher Pro for Word today! Smooth migration of legacy
RoboHelp content into your new Help systems. EContent Magazine Decision-
maker review (October 2005) is here: http://www.webworks.com/techwr-l

Doc-To-Help 2005 converts RoboHelp files with one click. Author with Word or any HTML editor. Visit our site to see a conversion demo movie and learn more. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: DITA, XMetaL and FrameMaker Together ???
Next by Author: starting an open source project on SourceForge
Previous by Thread: Implementing a glossary
Next by Thread: RE: Implementing a glossary


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads