From: <drobbins@gentoo.org>
To: gentoo-dev@gentoo.org
Subject: Re: [gentoo-dev] Gentoo Documentation Considerations
Date: Sun Mar 25 10:43:01 2001 [thread overview]
Message-ID: <20010325104248.A3589@cvs.gentoo.org> (raw)
In-Reply-To: <3ABE1B4D.7804C925@gottinger.de>; from AGottinger@t-online.de on Sun, Mar 25, 2001 at 06:22:37PM +0200
On Sun, Mar 25, 2001 at 06:22:37PM +0200, Achim Gottinger wrote:
> I have a few thoughts how we can handle the documentation for gentoo in a way
> that we can use it for our webpage and independently for a printable book.
> Now my plan. We separate the articles from the build packages. This means
> we create gentoo-install, gentoo-portage, gentoo-ebuild, gentoo-man which
> contain either gentoo-xsl or docbook style docs and those docs only get
> installed to /usr/share/doc/gentoo/[guide|docbook]. Once daniel has finished
> his gentoo->html xsl stylesheet, I create a gentoo->docbook xsl-sheet.
Yes, I'd like to use "guide" as our official format and use XSLT to convert
from there. I can focus on the guide -> HTML XSLT, and if you can focus on
the guide -> docbook XSLT, then that would be great. Right now, web page HTML
documentation is our number one priority, but it would also be nice to use
"guide" XML as the master file for our man pages.
> gentoo-web now can contain an global xml file which is generated dynamic from
> the content of /usr/share/doc/gentoo/guide. It generates the website-content
> from this global file.
And I'm guessing that we should design it this way so that I need to remerge
the actual documentation before it goes "live" on the website? Because, if
it pulled the docs directly from /usr/portage instead, then it could be using
documentation that's currently in development and not yet production-ready?
> gentoo-doc must convert the guide-style files to docbook. After that it
> generates a global docbook book file and creates prinatble output.
OK, so we have the following XML packages, each one containing a master
document in "guide" XML format:
gentoo-install
gentoo-portage
gentoo-ebuild
gentoo-man
Then, we have two "target" packages that generate content from these packages:
gentoo-web
gentoo-doc
> This way we have our docs allways up to date on the web and as a book.
Sounds good... I'll need to think about how this will work from the webmaster's
(my) perspective.
--
Daniel Robbins <drobbins@gentoo.org>
President/CEO http://www.gentoo.org
Gentoo Technologies, Inc.
next prev parent reply other threads:[~2001-03-25 17:42 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2001-03-25 9:50 [gentoo-dev] Gentoo Documentation Considerations Achim Gottinger
2001-03-25 10:43 ` drobbins [this message]
2001-03-25 11:20 ` Achim Gottinger
2001-03-25 15:30 ` drobbins
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20010325104248.A3589@cvs.gentoo.org \
--to=drobbins@gentoo.org \
--cc=gentoo-dev@gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox