aboutsummaryrefslogtreecommitdiffstats
path: root/main/project/attributes_okapi/readme.txt
diff options
context:
space:
mode:
authorrsudev <rasch@munin-soft.de>2013-05-28 23:17:56 -0700
committerrsudev <rasch@munin-soft.de>2013-05-28 23:17:56 -0700
commitf6779ac30d6ac1357d67654ea17afa1f1d6fa770 (patch)
treee1e84fca95948ef7ba13be7e12809388b24d3267 /main/project/attributes_okapi/readme.txt
parentd6f1bc648361076c3b2038a6ab9b175e1de39b3d (diff)
parenta7de49db675048db5ae0c05ccd730a8579e6876e (diff)
downloadcgeo-f6779ac30d6ac1357d67654ea17afa1f1d6fa770.zip
cgeo-f6779ac30d6ac1357d67654ea17afa1f1d6fa770.tar.gz
cgeo-f6779ac30d6ac1357d67654ea17afa1f1d6fa770.tar.bz2
Merge pull request #2787 from rsudev/ocde_okapi_2
Implements OKAPI access for opencaching.de
Diffstat (limited to 'main/project/attributes_okapi/readme.txt')
-rw-r--r--main/project/attributes_okapi/readme.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/main/project/attributes_okapi/readme.txt b/main/project/attributes_okapi/readme.txt
new file mode 100644
index 0000000..5382ebe
--- /dev/null
+++ b/main/project/attributes_okapi/readme.txt
@@ -0,0 +1,10 @@
+In the current version of OKAPI (rev. 798) are attributes not returned with a unified id but only with the localized text.
+Luckily a metadata file to prepare the unification of these attributes has already been prepared by the OKAPI project
+(http://code.google.com/p/opencaching-api/source/browse/trunk/etc/attributes.xml), which do not officially publish as a stable definition,
+but which can serve as an easier starting point for the generation of a parser class.
+To allow the representation with icons we need to map these localized texts to our internal ids which is done with a parser
+generated from the aforementioned file. Soo the AttrGen project for more details.
+
+If attributes.xml will be updated, we need of course to check first if it is structurally compatible to the previous version.
+If present it seems to be necessary to remove the BOM at the beginning of the file. Then you can run genattr.sh
+and copy the generated AttributeParser.java to the appropriate location (connector.oc).