2011-06-29 33 views
9

Có ai đi qua hướng dẫn để tạo tài liệu cho các hàm bạn tạo trong Mathematica? Tôi đang cố gắng tổ chức một số chức năng mà tôi đã viết nhưng cho đến nay tôi đang làm một công việc khủng khiếp. Tôi thực sự muốn có một tập tin rõ ràng cho các chức năng và một cho tài liệu và bằng cách nào đó thêm một đường dẫn đến tài liệu Mathematica để Mathematica cũng có thể tìm kiếm nó.Mathematica: Tài liệu Chức năng

Lấy tài liệu cho Sin chức năng ví dụ:

doc

Khi bạn nhấn chuột vào mũi tên nó sẽ mở ra một máy tính xách tay với thông tin về Sin chức năng. Tôi đã thử sao chép nội dung của sổ ghi chép đó và dán vào sổ tay mới để tôi có thể chỉnh sửa nó nhưng tôi không thể sửa đổi nội dung.

Tôi thực sự thích định dạng Mathematica cho tài liệu và tôi muốn ghi lại các chức năng của mình theo cách tương tự để tham khảo trong tương lai. Có ai biết làm thế nào để tài liệu chức năng giống như cách Mathematica không?

+2

Các trang tài liệu được tích hợp đầy đủ vào Trợ giúp Mathematica có thể được tạo bằng cách sử dụng 'Bàn làm việc'. Có một hướng dẫn sử dụng màn hình đẹp (bởi Adam Berry) có sẵn [ở đây] (http://www.wolfram.com/broadcast/screencasts/workbench/documentation/). Các hướng dẫn về màn hình Workbench khác có sẵn [ở đây] (http://www.wolfram.com/products/workbench/videos/) – tomd

+1

Tôi nghĩ câu hỏi này có liên quan một phần: "[Cách thuận tiện để thêm định dạng nội tuyến vào Thông báo sử dụng] (http : //stackoverflow.com/questions/6419830/convenient-way-to-add-inline-formatting-to-usage-messages) ". –

+0

@ Alexey, tôi nghĩ rằng những gì bạn đăng ở đó là khá phù hợp. Tôi đang cố gắng viết một số hàm C và tôi muốn có thể định dạng thẻ sử dụng. Tôi thực sự tự hỏi làm thế nào để đặt một siêu liên kết trong các tin nhắn quá. Tôi đã suy nghĩ về 'Workbench' sau khi đọc tất cả các câu trả lời nhưng tôi thực sự không cảm thấy muốn điền vào một biểu mẫu khác với Wolfram chỉ để tải xuống nó. – jmlopez

Trả lời

1

Tôi nghĩ bạn đang tìm kiếm :: sử dụng. Hãy xem hướng dẫn/DocumentationConstructs trong Trung tâm Tài liệu.

+2

Tôi đã sử dụng :: cách sử dụng để có mô tả ngắn. Nhưng những gì tôi thực sự quan tâm là làm thế nào để xây dựng toàn bộ trang tài liệu. Theo cách đó tôi sẽ có thể viết thêm thông tin và ví dụ về các hàm giống như chúng làm với các hàm Mathematica còn lại. – jmlopez

7

Bạn có thể sử dụng bàn làm việc của Mathematica để create documentation.

videos here cũng tốt để bắt đầu sử dụng Wolfram Workbench.

Các vấn đề liên quan