2010-06-30 18:00:59

by Johannes Berg

Subject: [PATCH] docbook: use ID as filename

From: Johannes Berg <[email protected]>

I'm trying to generate a <set> of <book>s in
docbook for wireless to link together all the
cfg80211 and mac80211 documentation.

However, docbook will generate "re01.html"
anew for each book for the first <refentry>,
presumably due to a bug in the stylesheets.

An effective workaround is to use IDs for the
filenames, which makes them more descriptive
as well, e.g. API-enum-ieee80211-band.html.

Cc: Randy Dunlap <[email protected]>
Signed-off-by: Johannes Berg <[email protected]>
---
Documentation/DocBook/stylesheet.xsl | 1 +
1 file changed, 1 insertion(+)

--- wireless-testing.orig/Documentation/DocBook/stylesheet.xsl 2010-06-30 19:57:19.000000000 +0200
+++ wireless-testing/Documentation/DocBook/stylesheet.xsl 2010-06-30 19:57:23.000000000 +0200
@@ -6,4 +6,5 @@
<param name="callout.graphics">0</param>
<!-- <param name="paper.type">A4</param> -->
<param name="generate.section.toc.level">2</param>
+<param name="use.id.as.filename">1</param>
</stylesheet>

2010-06-30 22:58:18

by Randy Dunlap

Subject: Re: [PATCH] docbook: use ID as filename

On Wed, 30 Jun 2010 20:00:55 +0200 Johannes Berg wrote:

> From: Johannes Berg <[email protected]>
>
> I'm trying to generate a <set> of <book>s in
> docbook for wireless to link together all the
> cfg80211 and mac80211 documentation.
>
> However, docbook will generate "re01.html"
> anew for each book for the first <refentry>,
> presumably due to a bug in the stylesheets.
>
> An effective workaround is to use IDs for the
> filenames, which makes them more descriptive
> as well, e.g. API-enum-ieee80211-band.html.
>
> Cc: Randy Dunlap <[email protected]>
> Signed-off-by: Johannes Berg <[email protected]>
> ---
> Documentation/DocBook/stylesheet.xsl | 1 +
> 1 file changed, 1 insertion(+)
>
> --- wireless-testing.orig/Documentation/DocBook/stylesheet.xsl 2010-06-30 19:57:19.000000000 +0200
> +++ wireless-testing/Documentation/DocBook/stylesheet.xsl 2010-06-30 19:57:23.000000000 +0200
> @@ -6,4 +6,5 @@
> <param name="callout.graphics">0</param>
> <!-- <param name="paper.type">A4</param> -->
> <param name="generate.section.toc.level">2</param>
> +<param name="use.id.as.filename">1</param>
> </stylesheet>
>
>
> --

Applied to my patch queue. We'll see if it trips up anything.

Thanks.
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***