discuss: [RFC] General Guide
Subject:
Re: [RFC] General Guide
From:
"Martin A. Brown" ####@####.####
Date:
20 May 2016 17:48:20 +0100
Message-Id: <alpine.LSU.2.11.1605160836580.29512@znpeba.jbaqresebt.arg>
Greetings David,
>I apologize for the delay, I decided to write it in FAQ format and
FAQ is good--thank you for sending this in!
We have a few FAQs already and, in fact, but with the retirement of
David Merrill's "Linux-FAQ", we don't have any that are targetted at
a general user trying to orient him/herself in the Linux landscape.
>I wanted to see if the other languages for docs would support several
>separate TOCs.
DocBook can certainly generate ToCs for sections as well as the main
article or book.
>I wound up using plain had written xhtml.
That's a fine way to start. Before submission and publication, we
would need to convert it into one of the source formats that we can
currently support. These are:
* Linuxdoc
* Asciidoc
* Docbook XML 4.x
* Docbook XML 5.x
* Docbook SGML 4.x [not recommended]
I (and others) can help you choose a format that addresses your
desire for section ToCs and also with the transformation.
>EDIT: (Then I learned that I needed to compress it before sending).
>This is only a draft, I expect to increase it's size. I noticed
>that a couple of the questions I answer are answered in the LDPs
>dictionary.
There will always be overlap. And, that's not a bad thing.
>Interestingly enough, there are also a few apps in the dictionary,
>like games. I'd argue that they do not belong there and want a bit
>of an idea where my QA style guide ends and where the LD should
>begin. Tell me what you think of my guide so far, this is an RFC.
I will read and review your document and send you comments directly.
Best regards,
-Martin
--
Martin A. Brown
http://linux-ip.net/
