Add instructions for the dependency check script

The dbi sqlite module is not directly used in the site-generator code.
The module is called by template files. Removing it allows the main
code to be database independent.

GETTING_STARTED.md

@@ -0,0 +1,219 @@
+# Clone the repository
+
+If git is not installed on the operating system, please install it now 
+(see the git documentation for [instructions on installing git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)).
+
+To retrieve the code from the repository on anhonesthost.net (a username and 
+password are required), run:
+
+`git clone https://repo.anhonesthost.net/rho_n/hpr_generator.git`
+
+To retrieve the code from the repository on gitlab.com, run: 
+
+`git clone https://gitlab.com/roan.horning/hpr_generator.git`
+
+On success, an "hpr_generator" directory will be created in the folder from 
+which the clone command was executed containing a local copy of the git repository.
+
+# Install required Perl modules
+
+Installing the Perl modules is the most finicky part of the installation process. 
+The needed Perl modules can be found using the operating system's package 
+manager or using the modules found in the 
+[Comprehensive Perl Archive Network (CPAN)](https://www.cpan.org/).
+
+## Installing modules on Debian based Linux distributions
+
+Run command (tested on Debian 11):
+
+```
+apt install libconfig-std-perl \
+	libtemplate-perl \
+	libtemplate-plugin-dbi-perl \
+	libdbd-sqlite3-perl libdate-calc-perl \
+	libtie-dbi-perl \
+	libtext-csv-xs-perl \
+	libhtml-parser-perl \
+	libtemplate-plugin-html-strip-perl
+
+```
+
+## Using CPAN to install the modules
+
+A cross platform method to install the needed modules is the Perl CPAN application. 
+Make sure that the [gcc](https://www.gnu.org/software/gcc/), 
+[make](https://www.gnu.org/software/make/manual/make.html), 
+and [cpan](https://perldoc.perl.org/CPAN) commands are available. 
+Install them using the operating system's package manager, or from source.
+
+Run commands:
+
+```
+cpan Config::Std
+cpan Template
+cpan Template::Plugin::DBI
+cpan Template::Plugin::HTML::Strip
+cpan DBD::SQLite
+cpan Date::Calc
+cpan Tie::DBI
+cpan Text:CSV_XS
+```
+
+## Testing for Perl module dependencies
+
+A bash script is included in the utils directory that will list the Perl modules used by the site-generator and report whether the modules are installed on the current OS.
+
+It can be run from any directory. To run from the utils directory:
+
+```
+./check-dependencies.sh
+```
+
+# Create the HPR database
+
+The hpr_generator relies on information from a database to generate many of the 
+files for the website (for example: index.html, series/index.html, 
+hpr_mp3.rss, etc). This data is available from a MySQL dump file found on 
+hackerpublicradio.org at URL "https://www.hackerpublicradio.org/hpr.sql".
+
+The first step is to download the hpr.sql file. This can be done using your 
+browser, or by running one of the following commands:
+
+`curl https://www.hackerpublicradio.org/hpr.sql --output ./hpr.sql`
+
+or
+
+`wget --directory-prefix=./ https://www.hackerpublicradio.org/hpr.sql`
+
+## Creating an SQLite database file
+
+The SQL of the hpr.sql file must be converted from MySQL specific statements to 
+SQLite specific statements. The mysql2sqlite script found in the utils directory 
+is used for this conversion. First remove the lines from hpr.sql that 
+mysql2sqlite can't handle:
+
+`sed '/^DELIMITER ;;/,/^DELIMITER ;/d' < ./hpr.sql > ./hpr-sqlite.sql`
+
+Next run the mysql2sqlite script piping its output into the sqlite3 
+program which creates the hpr.db file:
+
+`./utils/mysql2sqlite ./hpr-sqlite.sql | sqlite3 ./hpr.db`
+
+For convenience, the update-sqlite-db.sh script in the utils directory
+automates the above steps (including downloading the hpr.sql file). 
+From the root of the local hpr_generator repository run:
+
+`./utils/update-sqlite-db.sh`
+
+# Configure the site-generator
+
+In your favorite text editor, open the site.cfg file found in the root of the 
+"hpr_generator" folder. Full details about options for configuring the site.cfg 
+file are found in the comments within the file.
+
+## Configuring the database connection
+
+Any database supported by the Perl:DBI and Perl::DBD modules can be used with 
+the site-generator program. Currently the hpr_generator project works with 
+a MySQL or SQLite database.
+
+Find the [DBI] section of the file. It should look like the following
+
+```
+[DBI]
+# Configuration settings for SQLite
+#database: sqlite
+#driver: dbi:SQLite:hpr.db 
+#user:        (not used - leave blank)
+#password:    (not used - leave blank)
+# Configuration settings for MySQL
+#database: mysql
+#driver: dbi:mysql:database=hpr_hpr:hostname=localhost 
+#user: hpr-generator  (Suggested user with read-only privileges)
+#password: *********  (Password for user)
+```
+
+### SQLite
+
+Remove the comment character from the start of the database and driver 
+option lines:
+
+ ```
+# Configuration settings for SQLite
+database: sqlite
+driver: dbi:SQLite:hpr.db 
+#user:        (not used - leave blank)
+#password:    (not used - leave blank)
+```
+
+The hpr.db section of the driver option `dbi:SQLite:hpr.db` is the path 
+to the sqlite file. The default assumes the hpr.db file is located in the same
+directory as the site-generator. 
+
+### MySQL
+
+Remove the comment character from the start of the database, driver, 
+user, and password option lines:
+
+ ```
+# Configuration settings for MySQL
+database: mysql
+driver: dbi:mysql:database=hpr_hpr:hostname=localhost 
+user: hpr-generator
+password: *********
+```
+
+This assumes that the MySQL database service is available at the localhost 
+hostname, that the database name (hpr_hpr) is the database created from 
+the hpr.sql dump file or manually created by you, that the user (hpr-generator) 
+was added by you and has read rights to the hpr_hpr database, and that the 
+password (replace ********* with the actual password) matches the password set 
+for the hpr-generator database user.
+
+## Configuring the website for viewing locally
+
+For HTML links to work when viewing the files on your local machine using the 
+"file://" protocal (i.e. using the "Open..." command in your browser, each HTML 
+file must include a \<base\> meta-data tag in the \<head\> section of its 
+contents. To configure this in the site.cfg file, find the [root_template] 
+section. It should look like the following:
+
+```
+[root_template]
+content: page.tpl.html
+#baseurl: OPTIONAL [i.e. file://<full path to local website directory>]
+```
+Below the #baseurl comment line add:
+
+```
+baseurl: file://</path/to>/hpr_generator/public_html
+```
+
+Replace \<path/to\> with the full path to the hpr_generator directory. For 
+example: `file:///home/rho_n/development/hpr_generator/public_html`
+
+## Configuring the website media file links
+
+If you do not want to host all the media files (currently, audio files and 
+transcription files), you can configure the `media_baseurl` option. This can 
+be added to the [root_template] section of the site.cfg file. Suggested 
+external site is archive.org. To use this site add:
+
+```
+media_baseurl: https://archive.org/download/hpr$eps_id/
+```
+
+# Run the site-generator
+
+Run the site generator form the hpr_generator directory:
+
+```
+./site-generator --all
+```
+
+This will generate all the files for the website. For more examples and to see 
+all available options run:
+
+```
+./site-generator --help
+```

README.md

@@ -3,26 +3,52 @@ Static web page generator for the Hacker Public Radio website.
 
 ## Installation
 * Clone or download this repository
-* Create the sqlite3 database from the files in the _sql directory. The default name for the database file is "hpr.db" and should be located in the root of the project directory. The name and location can be set in the site.cfg file.
-* Two sql helper scripts are available to generate an empty database or a database filled with test data.
-  - For an empty database: `cat Create_Database_Empty.sql | sqlite3 hpr.db`
-  - For a database with test data: `cat Create_Database_Test.sql | sqlite3 hpr.db`
+* With SQLite
+	* Create the sqlite3 database from the hpr.sql MySQL dump file available on
+	  hackerpublicradio.org. The default name for the database file is "hpr.db"
+	  and should be located in the root of the project directory. The name and
+	  location can be set in the site.cfg file.
+	* An "update-hpr.sh" helper script is available in the utils directory. This
+	  script will download the hpr.sql file, convert it to the SQLite hpr.db file,
+	  and regenerate the website using the site-generator.
+		1. `cd` into the root of the project directory
+		2.  Run `./utils/update-hpr.sh`
+	* SQLite v3.8.3 or greater is recommended. CTE WITH clauses are used in some template queries. Must convert WITH
+	  clauses to sub-queries when using earlier versions of SQLite.
+* With MySQL
+	* Create database hpr_hpr in the MySQL server from HPR dump file.
+		- ``sudo mysql --host=localhost < hpr.sql``
+	* Create a user that will be used by the site-generator.
+		- Suggested username: hpr-generator
+		- ``CREATE USER 'hpr-generator'@'localhost' IDENTIFIED BY '<password>';``
+	* Limit the user's privileges to EXECUTE and SELECT
+		- ``GRANT SELECT ON hpr_hpr.* TO 'hpr-generator'@'localhost';``
+		- ``GRANT EXECUTE ON `hpr_hpr`.* TO 'hpr-generator'@'localhost';``
 * Install the needed Perl modules using preferred method (distribution packages, CPAN, etc.)
-    * GetOpt
+    * Getopt::Long
     * Pod::Usage
     * Config::Std
     * Template
-    * Template::Plugin:File
+    * Template::Plugin::File
+    * Template::Plugin::DBI
+    * Template::Plugin::Date
+    * Template::Plugin::HTML::Strip
     * DBI
     * Tie::DBI
+    * DBD::SQLite or DBD::mysql
     * Date::Calc
+    * Text::CSV_XS
+    * HTML::Entities
+
+* See the [Getting Started](GETTING_STARTED.md) tutorial for more details on
+  installing the HPR generator.
 
 ## Usage
 Generate two specific pages:
-`site-generator index about`		
+`site-generator index about`
 
 Generate the whole site:
-`site-generator ALL`	
+`site-generator --all`
 
 Generate pages based on the same template:
 `site-generator correspondent=1,3,5..10`
@@ -45,5 +71,9 @@ To make a suggestion, please [submit an Issue](https://repo.anhonesthost.net/rho
 and add the label "**Feature Request**".
 
 ## Authors and acknowledgment
-* Roan "Rho`n" Horning 
+* Roan "Rho`n" Horning
+* Dave Morriss
+* gordons
+* Ken Fallon
+* norrist
 

public_html/css/hpr.css

@@ -1,7 +1,7 @@
 @charset "utf-8";
 /* Website design Copyright Ken Fallon - Released into the public domain/
 
-http://creativecommons.org/publicdomain/ 
+https://creativecommons.org/publicdomain/ 
  
 */
 
@@ -198,7 +198,7 @@ h1.showtitle { font-size: 125%;}
 
 p.author { font-size: 85%;}
 p.shownotes { padding: .5em;}
-#maincontent footer p { font-size: 75%; margin-bottom: 1em;}
+#maincontent footer p { /* font-size: 75%; */ margin-bottom: 1em;}
 /* link styling */
 a:link {text-decoration: none;}
 
@@ -235,7 +235,23 @@ pre { /* Add background, border and scrollbar to <pre> */
     clear: both;
 }
 
+table.hosts {
+	background: white
 }
+table.hosts tr:nth-child(even) { background-color:#cccccc; }
+table.hosts tr:nth-child(odd) { background-color:white; }
+table.hosts tr td img { vertical-align:middle }
+
+pre.comment {
+	white-space: pre-wrap;
+	padding: 2px;
+	line-height: 1.2rem;
+}
+
+h3.title { margin: 1.25rem 0 0.75rem 0 }
+p.meta { margin: 0.25rem 0 }
+p.summary { margin: 0.25rem 0 }
+p.listen-in { margin-top: 0 }
 
 @media only screen and (max-width: 680px) { 
 	#container {width: 95%;}