Cache attributes

From Opencaching.eu
Revision as of 10:36, 3 June 2019 by Andrixnet (talk | contribs) (OC attributes mapping (initial edit))
Jump to navigation Jump to search


DRAFT, WORK IN PROGRESS

A geocache may have attached a number of attributes, giving more information about the cache, the hiding, the recommendations, requirements, permissions, hazards, other helpful information related with the search.

This document describes the existing cache attributes across Opencaching sites.

Attribute numbering rules

  • all OC attributes that have equivalent meaning to a GC attribute to use the same numeric ID; (while the meaning is equivalent, the exact wording of it's name need not be the same. examples are "bring your children / suitable for children / kids friendly / etc");
  • all OC attributes that have equivalent meaning to a negated GC attribute to use the same numeric ID added to 9000. (for example: "available 24/7" is ID 13. "NOT available 24/7" to be ID 9013.);
    • DE branch negated attributes use a separate flag and retain the ID without adding 9000.
  • OC attributes that have equivalent meaning on both PL and DE branches
  • existing DE branch only attributes to retain their IDs in the range 100 - 199;
  • all OC future and existing attributes that are PL branch specific to have numeric IDs in the range 200 - 299;
  • all OC future attributes that are DE branch specific to have numeric IDs in the range 300 - 399;
  • all OC special purpose attributes to have numeric IDs in the range 900 - 999;
  • all OC attributes that have the meaning of a negated OC attribute to use the same numeric ID on the least significant 3 digits, the fourth digit be the branch designator (according to applicability) and the fifth (most significant digit) be 9; (hypothetical generic example: "available during high tide" ID 241 - PL branch (UK), "NOT available during high tide" ID 9241 - PL branch)
  • all attributes have assigned a unique ACODE (according to OKAPI).
  • all "OC only" attributes have assigned a unique OCGS number, equal to their ID. (for GPX export purposes).

Attributes matrix

OC attributes mapping

Every OC installation has its own set of internal attributes.

Some attributes are common between OC sites; some attributes are common with GC; some attributes are OC only; some attributes are specific to only some OC sites but not all.

OKAPI also provides a unified interface for information exchange with third party apps (eg. c:geo) using GC compatibility and OC extensions (GPX export function).


Notes:

  • Opencaching-PL implements all attributes as either ON or OFF; Inverse meaning is handled by a different attribute.
  • Opencaching-DE implements attributes with a unique internal ID and the same public ID and uses a flag to indicate normal (inc=1) / inverse (inc=0) meaning.
  • OKAPI defines an internal ACODE to map OC attributes to GC equivalent.
  • OKAPI defines an additional pseudo-Groundspeak ID ("OCGS" IDs) for Opencaching attributes which have no Groundspeak equivalent, used to store such attributes in GPX <groundspeak:attribute> elements. "OCGS" IDs are unique and do not overlap with Groundspeak attribute IDs.

GC attributes reference

Reference documented for establishing equivalences necessary for compatibility with third party apps using GPX file.

  • Attribute has only YES = attribute that can be set or unset;
  • Attribute has both YES and NO = attribute that can be set normally, set as it's inverse meaning or unset;


Cite error: <ref> tags exist for a group named "GC attributes", but no corresponding <references group="GC attributes"/> tag was found