5
$\begingroup$

I'd like to create and distribute a notebook that functions very much like the help window that appears in Mathematica to provide documentation about functions, tutorials, and etc., but my content would be an entirely different subject. In particular, I'd like the search functionality, hierarchical breadcrumb links across the top, styling ands sectioning, cross-referencing, right-click access from a different notebook, etc.

I get that a lot of this is probably hand-coded into each page, but there must be serious infrastructure in the notebook, and I'd like to mimic it. Does that help system exist as a single notebook somewhere, or is it a more distributed system?

Any suggestions or pointers would be welcome.

|improve this question
$\endgroup$
  • 1
    $\begingroup$ You could maybe start with putting a docked cell at the top. Hope this keyword will help. $\endgroup$ – Szabolcs Mar 4 '15 at 18:21
  • $\begingroup$ Thanks. I'm familiar with "docked" cells, but going down that road means rolling my own. I'm hoping I can just use the help system infrastructure, perhaps by copying and changing the "content" of its notebook (if there is one), or invoking whatever package/code it might invoke. $\endgroup$ – ibeatty Mar 4 '15 at 18:41
  • 2
    $\begingroup$ Wolfram Workbench can create documentation. However, it is a separate program that requires a separate license. $\endgroup$ – bbgodfrey Mar 4 '15 at 19:11
  • 2
    $\begingroup$ related: Creating cross-version compatible documentation with Workbench $\endgroup$ – Kuba♦ Mar 4 '15 at 22:58
1
$\begingroup$

Thanks for the tip, @bbgodfrey. I dug into the online docs for Workbench, and see that it does in fact offer precisely the kind of functionality and information I was hoping for.

|improve this answer
$\endgroup$

Your Answer

By clicking "Post Your Answer", you acknowledge that you have read our updated terms of service, privacy policy and cookie policy, and that your continued use of the website is subject to these policies.

Not the answer you're looking for? Browse other questions tagged or ask your own question.