|
|
 | | From: | Mark Lewin | | Subject: | XML/DocBook for newbies | | Date: | Thu, 20 Jan 2005 17:51:16 +0000 |
|
|
 |
Hi all
We're just about to start on a big new round of documentation and
because it might end up in several different formats, I have suggested
going down the XML route. Brave (silly?) of me, because I know very
little about using XML to write technical manuals. But hey -- it will
be good for my career, I keep telling myself.
So now I've got to get up to speed quickly. All I know is that I need
to choose a DTD, a CSS and some form of editor that can work with
them. Can anyone suggest any free/open source tools? And maybe some
good online or printed resources?
Thanks,
Mark
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l
Technical Communication Certificate online - Malaspina-University College, Canada. Online training in technical writing, software (FrameMaker, RoboHelp, Dreamweaver, Acrobat), document & web design, writing manuals, job search. www.pr.mala.bc.ca/tech_comm.htm for details.
---
You are currently subscribed to techwr-l as:
techwr-l@gts.org
To unsubscribe send a blank email to leave-techwr-l-185178C@lists.techwr-l.com
Send administrative questions to lisa@techwr-l.com. Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
|
|
| | From: | Bill Trippe | | Subject: | RE: XML/DocBook for newbies | | Date: | Thu, 20 Jan 2005 14:50:47 -0500 |
|
|
|
Hi Mark
On Thursday, January 20, 2005 12:51 PM Mark Lewin wrote
| Hi all
|
| We're just about to start on a big new round of documentation and
| because it might end up in several different formats, I have suggested
| going down the XML route. Brave (silly?) of me, because I know very
| little about using XML to write technical manuals. But hey -- it will
| be good for my career, I keep telling myself.
|
| So now I've got to get up to speed quickly. All I know is that I need
| to choose a DTD, a CSS and some form of editor that can work with
| them. Can anyone suggest any free/open source tools? And maybe some
| good online or printed resources?
|
I would also suggest you look at DITA, the Darwin Information Typing
Architecture.
A couple of good starting points:
http://xml.coverpages.org/dita.html
http://www-106.ibm.com/developerworks/xml/library/x-dita1/
You could also look at a high-level white paper I wrote on this (free, no
registration required):
http://www.gilbane.com/whitepapers.pl?view=13
A number of the XML vendors have announced DITA support, including ArborText
and XMetal, and it appears that some folks have put together a FrameMaker
EDD as well.
One brief technical point: you are right that you need to choose some sort
of style sheet mechanism to go from any XML to, say, print or HTML. It does
not have to be CSS though. People are using XSLT and XSL-FO stylesheets, as
well as proprietary print engines. Some of the XML editors, like ArborText,
have their own technology for going to print and other output formats.
Hope this helps!
Bill
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l
Technical Communication Certificate online - Malaspina-University College, Canada. Online training in technical writing, software (FrameMaker, RoboHelp, Dreamweaver, Acrobat), document & web design, writing manuals, job search. www.pr.mala.bc.ca/tech_comm.htm for details.
---
You are currently subscribed to techwr-l as:
techwr-l@gts.org
To unsubscribe send a blank email to leave-techwr-l-185178C@lists.techwr-l.com
Send administrative questions to lisa@techwr-l.com. Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
|
|
| | From: | Barry Campbell | | Subject: | Re: XML/DocBook for newbies | | Date: | Thu, 20 Jan 2005 13:06:37 -0500 |
|
|
|
Mark,
Lots of good stuff here: http://docbook.org/
- bc
--
Barry Campbell
http://enrevanche.blogspot.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l
Technical Communication Certificate online - Malaspina-University College, Canada. Online training in technical writing, software (FrameMaker, RoboHelp, Dreamweaver, Acrobat), document & web design, writing manuals, job search. www.pr.mala.bc.ca/tech_comm.htm for details.
---
You are currently subscribed to techwr-l as:
techwr-l@gts.org
To unsubscribe send a blank email to leave-techwr-l-185178C@lists.techwr-l.com
Send administrative questions to lisa@techwr-l.com. Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
|
|
| | From: | Lisa M. Bronson | | Subject: | Re: XML/DocBook for newbies | | Date: | Fri, 21 Jan 2005 12:39:42 -0700 (MST) |
|
|
|
I am in a similar situation, and today had a presentation by Vasont
Systems (www.vasont.com). It looks like a good solution for what I need,
so I'm looking into it further. They have a free Webinar coming up on
Monday. The following is from a press release the rep sent to me after the
presentation:
"This free Webinar features guest speaker Paul Prescod of Blast Radius and
co-author of "The XML Handbook." Blast Radius is the maker of the XMetaLŽ
product family, which simplifies XML-based content creation and
management. During this free Webinar, Prescod and Bret Freeman of Vasont
Systems will address the following:
ˇ How organizations can convert content from paper and proprietary
formats to XML;
ˇ Key steps organizations can take when selecting an XML editing tool and
content management system; and
ˇ How an XML editing tool and content management system will help
organizations reduce their translation costs."
To register, go to
http://www.techwr-l.com/ct.php?link=http://placeware.viewcentral.com/reg/vasont/speakXMLpt1
Good luck, Mark. I think we've got some interesting things coming down the
pike!
Lisa B.
| Hi all
|
| We're just about to start on a big new round of documentation and
| because it might end up in several different formats, I have suggested
| going down the XML route. Brave (silly?) of me, because I know very
| little about using XML to write technical manuals. But hey -- it will
| be good for my career, I keep telling myself.
|
| So now I've got to get up to speed quickly. All I know is that I need
| to choose a DTD, a CSS and some form of editor that can work with
| them. Can anyone suggest any free/open source tools? And maybe some
| good online or printed resources?
|
| Thanks,
|
| Mark
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l
Technical Communication Certificate online - Malaspina-University College, Canada. Online training in technical writing, software (FrameMaker, RoboHelp, Dreamweaver, Acrobat), document & web design, writing manuals, job search. www.pr.mala.bc.ca/tech_comm.htm for details.
---
You are currently subscribed to techwr-l as:
techwr-l@gts.org
To unsubscribe send a blank email to leave-techwr-l-185178C@lists.techwr-l.com
Send administrative questions to lisa@techwr-l.com. Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
|
|
|
