GPX Spinner  
Home
Examples
Help
Download
Links
 

List of Options in GPX Spinner.ini file

The following options can be specified in GPX Spinner.ini

Name Description
Input_Path This is where GPX Spinner will search for input files if none are specified on the command line or by dragging and dropping.

Default is the application directory.

Input_Path_Recursive Tells GPX Spinner whether to read all sub-directories of the input path. Also applies when directories, rather than files, are specified on the command line or by dragging and dropping.
Ignore_List Specifies the filename of the Ignore list. For more information on the Ignore list, see Customizing GPX Spinner.

Default is no Ignore list. If a full path is not supplied, it will be relative to the application directory.

Corrected_List Specifies the filename of the Corrected Cache list. For more information on the Corrected Cache list, see Customizing GPX Spinner.

Default is no Corrected Cache list. If a full path is not supplied, it will be relative to the application directory.

Reference_Locations Specifies the filename of the Reference Locations list. For more information on the Reference Locations list, see Customizing GPX Spinner.

Default is no Reference Locations list. If a full path is not supplied, it will be relative to the application directory.

Watcher_Directory If you use Watcher, set this variable to have GPX Spinner use Watcher's ignore list.
Templates_Directory Specifies the directory where the HTML templates are located.

Default is templates. If a full path is not supplied, it will be relative to the application directory.

Images_Directory Specifies the directory where the images for the HTML output are located. The contents of this directory will be copied to the HTML_Directory.

Default is images. If a full path is not supplied, it will be relative to the application directory.

HTML_Directory This is where the HTML files will be created.

Relative paths are referenced to Input_Path.

If this variable is blank, no HTML files will be created.

Benchmark_Prefix
CITO_Event_Prefix
Earthcache_Prefix
Event_Prefix
Letterbox_Hybrid_Prefix
Locationless_Prefix
Multi_Prefix
Project_APE_Prefix
Traditional_Prefix
Unknown_Prefix
Virtual_Prefix
Webcam_Prefix
Use these options to define the value of the %C format specifier for the various cache types.
Waypoint_Format Waypoint is the name for waypoints in your GPS receiver. Geocaching.com uses the equivalent of %C%I but you may find it more useful too show the actual name (%N) of the cache instead. You could also include the hider and/or the difficulty/terrain ratings if you desire.

The following Format Specifiers are available, and are evaluated in the listed order:

%CCode (as specified in the table below)
%YCache type, spelled out.
%IID - the xxxx part of GCxxxx.
%DDifficulty, in original x.x format.
%dDifficulty, shortened to 1 character.
1=1, 1.5=2, 2=3 ... 4.5=8, 5=9
%TTerrain, in original x.x format.
%tTerrain, shortened to 1 character, like %d above.
%SSize of cache. (new in 3.0.0)
%sFirst letter of cache size. (new in 3.0.0)
%OxOwner, truncated to x characters. If x is zero or omitted, the name is truncated as needed to keep the entire length within _Max_Length.
%PxPlaced by, truncated to x characters. If x is zero or omitted, he name is truncated as needed to keep the entire length within _Max_Length.
%hxCache hint, truncated to x characters. If x is zero or omitted, the hint is truncated as needed to keep the entire length within _Max_Length. (new in 3.0.0)
%NxName of cache, truncated to x characters. If x is zero or omitted, the name is smart-truncated as needed to keep the entire length within _Max_Length.
All other characters used literally.

Note that while %O, %P, %h and %N can theoretically be used together, in practice they tend to be mutually exclusive. For example, say Desc_Max_Length is 20, and Desc_Format is "%N by %O". The specifiers are evaluated in the order shown above, so %O will be evaluated first. If the owner name is 15 characters, it will leave 1 character available for %N, since " by " also takes up 4 characters.

Waypoint_Max_Length

Waypoint_Allowed_Chars

You can determine the maximum length and set of allowable characters by entering a waypoint manually into your GPS receiver. The on-screen keyboard will show which characters are allowed. On some models there is also a 'shift' key that enables even more characters. Letters and numbers are assumed. Do not include them here.
Desc_Format Description is the description of the waypoint in your GPS receiver. This is usually shown on the waypoint information screen, but not all receivers support it. You may also have to press MENU from the waypoint information screen to access the Description.

See Waypoint_Format above for a list of Format Specifiers.

Desc_Max_Length

Desc_Allowed_Chars

You can determine the maximum length and set of allowable characters by entering a waypoint description manually into your GPS receiver. The on-screen keyboard will show which characters are allowed. On some models there is also a 'shift' key that enables even more characters. Letters and numbers are assumed. Do not include them here.
Benchmark_Not_Found
CITO_Event_Not_Found
Earthcache_Not_Found
Event_Not_Found
Letterbox_Not_Found
Locationless_Not_Found
Multi_Not_Found
Project_APE_Not_Found
Traditional_Not_Found
Unknown_Not_Found
Virtual_Not_Found
Webcam_Not_Found

