Group Abstract Group Abstract

Message Boards Message Boards

Create and add your own documentation file into the documentation center?

Posted 9 years ago

Hello! I want to know learn how to create their own documentation. I do not care page layout documents. I want to understand how to create a file that will open when searching for the name in the documentation center. This file may be in an arbitrary position?

POSTED BY: Kirill Belov
3 Replies

Kirill,

I have an essay at my web site called A Mathematica Style that among other things gives an overview of using Workbench to create documentation. Documentation would usually be part of a larger entity called a Mathematica Application, which might include various combinations of notebooks, packages, style sheets. palettes and documentation. The essay discusses how to lay this all out. Mathematica Applications are quite a standard part of Mathematica and the Wolfram Language and a good way to organize work.

Workbench comes with Premier service but there may be other ways to obtain it. You would have to contact Support.

Recent versions of Mathematica, V10+, require Workbench 3. This is not even in formal beta testing, but it usually can be obtained by contacting Wolfram. I use it constantly for documentation and it works perfectly well. I don't know what Wolfram's long term plans are for documentation. I just cross my fingers and hope that whatever it is, it will maintain compatibility with present paclet documentation.

Posted 9 years ago

Thank you! I understand that it is better to use a ready-made solutions. But I want to understand what needs to be done to create a document that will be searched in the documentation center, without creation of the applications, installation and etc.

POSTED BY: Kirill Belov
POSTED BY: Szabolcs Horvát
Reply to this discussion
Community posts can be styled and formatted using the Markdown syntax.
Reply Preview
Attachments
Remove
or Discard