| 1 |
On Sun, Mar 25, 2001 at 06:22:37PM +0200, Achim Gottinger wrote: |
| 2 |
|
| 3 |
> I have a few thoughts how we can handle the documentation for gentoo in a way |
| 4 |
> that we can use it for our webpage and independently for a printable book. |
| 5 |
|
| 6 |
> Now my plan. We separate the articles from the build packages. This means |
| 7 |
> we create gentoo-install, gentoo-portage, gentoo-ebuild, gentoo-man which |
| 8 |
> contain either gentoo-xsl or docbook style docs and those docs only get |
| 9 |
> installed to /usr/share/doc/gentoo/[guide|docbook]. Once daniel has finished |
| 10 |
> his gentoo->html xsl stylesheet, I create a gentoo->docbook xsl-sheet. |
| 11 |
|
| 12 |
Yes, I'd like to use "guide" as our official format and use XSLT to convert |
| 13 |
from there. I can focus on the guide -> HTML XSLT, and if you can focus on |
| 14 |
the guide -> docbook XSLT, then that would be great. Right now, web page HTML |
| 15 |
documentation is our number one priority, but it would also be nice to use |
| 16 |
"guide" XML as the master file for our man pages. |
| 17 |
|
| 18 |
> gentoo-web now can contain an global xml file which is generated dynamic from |
| 19 |
> the content of /usr/share/doc/gentoo/guide. It generates the website-content |
| 20 |
> from this global file. |
| 21 |
|
| 22 |
And I'm guessing that we should design it this way so that I need to remerge |
| 23 |
the actual documentation before it goes "live" on the website? Because, if |
| 24 |
it pulled the docs directly from /usr/portage instead, then it could be using |
| 25 |
documentation that's currently in development and not yet production-ready? |
| 26 |
|
| 27 |
> gentoo-doc must convert the guide-style files to docbook. After that it |
| 28 |
> generates a global docbook book file and creates prinatble output. |
| 29 |
|
| 30 |
OK, so we have the following XML packages, each one containing a master |
| 31 |
document in "guide" XML format: |
| 32 |
|
| 33 |
gentoo-install |
| 34 |
gentoo-portage |
| 35 |
gentoo-ebuild |
| 36 |
gentoo-man |
| 37 |
|
| 38 |
Then, we have two "target" packages that generate content from these packages: |
| 39 |
|
| 40 |
gentoo-web |
| 41 |
gentoo-doc |
| 42 |
|
| 43 |
> This way we have our docs allways up to date on the web and as a book. |
| 44 |
|
| 45 |
Sounds good... I'll need to think about how this will work from the webmaster's |
| 46 |
(my) perspective. |
| 47 |
|
| 48 |
-- |
| 49 |
Daniel Robbins <drobbins@g.o> |
| 50 |
President/CEO http://www.gentoo.org |
| 51 |
Gentoo Technologies, Inc. |
Archives