2011-06-29 26 views
9

¿Alguien ha encontrado un tutorial para crear documentación para las funciones que crea en Mathematica? Estoy tratando de organizar algunas funciones que he escrito, pero hasta ahora estoy haciendo un trabajo terrible. Realmente me gustaría tener un archivo explícitamente para las funciones y otro para la documentación y de alguna manera agregar una ruta a la documentación de Mathematica para que Mathematica también pueda buscarla.Mathematica: Documentación de función

Tome la documentación de la función Sin por ejemplo:

doc

Al hacer clic en las flechas que se abre un cuaderno con información sobre la función Sin. Traté de copiar el contenido de ese cuaderno y pegarlo en un cuaderno nuevo para poder editarlo, pero no puedo modificar el contenido.

Me gusta mucho el formato de Mathematica para la documentación y me gustaría documentar mis funciones de la misma manera para referencia futura. ¿Alguien sabe cómo documentar las funciones de la misma manera que lo hace Mathematica?

+2

Las páginas de documentación que están completamente integradas en la Ayuda de Mathematica pueden crearse utilizando 'Workbench'. Hay un buen tutorial de screencast (por Adam Berry) disponible [aquí] (http://www.wolfram.com/broadcast/screencasts/workbench/documentation/). Otros tutoriales de screencast de Workbench están disponibles [aquí] (http://www.wolfram.com/products/workbench/videos/) – tomd

+1

Creo que esta pregunta es parcialmente relevante: "[Forma conveniente de agregar formato en línea a los mensajes de uso] (http : //stackoverflow.com/questions/6419830/convenient-way-to-add-inline-formatting-to-usage-messages) ". –

+0

@Alexey, creo que lo que publicaste allí es bastante relevante. Intento escribir algunas funciones C y me gustaría poder formatear la etiqueta de uso. Realmente me pregunto cómo poner un hipervínculo en los mensajes también. Estaba pensando en 'Workbench' después de leer todas las respuestas, pero realmente no tengo ganas de rellenar otro formulario con Wolfram solo para descargarlo. – jmlopez

Respuesta

1

Creo que estás buscando :: uso. Eche un vistazo al tutorial/DocumentationConstructs en el Centro de documentación.

+2

He utilizado :: uso para obtener una breve descripción. Pero lo que realmente me interesa es cómo crear toda la página de documentación. De esa manera, podré escribir más información y ejemplos sobre las funciones tal como lo hacen con el resto de las funciones de Mathematica. – jmlopez

Cuestiones relacionadas