Brandon Van Every wrote:
On 10/19/07, Fernando Cacciola
<[EMAIL PROTECTED]> wrote:
Is there any hyperlinked (and preferably indexed) command reference?
There's the book "Mastering CMake."
OK
Electronically, nope. It would be nice. We've discussed doc
improvement strategies in the past few months on this mailing list,
but I must admit I haven't done anything. Too busy. It's something
CMake needs in the long term. In the short term, I keep filing doc
bugs / clarifications in the bug tracker, and some of those are indeed
getting knocked off by Kitware. I amend things on the wiki as I have
time and energy, as do others. So the docs are gradually improving.
Hyperlinks, indices, Table Of Contents, and synching the wiki with the
shipped docs are pretty major items though, not gradual.
I read in a DDJ article that each command returns its own documentation.
(And cmake.exe builds up the single-page doc based on that).
Assuming that's true (I haven't seen any source code), isn't it somewhat
simple to extend the pattern so that each command outputs also an HTML
friendly documentation entryr?
Something like:
command->get_documentation_html_anchor();
command->get_documentation_html_entry();
The first would return "<a href="#command_id>Command</a>" line, to be put in
a list on the top of the html document.
And the second would return a "<a name="command_id>Command</a><p>COMMAND
EXPLANATION</p>"
It shouldn't be so difficult to add that based on the current documentation
function.. is just a matter of adding the HTML formating.
Best
--
Fernando Cacciola
SciSoft
http://fcacciola.50webs.com
_______________________________________________
CMake mailing list
[email protected]
http://www.cmake.org/mailman/listinfo/cmake