Benchmark_Found
CITO_Event_Found
Earthcache_Found
Event_Found
Letterbox_Found
Locationless_Found
Multi_Found
Project_APE_Found
Traditional_Found
Unknown_Found
Virtual_Found
Webcam_Found

These variables define how GPX Spinner will change the symbol for the various combinations of cache types and found status.

Leave a definition blank to leave that cache type with the default symbol, "Geocache".

<type>_<size>_Not_Found

<type>_<size>_Found

Examples:

Traditional_Micro_Not_Found
Traditional_Other_Not_Found
Multi_Micro_Not_Found
Unknown_Other_Not_Found

These combinations allow almost unlimited control over the symbols used for various sizes of each cache type. Traditional/Micros can have a different symbol than Multi/Micros which can have a different symbol than Unknown/Micros.

New in 3.0.0.

TB_Prefix
TB_Not_Found
TB_Found
This prefix and symbols will override the above prefix and symbols if the cache contains any travel bugs.
Leave blank for no change - i.e. use symbol from above.
Corrected_Prefix
Corrected_Not_Found
Corrected_Found
This prefix and symbols will override the above prefix and symbols if the cache coordinates have been updated by an entry in the Corrected Cache list. (new in 3.0.0)
Leave blank for no change.
DNF_Limit
DNF_Prefix
DNF_Not_Found
DNF_Found
This prefix and symbols will override the above prefix and symbols if there are DNF_Limit or more 'Not Found' log entries.
Leave blank for no change.
Disabled_Prefix
Disabled_Not_Found
Disabled_Found
This prefix and symbols will override the above prefix and symbols if the cache is disabled. (new in 3.0.0)
Leave blank for no change.
Archived_Prefix
Archived_Not_Found
Archived_Found
This prefix and symbols will override the above prefix and symbols if the cache is archived. (new in 3.0.0)
Leave blank for no change.
Owner If you want your own caches to be identified, fill in your username here.

You may also user your user ID number, (such as if your username has changed). You can determine your ID number by going to your "My Cache Page" then clicking on "View your profile as others see you". Your ID number will be at the end of the resulting URL (e.g. A=12409).

If you want to list multiple usernames/ID numbers, separate them with a | pipe character.

Example:
Owner = Lil Devil|12409

Distance_Units Specify whether to show distances in miles or kilometers. The default is miles.
Max_Distance_Limit

Min_Quantity_Limit
Max_Quantity_Limit

When showing the nearest caches to a given cache, GPX Spinner lists all caches within Max_Distance_Limit, or at least Min_Quantity_Limit unfound caches, whichever is greater.

The list will never be longer than Max_Quantity_Limit.

Max_Distance_Limit is specified in Distance_Units (see above)

Previous to version 3.0.0, Max_Distance_Limit was called Distance_Limit and Min_Quantity_Limit was Qty_Limit. The older variables will still be used if the new ones are not present.
Max_Quantity_Limit is new in version 3.0.0.

Include_TB_pages
Include_TB_pic
Hours_to_cache_TBs
HTTP_delay_seconds
Please read this page for details on the travel bug feature.
Include_Map
Include_Aerial_Photo
Include_Hires_Aerial_Photo
Setting these options to true will enable topo maps and aerial photos on the cache pages. For caches in the U.S., the images come from TerraServer-USA and show the nearest 6 caches (limited by 255 character URLs). Outside the U.S. the maps are from the geocaching.com cache pages.

On the Index by Distance/Bearing pages, the maps are from the Tiger mapping engine.

Warning: Enabling these options will significantly increase the size of the Plucker/iSilo file. If you are using a PDA with limited memory you should leave these options off.

Map_Width
Map_Height
These options provide a convenient place to adjust the size of the map and aerial photo images. Set these to optimum values for your PDA. You don't want Plucker/iSilo to scale these images because they will lose detail.
Pause_at_end When Spinner is all done, it will pause for a few seconds to allow you to read its progress messages and any error messages that may have occurred.
Run_After You can run another program or batch file when GPX Spinner is done spinning. The same parameters that were passed to GPX Spinner will be passed to the program or batch file.

If no path is supplied, it will look for the file in Input_Path.

The sample file provided includes several example commands to convert Spinner's output to various formats using GPS Babel, or to convert the HTML output using Plucker or iSilo.

 

Obsolete Options

Name Description *Version
Micro_Prefix This functionality has been replaced by the %S and %s format specifiers. 3.0.0
Micro_Not_Found
Micro_Found
This functionality has been replaced by separate options for the various combinations of cache type and size. 3.0.0
GPX_Output_File This option has been replaced with the <%output_filename%> pragma, placed directly in the output template. 2.0.6
Abbreviation This is now automatic based on the value of Distance_Units. 2.0.6
Triple_slash_file_URLs No longer needed with the elimination of %image_path%. 2.0.6
* Version is the GPX Spinner version that deprecated this variable.

 

Home   Examples   Help   Download   Links

GPX Spinner is Copyright © 2003-2006 by Lil Devil
The Groundspeak Geocaching Logo is a trademark of Groundspeak, Inc. Used with permission.