Mailing List Archive

Jeremy C. Reed wrote:
> A few questions:
>
> The "Documentation Development Tips & Tricks" webpage mentions ways to get
> latest documentation.
>
> Does Gentoo provide anonymous CVS? I'd prefer to use CVS to fetch
> the files instead of a "latest" tarball. (I did fetch it in the
> meanwhile.) CVS would be nice because I can use cvs history and version
> IDs to keep track of the doc changes (instead of using cvsweb). If not,
> I'll just use diff and different "latest" tarballs and cvsweb.

You're not the first one to ask.
Anonymous CVS is not available. Sorry.
If you want to keep track of changes to the docs, you should subscribe to the
gentoo-doc-cvs mailing list, send an email to
gentoo-doc-cvs-subscribe@gentoo.org to subscribe.
A mail is automatically posted by the CVS system on every commit to the doc/en
files, i.e. not translations, just originals.

> The "Gentoo Linux XML Guide" webpage mentions DocBook XML/SGML. Does
> anyone have a stylesheet for converting your book.dtd-using documents to
> DocBook XML/SGML? (Or for converting the GuideXML docs to DocBook?)

Not that I know of.

> The Tips & Tricks webpage links to a special version of guide.xsl
> available on SwifT's webspace. It does work for me, but it would be nice
> to have the actual scripts and/or Makefiles that generate the entire GDP
> to HTML. Where are the scripts and/or Makefiles for rendering all of
> Handbook to web?

It's just a matter of processing all .xml files through xsltproc, you don't
need much of a script or makefile for that.
FYI, I always use the official stylesheets and change the links to images and
/css/main.css with a trivial sed cmd, just to be sure I am not using an
obsolete xsl.
Feel free to ask for any help or tips you might need.



With kind regards,
--
/ Xavier Neys
\_ Gentoo Documentation Project
/ French & Internationalisation Lead
\ http://www.gentoo.org/doc/en
/\

On Tue, 14 Sep 2004, Xavier Neys wrote:

> You're not the first one to ask.
> Anonymous CVS is not available. Sorry.
> If you want to keep track of changes to the docs, you should subscribe to the
> gentoo-doc-cvs mailing list, send an email to
> gentoo-doc-cvs-subscribe@gentoo.org to subscribe.
> A mail is automatically posted by the CVS system on every commit to the doc/en
> files, i.e. not translations, just originals.

Okay. Thanks.

> > The Tips & Tricks webpage links to a special version of guide.xsl
> > available on SwifT's webspace. It does work for me, but it would be nice
> > to have the actual scripts and/or Makefiles that generate the entire GDP
> > to HTML. Where are the scripts and/or Makefiles for rendering all of
> > Handbook to web?
>
> It's just a matter of processing all .xml files through xsltproc, you don't
> need much of a script or makefile for that.

It doesn't seem like that is good enough. For example, using xsltproc
creates a link to hb_part2_chap1.html. How do I tell xsltproc to create
that filename (hb_part2_chap1.html) from hb-working-use.xml
automatically?

The "Documentation Development Tips & Tricks" webpage suggests using
--stringparam part 1 --stringparam chap 1 with xsltproc to create
hb-install-about.html. I can do this manually, but it seems like you would
have a script or Makefile to do this. Without a script, it seems like I'd
have to look inside of files to know what part and what chapter.

And that example seems wrong. Because it creates one file
(hb-install-about.html), but the link to it is a different filename
(hb_part1_chap1.html).

Maybe I am missing something?


Jeremy C. Reed

BSD News, BSD tutorials, BSD links
http://www.bsdnewsletter.com/



--
gentoo-doc@gentoo.org mailing list

Jeremy C. Reed wrote:
> On Tue, 14 Sep 2004, Xavier Neys wrote:
>
>>>The Tips & Tricks webpage links to a special version of guide.xsl
>>>available on SwifT's webspace. It does work for me, but it would be nice
>>>to have the actual scripts and/or Makefiles that generate the entire GDP
>>>to HTML. Where are the scripts and/or Makefiles for rendering all of
>>>Handbook to web?
>>
>>It's just a matter of processing all .xml files through xsltproc, you don't
>>need much of a script or makefile for that.
>
> It doesn't seem like that is good enough. For example, using xsltproc
> creates a link to hb_part2_chap1.html. How do I tell xsltproc to create
> that filename (hb_part2_chap1.html) from hb-working-use.xml
> automatically?

Well, you can write a script ;-) I don't know of any existing script that does
that atm.

> The "Documentation Development Tips & Tricks" webpage suggests using
> --stringparam part 1 --stringparam chap 1 with xsltproc to create
> hb-install-about.html. I can do this manually, but it seems like you would
> have a script or Makefile to do this. Without a script, it seems like I'd
> have to look inside of files to know what part and what chapter.

