ArtWonk Packages

Packages

Packages are thematic groups of Functions, Macros and Patches supplied as add on packages which are created and maintained by the contributor. They are not simply example patches; rather they are extended works that include substantial documentation to provide you with comprehensive and comprehensible tools for advanced algorithmic composing.

To access Package documentation, go to the Help menu on the top menu bar. If any Packages have been installed, you will see a "Packages" submenu directly under the "Online Manual" choice. This will not be visible if no Packages have been installed.

Packages are available from the Algorithmic Arts Download page, and they may be available directly from Package authors. Algorithmic Arts will post links to Package authors as they notify us of available Packages they have authored.

Using Packages

To use a Package Patch or component module (Macro or Function), simply create it in the usual way with the Module menu that pops up when you right click on the Workspace background. The component will be in the Packages submenu under Macros or Functions. Package Patches are found in the Patches\Packages directory. Help for Packages are in the Help menu, under Help\Packages.

Installing Packages

Packages are saved in standard .zip format, and will unzip into the proper Packages submenus. Simply unzip into the ArtWonk directory. Using WinZip select "Extract" and then select the ArtWonk directory as the target directory. Do not select individual Package directories because the Extract function will automatically install - creating if necessary - the proper directory structures. For an example Package named "NewPackage\" these would be:

ArtWonk\Patches\Packages\NewPackage\
ArtWonk\Macros\Packages\NewPackage\
ArtWonk\Functions\Packages\NewPackage\
ArtWonk\Help\Packages\NewPackage\

Again, the creation of these subdirectories is automatic. All you need to do is be sure you select the "Extract" function in WinZip, or the equivalent function from your unzip program, and select the ArtWonk directory as the target.

All packages will install a Help directory entry, and at least one of the other three entries. After installing the Package, start ArtWonk, and look for the Help file in Help\Packages. If it is there, the Package was properly installed. The Help file will indicate what other items were installed.

How to create your own Package

It's easy to create your own Package. Make a directory structure as given for "NewPackage" above, replacing "NewPackage" with your package name. You need only make a subdirectory for Help and the specific Package components you want to provide. For example, if your package does not include Functions, you do not need to create the Functions subdirectory, etc. Only the Help subdirectory is absolutely required, and it must have a specific .htm file name "Help.htm"). For example, with a package named MyPackage this would be: ArtWonk\Help\Packages\MyPackage\\help.htm.

While only help.htm is required, you can put anything else you like in your Help subdirectory: images other .htm pages, even other subdirectories. The help.htm file acts as the index file in a web page, and any links it contains to other pages or images will load into the help browser as expected.

How to create an install .zip for your Package

By far the easiest way to create an install .zip file for your package is to create a dummy directory tree for it, copy the files into the subdirectories, then drag the top level folders onto WinZip and let it do the work for you. Here is a step by step example. Assumptions are that you are using a registered copy of WinZip as your zip file creator software, that your Package is named "MyPackage," and that you have some assortment of Patches, Macros, and Functions in your Package, plus the ever important Help file.

1. Create a temporary dummy directory, giving it any name you like (this one will be called "foo"):

c:\foo

2. Create the following subdirectories within c:\foo (only create the subdirectories you will actually need, for example if you aren't using Functions, don't create the c:\foo\Functions\ subdirectory):

c:\foo\Patches\Packages\MyPackage\
c:\foo\Macros\Packages\MyPackage\
c:\foo\Functions\Packages\MyPackage\
c:\foo\Help\Packages\MyPackage\

3. Copy the files you want to include in your Package from the ArtWonk directories to the appropriate subdirectories.

4. Go into the dummy directory ("foo" in the example) so that you see the top level folders, Patches, Macros, Functions and Help. Drag the those folders onto WinZip to create the Package .zip file. Create another dummy directory and unzip your Package into that to test it.

If you want to make your Package available to others, contact us (support@algoart.com) to include it with our Package download library.