MantisBT - CMake
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0010338CMakeDocumentationpublic2010-02-26 08:422010-03-01 08:58
Reportersimonh 
Assigned ToBrad King 
PrioritynormalSeverityminorReproducibilityalways
StatusclosedResolutionfixed 
PlatformOSOS Version
Product VersionCMake-2-8 
Target VersionFixed in Version 
Summary0010338: CMake generated HTML is not valid HTML
DescriptionThere are a number of HTML mistakes in the auto-generated HTML documentation for CMake 2.8.0
- The anchor tag is not closed properly in the section index
- There is no DOCTYPE specifier
- A number of section anchor names have spaces; not allowed as an ID
Steps To Reproduce
Additional Information
TagsNo tags attached.
Relationships
related to 0010857closed Brad King CMake.HTML test requires internet access 
Attached Filespatch cmake-cfs-htmldocs.patch (3,869) 2010-02-26 08:42
https://public.kitware.com/Bug/file/2905/cmake-cfs-htmldocs.patch
patch 0001-Ensure-that-the-HTML-documentation-generated-by-CMak.patch (4,683) 2010-03-01 07:22
https://public.kitware.com/Bug/file/2917/0001-Ensure-that-the-HTML-documentation-generated-by-CMak.patch
Issue History
Date ModifiedUsernameFieldChange
2010-02-26 08:42simonhNew Issue
2010-02-26 08:42simonhFile Added: cmake-cfs-htmldocs.patch
2010-02-26 08:45simonhNote Added: 0019642
2010-02-26 13:18Bill HoffmanStatusnew => assigned
2010-02-26 13:18Bill HoffmanAssigned To => Brad King
2010-02-26 13:50Brad KingNote Added: 0019651
2010-03-01 04:28simonhNote Added: 0019661
2010-03-01 07:22simonhFile Added: 0001-Ensure-that-the-HTML-documentation-generated-by-CMak.patch
2010-03-01 07:23simonhNote Added: 0019662
2010-03-01 08:58Brad KingNote Added: 0019664
2010-03-01 08:58Brad KingStatusassigned => closed
2010-03-01 08:58Brad KingResolutionopen => fixed
2010-06-21 17:25Brad KingRelationship addedrelated to 0010857

Notes
(0019642)
simonh   
2010-02-26 08:45   
I've uploaded a patch against 2.8.0 which addresses the above issues and makes the output "XHTML 1.0 Strict" compliant.

This makes the output much easier for me to parse with our documentation generator - all tags are now correctly closed, i.e. fully XML compliant.
(0019651)
Brad King   
2010-02-26 13:50   
Thanks! I have two requests:

(1) CMake now uses Git, so we can credit you as author of the patch if we have a name and email address. Please either provide them here or clone the repository, create your commit, and use "git format-patch" to construct a new patch.

  http://www.cmake.org/Wiki/CMake/Git [^]

(2) I'd like to add a test to CMake to validate the generated documentation. Can you suggest a command-line tool for xhtml validation?
(0019661)
simonh   
2010-03-01 04:28   
I'll take a look at (1) of 0010338:0019651 shortly.

As for (2), I've used libxml2's xmllint, e.g.
xmllint --valid --noout CMake.html


This is part of a C-implemented XML library (part of Gnome). See
http://xmlsoft.org/xmllint.html [^]
(0019662)
simonh   
2010-03-01 07:23   
Git patch now attached.
(0019664)
Brad King   
2010-03-01 08:58   
Thanks. I've published it as commit 5771dd2f:

  http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=5771dd2f [^]

with a couple other commits for cleanup and a test:

  http://cmake.org/gitweb?p=cmake.git;a=shortlog;h=370e5b94 [^]