From 526d66204545a6ddacd410f856484fe94b51968b Mon Sep 17 00:00:00 2001 From: Pekka Paalanen Date: Fri, 16 Jan 2026 14:33:03 +0200 Subject: [PATCH 1/4] doc: fix appendix DOCTYPE root element It's , not . Fixes a minor validation warning. Signed-off-by: Pekka Paalanen --- doc/publican/Client.xml | 2 +- doc/publican/Server.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/publican/Client.xml b/doc/publican/Client.xml index 19bf3e95..77449d10 100644 --- a/doc/publican/Client.xml +++ b/doc/publican/Client.xml @@ -1,5 +1,5 @@ - %BOOK_ENTITIES; diff --git a/doc/publican/Server.xml b/doc/publican/Server.xml index 2333b1a4..df25e789 100644 --- a/doc/publican/Server.xml +++ b/doc/publican/Server.xml @@ -1,5 +1,5 @@ - %BOOK_ENTITIES; From 48bfba83783b3ed46d7058bf828fcc2993a88522 Mon Sep 17 00:00:00 2001 From: Pekka Paalanen Date: Fri, 16 Jan 2026 14:36:06 +0200 Subject: [PATCH 2/4] doc: rename libwayland appendix IDs ProtocolSpec.xml sets the precedent that appendix IDs should be appe. Fix the libwayland appendices to follow. In the future we may start using the IDs as HTML file names, and then the inconsistency would be visible. Signed-off-by: Pekka Paalanen --- doc/publican/Client.xml | 4 ++-- doc/publican/Compositors.xml | 2 +- doc/publican/Server.xml | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/publican/Client.xml b/doc/publican/Client.xml index 77449d10..f1eba096 100644 --- a/doc/publican/Client.xml +++ b/doc/publican/Client.xml @@ -4,13 +4,13 @@ %BOOK_ENTITIES; ]> - + Client API
Introduction The open-source reference implementation of Wayland protocol is split in two C libraries, libwayland-client and libwayland-server. Their main + linkend="appe-Library-Server">libwayland-server. Their main responsibility is to handle the Inter-process communication (IPC) with each other, therefore guaranteeing the protocol objects marshaling and messages synchronization. diff --git a/doc/publican/Compositors.xml b/doc/publican/Compositors.xml index 7a7bdaa0..5eed9593 100644 --- a/doc/publican/Compositors.xml +++ b/doc/publican/Compositors.xml @@ -19,7 +19,7 @@ In this section, we introduce three types of Wayland compositors relying - on libwayland-server. + on libwayland-server.
diff --git a/doc/publican/Server.xml b/doc/publican/Server.xml index df25e789..f31a3f3a 100644 --- a/doc/publican/Server.xml +++ b/doc/publican/Server.xml @@ -4,13 +4,13 @@ %BOOK_ENTITIES; ]> - + Server API
Introduction The open-source reference implementation of Wayland protocol is split in two C libraries, libwayland-client and + linkend="appe-Library-Client">libwayland-client and libwayland-server. Their main responsibility is to handle the Inter-process communication (IPC) with each other, therefore guaranteeing the protocol objects marshaling and From 8c9aedf36edf83322c9ac9bc95f6095a73a7bcb2 Mon Sep 17 00:00:00 2001 From: Pekka Paalanen Date: Fri, 16 Jan 2026 13:40:39 +0200 Subject: [PATCH 3/4] doc: move docbook config to a file I think it's nicer to have the configuration in a separate file, and not clutter the Meson file. Yes, the XML syntax is inconvenient. This patch does not change the generated output. Signed-off-by: Pekka Paalanen --- doc/publican/meson.build | 6 +----- doc/publican/xsl/docbook-config.xsl | 11 +++++++++++ 2 files changed, 12 insertions(+), 5 deletions(-) create mode 100644 doc/publican/xsl/docbook-config.xsl diff --git a/doc/publican/meson.build b/doc/publican/meson.build index 2edf7988..e6b5121f 100644 --- a/doc/publican/meson.build +++ b/doc/publican/meson.build @@ -96,11 +96,7 @@ custom_target( 'Wayland-docbook-html', command: [ xmlto, - '--stringparam', 'chunker.output.encoding=UTF-8', - '--stringparam', 'chunk.section.depth=0', - '--stringparam', 'toc.section.depth=1', - '--stringparam', 'generate.consistent.ids=1', - '--stringparam', 'html.stylesheet=css/default.css', + '-m', files('xsl/docbook-config.xsl'), '-o', '@OUTPUT@', 'html', '@INPUT0@' diff --git a/doc/publican/xsl/docbook-config.xsl b/doc/publican/xsl/docbook-config.xsl new file mode 100644 index 00000000..2e176b89 --- /dev/null +++ b/doc/publican/xsl/docbook-config.xsl @@ -0,0 +1,11 @@ + + + + + + UTF-8 + 0 + 1 + 1 + css/default.css + From 5c5e28294f2f9c5f733294f37e7eb4af8822f3cc Mon Sep 17 00:00:00 2001 From: Pekka Paalanen Date: Fri, 16 Jan 2026 14:16:57 +0200 Subject: [PATCH 4/4] doc: change HTML file names Previously the HTML files generated from the DocBook sources were named ch01.html, ch02.html, apa.html, apb.html, etc. with running numbering. This means that if one added a new chapter between existing chapters, the following chapter file names would change and break all web links pointing to them. Instead, let's use the chapter ID as the file name. This way, web links will not be broken when new chapters are added. Of course, this change breaks all web links to everything but index.html (and pr01.html and pr02.html). Signed-off-by: Pekka Paalanen --- doc/publican/xsl/docbook-config.xsl | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/publican/xsl/docbook-config.xsl b/doc/publican/xsl/docbook-config.xsl index 2e176b89..6c93d204 100644 --- a/doc/publican/xsl/docbook-config.xsl +++ b/doc/publican/xsl/docbook-config.xsl @@ -7,5 +7,6 @@ 0 1 1 + 1 css/default.css