This project has moved and is read-only. For the latest updates, please go here.

Frame-less HTML output

Topics: Developer Forum, Project Management Forum, User Forum
Mar 22, 2007 at 7:22 PM
Has there been any consideration of a frame-less html output? This would allow hyperlinking directly to a specific topic from an email, web page, word doc, etc. Also it would be great if the html page for each topic was the fully qualified name of the class or method as opposed to a guid. Basically I'd like to create links to our own internal documentation in the same style as the online MSDN documentation similar to the following:

Thanks for making this great tool available!
Mar 22, 2007 at 8:20 PM
Edited Mar 22, 2007 at 8:22 PM
There's an open work item to update the web output to use frame-less HTML. I haven't looked into making the change yet. However, it is just an HTML page so you can just link to it and it would open. The only thing missing would be the table of content.

Regarding the filenames, you can use the NamingMethod property to use member names or hashed member names. See the help file for details. It includes code snippets showing how you can link to the pages when using those options.

Mar 22, 2007 at 9:13 PM
Thanks Eric, that will at least allow for the hyperlink scenario I spoke of. It would be nice of course to maintain the table of contents. For what it's worth, one possible way to do this would be to link to the index.html page but pass the desired topic name in the querystring, something like index.html?topic=PropertiesTClass_PropertyName and use JavaScript to set the src of the frame and to automatically sync the TOC. It might also be nice to have a permalink button on the topic template that would construct the url like above and put it on the clipboard. That would make it easy to effectively copy and paste a url to a specific topic from within the browser.

Thanks again.

Apr 16, 2009 at 8:05 AM
Sandcastle and permanent links in html documentation