Gentoo Logo
Gentoo Spaceship




Note: Due to technical difficulties, the Archives are currently not up to date. GMANE provides an alternative service for most mailing lists.
c.f. bug 424647
List Archive: gentoo-doc
Navigation:
Lists: gentoo-doc: < Prev By Thread Next > < Prev By Date Next >
Headers:
To: gentoo-doc@g.o
From: AllenJB <gentoo-lists@...>
Subject: Re: How are the docs written?
Date: Wed, 20 May 2009 10:16:02 +0100
Gunnar wrote:
> Hello.
> I'm new on this list and I have a simple question, how is the docs written?
> Do you use any tools for generating the html or do you write it directly in 
> plain emacs/vi?
> 
> Regards
> Gunnar.
> 
Gentoo documentation is ultimately stored in a custom xml-based format 
called GuideXML. You can find out more by checking out the 
"Documentation Project Documentation" section of 
http://www.gentoo.org/doc/en/list.xml

This does not mean that you can't submit documentation in other formats. 
I'm fairly sure the project will accept documentation in HTML or plain 
text and then have knowledgeable people convert it for you - however 
this will obviously take more time.

On the above mentioned articles you'll also find instructions on pulling 
down existing documentation from the source repo so that you can easily 
edit existing documentation.

GuideXML isn't overly difficult to learn if you already know HTML. You 
can get help on the #gentoo-doc IRC channel on Freenode ( 
irc://irc.freenode.net/gentoo-doc )

It's probably in the above mentioned documentation already, but as a 
quick tip: on almost any page on www.gentoo.org you can add ?passthru=1 
to the end of the URL and view GuideXML source for that page.

Hope that helps

AllenJB


References:
How are the docs written?
-- Gunnar
Navigation:
Lists: gentoo-doc: < Prev By Thread Next > < Prev By Date Next >
Previous by thread:
How are the docs written?
Next by thread:
Re: How are the docs written?
Previous by date:
How are the docs written?
Next by date:
Re: How are the docs written?


Updated Jun 17, 2009

Summary: Archive of the gentoo-doc mailing list.

Donate to support our development efforts.

Copyright 2001-2013 Gentoo Foundation, Inc. Questions, Comments? Contact us.