Site Setup

`Required and optional configuration`

On this Page:: Content Directories; yBlog Directories; yBlog Directories; The yBlog.php File; The config.php File; The foot.php File; (Click the images for a lightbox slideshow)

Content Directories

Created: Nov 2020

Modified: July 7, 2021

Beta .33: July 7, 2021

Content pages may be in the root directory and any directory besides the yBlog directories. By convention, image files are kept in an ./img/ subdirectory in the same directory as the content files. PDF files and ZIP files for download must be in the SITE_ROOT/inc/ directory for the plugins to work.

yBlog Directories

Content pages are in the root directory any desired folders except those reserved for yBlog, LIB, and INC. There are a few more support files in the root directory:

./htaccess will probably work on your ISP's server with minor customizations (see comments in file):

Options +FollowSymLinks <filesMatch ".(php)$"> Header set Cache-Control "no-cache, private" </FilesMatch> <filesMatch ".(css|js|gif|ico|jpg|jpeg|png|pdf)$"> Header set Cache-Control "max-age=31536000, public" </filesMatch> RewriteEngine On <If "%{HTTP_HOST} == 'localhost'"> SetEnv MYHOST "localhost" SetEnv MYDIR "/public_html" RewriteCond %{HTTPS} on RewriteRule (.*) http://localhost%{REQUEST_URI} [L] ErrorDocument 403 http://%{ENV:MYHOST}%{ENV:MYDIR}/lib/404.php ErrorDocument 404 http://%{ENV:MYHOST}%{ENV:MYDIR}/lib/404.php Options +Indexes </If> <Else> SetEnv MYHOST "yofiel.com" # // force to non-www RewriteCond %{HTTP_HOST}^www.%{ENV:MYHOST} [NC] RewriteRule ^(.*)$ https://%{ENV:MYHOST}/$1 [L,R=301] # // force HTTPS RewriteCond %{HTTPS} off RewriteRule ^(.*)$ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301] ErrorDocument 403 https://%{ENV:MYHOST}/lib/404.php ErrorDocument 404 https://%{ENV:MYHOST}/lib/404.php # // File moves Redirect 301 /jesus.php /essay.php Redirect 301 /gnosticism.php /essay.php Redirect 301 /darwin.php /essay/darwin.php Redirect 301 /rights2.php /essay/rights2.php Redirect 301 /will.php /essay/afterlife.php Redirect 301 /gnosticism/platonism.php /index.php Redirect 301 /gnosticism/poetry.php /index.php RewriteRule /jesus/(.*)$ /essay/$1 [R=301,NC,L] RewriteRule /essays/(.*)$ /essay/$1 [R=301,NC,L] RewriteRule /gnosticism/(.*)$ /essay/$1 [R=301,NC,L] # // Security DirectoryIndex index.php IndexIgnore * <IfModule mod_headers.c> # // Header always set Strict-Transport-Security "max-age=31536000" # // Header set Access-Control-Allow-Origin "https://www.facebook.com/*" Header set X-Frame-Options "DENY" Header set X-XSS-Protection: 1 Header set X-Content-Type-Options: nosniff </IfModule> RewriteCond %{REQUEST_URI} ^/(wp-login.php|wp-admin/|wp-content/plugins/|wp-includes/).* [NC] RewriteCond %{THE_REQUEST} ^[A-Z]{3,9}\ ///.*\ HTTP/ [NC,OR] RewriteCond %{THE_REQUEST} ^[A-Z]{3,9}\ /.*\?\=?(http|ftp|ssl|https):/.*\ HTTP/ [NC,OR] RewriteCond %{THE_REQUEST} ^[A-Z]{3,9}\ /.*\?\?.*\ HTTP/ [NC,OR] RewriteCond %{THE_REQUEST} ^[A-Z]{3,9}\ /.*\.(asp|ini|dll).*\ HTTP/ [NC,OR] RewriteCond %{THE_REQUEST} ^[A-Z]{3,9}\ /.*\.(htpasswd|htaccess|aahtpasswd).*\ HTTP/ [NC] RewriteCond %{REQUEST_METHOD} =POST RewriteCond %{HTTP:VIA}%{HTTP:FORWARDED}%{HTTP:USERAGENT_VIA}%{HTTP:X_FORWARDED_FOR}%{HTTP:PROXY_CONNECTION} !^$ [OR] RewriteCond %{HTTP:XPROXY_CONNECTION}%{HTTP:HTTP_PC_REMOTE_ADDR}%{HTTP:HTTP_CLIENT_IP} !^$ RewriteCond %{REQUEST_URI} ^/(wp-login.php|wp-admin/|wp-content/plugins/|wp-includes/).* [NC] RewriteCond %{REQUEST_URI} !^/(lib).* [NC] RewriteCond %{HTTP_HOST} ^$ RewriteRule .? - [F,NS,L] </Else> <ifmodule mod_deflate.c> # // compression directives AddOutputFilterByType DEFLATE application/javascript AddOutputFilterByType DEFLATE application/x-javascript AddOutputFilterByType DEFLATE image/x-icon AddOutputFilterByType DEFLATE text/css AddOutputFilterByType DEFLATE text/javascript BrowserMatch ^Mozilla/4\.0[678] no-gzip BrowserMatch \bMSIE !no-gzip !gzip-only-text/html Header append Vary User-Agent </IfModule>
./robots.txt is written so it needs no updating.
./favicons.ico may be replaced to change the icon shown in the browser toolbar
./sitemap.xml may be automatically updated in a future release.
./img/ is the suggested location for content's image files.
./inc/ contains downloadable files and PDFs.

yBlog Directories

./lib/ contains the site template and CMS PHP files, described below.
./lib/img contains the template's image files.
./lib/CodeMirror/ contains the code editor.
./lib/img/ contains image files for the template.
./lib/pwd/ contains protectedd login data.

