Baudokumentation mit interaktiven Beispielen in Wolfram Mathematica

  • In der Dokumentation von Wolfram Mathematica finden Sie interaktive Beispiele. Um sie zu kompilieren, brauchen wir nur Shift + Enter . Ich möchte solche Beispiele für Funktionen aus meinem eigenen Paket entwickeln. Wie kann ich das tun?


    Vielen Dank für Kommentare ..Ich Verwenden Sie W. Workbench 2.0, um Dokumentation zu erstellen. Aber hier ist das Problem beim Bauen, selbst die Beispiele wie NumericalAnalysis sind mit Fehlern fehlgeschlagen:

    BUILD FAILED

    C: \ Dokumente und Einstellungen \ NumericalAnalysis \ docbuild.xml: 132: Bei der Ausführung dieser Zeile ist der folgende Fehler aufgetreten:

    C: \ Dokumente und Einstellungen \ NumericalAnalysis \ docbuild.xml: 97: Der folgende Fehler ist bei der Ausführung dieser Zeile aufgetreten:

    C: \ Programme \ Wolfram Research \ WolframWorkbench \ 2.0 \ configuration \ org.eclipse.osgi \ bundles \ 10 \ 1.cp \ MathematicaSource \ DocumentationBuild \ SystemFiles \ ant \ Build \ notebook.xml: 71: Fehler beim Starten oder Herstellen einer Verbindung zum Mathematica-Kernel: Das verbundene MathLink-Programm hat eine Verbindung Der Link wurde geschlossen, aber möglicherweise sind noch Daten im Gange.

    Gesamtzeit: 3 Sekunden

    Wenn jemand Vorschläge hat, schreiben Sie bitte!

    14 June 2012
    Mr.Wizard
2 answers
  • Diese Antwort soll schrittweise aktualisiert werden, da ich selbst Erfahrung mit dieser Funktionalität habe. Ich gehe davon aus, dass Sie Wolfram Workbench und die dazugehörigen Dokumentations-Authoring-Tools verwenden.

    Wie in der Dokumentation beschrieben, müssen Sie sicherstellen, dass sich Ihre Pakete in einer richtigen Verzeichnisstruktur befinden für eine Mathematica-Anwendung. Sie können dies tun, indem Sie zunächst in Workbench als Projekttyp "Anwendung" auswählen. ( Datei & gt; Neues & gt; Projekt ) Baudokumentation mit interaktiven Beispielen in Wolfram Mathematica

    Wenn Sie bereits Pakete haben, müssen Sie sie in diese Struktur verschieben. auf der obersten Ordner für das Projekt. (Ich habe den Projektnamen hier verdeckt, um meinen Arbeitgeber nicht zu identifizieren.)

    Baudokumentation mit interaktiven Beispielen in Wolfram Mathematica

    Rechtsklicken / Klicken Sie bei gedrückter Strg-Taste auf einen der Unterordner in der Dokumentationsordnerstruktur und wählen Sie Neu & gt; Notebook-Datei .

    Baudokumentation mit interaktiven Beispielen in Wolfram Mathematica

    Nach dem Erstellen können Sie mit der rechten Maustaste auf diese Datei klicken, um sie in Mathematica zu öffnen. Wenn Mathematica auf diese Weise gestartet wird, wird ein Menüpunkt für Dokumentationswerkzeuge in das Menü Pallettes aufgenommen.

    Baudokumentation mit interaktiven Beispielen in Wolfram Mathematica

    Klicken Sie auf die Schaltfläche Dienstprogramme , um die anzuzeigen > Schaltfläche Funktionsseiten erstellen . Wenn Sie hierauf klicken, werden neue Dokumentationsseiten für alle der in Ihrem Paket definierten Funktionen und Optionen generiert. Es ist auch klug genug, durchzugehen, wenn Ihr Hauptpaket andere benutzerdefinierte Pakete aufruft und auch Dokumentation für diese Objekte erstellt. Mein aktuelles Projekt verfügt über rund 60 neue Funktionen und Optionen. Es hat ungefähr drei Minuten gedauert, bis alle Seiten erstellt wurden.

    Damit dies funktioniert, ist es jedoch wichtig, dass Sie bereits für alle Funktionen gute Verwendungsnachrichten definiert haben und Optionen, die in Ihren Paketen definiert sind. Nutzungsnachrichten müssen mit dem Namen der Funktion beginnen, um richtig erkannt zu werden: siehe Beispiel in der Abbildung unten.

    [&&8

    11 June 2012
    Verbeia
  • Schauen Sie sich Wolfram Workbench 2 und seine Dokumentation an. Sie zeigen, wie Hilfeseiten ähnlich wie die eingebauten eingerichtet werden.

    10 June 2012
    Rob Burke