Extending/Modifying KnotTheory`: Difference between revisions

From Knot Atlas
Jump to navigationJump to search
No edit summary
Line 5: Line 5:
===Seeing the sources===
===Seeing the sources===


The source files for <tt>KnotTheory`</tt> are kept in a [http://subversion.tigris.org/ Subversion] repository whose overall directory structure is as follows:
Visit the sources at [http://katlas.math.toronto.edu/svn/KnotTheory/ http://katlas.math.toronto.edu/svn/KnotTheory/] and especially at [http://katlas.math.toronto.edu/svn/KnotTheory/trunk/src/ http://katlas.math.toronto.edu/svn/KnotTheory/trunk/src/].

[http://katlas.math.toronto.edu/svn/KnotTheory/ http://katlas.math.toronto.edu/svn/KnotTheory/...]
* [http://katlas.math.toronto.edu/svn/KnotTheory/trunk/ trunk/...] contains the current "working" version of the package.
** [http://katlas.math.toronto.edu/svn/KnotTheory/trunk/KnotTheory/ KnotTheory/...] is an unpacked version of the whole package, as seen by users.
** [http://katlas.math.toronto.edu/svn/KnotTheory/trunk/src/ src/...] contains the individual mathematica "modules" that are glued together to make [http://katlas.math.toronto.edu/svn/KnotTheory/trunk/KnotTheory/init.m KnotTheory/init.m], the main execuatable of <tt>KnotTheory`</tt>.
* [http://katlas.math.toronto.edu/svn/KnotTheory/branches/ branches/...] currently unused.
* [http://katlas.math.toronto.edu/svn/KnotTheory/tags/ tags/...] currently unused.


===Writing Your Extension===
===Writing Your Extension===

Revision as of 15:58, 8 December 2005


Anybody is welcome, indeed encouraged, to fix, modify or extend the package KnotTheory` to the benefit of everybody else. This note explains how this can be done and outlines some of the conventions used within KnotTheory`.

Seeing the sources

The source files for KnotTheory` are kept in a Subversion repository whose overall directory structure is as follows:

http://katlas.math.toronto.edu/svn/KnotTheory/...

  • trunk/... contains the current "working" version of the package.
    • KnotTheory/... is an unpacked version of the whole package, as seen by users.
    • src/... contains the individual mathematica "modules" that are glued together to make KnotTheory/init.m, the main execuatable of KnotTheory`.
  • branches/... currently unused.
  • tags/... currently unused.

Writing Your Extension

Submitting Your Extension

KnotTheory` is a computer program written in an unrestricted language. Meaning that a vicious programmer could use it to do harmful things to the computer running it. Therefore unlike much of the rest of the Knot Atlas, it can be modified directly only by the administrators of this site. If you aren't one, email your extension/modification to Dror. Dror will read through it quickly to confirm that it's not malicious and doesn't do anything obviously wrong and post it in the Setup section of this manual. Thanks!