Overview
| Info |
|---|
This page is still incomplete. Please help us to write a comprehensive CONTENIDO documentation. |
CONTENIDOs filesystem structure seems a bit overwhelming for the novice developer but follows a quite straight forward scheme. This article describes this scheme and should help to find the files you're looking for. Files are systemwide ressources.
| Note |
|---|
| The location of many folders can be configured to suite your needs. This can be achieved by editing several configuration files (TODO exlpain which). This article assumes that all folders have their default locations! |
...
| name | description |
|---|---|
ROOT/contenido/classes | Contains one file for each CONTENIDO class. |
ROOT/contenido/cronjobs | Cron or pseudocron jobs are located in this folder. |
ROOT/contenido/external | External tools liek CodeMirror or TinyMCE can be found here. TODO the folders backendedit and frontend have to be described. |
ROOT/contenido/images | Images that are used in the CONTENIDO backend are located in this folder. |
ROOT/contenido/includes | Contains files with functions used in the CONTENIDO backend that can alos also be used in plugins and modules. |
ROOT/contenido/jar | Contains the Java package org.contenido that is used for the file upload drag and drop feature. |
ROOT/contenido/plugins | CONTENIDO plugins are located in this folder. |
ROOT/contenido/scripts | This folder contains JavaScripts that are used in the CONTENIDO backend. This also includes the jQuery library. |
ROOT/contenido/styles | This folder contains CSS style sheets that are used in the CONTENIDO backend. This also includes the style sheets for jQuery. |
ROOT/contenido/templates | Templates that are used to render pages in the CONTENIDO backend. |
ROOT/contenido/templates_c | Smarty cache for templates that are used with the class cSmartyBackend when using the Smarty plugin. Smarty usually precompiles its templates and stores them in this folder. |
ROOT/contenido/tools | Command line tools (CLI) that are used for certain CONTENIDO related tasks e.g. automatic creation of the autoloader configuration file or the detection of PHP dependencies. |
ROOT/contenido/xmlTODO I have no clue | This folder contains some XML files required for the CONTENIDO backend. legend.xml contains descriptions of the icon legend shown in Content | Article. navigation.xml defines the structure of the main- and subnavigation. system.xml defines settings which will be displayed on the system configuration page in Administration | System. |
Data
| name | description |
|---|---|
ROOT/data/cache | This folder is used for caching of client independant files that are created by some plugins (e.g. PIFA or PIXI) and modules. Also the CONTENIDO UpdateNotifier uses this folder for its files. |
ROOT/data/config | Client independant configuration files are located in this folder. |
ROOT/data/cronlog | When cronjobs are setup, these usually store *.job-files containing a timestamp in this folder to signal that and when they have been run last. |
ROOT/data/locale | This folder contains gettext files used to localize the CONTENIDO backend. |
ROOT/data/logs | Depending upon configuration settings some log files are maintained that can be found in this folder. |
ROOT/data/temp | This folder is intended to be used for any temporary data. When using this folder it might be a good idea to create a subfolder for each task in order to avoid name collisions. |