On Sat, Jan 13, 2007 at 12:09:49AM -0800, David Lawyer wrote:
> Package: linuxdoc-tools
> Version: 0.9.21-0.5
> 
> The current package description reads:

...

> Improvements:  I think the above description is too long and should be
> shortened.  Let me know and I'll write you a shorter one.  But the
> most urgent task is to remove the errors I've pointed out.

Hi, David and Sano,

Cloning old bug report and reopening it wrt description length.

I have been looking at this, and since I agree that a shorter description is
preferrable, I have prepared a first cut for it,

---------------------------------------------------------
Description: SGML converters for the LinuxDoc DTD only.
 LinuxDoc is a kind of SGML DTD. It was created for  the Linux
 HOWTOs, and is being used by the Linux Documentation Project
 (LDP). linuxdoc-tools was created on the  basis of
 sgml-tools_v1, and has been designed and implemented
 only for linuxdoc DTD.
 .
 HTML can be generated without any other Debian text
 processing package, but for the other formats the
 appropriate packages will have to be installed. See
 /usr/share/doc/linuxdoc-tools/README.Debian.
---------------------------------------------------------

I propose moving most other stuff to something like attached README.Debian,
where I think it belongs. Comments are welcome.

Thanks for your feedback,

-- 
Agustin
linuxdoc-tools README for Debian
================================

Dependencies
------------

out-of-the-box linuxdoc-tools will only provide support for
sgml2html conversion. Other conversions will need other Debian
packages be installed. Those dependencies will be pulled either
by linuxdoc-tools-text, linuxdoc-tools-info or
linuxdoc-tools-latex packages, although you can install them
by your own.

The relevant dependencies are:

sgml2txt:
  * groff package

sgml2info:
  * texinfo package

sgml2latex:
  * texlive-latex-base | tetex-base
  * texlive-base-bin | tetex-bin
  * texlive-latex-recommended | tetex-extra

Different backends
------------------

The main command is linuxdoc, and -B option is provided
to choose the proper backend driver for desired output:

  linuxdoc -B check: for syntax checking
  linuxdoc -B html: conversion to html
  linuxdoc -B info: conversion to info
  linuxdoc -B latex: conversion to latex, dvi, and postscript
  linuxdoc -B lyx: conversion to lyx
  linuxdoc -B rtf: conversion to rtf
  linuxdoc -B txt: conversion to text

Handling of other DTD
---------------------

linuxdoc-tools has been designed and implemented only for linuxdoc DTD.
If you wish to convert debiandoc DTD documents, please install and use
debiandoc-sgml package. If you wish to convert docbook DTD documents,
please install and use jade (with or without sgmltools-lite).

 -- Agustin Martin Domingo <[EMAIL PROTECTED]>, Fri, 25 May 2007 15:31:20 +0200

Reply via email to