HTML5 Boilerplate v9.0.0 update

README.md

@@ -1,13 +1,13 @@
-# [HTML5 Boilerplate for ProcessWire](https://github.com/BlowbackDesign/PW-H5BP)
+# [ProcessWire HTML5 Boilerplate](https://processwire.com/modules/html5-boilerplate/)
 
 [HTML5 Boilerplate](https://html5boilerplate.com) site profile for [ProcessWire](https://processwire.com).
 
-PW-H5BP is based on ProcessWire site-blank default profile and keeps up to date with PW master branch / HTML5 Boilerplate latest release. Please feel free to contribute and [report any issues](https://github.com/BlowbackDesign/PW-H5BP/issues) you may find. Thanks!
+PW-H5BP is based on ProcessWire site-blank default profile and keeps up to date with HTML5 Boilerplate latest release. Please feel free to contribute and [report any issues](https://github.com/BlowbackDesign/PW-H5BP/issues) you may find. Thanks!
 
 ## Installation
 
 Extract the content from this repository to your web root along with [ProcessWire](https://github.com/ryancramerdesign/ProcessWire) and proceed to [installation](https://github.com/ryancramerdesign/ProcessWire#installation). When prompted for **Site Installation Profile** select **HTML5 Boilerplate** from dropdown menu and follow the install instructions.
 
 ## License
 
-[GNU Public License (GPL)](http://www.gnu.org/copyleft/gpl.html)
+[MIT License](https://opensource.org/license/mit/)

site-h5bp/assets/index.php

@@ -1,4 +1,4 @@
 <?php
-// Intentionally left blank to test that htaccess rewrite rules are working.
+// Intentionally left blank to test that htaccess rewrite rules are working. 
 // Accessing this file from http should produce a '403 forbidden' error,
 // since all PHP files are blocked under /assets/.

site-h5bp/classes/HomePage.php

@@ -0,0 +1,20 @@
+<?php namespace ProcessWire;
+
+/**
+ * Example custom page class for pages using template “home”
+ * 
+ * Feel free to delete this file if you do not want it. This is here as a
+ * placeholder to ensure the /site/classes/ directory exists.
+ * 
+ * When this file/class is present, page using template “home” will use this 
+ * class “HomePage” rather than class “Page”. You can do the same for any 
+ * other templates. For example, template “basic-page” would have a class 
+ * named “BasicPagePage” and template “admin” would have “AdminPage”, etc.
+ * 
+ * Custom page classes must extend class “Page”, or one derived from it. 
+ * 
+ * @property string $title
+ * 
+ */
+class HomePage extends Page {
+}

site-h5bp/config.php

@@ -8,37 +8,42 @@
  * Please see the file /wire/config.php which contains all configuration options you may
  * specify here. Simply copy any of the configuration options from that file and paste
  * them into this file in order to modify them.
- *
+ * 
  * SECURITY NOTICE
  * In non-dedicated environments, you should lock down the permissions of this file so
  * that it cannot be seen by other users on the system. For more information, please
  * see the config.php section at: https://processwire.com/docs/security/file-permissions/
- *
+ * 
  * This file is licensed under the MIT license
  * https://processwire.com/about/license/mit/
  *
- * ProcessWire 3.x, Copyright 2016 by Ryan Cramer
+ * ProcessWire 3.x, Copyright 2023 by Ryan Cramer
  * https://processwire.com
  *
  */
 
 if(!defined("PROCESSWIRE")) die();
 
+/** @var Config $config */
+
 /*** SITE CONFIG *************************************************************************/
 
-/** @var Config $config */
+// Let core API vars also be functions? So you can use $page or page(), for example.
+$config->useFunctionsAPI = true;
 
-/**
- * Enable debug mode?
- *
- * Debug mode causes additional info to appear for use during dev and debugging.
- * This is almost always recommended for sites in development. However, you should
- * always have this disabled for live/production sites.
- *
- * @var bool
- *
- */
-$config->debug = false;
+// Use custom Page classes in /site/classes/ ? (i.e. template "home" => HomePage.php)
+$config->usePageClasses = true;
+
+// Use Markup Regions? (https://processwire.com/docs/front-end/output/markup-regions/)
+$config->useMarkupRegions = true;
+
+// Prepend this file in /site/templates/ to any rendered template files
+$config->prependTemplateFile = '_init.php';
+
+// Append this file in /site/templates/ to any rendered template files
+$config->appendTemplateFile = '_main.php';
 
+// Allow template files to be compiled for backwards compatibility?
+$config->templateCompile = false;
 
 /*** INSTALLER CONFIG ********************************************************************/

site-h5bp/finished.php

@@ -0,0 +1,14 @@
+<?php namespace ProcessWire;
+
+if(!defined("PROCESSWIRE")) die();
+
+/** @var ProcessWire $wire */
+
+/**
+ * ProcessWire Request Finished
+ * ============================
+ * This finished.php file is called after ProcessWire has finished serving the current
+ * request. This occurs after the current page has been rendered. This file receives a
+ * copy of all ProcessWire API variables.
+ *
+ */

site-h5bp/init.php

@@ -0,0 +1,19 @@
+<?php namespace ProcessWire;
+
+if(!defined("PROCESSWIRE")) die();
+
+/** @var ProcessWire $wire */
+
+/**
+ * ProcessWire Bootstrap Initialization
+ * ====================================
+ * This init.php file is called during ProcessWire bootstrap initialization process.
+ * This occurs after all autoload modules have been initialized, but before the current page
+ * has been determined. This is a good place to attach hooks. You may place whatever you'd
+ * like in this file. For example:
+ *
+ * $wire->addHookAfter('Page::render', function($event) {
+ *   $event->return = str_replace("</body>", "<p>Hello World</p></body>", $event->return);
+ * });
+ *
+ */

site-h5bp/install/files/README.txt

@@ -0,0 +1 @@
+This file is here to ensure Git adds the dir to the repo. You may delete this file. 

site-h5bp/install/finish.php

@@ -0,0 +1,30 @@
+<?php namespace ProcessWire;
+
+/**
+ * Install finish file (3.0.191+ only)
+ * 
+ * This file is called when profile installation has finished 
+ * but before install assets have been deleted. The Installer
+ * can also be accessed via the $installer variable. 
+ * 
+ * Use this file to perform any additional updates to the site
+ * that are needed by your site profile. 
+ * 
+ * Most ProcessWire API variables are available and locally
+ * scoped to this file. 
+ * 
+ * ProcessWire versions prior to 3.0.191 ignore this file. 
+ * 
+ */
+
+if(!defined("PROCESSWIRE_INSTALL")) die();
+
+/** @var Installer $installer */
+/** @var ProcessWire $wire */
+/** @var Pages $pages */
+/** @var User $user */
+// …and so on for other API variables 
+
+// your custom finishing code here
+
+$installer->ok('Finished installing site profile'); 

site-h5bp/install/info.php

@@ -1,6 +1,7 @@
-<?php if(!defined("PROCESSWIRE_INSTALL")) die();
+<?php namespace ProcessWire;
+if(!defined("PROCESSWIRE_INSTALL")) die();
 $info = array(
-	'title' => "HTML5 Boilerplate",
-	'summary' => "This is HTML5 Boilerplate for ProcessWire. Based on blank site profile that includes only the bare minimum pages, fields and templates.", 
+	'title' => "HTML5 Boilerplate", 
+	'summary' => "This is HTML5 Boilerplate for ProcessWire. Based on a blank site profile that includes only the bare minimum pages, fields and templates.", 
 	'screenshot' => ""
-	);
+);