Thread (10 messages) 10 messages, 4 authors, 2016-06-15

Re: user-manual.html invalid HTML

flat view

From: Jonathan Nieder <hidden>
Date: 2016-06-15 22:49:21
Subsystem: documentation, the rest · Maintainers: Jonathan Corbet, Linus Torvalds

Hi,

Sorry for the long silence.

Jeff King wrote:
On Fri, Dec 12, 2008 at 04:32:15AM +0800, jidanni@jidanni.org wrote:
[user-manual.html lacks a !DOCTYPE declaration]
The versions I build locally have:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

in each HTML file, which is added by asciidoc.  Maybe the package you
are looking at was built with an older version of asciidoc that doesn't
do this (I don't actually know the history of this feature, but it seems
to me that this is something asciidoc should be doing, not git).
It looks like the HTML for user-manual.html (unlike the reference
manual and other articles) is not generated by asciidoc after all;
instead, the rule in Documentation/Makefile uses xsltproc directly to
convert the asciidoc-generated XML to HTML.

Apparently the caller is supposed to set the
chunker.output.doctype-public parameter.
http://www.sagehill.net/docbookxsl/Chunking.html#OutputDoctype

Maybe something as simple as this would work.

-- 8< --
Subject: Documentation: set a !DOCTYPE for user manual

asciidoc already takes care of including a doctype for most of the
HTML documentation, but the user manual which is processed with
docbook-xsl directly lacks one (at least with Debian docbook-xsl
1.75.2+dfsg-5).  This makes it harder to automatically validate the
HTML.

Reported-by: 積丹尼 <redacted>
Signed-off-by: Jonathan Nieder <redacted>
---
diff --git a/Documentation/docbook.xsl b/Documentation/docbook.xsl
index 9a6912c..da8b05b 100644
--- a/Documentation/docbook.xsl
+++ b/Documentation/docbook.xsl
@@ -1,5 +1,8 @@
 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
 		version='1.0'>
  <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"/>
- <xsl:output method="html" encoding="UTF-8" indent="no" />
+ <xsl:output method="html"
+     encoding="UTF-8" indent="no"
+     doctype-public="-//W3C//DTD HTML 4.01//EN"
+     doctype-system="http://www.w3.org/TR/html4/strict.dtd" />
 </xsl:stylesheet>
-- 
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help