GPX Spinner  
Home
Examples
Help
Download
Links
 

List of All Available Variables for Templates

General Variables:

The following variables can be used in any GPX Spinner template. See also reverse compatibility.

Name Value
%version% GPX Spinner version number.
%current_date%
%current_date_xml%
%current_date_raw%
Current date and time.
The first version is formatted in human-readable format (e.g. May 3, 2000 12:34).
The _xml% version is formatted for XML files (e.g. 2000-05-03T12:34Z).
The _raw% version is the number of seconds since 1/1/1970.

See also: How to use variables in templates

 

Variables for the cache pages and the caches or nearcaches section of an index page

The following variables can be used in any "cache" template. They can also be used in any "caches" or "nearcaches" sections of an index page.

NameValue
%ID%ID number of cache.
%GCID%xxxx part of GCxxxx (e.g. 12AB)
(field name changed in 3.0.0)
%GCID_prefix%This is the string that replaces the "GC" based on cache type.
It is customizable in your GPX Spinner.ini file.
(field name changed in 3.0.0)
%name%Name of cache.
%first_letter_of_name%Used for grouping on the index pages.
%placed_by%Person(s) who placed the cache.
%first_letter_of_placed_by%Used for grouping on the index pages. (new in 3.0.0)
%owner%Owner of cache.
%ownerID%Owner's ID number.
%owned%True if %owner% or %ownerID% matches Owner.
(Owner is defined in the GPX Spinner.ini file).
%type%Type of cache (e.g. CITO Event)
%url_type%URL-encoded type, for use in URLs (e.g. CITO_Event)
%size%Size of cache (e.g. Regular)
%hidden_date%
%hidden_date_xml%
%hidden_date_raw%
Date cache was placed.
The first version is formatted in human-readable format (e.g. May 3, 2000 12:34).
The _xml% version is formatted for XML files (e.g. 2000-05-03T12:34Z).
The _raw% version is the number of seconds since 1/1/1970.
%age%Age of cache in days since it was placed. (new in 3.0.0)
%exported_date%
%exported_date_xml%
%exported_date_raw%
Date of GPX file that cache was extracted from.
See notes above for %hidden_date%
%latitude%
%longitude%
Formatted (e.g. W123° 45.678') latitude and longitude of cache.
%latitude_raw%
%longitude_raw%
Unformatted (e.g. -123.76130) latitude and longitude of cache.
%utm_zone%
%utm_easting%
%utm_northing%
Coordinates in UTM values.
(new in 3.0.0)
%updated_coords%True if coordinates are changed by the CorrectedCaches.txt file.
%state%State or territory that cache is in.
%country%Country that cache is in.
%difficulty%
%terrain%
Difficulty and Terrain ratings from Geocaching.com
%short_difficulty%
%short_terrain%
Difficulty and Terrain ratings shortened to one digit.
(1=1, 2=1.5, 3=2, 4=2.5, 5=3, 6=3.5, 7=4, 8=4.5, 5=9)
%short_description%
%long_description%
Short and long descriptions of the cache. These are the main descriptions on the web page and should not be confused with %old_description% and %new_description% below.
%short_description_html%
%long_description_html%
True if the corresponding description field uses html.
%encoded_hints%
%decoded_hints%
Encoded and decoded versions of the hints.
%logs% The number of log entries. Note this will never be more than 5, since only 5 log entries are included in a GPX file.
Can be useful in an <%if logs%> statement.
Can also be used in <%group%> and <%sort%> statements. See below.
%any_log_encoded%True if any log is encoded.
Use in an <%if any_log_encoded%> statement.
%travel_bugs%The number of travel bugs in the cache.
Can be useful in an <%if travel_bugs%> statement.
Can also be used in <%group%> and <%sort%> statements. See below.
%found%Returns true if %old_symbol% is 'Geocache Found'.
Use in an <%if found%> or <%if not found%> statement.
%waypoint%As defined by Waypoint_Format in the GPX Spinner.ini file.
(field name changed in 3.0.0)
%first_letter_of_waypoint%Used for grouping on the index pages. (new in 3.0.0)
%old_description%Original description. Typically in the format:
Rapunzel by Lil Devil, Traditional Cache (4/1)
Note this description is uploaded to a GPSr as a "note" for the waypoint. It should not be confused with %short_description% and %long_description% above.
%new_description%New description as defined by Desc_Format in the GPX Spinner.ini file.
%old_symbol%Original symbol. Will be either 'Geocache' or 'Geocache Found'.
%new_symbol%New symbol as specified in the GPX Spinner.ini file.
%DNF_count%Number of recent Not Found logs.
%may_be_missing%True if %DNF_count% is greater than or equal to DNF_Limit.
(DNF_Limit is defined in the GPX Spinner.ini file.)
%available%False if the cache is disabled. (new in 3.0.0)
%archived%True if the cache is archived. (new in 3.0.0)
%name_clean%
%waypoint_clean%
%new_description_clean%
%placed_by_clean%
Special versions of the equivalent variables (without _clean). These "clean" versions have been stripped of html tags and entities have been reduced (e.g. &amp; -> &). These are used in a special GPX template designed for Easy/ExpertGPS compatibility, since those programs don't convert entities correctly. (new in 3.0.0)

 

Variables for the logs section of a cache or index page

The following variables can be used with a <%group logs%> or <%sort logs%> section of a cache page or enclosing <%group caches%> or <%sort caches%> section.

Name Value
%logID%Log ID number.
%log_date%
%log_date_xml%
%log_date_raw%
Date of log.
See notes above for %hidden_date%
%type%Type of log entry (e.g. Not Found)
%url_type%URL-encoded type, for use in URLs (e.g. Not_Found)
%finder%Who made the log entry.
%finderID%Finder's ID number.
%latitude%
%longitude%
Formatted (e.g. W123° 45.678') latitude and longitude of log entry, if supplied.
%latitude_raw%
%longitude_raw%
Unformatted (e.g. -123.76130) latitude and longitude of log entry, if supplied.
%decoded_log_text%Text of log entry.
%log_encoded%True if log is encoded.
Can be useful in an <%if log_encoded%> statement.
%encoded_log_text%If log entry is encoded, this will contain the encoded text. Otherwise it will be a duplicate of the %decoded_log_text% variable.

 

Variables for the travel bugs section of a cache or index page

The following variables can be used with a <%group travel_bugs%> or <%sort travel_bugs%> section of a cache page or enclosing <%group caches%> or <%sort caches%> section.

Name Value
%bugID%ID number of travel bug.
%bugGUID%TBxxxx designation of travel bug.
%name%Name of travel bug.

 

Variables for the index pages.

The following variables can be used in any "index" template.

Name Value
%location%Location names from the RefLocations.txt file.
Only available if a <%group%> or <%sort%> instruction refers to distance or bearing.
%index_list%List of links to all indexes.
%links%List of links to all indexes except the current one, and any that contain the <%show=false%> pragma.
%path1%
%path2%
...
The full path of the source files. (new in 3.0.0)
%folder1%
%folder2%
...
The enclosing folders containing the source files. (new in 3.0.0)
%zipname1%
%zipname2%
...
The names of the ZIP files containing the source files. (new in 3.0.0)
%filename1%
%filename2%
...
The filenames of the source files. (new in 3.0.0)

 

Reverse Compatibility

The following variables are deprecated. For compatibility with older templates, they are set to the same values as the variables that replaced them.

Name Value *Version
%create_date%Replaced by %current_date% 2.0.6
%current_time%Replaced by %current_date_xml% 2.0.6
%imagepath%This variable was an ill-conceived attempt in early versions to provide a path to the /images/ directory. Unfortunately there were too many factors to consider and this variable often didn't work as desired. It was ultimately made obsolete by simply copying the contents of the /images/ directory into the /cache/ output directory. For compatibility, this variable is set to '.' (period) which means 'the current directory.'2.0.6
%GUID% Replaced by %GCID% for possible future support of true GUIDs. 3.0.0
%GUID_prefix% Replaced by %GCID_prefix% 3.0.0
%new_name% Replaced by %waypoint% 3.0.0
%short_desc%
%long_desc%
Replaced by %short_description% and %long_description% 3.0.0
%short_desc_html%
%long_desc_html%
Replaced by %short_description_html% and %long_description_html% 3.0.0
* 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.