Greenmine/folders: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{hilite|This is currently being revised a bit; documentation is not correct anymore. 2020-11-10}} | |||
Entries marked CANON are canonical/official sub-paths; the rest are mainly as examples for clarity. | Entries marked CANON are canonical/official sub-paths; the rest are mainly as examples for clarity. | ||
# <code>$home/public_html</code> | # <code>$home/public_html</code> | ||
| Line 15: | Line 17: | ||
###### <code>$home/site/git/greenmine/config/portable</code> - CANON: config files which (usually) can be used as-is | ###### <code>$home/site/git/greenmine/config/portable</code> - CANON: config files which (usually) can be used as-is | ||
####### <code>$home/site/git/greenmine/config/portable/defaults.php</code> - CANON: default global values, and abstracts which need setting locally | ####### <code>$home/site/git/greenmine/config/portable/defaults.php</code> - CANON: default global values, and abstracts which need setting locally | ||
####### <code>$home/site/git/greenmine/config/portable/www/</code> - CANON: stuff which gets linked from <code>public_html</code> | |||
####### <code>$home/site/git/greenmine/config/portable/www/index.php</code> - CANON: link from <code>public_html</code> | |||
####### <code>$home/site/git/greenmine/config/portable/www/.htaccess</code> - CANON: link from <code>public_html</code> | |||
###### <code>$home/site/git/greenmine/config/examples</code> - CANON: files which will need configuration for local instance | ###### <code>$home/site/git/greenmine/config/examples</code> - CANON: files which will need configuration for local instance | ||
####### <code>$home/site/git/greenmine/config/examples/creds.php</code> - CANON: database credentials (to be configured) | ####### <code>$home/site/git/greenmine/config/examples/creds.php</code> - CANON: database credentials (to be configured) | ||
==Dependency Chaining== | |||
* <code>$home/public_html/index.php</code> - entry point (obviously) | |||
** defines <code>$kfpConfigGreenmine</code> | |||
** calls <code>$home/site/config/greenmine/portable/defaults.php</code> | |||
*** uses <code>$kfpConfigGreenmine</code> | |||
*** calls <code>$home/site/config/greenmine/local/globals.php</code> | |||
**** uses <code>\greenmine\cGlobals</code> - defined in <code>$home/site/config/greenmine/portable/defaults.php</code> | |||
Latest revision as of 13:14, 10 November 2020
This is currently being revised a bit; documentation is not correct anymore. 2020-11-10
Entries marked CANON are canonical/official sub-paths; the rest are mainly as examples for clarity.
$home/public_htmlindex.php- link to$home/site$home/site/config$home/site/config/greenmine$home/site/config/greenmine/portable- CANON$home/site/config/greenmine/portable/defaults.php- CANON: THIS FILE (link to git version, or copy)$home/site/config/greenmine/local- CANON$home/site/config/greenmine/local/creds.php- CANON: database credentials, adapted from git/greenmine/config/examples/creds.php
$home/site/git$home/site/git/ferreteria- ferreteria CANON$home/site/git/greenmine- CANON$home/site/git/greenmine/config/- CANON: greenmine site config folder$home/site/git/greenmine/config/portable- CANON: config files which (usually) can be used as-is$home/site/git/greenmine/config/portable/defaults.php- CANON: default global values, and abstracts which need setting locally$home/site/git/greenmine/config/portable/www/- CANON: stuff which gets linked frompublic_html$home/site/git/greenmine/config/portable/www/index.php- CANON: link frompublic_html$home/site/git/greenmine/config/portable/www/.htaccess- CANON: link frompublic_html
$home/site/git/greenmine/config/examples- CANON: files which will need configuration for local instance$home/site/git/greenmine/config/examples/creds.php- CANON: database credentials (to be configured)
Dependency Chaining
$home/public_html/index.php- entry point (obviously)- defines
$kfpConfigGreenmine - calls
$home/site/config/greenmine/portable/defaults.php- uses
$kfpConfigGreenmine - calls
$home/site/config/greenmine/local/globals.php- uses
\greenmine\cGlobals- defined in$home/site/config/greenmine/portable/defaults.php
- uses
- uses
- defines