The yBlog.php File

In the page template, the REQUIRE_ONCE ./lib/yBlog.php statement calls the maikn script to generate the page head, nav bar, responsive body header, TOC, plugin insertion, and footer. This file need not be edited, but you can change the top-of-page layout and other such features in this file.

The config.php File

The ./lib/yBlog.php file first calls a small site variable file, ./lib/config.php. The ./lib/config.php file sets the site's name, base URL, and options. This file then generates one set of variables for the public server, and another for localhost at http://127.0.0.1 which is selected automatically, depending where the directory resides. This file also sets site options, such as the logo, default stylesheet, and ID's for Google and Adobe integration. Additionally it provides default page values for any variables not set on individual content pages.

<?php // config.php. Site configuration
//--------------------------------------------------------------------------------
if(!defined('SITEURL')){ 
	define("REMOTE_SITE_URL" 		, "yofiel.com");
	define("LOCAL_ROOT_URL"  		, "localhost/public_html");
	define("SITE_NAME"		 		, "Yofiel");
	define("REMOTE_IP"		 		, "35.208.253.55");
	define("LOCAL_IP"		 		, "127.0.0.1");
	define("SITE_DESC"		 		, "Welcome! Named for the Archangel of Beauty, this site hosts knowledge and tools to protect and create beauty.");
	define("SITE_AUTHOR"		 		, "Ernest Leonardo Meyer");
	define("SITE_LOGO"		 		, "lib/img/logo.png");
	define("SHARING_LOGO"	 		, "lib/img/logo_square.jpg");//200x200 pixels required
	define("GOOGLE_ANALYTICS_ID"	, "UA-201051445-1");
	define("ADOBE_SDK_KEY"			, "b622b1d43090483d986b64418452d98d");// 0 to disable
} // Page Defaults
if(!isset($CODETHEME )){$CODETHEME  = 'erlang-dark';}
if(!isset($STYLES	  	)){$STYLES	   = 'blue'			;}
if(!isset($ANIMATE	)){$ANIMATE	   = true			;}
if(!isset($MENU_ORDER)){$MENU_ORDER = 0;				;}
$var_nav = "rgba(0,0,0,.66)";// needed in both css and javascript
//--------------------------------------------------------------------------------------
// yBlog magic. DON'T CHANGE!!
//--------------------------------------------------------------------------------------
if(!isset($TITLE     )){$TITLE      = SITE_NAME		;}
if(!isset($DESC      )){$DESC		   = SITE_DESC		;}
if(!isset($AUTHOR    )){$AUTHOR     = SITE_AUTHOR	;}
if(!isset($BLOG_DIR  )){$BLOG_DIR   = "";				;}
if(!isset($PAGE_TYPE )){$PAGE_TYPE  = 'Article'		;}
if(!defined('SITEURL')){
	define("PROTOCOL" , ((!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS']!='off') 
		|| $_SERVER['SERVER_PORT']==443)? "https://" : "http://");
	define("SITE_ROOT", substr(__DIR__, 0, strlen(__DIR__) - 3));
	$whitelist = array("localhost", REMOTE_SITE_URL);//for downloads
	$localhosts = array("127.0.0.1", "::1");
	if(in_array($_SERVER['REMOTE_ADDR'], $localhosts)){
		define("SITENAME" 	, "Localhost");
		define("SITEURL"  	, PROTOCOL.LOCAL_ROOT_URL.'/'); 
		define("SITEIP"  	, PROTOCOL.LOCAL_IP.'/'); 
		define("ANALYTICS"	, "0");
		define("ADOBE_KEY"	, "0");
		define("IS_LOCALHOST", true);
	} else {
		define("SITENAME" 	, "Yofiel");
		define("SITEURL"  	, PROTOCOL.REMOTE_SITE_URL.'/');
		define("SITEIP"  	, PROTOCOL.REMOTE_IP.'/'); 
		define("ANALYTICS"	, GOOGLE_ANALYTICS_ID);
		define("ADOBE_KEY"	, ADOBE_SDK_KEY);	
		define("IS_LOCALHOST", false);
	}
	define("PAGE_URL"	, PROTOCOL . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']);
	define("PAGE_TEST", dirname(PAGE_URL).'/');
	if(strcasecmp(PAGE_TEST, SITEURL) != 0 && strcasecmp(PAGE_URL, SITEURL) !=0){	
		define("PAGE_DIR" 	 , PAGE_TEST);
		define("PAGE_DIR_REL" , str_replace(SITEURL, '', dirname(PAGE_URL)).'/');
	} else {
		define("PAGE_DIR"     , SITEURL);	
		define("PAGE_DIR_REL" , '');	
	} 
}?>

Specifications for the variables are in preparation

To set up Google Analytics, visit its site and obtain an ID for this config file.
To set up Adobe DC Reader, visit its site and obtain an ID for this config file.

The ./lib/yBlog.php file then generates all the metadata for the page's HEAD element from the page and site variables. It also includes the site stylesheet and all scripts needed for Google Analytics and plugins.

The ./lib/yBlog.php file then closes the HEAD element and adds an opening <BODY> tag. At the top of the BODY element, yBlog inserts a HEADER element which contains the responsive header. A NAV element inside the HEADER element containing the site menu. The menu contents generated automatically.

The ./lib/head.php file then parses the page and replaces the PHP plugin snippets with HTML andJavaScript, generated by the ./lib/plugins.php file.

The foot.php File

After an article's content, the ./lib/yBlog.php file adds footer content from the ./lib/foot.phpfile. Each blog site will prefer a different footer, which is edited just like a standard Web page. The .lib/yBlog.php file then performs any necessary parsing on the whole page and sends it to the browser client.