Если вы некоторое время используете Mathematica, вы, вероятно, уже привязаны к центру документации. На этих страницах всегда есть что-то новое. Пусть это варианты для функции или просто некоторые примеры, которые в какой-то момент вам не показались полезными.
Вероятно, вы написали пакеты с вашими специализированными функциями, которые вы используете все время. Иногда вы можете подумать о аккуратном примере для использования с вашей функцией, но вполне вероятно, что он забудется где-то на вашем жестком диске. Если бы вы написали его в документации в тот момент, когда подумали об этом, возможно, вы не захотите его отчаянно позже.
По этой причине я хотел бы знать, как программно интегрировать документацию для ваших собственных функций с программным центром Mathematica. Этот вопрос здесь, чтобы изучить, как адаптировать документацию. Если у вас есть письменные сценарии, которые помогут вам сделать это, поделитесь им с сообществом.
Wolfram Workbench не является приемлемым решением для этого вопроса. Все должно быть сделано с простой установкой Mathematica. Существует несколько моментов, которые должно охватывать решение:
- Создание документации для функции (предпочтительно шаблон).
- Создание руководств и руководств (если они считаются полезными).
- Связывание ноутбуков с центром документации.
- Создание сообщений об использовании, которые отображаются правильно в разных средах.
- В ноутбуке Mathematica
?Symbol
- В Центре документации
Search: Symbol
- В ноутбуке Mathematica
Это очень широкая тема, у меня есть решения для 1, 2 и 3. Мне не хватает точки номер 4. Так скажите нам, как вы документируете свои функции в центре документации?
Update
Я добавил еще один ответ. Надеюсь, этот ответ более воодушевляет пользователей Mathematica писать страницы документации со своими пакетами. Я думаю, что написание страниц документации полезно для писателя приложения, а также для пользователей приложения. Если вы загрузите пакет, который я написал, я предлагаю вам следовать руководству, чтобы вы могли видеть, что происходит на каждом шагу. Это даст вам ценный опыт для будущих проектов.
Гитуб (24 мая 2014 года)
Поскольку я написал пакет, в этом пакете было заинтересовано несколько человек. Я загрузил пакет в Github: https://github.com/jmlopez-rod/ApplicationMaker. Пожалуйста, свяжитесь со мной, если вы хотите быть участником репозитория.