This project has moved. For the latest updates, please go here.

Recommended way to send a url of documentation topic to someone

Topics: User Forum
Jun 17, 2011 at 3:29 PM

I often find myself sending a link in a email to someone saying something like, "read more here".  Where 'here' is a hyperlink to the documentation in web output format.

Getting that address so it not only shows the page, but also displays the table of contents, seems to involve an exercise of putting it together in notepad.

For example, if I want to send someone to a specific page and show the table contents the url is 'http://yoursite/Index.aspx?topic=html/topicguid.htm'.

There doesn't seem to be an 'easy' way to get that unless I'm missing something.  I see that I can right click on a topic in the table of contents and copy the link address to the clipboard but that url does not display the table of contents, e.g. 'http://yoursite/html/topicguid.htm'.

Any thoughts?

Jun 21, 2011 at 7:19 PM

So far the only way to get a link that shows the TOC is to copy the link to the clipboard using the context menu on the TOC link and then insert "Index.asxp?topic=" in front of the "html/" part of the link once you paste it somewhere.



Jun 21, 2011 at 8:25 PM

So if I wanted to add a 'Link to this page with TOC' anchor element that would do this for me on each, would I be modifying something in the SHFB files or the Sandcastle tools itself?  I see some files under SHFB which seem to be responsible for generating the web output?

Jun 26, 2011 at 10:31 PM

It's possible you could modify the Index.aspx file and/or TOC.js to add that functionality.  It's been a while since I've done any web stuff so I can't think of any suggestions on how that might be accomplished right now without some research.