Indeed, the part and chapter numbers can be found by looking in the main file.
Maybe the list of docs that I use for my translators can help you with this
http://dev.gentoo.org/~neysx/trads-fr.html

> And that example seems wrong. Because it creates one file
> (hb-install-about.html), but the link to it is a different filename
> (hb_part1_chap1.html).

You choose the name of generated files but I don't think you'll get links to
other parts to point to anything.html. Where did you see a link to
hb_part1_chap1.html? The links will point to handbook-x86.xml?part=n&chap=m...
BTW, the handbook can be rendered as a single html document, would that be
good enough for you?

It would help to know what you are looking for.
Do you want printable versions?
Do you want to browse the xml or html locally? You can browse the xml with
apache or even without it btw.


With kind regards,
--
/ Xavier Neys
\_ Gentoo Documentation Project
/ French & Internationalisation Lead
\ http://www.gentoo.org/doc/en
/\

On Tue, 14 Sep 2004, Xavier Neys wrote:

> It would help to know what you are looking for.
> Do you want printable versions?

Yes. I have written my own guide.xsl and some sed scripts. It outputs to a
latex/lyx hybrid.

I am using it to generate printable chapters. I plan on publishing
the handbook as a printable book.

One thing I have changed is to get rid of the "Code Listing #" header
above every example. At first I had to show "Example" # but that was too
much clutter.

Also, I automatically create footnotes for hyperlinks. And some other
changes for printing. I am working on using lyx cross references
for the anchors. And converting CSS to tex/lyx.

I have a degree in Journalism and I have several years experience with
editing and writing computer articles and training materials. It will be
difficult to try to resync any of my copyedits and improvements to any
changes the rest of the gentoo developers have made since there is not any
anonymous CVS. If you have easy suggestions for how I can share my
changes back, please let me know.

Jeremy C. Reed

BSD News, BSD tutorials, BSD links
http://www.bsdnewsletter.com/




--
gentoo-doc@gentoo.org mailing list

On Sat, Sep 18, 2004 at 10:16:14PM -0700, Jeremy C. Reed wrote:
> I have a degree in Journalism and I have several years experience with
> editing and writing computer articles and training materials. It will be
> difficult to try to resync any of my copyedits and improvements to any
> changes the rest of the gentoo developers have made since there is not any
> anonymous CVS. If you have easy suggestions for how I can share my
> changes back, please let me know.

You might want to take a look at cvsgrab (cvsgrab.sourceforge.net). It
allows you to have a "sort-of" anonymous access to the CVS by parsing
ViewCVS.

Wkr,
Sven Vermeulen

--
^__^ And Larry saw that it was Good.
(oo) Sven Vermeulen
(__) http://www.gentoo.org Documentation & PR

On Mon, Sep 20, 2004 at 11:49:42AM +0200 or thereabouts, Sven Vermeulen wrote:
> You might want to take a look at cvsgrab (cvsgrab.sourceforge.net). It
> allows you to have a "sort-of" anonymous access to the CVS by parsing
> ViewCVS.

Uh....this *will* get you banned from our web sites. cvsgrab is an
abomination that places an undue load on our servers by perverting a
program into doing something it was never intended to do. We generally get
notified any time someone uses cvsgrab or a similar program because it
spikes the load on the server being hit. This generally results in us
banning that IP from that server and, if it persists, all our other
servers.

We don't offer anonymous CVS because we don't have the spare capacity in
our CVS server. If someone wants to donate a server that is capable of
handling the load, I will gladly set up a dedicated anonymous CVS server.
Until then, we do not offer this feature in any way.

--kurt

On Mon, Sep 20, 2004 at 09:55:53AM +0000, Kurt Lieber wrote:
> Uh....this *will* get you banned from our web sites. cvsgrab is an
> abomination that places an undue load on our servers by perverting a
> program into doing something it was never intended to do. We generally get
> notified any time someone uses cvsgrab or a similar program because it
> spikes the load on the server being hit. This generally results in us
> banning that IP from that server and, if it persists, all our other
> servers.

Okay, forget cvsgrab then. Please subscribe to gentoo-doc-cvs@gentoo.org
which will inform you of all updates to the English documentation :)

Wkr,
Sven Vermeulen

--
^__^ And Larry saw that it was Good.
(oo) Sven Vermeulen
(__) http://www.gentoo.org Documentation & PR

On Mon, 20 Sep 2004, Sven Vermeulen wrote:

> Okay, forget cvsgrab then. Please subscribe to gentoo-doc-cvs@gentoo.org
> which will inform you of all updates to the English documentation :)

I am already subscribed.

The problem is not being able to easily synchronize my changes with your
changes.

I guess I'll try just using the daily tarball snapshots and then use merge
or rcsmerge to attempt to merge in the changes.

Jeremy C. Reed

BSD News, BSD tutorials, BSD links
http://www.bsdnewsletter.com/


--
gentoo-doc@gentoo.org mailing list