Difference between revisions of "Userlevel:Admin:Technical Documentation - Websites:File Structure"
Allan Jensen (Talk | contribs) |
Allan Jensen (Talk | contribs) |
||
| Line 11: | Line 11: | ||
*.htaccess<br> | *.htaccess<br> | ||
*favicon.ico<br> | *favicon.ico<br> | ||
| − | *robots.txt<br> | + | *robots.txt : rules for web crawlers<br> |
| − | *go.php<br> | + | *go.php : for making shorter URLs for certain pages<br> |
*the rest is WordPress files<br> | *the rest is WordPress files<br> | ||
| Line 26: | Line 26: | ||
| | | | ||
Basically everything on the dynamic ShareHim website is under this folder. | Basically everything on the dynamic ShareHim website is under this folder. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| Line 80: | Line 71: | ||
|- | |- | ||
| | | | ||
| − | /php/_default.php | + | /php/_default.php |
| | | | ||
| − | A template that can be used for creating new pages. | + | A template that can be used for creating new pages. |
|- | |- | ||
| Line 90: | Line 81: | ||
| | | | ||
| − | Mostly internal or temporary scripts, which most often are not uploaded to the production site | + | Mostly internal or temporary scripts, which most often are not uploaded to the production site |
|- | |- | ||
| | | | ||
| − | /php/includes/<br> | + | /php/includes/<br> |
| | | | ||
| − | Functions and libraries that are used within the files in /php/ | + | Functions and libraries that are used within the files in /php/ |
|- | |- | ||
| | | | ||
| − | /php/includes/map_php_functions.php<br>/php/includes/map_php_classes.php<br>/php/includes/map_js_functions.php<br> | + | /php/includes/map_php_functions.php<br>/php/includes/map_php_classes.php<br>/php/includes/map_js_functions.php<br> |
| All PHP functions and classes as well as Javascript functions are defined in these fils-.<br> | | All PHP functions and classes as well as Javascript functions are defined in these fils-.<br> | ||
|- | |- | ||
| | | | ||
| − | /php/includes/layout.css | + | /php/includes/layout.css |
| | | | ||
| − | Master CSS file | + | Master CSS file |
|- | |- | ||
| | | | ||
| − | /php/files/ | + | /php/files/ |
| | | | ||
| − | Misc log and temporary files | + | Misc log and temporary files |
| + | |||
| + | |- | ||
| + | | | ||
| + | /php/files/uploads_shortlife/ | ||
| + | |||
| + | | | ||
| + | Folder for holding files with a "short life", which means that they are obsolete shortly after they have been created and can be overwritten at anytime. | ||
| + | |||
| + | It is made for the purpose of uploading files that are to be attached to e-mails, but can be use for any kind of "short-lived" file. | ||
| + | |||
| + | There is a PHP script (scheduled_cleanup_shortlife_files.php) that deletes files that are older than 5 days. | ||
|- | |- | ||
| | | | ||
| − | SVN: /_nonapplication/ | + | SVN: /_nonapplication/ |
| | | | ||
| − | Documentation files which are not part of the website and not uploaded | + | Documentation files which are not part of the website and not uploaded |
|- | |- | ||
| | | | ||
| − | SVN: /_parent/ | + | SVN: /_parent/ |
| | | | ||
| − | Files that go in the root of the website | + | Files that go in the root of the website |
|- | |- | ||
| Line 137: | Line 139: | ||
| | | | ||
| − | Views for the MVC model<br> | + | Views for the MVC model<br> |
|- | |- | ||
Revision as of 00:11, 4 December 2011
Root
|
/ |
|
| /wp-admin/ /wp-content/ /wp-includes/ |
Folders that belong to WordPress. wp-content holds all ShareHim specific content, the remaining two folders are WordPress system files only. |
| /php/ |
Basically everything on the dynamic ShareHim website is under this folder. |
| /help |
Holds this MediaWiki system |
PHP folder (custom website)
|
/php/ |
All pages that are accessed (usually used directly in the URL) |
|
/php/ini.php |
A global initialization file (bootstrap) that is included as the first file in every PHP script, and holds project settings (those that are not in the database table system_settings). |
|
/php/ini_ctl.php |
A global initialization |
|
/php/ini_serverconfig.php |
Configuration file that pertains to the specific server that the website is running on. It is included into ini.php |
|
/php/_default.php |
A template that can be used for creating new pages. |
|
/php/_*.* |
Mostly internal or temporary scripts, which most often are not uploaded to the production site |
|
/php/includes/ |
Functions and libraries that are used within the files in /php/ |
|
/php/includes/map_php_functions.php |
All PHP functions and classes as well as Javascript functions are defined in these fils-. |
|
/php/includes/layout.css |
Master CSS file |
|
/php/files/ |
Misc log and temporary files |
|
/php/files/uploads_shortlife/ |
Folder for holding files with a "short life", which means that they are obsolete shortly after they have been created and can be overwritten at anytime. It is made for the purpose of uploading files that are to be attached to e-mails, but can be use for any kind of "short-lived" file. There is a PHP script (scheduled_cleanup_shortlife_files.php) that deletes files that are older than 5 days. |
|
SVN: /_nonapplication/ |
Documentation files which are not part of the website and not uploaded |
|
SVN: /_parent/ |
Files that go in the root of the website |
|
/php/views/ |
Views for the MVC model |
|
/php/i_*.* |
Files generated by a code generator (Centralizer) |
|
/php/main_*.* |
Files originally generated by a software PHPMaker but which is no longer used (now Centralizer is used instead) |
Permissions
| FOLDER+SUB | /files | read/write permission |
| FOLDER | /email_templates/specific | read/write permission |
| FOLDER+SUB | /docs | read/write permission |
| FOLDER+SUB | /multimedia | read/write permission |
| FOLDER+SUB | /pdf_generated | read/write permission |
| FOLDER | /upload/filesXU77 | read/write permission |
