Go Back   Armenian Knowledge Base > Entertainment > Literary nook > TWARM

Reply
 
Thread Tools

Винт2Linux -> Shifting OS for TechWriting
Old 25.08.2004, 06:51   #1
★★★★★★★★★★★★★
 
Hrach_Techie's Avatar
 
Join Date: 08 2004
Location: London, UK
Age: 46
Posts: 16,531
Rep Power: 8
Arrow Винт2Linux -> Shifting OS for TechWriting

Hi ...

The standard format for storing documentation sources on Linux is Docbook
http://www.docbook.org. Docbook is an SGML/XML DTD/XSD that is particularly well suited to the markup of structured information about technical subjects. Docbook is a standards managed by OASIS and the Docbook Technical Committee http://www.oasis.org.

There are a number of structured editors that can be used to edit Docbook
files. Although any text editor can be used, an XML editor such as Oxygen XML Editor is always best.

See this page for information as to why more and more writers like Oxygen:

http://www.inwords.co.za/products.html.

Another good choice is "emacs" free and serves as everything + the kitchen sink. Kate, the default KDE editor also does a good job. If the src view scares you, try XXE from XMLmind, it give you as WYSIOO interface for authoring.

There are also tools like Conglomerate and Morphon. However, I always recomend learning to markup in a src view editor. That way when people use the WYSIOO editors they know what is going on under the hood.

Open Office and Frame can also be used. For graphics, no doubt - Gimp is
good. Download it here, if it is not shipped with the package:

www.gimp.org

Not only is it a Graphics editor but also enables screen capture etc.

However, on Linux you have so many tools to choose from. To edit HTML use
Quanta + or something like that. Really if you choose a desktop like

KDE
http://www.kde.org

or

GNOME
http://www.gnome.org

you will find all the tools you need.

With regards to MS Help. This is just one of the target outputs for formatted
information, other include RTF, HTML/XHTML, PS, HTML Help JavaHelp and of
course PDF.

A good place to get started finding information is with the Gnome
Documentation Project or the i18n server at KDE.

As for the documentation team. If you are documenting on Linux, then first suggestion is that your team get proficient with the use of Linux. You will find it hard at first, but the learning curve is well worth it. There are so many Linux distros to choose from. Some cater specifically to Windows users such as Lindows or Mandrake.

I personally Like SuSE
http://www.suse.com

and Debian is a good choice too
http://www.debian.org

The last one is not for the total novice, but SuSE is good for both. Anyway, all of these can have either the KDE or GNOME desktop installed.

Authoring in XML will change your processes. For example I would use CVS or
SVN as revision management systems to store documents. Each author can
therefore checkout their working copy, hack the src and commit back to the
repository, resolving conflicts created by other authors doing commit before.

I work this way with customers all over the world. Developers like it to
since they can also checkout src and hack the code and commit it back. It's
truly collaborative.

Welcome to Linux !!!!!
__________________
Мадмазель, Медам, Месье! "Глория" меняет курс и направляется в Кейптаун! Кому это не нравится будет расстрелян на месте. (с)

http://texneg.livejournal.com

Last edited by Hrach_Techie; 25.08.2004 at 07:16.
Reply




Реклама:
реклама
Buy text link .

All times are GMT. The time now is 01:49.
Top

Powered by vBulletin® Copyright ©2000 - 2025, Jelsoft Enterprises Ltd.