2011-06-29 57 views
9

有沒有人遇到過創建文檔的教程,以便在中創建函數Mathematica?我試圖組織我編寫的一些功能,但到目前爲止,我正在做一件糟糕的工作。我真的希望明確地爲函數和文檔創建一個文件,並以某種方式爲Mathematica文檔添加一個路徑,以便Mathematica也可以搜索它。Mathematica:函數文檔

採取了Sin函數的文檔,例如:

doc

當你點擊箭頭它打開與在Sin功能信息的筆記本電腦。我嘗試複製該筆記本的內容並粘貼到新的筆記本中,以便我可以對其進行編輯,但無法修改內容。

我真的很喜歡Mathematica的文檔格式,我想以同樣的方式記錄我的功能以備將來參考。有沒有人知道如何以Mathematica的相同方式記錄函數?

+2

完全集成到Mathematica Help中的文檔頁面可以使用'Workbench'創建。有一個很好的截屏視頻教程(由亞當貝瑞)可用[這裏](http://www.wolfram.com/broadcast/screencasts/workbench/documentation/)。其他工作臺截屏視頻教程可在[這裏](http://www.wolfram.com/products/workbench/videos/) – tomd

+1

我認爲這個問題部分相關:「[方便添加內聯格式化使用信息](http ://stackoverflow.com/questions/6419830/convenient-way-to-add-inline-formatting-to-usage-messages)」。 –

+0

@Alexey,我認爲你發佈的內容非常相關。我正在嘗試編寫一些C函數,我希望能夠格式化使用標記。我真的很想知道如何在郵件中加入超鏈接。我在閱讀所有答案後正在考慮'Workbench',但我真的不想用Wolfram填寫另一個表單來下載它。 – jmlopez

回答

1

我認爲你正在尋找::用法。查看Documentation Center中的tutorial/DocumentationConstructs。

+2

我用::用法來得到一個簡短的描述。但我真正感興趣的是如何構建整個文檔頁面。通過這種方式,我將能夠寫出更多關於函數的信息和示例,就像他們對其他Mathematica函數所做的一樣。 – jmlopez