Commit Graph

17 Commits

Author SHA1 Message Date
Simon Harvey 5771dd2f15 Documentation: Comply with "XHTML 1.0 Strict"
Ensure that the HTML documentation generated by CMake complies with
"XHTML 1.0 Strict":

  - All tags are properly closed and DOCTYPE is specified
  - Useful for downstream XML-processors (e.g. for extracting section
    titles)

See issue #10338.

Signed-off-by: Simon Harvey <simon.harvey@cambridgeflowsolutions.com>
2010-03-01 08:51:20 -05:00
Brad King 96afb12087 Convert CMake to OSI-approved BSD License
This converts the CMake license to a pure 3-clause OSI-approved BSD
License.  We drop the previous license clause requiring modified
versions to be plainly marked.  We also update the CMake copyright to
cover the full development time range.
2009-09-28 11:43:28 -04:00
Bill Hoffman 899f11f919 Fix for bug# 5373, include CMake verison in generated docs. 2009-09-14 20:54:22 -04:00
Brad King 5a82a0b108 ENH: Improve generated documentation formatting
Applying patch provided in issue #7797.

Fixes to man-pages:
  - Character '-' must be espaced as '\-'
  - Surround preformatted text with '.nf' and '.fi' to adjust filling
  - Give every page a NAME section for indexing by mandb
  - Pass the man page filename without extension to .TH in its header

Also added a title to the HTML header.
2008-10-10 11:23:35 -04:00
Alexander Neundorf 4175b514fc ENH: handle HTML documentation for single items better: no warning about
ComputeSectionLinkPrefix, don't create an index for only one item

Alex
2008-07-21 17:52:59 -04:00
Brad King 199e85910f ENH: Fix generated documentation internal links.
- Previously all links started in 'command_' which led to conflicts
    and was confusing for non-command items.
  - Use a per-section name that is meaningful to humans.
  - Fix link id names to be valid HTML.
2008-05-05 12:02:36 -04:00
Bill Hoffman 385377cf1c STYLE: fix line length 2008-03-06 11:34:23 -05:00
Bill Hoffman 7173f2db0e ENH: add master index into html full help 2008-03-05 11:05:22 -05:00
Alexander Neundorf 969ea3f449 ENH: add support for creating the documentation in docbook format
(http://www.oasis-open.org/docbook/xml/4.2/), which users can then convert
to other formats.
Tested with meinproc from KDE, which generates HTML pages which look good.

Alex
2008-02-19 14:33:43 -05:00
Alexander Neundorf e13db53a9a PERF: reduce time for full docs as HTML from 1.4 s to 0.2 s, the map is now
created and filled only once instead for every character
I guess a simple case-switch would be still faster.

Alex
2008-02-17 12:31:29 -05:00
Bill Hoffman 6156a33633 ENH: better output for qt assistant 2007-11-27 15:59:22 -05:00
Ken Martin c2f0aac146 ENH: some more cleanup, fixes, and patch for HTML output 2007-10-24 11:36:47 -04:00
Ken Martin 6cdf032505 ENH: change to make the documentation class more generic, about halfway there, also provides secitons for Variables now 2007-10-22 12:49:09 -04:00
Ken Martin 35e13b11f3 BUG: revert doc changes since VS7 cannot compile them, will implement them in a different manner 2007-10-09 14:35:25 -04:00
Ken Martin 18ce24c748 ENH: make documentation entries actually store their data 2007-10-09 09:55:42 -04:00
Alexander Neundorf a347abe269 COMP: fix warning about unused parameters
Alex
2007-09-19 10:46:37 -04:00
Alexander Neundorf c5f249bdbd STYLE: move the code for the different formats of the generated help into
their own classes, making cmDocumentation smaller and also making it easier
to eventually add another format

Alex
2007-09-19 09:05:28 -04:00