mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
90 lines
4.7 KiB
Markdown
90 lines
4.7 KiB
Markdown
# Directory Structure
|
||
|
||
## Introduction
|
||
|
||
The directory-structure in SilverStripe it built on "convention over configuration", so the placement of some files and
|
||
directories is meaningful to its logic.
|
||
|
||
## Core Structure
|
||
|
||
Directory | Description
|
||
--------- | -----------
|
||
`assets/` | Contains images and other files uploaded via the SilverStripe CMS. You can also place your own content inside it, and link to it from within the content area of the CMS.
|
||
`cms/` | Contains all the files that form the CMS area of your site. It’s structure is similiar to the mysite/ directory, so if you find something interesting, it should be easy enough to look inside and see how it was built.
|
||
`framework/` | The framework that builds both your own site and as the CMS that powers it. You’ll be utilizing files in this directory often, both directly and indirectly.
|
||
|
||
## Custom Code Structure
|
||
|
||
We're using `<mysite>` as an example - arbitrary directory-names are allowed, as long as they don't collide with
|
||
existing modules or the directories lists in "Core Structure".
|
||
|
||
| Directory | Description |
|
||
| --------- | ----------- |
|
||
| `<mysite>/` | This directory contains all of your code that defines your website. |
|
||
| `<mysite>/_config` | YAML configuration specific to your application |
|
||
| `<mysite>/code` | PHP code for model and controller (subdirectories are optional) |
|
||
| `<mysite>/templates` | HTML [templates](templates) with *.ss-extension |
|
||
| `<mysite>/css ` | CSS files |
|
||
| `<mysite>/images ` | Images used in the HTML templates |
|
||
| `<mysite>/javascript` | Javascript and other script files
|
||
|
||
## Themes Structure
|
||
|
||
| `themes/simple/` | Standard "simple" theme |
|
||
| ------------------ | --------------------------- |
|
||
| `themes/yourtheme/` | The themes folder can contain more than one theme - here's your own |
|
||
|
||
|
||
See [themes](/topics/themes)
|
||
|
||
## Module Structure {#module_structure}
|
||
|
||
Modules are currently top-level folders that have a `_config.php` file or a `_config/` directory present.
|
||
They should follow the same conventions as posed in "Custom Site Structure"
|
||
|
||
Example Forum:
|
||
|
||
| Directory | Description |
|
||
| --------- | ----------- |
|
||
| `forum/` | This directory contains all of your code that defines your website. |
|
||
| `forum/code` | PHP code for model and controller (subdirectories are optional) |
|
||
| ... | ... |
|
||
|
||
|
||
|
||
### Module documentation
|
||
|
||
Module developers can bundle developer documentation with their code by producing
|
||
plain text files inside a 'docs' folder located in the module folder. These files
|
||
can be written with the Markdown syntax (See [Contributing Documentation](/misc/contributing/documentation))
|
||
and include media such as images or videos.
|
||
|
||
Inside the docs folder, developers should organize the markdown files into each
|
||
separate language they wish to write documentation for (usually just `en`). Inside
|
||
each languages' subfolder, developers then have freedom to create whatever structure
|
||
they wish for organizing the documentation they wish.
|
||
|
||
Example Forum Documentation:
|
||
|
||
| Directory | Description |
|
||
| --------- | ----------- |
|
||
| `forum/docs` | The docs folder will be picked up by the documentation viewer. |
|
||
| `forum/docs/_manifest_exclude` | Empty file to signify that SilverStripe does not need to load classes from this folder |
|
||
| `forum/docs/en/` | English documentation |
|
||
| `forum/docs/en/index.md` | Documentation homepage. Should provide an introduction and links to remaining docs |
|
||
| `forum/docs/en/installing.md` | |
|
||
| `forum/docs/en/_images/` | Folder to store any images or media |
|
||
| `forum/docs/en/sometopic/` | You can organize documentation into nested folders |
|
||
|
||
|
||
## PHP Include Paths
|
||
|
||
Due to the way `[api:ManifestBuilder]` recursively detects php-files and includes them through PHP5's
|
||
*__autoload()*-feature, you don't need to worry about include paths. Feel free to structure your php-code into
|
||
subdirectories inside the *code*-directory.
|
||
|
||
## Best Practices
|
||
|
||
### Making /assets readonly
|
||
See [secure-development#filesystem](/topics/security#filesystem)
|