Regarding changing the current package description of the linuxdoc-tools
package (David Lawyer suggested a shorter description).
On Tue, May 29, 2007 at 06:18:31PM +0200, Agustin Martin wrote:
> I have been looking at this, and since I agree that a shorter description is
> preferrable, I have prepared a first cut for it,
I think that it needs to explain it to someone who doesn't know what
Linuxdoc is. An example of this is the description for asciidoc:
:
Description: Highly configurable text format for writing documentation
AsciiDoc is a text document format for writing articles, books, manuals and
UNIX man pages. AsciiDoc files can be translated to HTML (with or without
stylesheets), DocBook (articles, books and refentry documents) and LinuxDoc
using the asciidoc command. AsciiDoc can also be used to build and maintain
websites.
.
You write an AsciiDoc document the same way you would write a
normal text document, there are no markup tags or weird format notations.
AsciiDoc files are designed to be viewed, edited and printed directly or
translated to other presentation formats
----------------------------------------------------------------------------
Here's an example I just wrote for LinuxDoc:
LinuxDoc is a format for writing documentation, something like html
only it's simpler and can be converted to various other formats,
including html for websites. You write a LinuxDoc document using any
text editor such as vim. Then you use linuxdoc-tools to convert it to
html, plain-text (install linuxdoc-tools-text), latex (install
linuxdoc-tools-latex), rtf, info (install linuxdoc-tools-info), dvi, or
postscript. The sgmltools-lite package can convert LinuxDoc to DocBook
format.
LinuxDoc automatically creates a table of contents. It's easier to write
and read than docbook since it allows one to omit most closing tags
while paragraphs are separated by just blank lines.
(The fact that LinuxDoc is SGML DTD, and that it originated from the Linux
Documentation Project, would be stated in the README.)
David Lawyer
PS: I once looked over the AsciiDoc format and thought that LinuxDoc
was easier to use than AsciiDoc.
Agustin Martin's draft:
> 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
--
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]
