This documentation is outdated.
The overall directory structure seems to be complex and redudant.
The reason for this is that we still have to support the directory structure of
previous source codes. Some of these directories can be removed in future
when the old source codes have been updated to use the current template
engine. Some other directories should be kept in future, because some
geocache listings or other website may reference to files inside that
directories. This document will first explain the currently intended directory
structure and after that explain the obsolete directories. You should only
use the new directory structure in new developments.
All directories in this document will reference to trunk as base directory.
Other branches and tags should use the same directory structure.
All files that have to be uploaded to the webserver are contained in this directory.
Command line utilities for Opencaching administration and utlilities used by the PHP code. This directory should only contain the binary itself. Config files and libraries should be placed in the appropriate directory.
Contains configuration files. The source code is delivered with an default configuration (settings-dist.inc.php). In the local webserver configuration (settings.inc.php) only values have to be included that differ from the default configuration. An example of this configuration is delivered with (settings-sample.inc.php).
This directory should be the document root of the apache configuration. Only these files have to be accessible for web users.
Contains Opencaching business logic files and classes.
Subdirectories may be created for storing a set of classes that contain to
the same functionality like "search modules".
Smarty HTML templates.
Directory containing all files that the users have uploaded. A seperate structure of subdirectories may be created for each upload functionality (e.g. GPX files or images).
Directory for caching files used to generate or speed up site processing. Like compiled smarty files or caching of the menu structure.
See documentation for details.
Contains files that were used to generate images and other "generated content".
Subdirectory structure may be used where appropriate.
Existing sources have been copied to code/htdocs because in previous codes, there was no strict seperation between "inside" and "ouside" the public accessbile root directory of the web server.
There are 2 template engines used in the opencaching source code.
The first one is a self-written template engine (refered as "old") and the
second one is smarty (refered as "new").
You can determine what source code is used when you
look into the first code lines of the file. If the soruce file
includes "lib/common.inc.php" the old template system is used. If it includes
"lib2/web.inc.php", the new template engine is used.
Directories ending with "2" belong to the new template engine. Directories
without a "2" at the end belong the the old template engine.