Generate Documentation which includes "handwritten" Topics

Topics: Conceptual Topics, Features, General Questions
Jan 13, 2009 at 11:05 AM
Hello!


I would like to generate a Documentation which is organized like MSDN, where each Topic normally consists of a "About", "Using" and "Reference" Section. Each one can have additional Sub-Topics and also "Folders". Each on shall be able to link to each other. IIRC Sandcastle is able to generate this, and the Sandcastle Helpfile Builder also supports this.

Is this also possible in DocProject? How can this be achived?

Thank you!
Jan 13, 2009 at 12:12 PM
Hi,

DocProject provides first-class support for Sandcastle's conceptual documentation process, which allows you to create help topics like "About" and "Using".  It will also automatically merge conceptual topics with auto-generated reference topics and you can define the placement of the root API reference topic in the table of contents (TOC).

Your conceptual topics must be written in MAML, which is an XML schema for structured authoring.  You'll find links to more information about MAML here:

Sandcastle Help
http://www.codeplex.com/DocProject/Wiki/View.aspx?title=Sandcastle%20Help#MAML

I also recommend taking a look at the MAML guide at the Sandcastle Styles project:

http://www.codeplex.com/SandcastleStyles/Release/ProjectReleases.aspx?ReleaseId=17333 

And also this article:

How To Enable IntelliSense in Conceptual Topics
http://www.codeplex.com/DocProject/Wiki/View.aspx?title=How%20To%20Enable%20IntelliSense%20in%20Conceptual%20Topics

In DocProject, Topic Explorer is used to manage the table of contents (TOC).  You can add new topics, nest topics, and even place the auto-generated reference structure under a "Reference" topic if you'd like, by simply dragging & dropping nodes.

See How To Use The Topic Management Dialog for more information about Topic Explorer and related features.

Note: Sandcastle does not currently provide support for folder-only nodes.  You must always have a topic associated with each node in the TOC as of DocProject 1.11.0 RC.

Look in the wikimap for additional help topics.

- Dave
Jan 13, 2009 at 12:33 PM

Hello Dave,

thank you for providing all this information and the links. I’ll check them out. I already thought, that there must be something within DocProject that allow me to create such a documentation.

Günter



powered by Exchange 2007 - hosted by a Microsoft Gold Partner - visit us www.world-direct.at