#212 Add handmade html pages to the MSDN chm file
Version: Nightly build source code
Framework: MS 1.0
Documenter: MSDN
Hello,
I wanted to add additional pages to the chm file. I
mentioned that you can add pages as you want, linking
them to the 'Overview' page. The bad thing is, they
don't appear in the TOC.
Solution: I added a new feature to NDoc (source code is
appended to the request) that allows to include any
pages you want, plus specify the layout of the pages in
the TOC. Additional, you ow can place the generated in-
code documentation in any book in the TOC you want to
(rendering the
options 'RootPageTOCName', 'RootPageFileName'
and 'RootPageContainsNamespaces' obsolete.
The layout of the TOC is configured using a simple XML
sytax as shown here:
<TOC>
<Book name="Overview" url="Overview.html">
<File name="What's new" url="WhatsNew.html"/>
<Book name="Other Pages">
<File name="Page1" url="Other\Page1.html"/>
<File name="Page2" url="Other\Page2.html"/>
</Book>
<File name="Contact" url="Contact.html"/>
</Book>
<Book name="Class reference">
<IncodeDocumentation/>
</Book>
</TOC>
As an example, this leyout would provide the following
TOC:
+ Overview
- What's new
+ Other Pages
- Page1
- Page2
- Contact
+ Class refernce
+ namespaces go here
+ another namespace
As you can see in the example, the feature supports
subdirectories, too.
I would be happy, if this feature would be included in the
next release of ndoc, as I saw, that other users have
the same problem adding handmade pages to their
generated chm file.
If you have questions, feel free to cantact me by mail:
miz -at- gmx -dot- de
Logged In: YES
user_id=725664
OK, indents is a problem with html, I know ;-)
Here are the indented versions of the samples above:
<TOC>
..<Book name="Overview" url="Overview.html">
....<File name="What's new" url="WhatsNew.html"/>
....<Book name="Other Pages">
......<File name="Page1" url="Other\Page1.html"/>
......<File name="Page2" url="Other\Page2.html"/>
....</Book>
....<File name="Contact" url="Contact.html"/>
..</Book>
..<Book name="Class reference">
....<IncodeDocumentation/>
..</Book>
</TOC>
and
+ Overview
..- What's new
..+ Other Pages
....- Page1
....- Page2
..- Contact
+ Class refernce
..+ namespaces go here
..+ another namespace
Source code changes (updated)
Logged In: YES
user_id=725664
Sorry for the frequent updates, I am running into problems
with my new features ;-)
Now I enhaned the feature by copiing recursively the content
of the directories the rferenced files are in, so that the MS
Help Compiler finds resources that are referenced within the
HTML files.
Now you don't have to care about resources you are unsing in
your handmade html files as log as they are present in the
same folder and/or a subfolder.
The files are NOT included in the hhp file explicitly, so only
the files that are really referenced are comiled in the chm.
Logged In: YES
user_id=682034
Michael - thanks a lot.
I stumbled over two issues trying to use this feature.
1. Make sure you see/set the TOCLayoutFileName property
in the "Html Help Options" section.
2. Make sure you use forwardslashes "/" and not
backslashes "\" in the url properties of the toc tags.
Thanks again Andi