Add the license informtion for Prism.

Resolves issue#3

README.md

@@ -1,136 +1 @@
 # simple_blog
-
-simple_blog is a basic blogging platform. It is designed to be a straightforward way to publish articles written in Markdown and display them using a renderer written in PHP. There is no login page or any way to manage simple_blog from the web. All management is done via the command line. This can be done with a shell script or with the python based [simple_blog_cms](/git/20xd6/simple_blog_cms). 
-
-## Requirements
-
-* Currently tested with PHP 7.4
-* Some shell access is necessary.
-    * The recommend way is via ssh.
-    * I don't see a technical reason it can't work with a web manager like cPannel or Ajenti as long has you have the ability to upload files and manage files.
-
-## Publishing
-
-Publishing can be done manually or with a script that accomplishes the following tasks.
-
-1. Create a directory under `/blog/by_year/$CURRENT_YEAR/$CURRENT_MONTH/`
-    * For a post in January of 2022 this would be `/blog/by_year/2022/01/`
-    * The directory should start with a numeral otherwise it will be sorted alphabetically
-2. Place a file named `article.md` containing the MarkDown formatted text of the article in the directory created in the previous step
-3. Copy or symlink `/common/index.php` into the directory created in step 1
-4. Place a file named `tags` containing a comma separated list of tags for the article in the directory created in step 1
-5. Add the article's relative path and title to `/by_tag/tags.csv` under the appropriate headings.
-
-The recommended method is to use [simple_blog_cms](/git/20xd6/simple_blog_cms "simple_blog_cms")
-
-## Article Tags
-
-### Per-article List
-
-A file named `tags` is placed in the directory for each article. It should contain a comma separated list of tags being applied to the article. This will be parsed and displayed by [`/common/md_read.php`](/git/20xd6/simple_blog/src/branch/master/common/md_read.php) at the bottom of the article.
-
-### by_tags
-
-This folder contains an index file that displays an article list generated by parsing the `tags.csv` file. A format example is displayed below.
-
-| "PHP" | "JS" | "Religion" | "Catholic" |
-| ----- | ---- | ---------- | ---------- |
-| "/blog/by_year/2021/10/03_Forcing_Elements_to_reload/" | "/blog/by_year/2021/10/03_Forcing_Elements_to_reload/" |"/blog/by_year/2021/10/reproduction_of_Gainer_Bishop_Ronald_4-1-16/" | reproduction_of_Gainer_Bishop_Ronald_4-1-16/" |
-| "Forcing page elements to reload" | "Forcing page elements to reload" | "Open Letter to Bishop Ronald Gainer" | "Open Letter to Bishop Ronald Gainer" |
-| "/blog/by_year/2022/06/28_A_Test_Post/"| | |
-| "A Test Post" | | |
-
-
-## File Descriptions
-
-### blog
-
-Contains the blog articles. The articles are placed in subdirectories of `by_year` according to the year and month they were published. 
-
-```
-├── by_year
-│   ├── 2021
-│   │   ├── 12
-│   │   └── index.php -> /path/to/common/index.php
-│   ├── 2022
-│   │   ├── 01
-│   │   ├── 02
-│   │   └── index.php -> /path/to/common/index.php
-│   └── index.php
-└── index.php  -> /path/to/common/index.php
-```
-
-### common
-
-This directory contains the files and libraries used to render the site's pages.
-
-#### Composer files
-* composer.json
-* composer.lock
-* [/common/vendor]() - Stores the composer files and libraries managed via composer.
-
-#### CSS
-
-* [styles.css](/git/20xd6/simple_blog/src/branch/master/common/styles.css) - The main site CSS.
-* [jmenu.css]() - Used to render the responsive menus.
-* [print.css]() - Used to style printed pages.
-* [gallery.css]() - Styles the floating 
-
-#### JS
-
-* font_size.js
-* [page_format.js]() - The main JS file used for formatting and adding extra functions to pages.
-* gallery.js
-
-#### PHP
-
-* [footer.php]() - The common page footer. Contains copyright information and links to the license.
-* [get_month_name.php]() - Translates a numeral month into the corresponding name. I.E. 01 into January.
-* [h1_month.php]() - Adds the proper `<h1>` heading based on the location of the 
-* [header.php]() - The common page header.
-* [index.php]() - The index file used for most of the pages on the site.
-* [markdown.php]()
-* [md_read.php]() - Renders Markdown files and adds 
-* [menu.php]() - Generates the blog menu items in the navigation menu.
-* [modal.php]() - Adds the modal `<div>` for displaying the image pop out.
-* [page_menu.php]() - Generates a menu from the files and directories where it's run from.
-* [page_menu_table.php]()
-* [path_menu.php]()
-
-#### /common/error_pages/
-
-* [/common/403.php]() - The 403 not allowed page.
-* [/common/404.php]() - The 404 page.
-* [/common/500.php]() - Displayed for all HTTP 500 errors
-
-#### /common/imgs/
-
-Images used site wide.
-
-* [cursor.gif]() - Blinking cursor used on the front page.
-* [icon-rss.png]() - RSS icon
-
-
-#### /common/prisim 
-
-Files for the prism syntax highlighter.
-
-### license
-
-This directory contains all the licensing information for simple_blog. simple_blog is licensed under the GPLv2 but uses components that are licensed under the MIT Open Source license. These components are:
-
-* [Jmenu](https://github.com/jamesjohnson280/JMenu)
-* [Parsedown](https://github.com/erusev/parsedown)
-* [Parsedown-extra](https://github.com/erusev/parsedown-extra)
-
-#### index.php
-
-Displays all of the reverent license and the components they apply to.
-
-* simple_blog is licensed GPLv2. This cannot be changed.
-* Default license for articles published. This is [Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/) by default. This licensed can be changed however the site admin wishes.
-* [Jmenu](https://github.com/jamesjohnson280/JMenu) is licensed MIT. This cannot be changed.
-* [Parsedown](https://github.com/erusev/parsedown) is licensed MIT. This cannot be changed.
-* [Parsedown-extra](https://github.com/erusev/parsedown-extra) is licensed MIT. This cannot be changed.
-
-Copies of all these licenses can be found in the `/license/` directory.

common/get_month_name.php

@@ -1,5 +1,4 @@
 <?php
-//Parses it's passed input to convert it to a month name.
 function get_month_name($passed_var){
   switch($passed_var){
     case "01":

common/h1_month.php

@@ -1,5 +1,4 @@
 <?php
-//Sets the proper level 1 heading for the folder.
 include_once ($_SERVER['DOCUMENT_ROOT'].'/common/get_month_name.php');
 $current_dir = basename(getcwd());
 $named_month = get_month_name($current_dir);

common/header.php

@@ -1,8 +1,7 @@
 <!DOCTYPE html>
 <html lang="en-US">
 <?php
-  //Sets the page title based on the name of the current directory
-  function Title() {//Needs cleanup.
+  function Title() {
     //~ $new_title = $_SERVER['REQUEST_URI'];
     
     //~ $new_title = preg_replace("/^^\//i", "", $new_title);
@@ -28,7 +27,7 @@
 ?>
 <head>
   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
-  <?php//If a tags file is present parse it and add any tags found to the renderd page's metadata.
+  <?php
     if(file_exists('tags')){
       $tag_data_raw = fopen('tags',"r");
       $tag_data = fread($tag_data_raw, filesize('tags'));

common/index.php

@@ -1,10 +1,7 @@
 <?php
-  //The common file used to render pages on the blog.
   include_once ($_SERVER['DOCUMENT_ROOT'].'/common/header.php');
   include_once ($_SERVER['DOCUMENT_ROOT'].'/common/menu.php');
-  //Looks for an article.md to see if the current directory is an article or not
-  //If it is not then it is a menu page.
-  if (file_exists('article.md')){ 
+  if (file_exists('article.md')){
     include_once ($_SERVER['DOCUMENT_ROOT'].'/common/md_read.php');
   } else {
     include_once ($_SERVER['DOCUMENT_ROOT'].'/common/h1_month.php');

common/page_format.js

@@ -1,10 +1,8 @@
-//
 function format_page(){//Set the title of the page based on the main header, <h1>, tag.le != '' )){
   if ( document.getElementsByTagName('h1').length !== 0){
     document.title = document.getElementsByTagName('h1')[0].innerText;
   }
-  //Detect if the page contains code blocks to be highlighted and loads the 
-  //prisim.js and prism.css files if codeblocks are found.
+  //detect if the page contains code blocks to be highlighted and loads the prisim.js and prism.css files to accomplish this.
   code_tag = document.getElementsByTagName('code').length;
   if ( code_tag !== 0 ){
     var script = document.createElement('script');
@@ -17,14 +15,11 @@ function format_page(){//Set the title of the page based on the main header, <h1
     document.head.appendChild(script);
     document.head.appendChild(style_sheet);
   }
-  //Sets the displayed fontsize.
-  //This functionality won't work without JavaScript enabled. For this reason the  
-  //buttons won't be shown if this script isn't run.
-  if ( document.getElementById("font_btns") ){//Show the font selection buttons. 
+  if ( document.getElementById("font_btns") ){//Show the font selection buttons.
     document.getElementById("font_btns").style.display = 'inline';
-    var font_size = read_cookie("font_size");//reads a saved value for fontsize from the site cookie
+    var font_size = read_cookie("font_size");
     if ( font_size != "" || font_size != "medium" ){
-      font_set(font_size);//insure a sane default
+      font_set(font_size);
     }
   }
   if ( document.getElementById("search_inputs") ){//Show the search box and button on the tags page.
@@ -48,7 +43,7 @@ function format_page(){//Set the title of the page based on the main header, <h1
     });
   }
 }
-function font_set(size_to_set){//Set a cookie to remember the fontsize selection.
+function font_set(size_to_set){
   document.getElementById("article").style.fontSize = size_to_set;
   set_cookie("font_size",size_to_set);
 }
@@ -57,7 +52,7 @@ function focus_element(element_id){
   ele_to_focus.focus();
   ele_to_focus.select();
 }
-function tag_search(){//searches in the avaliable tags and displays all articles matching the searched tag.
+function tag_search(){
   var search_input, filter, tag_list, li, a, i;
   search_input = document.getElementById("tag_sort");
   filter = search_input.value.toUpperCase();
@@ -71,8 +66,9 @@ function tag_search(){//searches in the avaliable tags and displays all articles
       li[i].style.display = "none";
     }
   }
+  
 }
-function title_search(){//searches for matches in the article titles rather than tags. Allows more granular search
+function title_search(){
   var search_input, filter, tag_list, li_list, ol, a, i;
   search_input = document.getElementById("title_sort");
   filter = search_input.value.toUpperCase();
@@ -92,7 +88,7 @@ function title_search(){//searches for matches in the article titles rather than
   }
   
 }
-function search_toggle(){//Toggles if the unit being sorted on is the article title or tag
+function search_toggle(){
   if (document.getElementById("tag_sort")){
     document.getElementById("tag_sort").placeholder = "Search Titles";
     document.getElementById("tag_sort").onkeyup = function() {title_search()};
@@ -111,10 +107,10 @@ function search_toggle(){//Toggles if the unit being sorted on is the article ti
     focus_element("tag_sort");    
   }
 }
-function set_cookie(prop_name, prop_value){//sets a passed cookie property and value.
+function set_cookie(prop_name, prop_value){
   document.cookie = prop_name + "=" + prop_value + ";path=/;SameSite=Strict;";
 }
-function read_cookie(cname){//reads a property value 
+function read_cookie(cname){
   let prop_name = cname + '=';
   let decoded_cookie = decodeURIComponent(document.cookie);
   let split_cookie = decoded_cookie.split(';');
@@ -129,11 +125,11 @@ function read_cookie(cname){//reads a property value
   }
   return "";
 }
-function printDiv(divName) {//Formats the page for printing.
+function printDiv(divName) {
   var printContents = document.getElementById(divName).innerHTML;
   w=window.open();
   w.document.write(printContents);
   w.print();
   w.close();
 }
-window.onload = format_page;//loades the page formatting script.
+window.onload = format_page;

common/page_menu.php

@@ -4,7 +4,6 @@
 <?php
 include_once ($_SERVER['DOCUMENT_ROOT'].'/common/get_month_name.php');
 
-//Removes the number used to keep articles in post order from the displayed title.
 function remove_sorting_number($link_title){
   $first_three = mb_substr($link_title, 0, 3,"UTF-8");
   
@@ -32,14 +31,14 @@ if (file_exists($dir) && is_dir($dir) ) {
         $file_array[] = $file;
       }
     }
-    foreach($file_array as $file) {//Renders the folder names as more readable titles.
-      $_replace = array('.php', '.html', '.htm');//Remove file extensions from webpages.
-      $link_title = str_replace('_',' ',$file);//Remove undersores and replace them with spaces
+    foreach($file_array as $file) {
+      $_replace = array('.php', '.html', '.htm');
+      $link_title = str_replace('_',' ',$file);
       $link_title = str_replace($_replace,'',$link_title);
-      $link_title = ucwords($link_title);//Set the first letter of each word to upercase.
-      $link_title = get_month_name($link_title);//
-      $link_title = remove_sorting_number($link_title);//Removes the number used to keep articles in post order from the displayed title.
-      echo("<ul><li><a href='$file'> $link_title </a></li></ul>\n");//Output the result.
+      $link_title = ucwords($link_title);
+      $link_title = get_month_name($link_title);
+      $link_title = remove_sorting_number($link_title);
+      echo("<ul><li><a href='$file'> $link_title </a></li></ul>\n");
     }
 }
 else {

license/index.php

@@ -8,7 +8,7 @@ include_once ($_SERVER['DOCUMENT_ROOT'].'/common/menu.php');
 ?>
 <article>
 <p>A summery of all licenses that apply to this website.</p>
-<h2>Code License</h2>
+<h2>simple_blog License</h2>
 <font size="2">
    Copyright <?php echo(strftime("%Y")); ?> 20xd6<br>
    <br>
@@ -46,5 +46,15 @@ JMenu is <a href="/license/MIT.php">MIT Licensed</a>.</p>
 <p>Parsedown is used for all of the Markdown processing for this site.<br/>
 Parsedown is <a href="/license/MIT.php">MIT Licensed</a>.</p>
 <?php display_file($_SERVER['DOCUMENT_ROOT'].'/common/vendor/erusev/parsedown/LICENSE.txt');?>
+<h3><a href="https://github.com/erusev/parsedown-extra">Parsedown Extra</a></h3>
+<blockquote><p>An extension of <a href="https://github.com/erusev/parsedown">Parsedown</a> that adds support for <a href="https://michelf.ca/projects/php-markdown/extra/">Markdown Extra.</a></p></blockquote>
+<p>Pasrsedown-extra is used primarily to add support for footnotes in articles. <br/>Parsedown-extra is <a href="/license/MIT.php">MIT Licensed</a>.</p>
+<?php display_file($_SERVER['DOCUMENT_ROOT'].'/common/vendor/erusev/parsedown-extra/LICENSE.txt');?>
+<h3>Prism</h3>
+<blockquote><p>Prism is a lightweight, robust, and elegant syntax highlighting library. It's a spin-off project from <a href="https://dabblet.com/">Dabblet</a>.<br/>
+You can learn more on <a href="https://prismjs.com/">prismjs.com</a>.</p></blockquote>
+<p>Prism is used for syntax highlighting is simple_blog.<br/>
+Prism is <a href="/license/MIT.php">MIT Licensed</a>.</p>
+<?php display_file("MIT_License.txt"); ?>
 </article>
 <?php include_once ($_SERVER['DOCUMENT_ROOT'].'/common/footer.php');?>