Conceptual Topic - Embed Text

Topics: Conceptual Topics
May 14, 2009 at 1:48 AM

Hi,

I am working on creating user documentation using DocProject.  I have created a new conceptual topic and in this file I would like to embed the text contained in the <summary> tags from the top of a class (and hopefully adhereing to the rules of the tags within this summary block).  e.g.

///<summary>

some text...

maybe another tag <exceptions/>...

//</summary>

public internal Class A

{

}

Is this possible?

Thanks in advance,

Janie

Jun 21, 2009 at 12:16 AM

Hi Janie,

I'm sorry for the delay - I must have missed your question and just noticed it sitting there unanswered :|

If you're trying to add XML markup into a conceptual topic, then you can use the <markup> element; however, this requires that the Sandcastle Styles patch be applied before creating your DocProject or DocSite.  If you've already created your project but haven't applied the patch yet then you must apply the patch and create a new project.  You can use the Import Topics and Settings wizard step (#3) to import content and settings from the old project into the new project.

If I'm not understanding your question correctly then please provide more details about what you are trying to accomplish.

- Dave