documentation update

This commit is contained in:
following 2013-07-20 12:29:11 +02:00
parent 105ee93d43
commit 5f258d21cc
9 changed files with 102 additions and 51 deletions

View File

@ -62,3 +62,4 @@ Related Websites
* [Opencaching API project](http://code.google.com/p/opencaching-api/)
* [Opencaching.pl project](http://code.google.com/p/opencaching-pl/)
* [Git explained](http://gitref.org/index.html)
* [old Opencaching.de/se Git Repository](https://github.com/OpencachingTeam/opencaching/)

View File

@ -1,15 +1,16 @@
for Version 3.0 changelog, see htdocs/templates2/ocstyle/articles/EN/changelog.tpl
for Database changelog, see htdocs/doc/sql/db-changes.txt
Opencaching Network Implementation Version 2.0
Opencaching Implementation Version 2.0
Changes File
This list is incomplete.
This list probably is incomplete.
27.08.2010 (Oliver)
- modified translation system

View File

@ -1,5 +1,7 @@
Cookies used by the Opencaching implementation
Opencaching Implementation Version 3
Cookies used
Name: $opt['session']['cookiename'] . 'data'

83
doc/directories.txt Normal file
View File

@ -0,0 +1,83 @@
Opencaching Implementation Version 3
Directory structure
There are three library framworks:
- The old OC 1.0 library which we call "lib1",
- the new OC 2.0 library which we call "lib2",
- the Opencaching.se library which we call "libse".
lib1 code is being ported to lib2 and will completely disappear.
Main directories
----------------
bin code and database maintenance scripts
doc documentaion
htdocs everything which regularly runs on the Opencaching website
lib/htmlpurifier-4.2.0
Old HTML purifier version used by lib1 and OKAPI code.
Is being replaced by htdocs/lib2/HTMLPurifier.
local Special-purpose tools which may be used on development or
productive systems.
htdocs subdirectories
---------------------
api miscellaneous simple APIs for external tools;
other APIs are in 'okapi' and in 'xml'.
cache lib1 temporary files
cache2 lib2 temporary files, precompiled and cached data
config2 lib2 settings files. lib1 settings are in htdocs/lib/settings*.
doc database documentation, static data and user documentation
download temporary files for XML interface requests, see htdocs/xml.
Directory is configured via lib/settings.inc.php, $zip_basedir
and $zip_wwwdir.
Note that zip downloads via seach.php are not stored in the file
system but directly streamed.
html some alternatives to index.php which may be displayed e.g.
if site is out of service
images images for several purposes
flag/flags: used by both lib1 and lib2. For compatibility reasons with
"external" links e.g. in cache descriptions, they will have to stay here.
icons GC replacement icons for smiley links in copied cache descriptions and logs
statpics cached statistics pictures, referenced indirectly via
htdocs/statpics/.htaccess -> ocstats.php rewrite
uploads uploaded cache and log pictures; directory is configured in lib1&2 settings
lang lib1 templates and resources; will all be ported to lib2, but some
image file will stay here because they can by referenced elsewhere.
lib OC 1.0 library (leftovers)
lib2 OC 2.0+ library, including 3rd party libraries
libse Opencaching.se library, used for additional waypoints and "personal notes"
in cache listings
okapi replicated from http://code.google.com/p/opencaching-api/source/browse/trunk/#trunk%2Fokapi
with core.php:$revision replaced by current svn revision number
resource2 all lib2 files which are no PHP or Smarty code
templates2 all lib2 Smarty templates
statipcs redirect source for statistics pictures, see images/statpics
util lib1 cronjobs and other tools
util2 lib2 cronjobs and other tools
var/okapi OKAPI temporary and cached files; may be moved to cache2
var/errorlog SQL error protocols
xml "XML interface" API

View File

@ -1,7 +1,7 @@
Opencaching Network Implementation Version 2.0
Opencaching Implementation Version 3
Rechteverwaltung
Rechteverwaltung
Rechte gelten jeweils für alle zuordneten Objekte

View File

@ -1,5 +1,5 @@

Opencaching Network Implementation Version 3
Opencaching Implementation Version 3
August 16, 2012
@ -101,7 +101,12 @@ PHP libraries
URI : http://htmlpurifier.org/
License : LGPL
10. OKAPI: Opencaching API
10. ss_zip class
Path : lib2/ss_zip.php
URI : http://smiledsoft.com/demos/phpzip/ (no longer works?)
License : ??
11. OKAPI: Opencaching API
Path : htdocs/okapi/
URI : http://code.google.com/p/opencaching-api/
License : MIT
@ -111,18 +116,18 @@ The following PHP libraries are currently not in use and may be discarded.
Note that they need to be properly licensed as long they are included in
the distrubution!
1. b2evo captcha
12. b2evo captcha
Path : htdocs/lib2/b2evo-captcha/
URI : http://sourceforge.net/projects/b2evo-captcha
License : GPL
2. InputFilter (modified)
13. InputFilter (modified)
Path : htdocs/lib2/logic/old/class.inputfilter.php
URI : http://freshmeat.net/projects/inputfilter/
http://cyberai.users.phpclasses.org/package/2189-PHP-Filter-out-unwanted-PHP-Javascript-HTML-tags-.html
License : GPL
3. SimpleTest unit testing
14. SimpleTest unit testing
Path : lib/simpletest
URI : http://simpletest.org/en/download.html
License : LGPL

Binary file not shown.

Before

Width:  |  Height:  |  Size: 561 B

View File

@ -1,34 +0,0 @@
# Mozilla/Opencaching plug-in by Carsten77
<search
version="7.1"
name="Opencaching.de"
description="Opencaching-Suche"
method="GET"
action="http://www.opencaching.de/searchplugin.php"
update=""
updateCheckDays=0
queryEncoding="ISO-8859-1"
queryCharset="ISO-8859-1"
searchForm="http://www.opencaching.de/search.php"
>
<input name="userinput" user>
<input name="sourceid" value="mozilla-search">
<inputnext name="startat" factor="20">
<inputprev name="startat" factor="20">
<interpret
browserResultType="result"
charset = "ISO-8859-1"
resultListStart="<!--a-->"
resultListEnd="<!--z-->"
resultItemStart="<!--m-->"
resultItemEnd="<!--n-->"
>
<browser
update="http://www.opencaching.de/resource2/misc/mozilla/OpencachingDE.src"
updateicon="http://www.opencaching.de/resource2/misc/mozilla/OpencachingDE.png"
updatecheckdays="30"
>
</search>

View File

@ -1,7 +0,0 @@
The Firefox seach plugin has been traditionally provided at
http://cms.opencaching.de/fileadmin/files/search. This domain is now
redirected to www.opencaching.de. We try to migrate the search plugin
to http://www.opencaching.de/resource2/misc/mozilla, but as there is
an unknown number of old copies of the .src file out there, the old
path is still needed for a while. (Analyze webserver accesslog to
find out wenn it can be discarded!)