History: Path structure
Preview of version: 25
Path structure
This page documents the result of File and directory structure revamp for Tiki18 and planned to be completed before Tiki19.
Path | Usage |
_custom/_default/* | For all files that are different from the standard Tiki and not re-generatable. You should back up this directory (along with the database). It is prefixed by underscore so it appears at the top of the list _default can be duplicated to be example.org for MultiTiki |
_custom/lib/setup/custom.php | For any custom PHP code |
_generated/* | Data generated by Tiki (prefdocs, H5P, etc.) |
_temp/* | For all temporary files which should be generated by content or code elsewhere. Ex.: cache |
_temp/templates_c/ | Smarty templates cache |
_temp/public/ | |
_temp/mail_attach/ | |
_temp/unified-index/ | Zend_Lucene_PHP for search index |
_temp/unified-preference-index-en/ | Zend_Lucene_PHP for preferences search engine, using 2-letter language code. |
_temp/example.org/ _temp/example.org /templates_c/ _temp/example.org/cache/ etc. | For MultiTiki |
*.php | File at the root to access the various features Usually corresponds to a file with the same name in templates/*.tpl Files that don't start with tiki- are usually included in others. |
img/ | Images |
lang/ | Translations |
lib/* | Business logic and database queries |
lib/wiki-plugins/* | Over 200 Wiki Plugins. This is a great place to start discovering about Tiki development. |
templates/*.tpl | Defaut Smarty Template files |
themes/* | Everything related to the theme/skin/theme look and feel. Used to be styles/* |
themes/themename/ | there are dozens of bundled themes |
themes/themename/css/ | The CSS is typically generated from .less files |
themes/themename/img/ | |
themes/themename/js/ | Permits custom JavaScript just for this theme |
themes/themename/fonts/ | |
themes/themename/lang/ | ?? |
themes/themename/less/ (?) | |
themes/themename/options/themeoption/... | Theme options are variants of a theme |
themes/themename/templates/ | Smarty templates that override the defaults which are in templates/ |
vendor/* | For Composer dependencies that are installed via the command line or the web interface: Packages. vendor is the standard terminology used by Composer, and developers are familiar with it. |
vendor_bundled/* | For Composer dependencies that are bundled in Tiki. |
_custom and _default start with underscore so they appear at the top of the list
See also: File Storage