Commit Graph

7 Commits

Author SHA1 Message Date
Ben Hutchings
b48ed85145 DocBook: Generate consistent IDs
By default, DocBook XSL uses a non-deterministic function to generate
IDs for HTML elements where it can't take a name from the input
document.  However, it has the option to generate 'consistent'
(deterministic) IDs instead.  Enable this to make the HTML pages
reproducible.

Reported-by: Jérémy Bobbio <lunar@debian.org>
Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-07-10 11:03:16 -06:00
Johannes Berg
ab265d5cdd docbook: use IDs as filenames to support multiple books
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.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2010-08-05 13:21:24 -07:00
Mauro Carvalho Chehab
b131e04eae DocBook: Don't use graphics callouts
By default, when a callout is used, DocBook will try to use
a graphics image for callouts. This requires that the graphics
to be copied to the documentation directory. As this is not
done, use the text callouts: (1), (2), ...

Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2009-09-19 00:14:17 -03:00
Pavel Pisa
460e79c30b [PATCH] DocBook/HTML: Generate chapter/section level TOCs for functions
Simple increase of section TOC level generation significantly enhances
navigation experience through generated kernel API documentation.

This change restores back state from SGML tools time.

Signed-off-by: Pavel Pisa <pisa@cmp.felk.cvut.cz>
Acked-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2007-02-11 10:51:30 -08:00
Martin Waitz
e56367fe70 [PATCH] DocBook: comment about paper type
Add a comment showing how to change paper type.

Signed-off-by: Martin Waitz <tali@admingilde.org>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
2005-11-13 18:14:21 -08:00
Martin Waitz
363412b4f7 [PATCH] DocBook: only use tabular style for long synopsis
There was a complaint that function declarations are shown tabular in the
documentation since switching to xmlto.  This patch disables tabular mode
when the function fits in one line.

Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
2005-06-24 00:06:40 -07:00
Martin Waitz
2948e57d94 [PATCH] Docbook: use custom stylesheet
With the custom stylesheet, functions are rendered using ANSI-C syntax and
xmlto is a bit quieter.

Signed-off-by: Martin Waitz <tali@admingilde.org>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
2005-05-01 08:59:27 -07:00