相关疑难解决方法(0)

如果您已经使用Mathematica一段时间,您可能已经加入了文档中心.在这些页面中总会找到新的东西.让它成为一个函数的选项,或者只是一些在某些时候似乎对你没用的例子.

您可能已经编写了包含您始终使用的专用函数的软件包.有时您可能会想到一个与您的功能一起使用的简洁示例,但很可能它最终被遗忘在硬盘中的某个地方.如果您在考虑它的那一刻就将其写入文档,那么您可能不会在以后拼命寻找它.

出于这个原因,我想知道如何以编程方式将Mathematica文档中心的文档集成到您自己的函数中.这个问题是为了探索如何调整文档.如果您有编写的脚本可以帮助您执行此操作,请与社区分享.

对于这个问题,Wolfram的Workbench不是一个可接受的解决方案.一切都必须通过Mathematica的简单安装完成.解决方案应涵盖以下几点:

1. 为函数创建文档(最好是模板).
2. 创建指南和教程(如果他们认为有用).
3. 将笔记本电脑链接到文档中心.
4. 创建在不同环境中正确显示的"使用"消息.
   • 在Mathematica笔记本中 ?Symbol
   • 在文档中心 Search: Symbol

这是一个非常广泛的主题,我有1,2和3的解决方案.我缺少第4点.那么请告诉我们,您如何使用文档中心记录您的功能？

更新

我添加了另一个答案.希望这个答案对于Mathematica的用户用他们的包编写文档页面更令人鼓舞.我认为编写文档页面对应用程序编写者以及应用程序的用户都是有益的.如果你下载我写的软件包,我建议你按照教程进行操作,这样你就可以看到每一步都会发生什么.这将为您未来的项目提供宝贵的经验.

Github(2014年5月24日)

自从我写这个软件包以来,有几个人对这个软件包很感兴趣.我已将软件包上传到Github:https://github.com/jmlopez-rod/ApplicationMaker.如果您想成为存储库的贡献者,请与我联系.

有没有人遇到过为您在Mathematica中创建的函数创建文档的教程？我正在尝试组织一些我写过的函数,但到目前为止,我的工作非常糟糕.我真的希望有一个文件显式的功能和一个文档,并以某种方式添加Mathematica文档的路径,以便Mathematica也可以搜索它.

以该Sin函数的文档为例:

当您单击箭头时,它会打开一个包含该Sin功能信息的笔记本.我试着复制那个笔记本的内容并粘贴在一个新的笔记本上,以便我可以编辑它,但我无法修改内容.

我非常喜欢Mathematica的文档格式,我想以同样的方式记录我的函数以供将来参考.有没有人知道如何以与Mathematica相同的方式记录功能？