Additional Topics

Topics: Features, General Discussion
Jul 9, 2007 at 11:55 PM
I've just come across ProjectDoc and so far I've been very impressed. Thank You.

One thing I'm wondering though, is it possible to write additional topics that aren't directly attached to a code construct. For example, suppose I wanted to write a couple of topics that explain various usage scenarios, conceptual background or other general information about a component, where would I put that? I've seen the Summary HTML in the API Topic Management, but I really need to be able to create a number of such pages for the project as a whole. Also I'd prefer keep the content of these in the original code base - not in a separate format/location.

Brad
Coordinator
Jul 10, 2007 at 12:23 AM
Hi Brad,

DocProject supports the addition of custom topics but you have to do most of the work in the current release.

For help see Creating Custom Topics. You may also find Ben Hall's blog post on the subject useful:

DocProject and creating custom topics
http://blog.benhall.me.uk/2007/07/sandcastle-docproject-and-creating.html

There are also a few work items for custom topics that you can vote on:

Currently, I'm waiting on the Sandcastle team to provide a built-in mechanism for adding additional topics as part of the standard build process. The conceptual transformations that shipped with the June 2007 CTP look promising but aren't functional yet.

Thanks,
Dave
Coordinator
Jul 10, 2007 at 2:02 PM
Hi Brad,

Here's some more information:

Adding Additional Topics Using DocProject
http://davesexton.com/blog/blogs/blog/archive/2007/07/10/AddingAdditionalTopicsUsingDocProject.aspx

- Dave