added cookie docs

This commit is contained in:
following 2013-07-17 20:37:18 +02:00
parent 30f0448465
commit a67781246b
5 changed files with 42 additions and 0 deletions

36
doc/cookies.txt Normal file
View File

@ -0,0 +1,36 @@
Cookies used by the Opencaching implementation
Name: $opt['session']['cookiename'] . 'data'
File: cookie.class.php
Type: permament
Contents: - login/session data (login.class.php)
- country & language selection (common.inc.php)
- last search query-id (search.php)
- translation interface mode (translate.php)
Name: 'ocgmlastpos'
Type: permanent
Contents: last map position and zoom level
File: map2.tpl
Name: 'ocgmconfig'
Type: permanent
Contents: selected map type, 'sidebar' status
File: map2.tpl
Name: 'ocgmfilter'
Type: temporary, discarded when browser closes
Contents: current map filter settings
File: map2.tpl
Nmae: 'ocgmfilter_saved'
Type: permanent
Contents: saved map filter settings
File: map2.tpl
Name: 'ocprofilearchived'
Type: permanent
Contents: flag for hiding archived caches in user profile
File: myhome.tpl

View File

@ -5,6 +5,7 @@
* Unicode Reminder メモ
*
* Cookie handling
* See doc/cookies.txt for more information in cookies.
***************************************************************************/
$cookie = new cookie();

View File

@ -68,6 +68,8 @@
Loginstatus, Sprache und Einstellungen des HTML-Editors. Dadurch verhält sich die Opencaching-Seite
beim nächsten Start des Webbrowsers wieder so wie beim letzten Mal.</p>
<p>Eine detaillierte Aufstellung der Cookie-Daten gibt es in der <a href="https://github.com/OpencachingDeutschland/oc-server3/tree/stable/doc/cookies.txt">Entwicklerdokumentation</a> (Englisch).</p>
<h2>Webserver-Protokolle</h2>
<p>Wie fast jeder Webserver führt auch der von Opencaching.de ein Protokoll über alle abgerufenen

View File

@ -50,6 +50,8 @@
by you, e.g. login status, language and editor preferences. This way, the Opencaching site
will behave the same after you leave it and come back.</p>
<p>For detailed information, see the developers' <a href="https://github.com/OpencachingDeutschland/oc-server3/tree/stable/doc/cookies.txt">cookie documentation</a>.</p>
<h2>Webserver protocols</h2>
<p>Like any webserver, Opencaching.de keeps a protocol of all requested pages. For each request,

View File

@ -91,6 +91,7 @@ var msInitCookieFilterName = 'ocgmfilter';
var msInitCookiePermFilterName = 'ocgmfilter_saved';
if (!navigator.cookieEnabled)
{
// see doc/cookies.txt for information on cookies
msInitCookieLastPosName = '';
msInitCookieConfigName = '';
msInitCookieFilterName = '';