Is it possible to combine two pages created by SandCastle into one main page?

For each project class, SandCastle creates (among other things) two pages:

  • The main page, called T_class_full_name , with a description, syntax, inheritance hierarchy, and see also
  • A member page called AllMembers_T_class_full_name , with constructors, methods, fields, etc.

Is there a way to combine the two together - with the addition of members page to the main page?

+68
sandcastle code-documentation
Jan 12 '10 at
source share
1 answer

I cannot provide a working answer for this, but I can offer some ideas that might work if someone wants to hack it:

1. The htmlBody.xsl configuration defines a part of the structure, including a section with a test for members: <xsl:if test="$subgroup='members'"> If it was enabled at the class level (or simply set to true, this can give you an idea of โ€‹โ€‹how this conclusion is created. (I donโ€™t think there will be a magic bullet here).

2.here (I think) where links to member subgroups are added, I would also play around with this:

 <!-- add a link to the member list section for this subgroup --> <a href="#{$elementVisibility}Toggle" onclick="OpenSection({$elementVisibility}Toggle)"> 

3. I have other ideas trying to play with the structure, but I will need to crack it to give a clear answer. I'm not even sure that htmlBody.xsl is the place to go. If I really had an urgent need, I think that I could achieve your goal the easiest way by doing the following:

  • Generate documentation in a standard way
  • Analyze the generated documentation and merge it using the DOM / XML parser (i.e. merge two codes and issue a new HTML document with one page with updated URLs on the bindings on the current page).

The best part is that the generated files and links have a consistent naming scheme, so I would think that it would be easier to write this process and update all the links that should be anchors than it would be too much to mess with templates. I actually think this will be quite easy to do for someone who has come across this type of document manipulation.

Caution: I am not even close to the SandCastle expert who used it only minimally and more than a year ago. I also did not conduct at any time until today a consideration of how I hacked it, only using it out of the box. I would not even answer this, except for the lack of other answers. There may be a supported configuration method for this, but I, as a regular user, cannot even think about how to approach it.

I also make some assumptions about how HTML output will look based on my experience with SHFB. I may be choking too much. I no longer have a project from which I can create sandcastle documentation, but if someone can post a link to some HTML output from SandCastle and are interested in this approach, I would be happy to help further.

+2
Jan 28 '13 at 22:13
source share



All Articles