discuss: [RFC] General Guide
Subject:
Re: [RFC] General Guide
From:
####@####.####
Date:
28 May 2016 11:53:33 +0100
Message-Id: <20160528065252.7ea84645@ulgy_thing>
On Fri, 20 May 2016 09:49:30 ####@####.#### wrote:
> 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.
>
All you have said and proposed is fine with me. As I know html well I'd
prefer to keep writing my local copy in xhtml for the time being. I don't
expect the work to be comprehensive for a least 3 months. That is because
I love contributing to linux (since helps others of course :) , and I'm
currently contributing to 3 projects in less active development then most
including the LDP.
Sincerely, David