RE: [Short] XML in Documentation

Subject: RE: [Short] XML in Documentation
From: "Sean Wheller" <swheller -at- bigpond -dot- net -dot- au>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 31 Jan 2003 10:53:04 +1100


Hello Manoj,

If you want to get started with learning XML with a view toward using it as
a technology for documenting, may I suggest the following links.

http://www.w3schools.com/ This will give you a brief introduction to XML.
Take the time to read the other sections like HTML and CSS, they also have
baring on your learning curve.

http://www.docbook.org/ DocBook is the most widely adopted DTD for XML
Authoring systems. It's also managed by OASIS, so has the advantage of being
stable (http://www.oasis-open.org/)

http://www.w3c.org No introduction to XML is complete without a visit to the
W3C.

Other industry standards you may want to visit, include:

DITA (Darwin Information Typing Architecture)
(http://www-106.ibm.com/developerworks/xml/library/x-dita1/index.html)

DTD for GCA XML Conference Proceedings created by IDEAlliance
(http://www.idealliance.org/)

NCAXML (National Coffee Association)
(http://www.ncausa.org/public/pages/index.cfm?pageid=237)

NewsML
(http://www.iptc.org/site/NewsML/)

NITF (News Industry Text Format)
(http://www.nitf.org/)

P3P (Platform for Privacy Preferences)
(http://www.w3c.org/P3P/) Also part of W3C.

RIXML (Research Information eXchange Markup Language)
(http://www.rixml.org/index.html)

TEI (Text Encoding Initiative)
(http://www.tei-c.org/)

USPTO Red Book
(http://www.uspto.gov/web/offices/ac/ido/oeip/sgml/st32/redbook/index.html)

XMLresume
(http://xmlresume.sourceforge.net/) A cool way to create your resume in XML.

HR-XML
(http://www.hr-xml.org) Again a nice way to create your resume in XML.

That's a start.

As for tools:

I like to use oxygen. (http://www.oxygenxml.com)

But there are also others EPIC, XXE, XMetal and more. These are the most
popular for WinOS users. If you like *NIX, and can use Emacs then Emacs
+psgmls is simply excellento. Next VIM. You may also try Kate as KDE doe
have some plug-ins that enable Kate as a structured markup editor. I still
prefer to use Oxygen.

Transformation is another subject. You want to decide on the best tool chain
for your purposes. Then install the parts as required. Visit DocBook.org to
get the picture. You may also visit Norman Walshes Web Site
http://www.nwalsh.com.

In general, I think that XML Authoring is most definitely the way to go.
SGML IS DEAD, leave it well alone. Installation and setup on WinOS is not
all that easy, so have patience. If you are on Linux you will find it much
easier, most of the Linux distributions already ship, in part or whole, the
components you need to get running.

Happy coding, stay tuned.

Sean Wheller



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Help Authoring Seminar 2003, coming soon to a city near you! Attend this
educational and affordable one-day seminar covering existing and emerging
trends in Help authoring technology. See http://www.ehelp.com/techwr-l2.

A new book on Single Sourcing has been released by William Andrew
Publishing: _Single Sourcing: Building Modular Documentation_
is now available at: http://www.williamandrew.com/titles/1491.html.

---
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.



References:
[Short] XML in Documentation: From: Bokil, Manoj

Previous by Author: Re: Formatting of Simplified Chinese & Traditional Chinese
Next by Author: User Guide, User Manual & Help System
Previous by Thread: RE: [Short] XML in Documentation
Next by Thread: FW: [Short] XML in Documentation


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


Sponsored Ads