Difference between revisions of "Userlevel:Admin:Technical Documentation - Websites:File Structure"

From ShareHim Documentation
Jump to: navigation, search
(Created page with '= File Structure - sharehim.org = == Root == {| cellspacing="0" cellpadding="8" border="1" |- | / | *.htaccess<br> *favicon.ico<br> *robots.txt<br> *go.php<br> *the r…')
 
(→‎PHP folder (custom website))
 
(2 intermediate revisions by one other user not shown)
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.  
−
 
−
|-
 
−
| /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.
 
  
 
|-
 
|-
Line 45: Line 36:
 
<br>  
 
<br>  
  
−
== PHP&nbsp;folder (custom website) ==
+
== PHP&nbsp;folder (custom website) ==
  
 
{| cellspacing="0" cellpadding="8" border="1"
 
{| cellspacing="0" cellpadding="8" border="1"
 
|-
 
|-
 
|  
 
|  
−
/php/
+
/php/  
  
 
|  
 
|  
−
All pages that are accessed (usually used directly in the URL)
+
All pages that are accessed (usually used directly in the URL)  
  
 
|-
 
|-
 
|  
 
|  
−
/php/ini.php
+
/php/ini.php  
  
 
|  
 
|  
−
A global initialization file (bootstrap) that is included as the first file in every PHP&nbsp;script, and holds project settings (those that are not in the database table system_settings).
+
A global initialization file (bootstrap) that is included as the first file in every PHP&nbsp;script, and holds project settings (those that are not in the database table system_settings).  
  
 
|-
 
|-
 
|  
 
|  
−
/php/ini_ctl.php
+
/php/ini_ctl.php  
  
 
|  
 
|  
−
A global initialization
+
A global initialization  
  
 
|-
 
|-
 
|  
 
|  
−
/php/ini_serverconfig.php
+
/php/ini_serverconfig.php  
  
 
|  
 
|  
−
Configuration file that pertains to the specific server that the website is running on.
+
Configuration file that pertains to the specific server that the website is running on.  
  
−
It is included into ini.php
+
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/<br>
 +
 +
|
 +
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>
 +
 +
| All PHP functions and classes as well as Javascript functions are defined in these fils-.<br>
 +
|-
 +
|
 +
/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
 +
 +
|-
 +
|
 +
/php/views/
 +
 +
|
 +
Views for the MVC model<br>
 +
 +
|-
 +
|
 +
/php/i_*.*<br>/php/ilist_*.*<br>/php/includes/php_functions_i_*.*<br>/php/includes/php_functions_ilist_*.*
 +
 +
|
 +
Files generated by a code generator (Centralizer)
 +
 +
|-
 +
|
 +
/php/main_*.*<br>/php/list_*.*
 +
 +
|
 +
Files originally generated by a software PHPMaker (started using Centralizer instead of PHPMaker)<br>
 +
 
|}
 
|}
  
−
<br>  
+
<br>
  
 
== Permissions  ==
 
== Permissions  ==

Latest revision as of 08:59, 4 July 2016

File Structure - sharehim.org

Root

/

  • .htaccess
  • favicon.ico
  • robots.txt : rules for web crawlers
  • go.php : for making shorter URLs for certain pages
  • the rest is WordPress files
/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
/php/includes/map_php_classes.php
/php/includes/map_js_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

/php/views/

Views for the MVC model

/php/i_*.*
/php/ilist_*.*
/php/includes/php_functions_i_*.*
/php/includes/php_functions_ilist_*.*

Files generated by a code generator (Centralizer)

/php/main_*.*
/php/list_*.*

Files originally generated by a software PHPMaker (started using Centralizer instead of PHPMaker)


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


Retrieved from "https://sharehim.org/help/index.php?title=Userlevel:Admin:Technical_Documentation_-_Websites:File_Structure&oldid=721"