Интеграция записных книжек в центр документации Mathematica

Если вы какое-то время использовали Mathematica , вы, вероятно, стали привязаны к центру документации. На этих страницах всегда есть что-то новое. Пусть это будут параметры функции или просто некоторые примеры, которые в какой-то момент не казались вам полезными.

Вероятно, вы написали пакеты со своими специализированными функциями, которые вы используете постоянно. Иногда вы можете придумать изящный пример для использования с вашей функцией, но вполне вероятно, что в конечном итоге он будет забыт где-то на вашем жестком диске. Если бы вы написали это в документации в тот момент, когда вы об этом подумали, возможно, вы бы не стали отчаянно искать его позже.

По этой причине я хотел бы знать, как интегрировать документацию для ваших собственных функций с Центр документации Mathematica программно. Этот вопрос здесь, чтобы узнать, как адаптировать документацию. Если вы написали сценарии, которые помогут вам в этом, поделитесь ими с сообществом.

Wolfram Workbench не является приемлемым решением для этого вопроса. Все должно быть сделано с помощью простой установки Mathematica . Это решение должно охватывать несколько моментов:

1. Создание документации для функции (предпочтительно шаблона).
2. Создание руководств и учебных пособий (если они будут сочтены полезными).
3. Связывание записных книжек с документацией center.
4. Создание сообщений об использовании, которые правильно отображаются в различных средах.
   • В Mathematica Notebook ? Символ
   • В Центре документации Поиск: Символ

Это действительно обширная тема, у меня есть решения для 1, 2 и 3. Мне не хватает номера точки 4. Итак, расскажите нам, как вы документируете свои функции с помощью центра документации?

Обновление

Я добавил еще один ответ. Надеюсь, этот ответ больше вдохновляет пользователей Mathematica писать страницы документации со своими пакетами. Я думаю, что написание страниц документации полезно как для автора приложения, так и для пользователей приложения. Если вы загрузили пакет, который я написал, я предлагаю вам следовать руководству, чтобы вы могли видеть, что происходит на каждом этапе. Это даст вам ценный опыт для будущих проектов.

Github (24 мая 2014 г.)

С тех пор, как я написал пакет, этим пакетом заинтересовались несколько человек. Я загрузил пакет на Github: https://github.com/jmlopez-rod/ApplicationMaker . Пожалуйста, свяжитесь со мной, если вы хотите участвовать в репозитории.