Permalink
Browse files

Folder documentation

  • Loading branch information...
1 parent b9beeca commit 4bd5010ed8f7efe59c325fffe0f558667d6271b0 @fplanque fplanque committed Jan 23, 2016
View
@@ -1,12 +1,12 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>/media Folder</title>
+ <title>/cache Folder</title>
</head>
<body>
- <h2><a href="http://evocore.net/">evoCore</a> FrameWork</h2>
+ <h2><a href="http://b2evolution.net/">b2evolution</a></h2>
<h1><code>/cache</code> folder</h1>
- <p>This folder holds the <strong>page cahe</strong> files. When enabled through the advanced blog properties, b2evolution will cache rendered blog pages in this folder.</p>
-<p><em>This folder does not need to be accessed through the web.</em></p>
+ <p>This folder holds the <strong>page cahe</strong> files. When enabled through the advanced collection properties, b2evolution will cache entire pages in this folder.</p>
+ <p><em>This folder does not need to be accessed directly through the web. It will be accessed only through PHP.</em></p>
</body>
</html>
View
@@ -6,17 +6,11 @@
<body>
<h2><a href="http://evocore.net/">evoCore</a> FrameWork</h2>
<h1><code>/conf</code> folder</h1>
- <p>This folder holds the configuration files for this evoCore application as well as this particular instance of the application.</p>
- <p><em>This is a configuration folder, it only needs to be accessed by PHP. It does not need to be accessed through the web.</em></p>
+ <p>This folder holds the configuration files for this application (including your database and potentially other passwords!).</p>
+ <p><em>This is a configuration folder, it only needs to be accessed by PHP. It does not need to be accessed through the web directly.</em></p>
<p>See the comments in each file for details about configuration options.</p>
- <p>There are several levels of settings, which can sometimes override each other: </p>
- <ul>
- <li>The conf settings for the application</li>
- <li>The conf settings for a particular instance of the application </li>
- <li>The general settings in the backoffice</li>
- <li>The user settings in the user profile</li>
- </ul>
<p>Note: in order to do local testing with different settings than your server settings, you can also override some of
- your conf settings with files named <code>_config_TEST.php</code> and <code>_overrides_TEST.php</code> .</p>
+ your conf settings with files named <code>_config_TEST.php</code> and <code>_overrides_TEST.php</code>.</p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
View
@@ -6,9 +6,9 @@
<body>
<h2><a href="http://evocore.net/">evoCore</a> FrameWork</h2>
<h1><code>/cron</code> folder</h1>
- <p>This folder holds the <strong>cron</strong> jobs, i-e: jobs that are typically scheduled to be run on a regular basis (every hour, every day...).</p>
+ <p>This folder holds the <strong>cron</strong> processor: `/cron/cron_exec.php`. This file should be called regularly and automatically in order to execute scheduled tasks.</p>
<p>Currently, you need to refer to your hosting provider in order to set up automatic calls to the jobs inside of this folder.</p>
- <p>You may also use a watchdog service which will ping the files in this folder periodically to achieve the same goal. </p>
- <p><em>Depending on how you set up your cron processor, this folder may or may not need to be accessed through the web.</em> </p>
+ <p><em>Depending on how you set up your cron processor, this folder may or may not need to be accessed through the web.</em></p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
View
@@ -7,7 +7,8 @@
<h2><a href="http://evocore.net/">evoCore</a> FrameWork</h2>
<h1><code>/htsrv</code> folder</h1>
<p>This folder holds the <strong>ht</strong>ml <strong>s</strong>e<strong>rv</strong>ices entry points.</p>
- <p>Each file in this folder performs a particular function when called by its url with the appropriate parameters.</p>
+ <p>Each file in this folder performs a particular function (login, register, post comment, etc.) when called by its url with the appropriate parameters. AJAX calls also go through this folder.</p>
<p><em>This is a services folder. It needs to be accessed through the web.</em> </p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
View
@@ -6,9 +6,10 @@
<body>
<h2><a href="http://evocore.net/">evoCore</a> FrameWork</h2>
<h1><code>/inc</code> folder</h1>
- <p>This folder holds the <strong>inc</strong>ludes needed by the main PHP entry points.</p>
- <p>This folder also holds the <code>_main.inc.php</code> file which handle the main initializations for the application.</p>
- <p>The includes are grouped into &quot;module&quot; folders that group files pertaining to a specific functionality set (e-g: file management).</p>
+ <p>This folder originally held the <strong>inc</strong>ludes needed by the main PHP entry points. For example, this folder holds the <code>_main.inc.php</code> file which handles the main initializations for the application.</p>
+ <p>In recent versions, this folder also holds a series of sub-folders. Each of these sub-folder is a &quot;module&quot; that groups files pertaining to a specific functionality set (e-g: file management).</p>
+ <p>Each module follows an MVC (Model - View - Controller) paradigm.</p>
+ <p><em>This folder (and its sub-folders) only needs to be accessed by PHP. It does not need to be accessed through the web directly.</em></p>
<h2>Controllers</h2>
<p>Each module may contain one or more controllers identified by their suffix of <code>.ctrl.php</code></p>
<p>Each controller is a PHP include file which implements the logic for manipulating a particular &quot;set&quot; of data. For example there could be a controller to handle general settings and another controller to handle local settings. Those two controllers may be found within the &quot;settings&quot; module.</p>
@@ -29,5 +30,7 @@
determine the exact rendering of the View (see the Admin skins <code>/skins_adm</code> folder).</p>
<p>It is also important to understand that a specific View can be called by different controllers. A contextual help block would be an example of that (provided the content is dynamic).</p>
<p>A single controller can also be calling several views in a row. (The controller can assemble multiple views).</p>
+
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
View
@@ -1,14 +1,14 @@
<html>
<head>
- <meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>/install Folder</title>
</head>
<body>
<h2><a href="http://evocore.net/">evoCore</a> FrameWork</h2>
<h1><code>/install</code> folder</h1>
<h3>If you are trying to install, <a href="index.php">click here to call the install script</a> . </h3>
- <p>This folder holds the <strong>install</strong> files.</p>
+ <p>This folder holds the <strong>install</strong> files needed to install or upgrade b2evolution. This folder should be deleted after installation or upgrade and a new folder should be uploaded the next time you wish to upgrade.</p>
<p><em>This folder needs to be accessed through the web at install time and should be erased after installation.</em></p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
View
@@ -6,7 +6,8 @@
<body>
<h2><a href="http://evocore.net/">evoCore</a> FrameWork</h2>
<h1><code>/locales</code> folder</h1>
- <p>This folder holds the <strong>locales</strong>. This means it primarily holds the language files which allow to use the applications in different languages.</p>
+ <p>This folder holds the <strong>locales</strong>. This means it holds the language packs which allow to use the applications in different languages.</p>
<p><em>Currently, this folder does not need to be accessed through the web but may need later; for localized icons for example.</em></p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
View
@@ -6,8 +6,9 @@
<body>
<h2><a href="http://evocore.net/">evoCore</a> FrameWork</h2>
<h1><code>/media</code> folder</h1>
- <p>This folder holds the <strong>media</strong> files<strong> </strong>(images, sounds, videos, PDF documents...). These files can be uploaded through the backoffice and included into blog posts or other pages presented to the user.</p>
- <p>This folder has different subfolders for different &quot;media roots&quot;. Each of these roots can have different access permissions in the backoffice. </p>
+ <p>This folder holds the <strong>media</strong> files<strong> </strong>(images, sounds, videos, PDF documents...). These files can be uploaded through the back-office and included into posts or other pages presented to the user.</p>
+ <p>This folder has different subfolders for different &quot;file roots&quot;. Each of these roots can have different access permissions in the backoffice. </p>
<p><em>Depending on how you set up <code>$public_acces_to_media</code> in <code>/conf/_advanced.php</code>, this folder may or may not need to be accessed through the web.</em></p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
View
@@ -6,8 +6,10 @@
<body>
<h2><a href="http://evocore.net/">evoCore</a> FrameWork</h2>
<h1><code>/plugins</code> folder</h1>
- <p>This folder holds the <strong>plugin</strong> files. Plugins typically package third party extensions to the application in a single PHP file.</p>
- <p>You can add new plugins by copying their file(s) into this folder. Once the files are in this folder you still need to install the desired plugins through the backoffice in order to activate them.</p>
- <p><em>Depending on the activated plugins <code></code>, this folder may or may not need to be accessed through the web.</em></p>
+ <p>This folder holds the <strong>plugin</strong> files. Plugins allow to add third-party extensions to the application.</p>
+ <p>Plugins can be a single file with the extension `.plugin.php` or a sub-folder with the suffix `_plugin`. It is recommended to use a sub-folder for each new plugin you may develop. You may also place each old single-file plugin into a folder.</p>
+ <p>You can add new plugins by copying it into this folder. Once the files are in this folder you still need to install the desired plugins through the back-office in order to activate them.</p>
+ <p><em>Depending on the activated plugins, this folder may or may not need to be accessed through the web.</em></p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
View
@@ -6,8 +6,12 @@
<body>
<h2><a href="http://evocore.net/">evoCore</a> FrameWork</h2>
<h1><code>/rsc</code> folder</h1>
- <p>This folder holds the <strong>r</strong>e<strong>s</strong>our<strong>c</strong>e files. Resource files are presentation elements used to make up the interface. This includes icons, CSS and even Javascript.</p>
+ <p>This folder holds the <strong>r</strong>e<strong>s</strong>our<strong>c</strong>e files. Resource files are presentation elements used to construct the user interface. This includes icons, CSS and even Javascript.</p>
<p>This folder holds general purpose resources. The elements in here may be extended and/or replaced by more specific resources found in the various skin folders. </p>
<p><em>This folder needs to be accessed through the web.</em></p>
+
+ <h3>`/build/` sub-folders</h3>
+ <p>Please note that there are several sub-folders names `/build/` in this directorty tree. The files they contain are built from other source files by using Grunt. The files in the `/build/` folders should never be modified manually because they will be automatically overwritten the next time grunt is run.</p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
View
@@ -1,17 +1,15 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>/skins Folder</title>
</head>
<body>
<h2><a href="http://b2evolution.net/">b2evolution</a></h2>
<h1><code>/skins</code> folder</h1>
- <p>This folder holds the <strong>skins</strong> for the blogs.</p>
- <p><strong>b2evolution Note:</strong> this folder only pertains to the <strong>public interface</strong> skins. The skins for the admin interface are to be found the the <code>/skins_adm</code> folder. </p>
- <p>Each available skin can be found in its own subfolder. You can install/create additional skins by copying/creating new subfolders into the <code>/skins</code> folder.</p>
- <p>Subfolders starting with a _ represent available skins which will remain hidden to the users. Those are typically used for RSS skins.</p>
- <p>Fallback templates can be found in folders like <code>/skins_fallback_v5</code>, <code>/skins_fallback_v6</code>, etc.</p>
+ <p>This folder holds the <strong>skins</strong> for the front-office. Each collection may use a different skin. It may actually even use different skins for web, tablet and mobile devices.</p>
+ <p>Each available skin can be found in its own sub-folder. You can install/create additional skins by copying/creating new subfolders into the <code>/skins</code> folder.</p>
+ <p>Subfolders starting with a `_` represent available skins which will remain hidden to the users. Those are typically used for RSS skins.</p>
<p><em>This folder needs to be accessed through the web.</em></p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
@@ -8,7 +8,7 @@
<h1><code>/skins_adm</code> folder</h1>
<p>This folder holds the <strong>skins</strong> for the <strong>adm</strong>in interface (the back-office).</p>
<p>The <code>adminUI_general</code> class implements a default behaviour for the admin User Interface. This default behaviour can be overridden in different skin subfolders.</p>
- <p><strong>b2evolution Note:</strong> this folder only pertains to the <strong>admin</strong> skins. The skins for the public blog views are to be found the the <code>/skins</code> folder. </p>
<p><em>This folder needs to be accessed through the web.</em></p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
@@ -7,9 +7,10 @@
<h2><a href="http://b2evolution.net/">b2evolution</a></h2>
<h1><code>/skins_email</code> folder</h1>
<p>This folder holds the <strong>skins</strong> that are used when sending out emails.</p>
- <p>For each email there is one template for HTML emails and one template for Plain Text emails.
+ <p>For each email there is one template for HTML emails and one template for Plain-Text emails.
<a href="http://b2evolution.net/man/themes-templates-skins/email-skins/">More info about email templates.</a></p>
<p>This folder holds a set of default templates files for each kind of outgoing email. These can be customized. For example <code>/skins_email/xxx.php</code> can be overridden by <code>/skins_email/custom/xxx.php</code>. </p>
<p><em>This folder may need to be accessed through the web if some CSS or graphics are used in the custom templates.</em></p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
@@ -7,8 +7,8 @@
<h2><a href="http://b2evolution.net/">b2evolution</a></h2>
<h1><code>/skins_fallback_v5</code> folder</h1>
<p>This folder holds the <strong>fallback skin templates</strong> for skins using the evoSkin API version 5 (all skins made before b2evolution v6).</p>
- <p><strong>b2evolution Note:</strong> this folder only pertains to the <strong>public interface</strong> skins. The skins for the admin interface are to be found the the <code>/skins_adm</code> folder. </p>
<p>For example <code>_feedback.php</code> lists the comments and the trackbacks in a standard manner and can then be included in any skin. However, if time permits, the skin designer can also override <code>_feedback.php</code> in his customized skin folder. </p>
<p><em>This folder does not need to be accessed through the web.</em></p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
@@ -7,9 +7,9 @@
<h2><a href="http://b2evolution.net/">b2evolution</a></h2>
<h1><code>/skins_fallback_v6</code> folder</h1>
<p>This folder holds the <strong>fallback skin templates</strong> for skins using the evoSkin API version 6 (available since b2evolution v6).</p>
- <p><strong>b2evolution Note:</strong> this folder only pertains to the <strong>public interface</strong> skins. The skins for the admin interface are to be found the the <code>/skins_adm</code> folder. </p>
<p>For example <code>_feedback.php</code> lists the comments and the trackbacks in a standard manner and can then be included in any skin. However, if time permits, the skin designer can also override <code>_feedback.php</code> in his customized skin folder. </p>
<p>IMPORTANT: If a fallback template is not found in this directory, b2evolution will look into the lower API version: <code>/skins_fallback_v5</code>.</p>
<p><em>This folder does not need to be accessed through the web.</em></p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
@@ -6,10 +6,10 @@
<body>
<h2><a href="http://b2evolution.net/">b2evolution</a></h2>
<h1><code>/skins_site</code> folder</h1>
- <p>This folder holds the <strong>skins</strong> that apply to the whole site (i-e, not specific to a particular blog or type of blog).</p>
+ <p>This folder holds the <strong>skins</strong> that apply to the whole <strong>site</strong> (i-e, not specific to a particular collection or type of collection).</p>
<p></p>
- <p>Each available skin can be found in its own subfolder. You can install/create additional skins by copying/creating new subfolders into the <code>/skins</code> folder.</p>
- <p>This folder holds a set of default behavior include files for several functions. For example <code>/skins_site/_xxx.php</code> can be overridden by <code>/skins_site/skin_name/_xxx.php</code>. </p>
+ <p>This folder holds a set of default behavior include files for several functions. Each one can be overriden and customized. For example <code>/skins_site/_xxx.php</code> can be overridden by <code>/skins_site/custom/_xxx.php</code>. </p>
<p><em>This folder needs to be accessed through the web.</em></p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>
View
@@ -8,6 +8,7 @@
<h1><code>/xmlsrv</code> folder</h1>
<p>This folder holds the <strong>xml</strong> <strong>s</strong>e<strong>rv</strong>ices entry points.</p>
<p>The files in this folder typically implement webservices.</p>
- <p><em>This is a services folder. It needs to be accessed through the web.</em> </p>
+ <p><em>This is a services folder. It needs to be accessed through the web.</em></p>
+ <p><a href="http://b2evolution.net/man/codebase-overview">A global overview of the codebase can be found here.</a></p>
</body>
</html>

0 comments on commit 4bd5010

Please sign in to comment.