2011-06-29 6 views
9

Est-ce que quelqu'un a trouvé un tutoriel pour créer la documentation des fonctions que vous créez dans Mathematica? J'essaie d'organiser certaines fonctions que j'ai écrites mais jusqu'à présent, je fais un travail terrible. Je voudrais vraiment avoir un fichier explicitement pour les fonctions et un pour la documentation et ajouter en quelque sorte un chemin à la documentation de Mathematica pour que Mathematica puisse également la rechercher.Mathematica: Documentation des fonctions

Prenez la documentation de la fonction Sin par exemple:

doc

Lorsque vous cliquez sur les flèches, il ouvre un ordinateur portable avec des informations sur la fonction Sin. J'ai essayé de copier le contenu de ce cahier et de le coller dans un nouveau cahier afin de pouvoir le modifier mais je ne peux pas en modifier le contenu.

J'aime vraiment le format de Mathematica pour la documentation et je voudrais documenter mes fonctions de la même manière pour référence future. Est-ce que quelqu'un sait comment documenter les fonctions de la même manière que Mathematica?

+2

Les pages de documentation entièrement intégrées dans l'aide de Mathematica peuvent être créées à l'aide de 'Workbench'. Il y a un joli tutoriel de screencast (par Adam Berry) disponible [ici] (http://www.wolfram.com/broadcast/screencasts/workbench/documentation/). D'autres didacticiels Screencast Workbench sont disponibles [ici] (http://www.wolfram.com/products/workbench/videos/) – tomd

+1

Je pense que cette question est partiellement pertinente: "[Manière pratique d'ajouter le formatage en ligne aux messages d'utilisation] (http : //stackoverflow.com/questions/6419830/convenient-way-to-add-inline-formatting-to-usage-messages) ". –

+0

@Alexey, je pense que ce que vous avez posté là-bas est assez pertinent. J'essaye d'écrire des fonctions C et j'aimerais pouvoir formater la balise d'utilisation. Je me demande vraiment comment mettre un lien hypertexte dans les messages aussi. Je pensais à 'Workbench' après avoir lu toutes les réponses, mais je n'ai vraiment pas envie de remplir un autre formulaire avec Wolfram juste pour le télécharger. – jmlopez

Répondre

1

Je pense que vous cherchez: utilisation. Jetez un coup d'oeil au tutoriel/DocumentationConstructs dans le centre de documentation.

+2

J'ai utilisé :: utilisation pour obtenir une courte description. Mais ce qui m'intéresse vraiment, c'est comment construire toute la page de documentation. De cette façon, je serai en mesure d'écrire plus d'informations et d'exemples sur les fonctions comme avec le reste des fonctions de Mathematica. – jmlopez

Questions connexes