HaverLab
/
basic-book-builder
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added name to Metadata

This commit is contained in:
John Haverlack 2025-11-13 07:56:33 -09:00
parent d81e8a1ad7
commit a5ae7a1b04
24 changed files with 1549 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Makefile
View File

@ -4,36 +4,36 @@ BASE = conf/pandoc.yaml
all: pdf epub html latex markdown all: pdf epub html latex markdown
pdf: pdf:
cat chapters/04_Hardware.base.md lib/md/server_comparison.md > chapters/04_Hardware.md
@mkdir -p build @mkdir -p build
@scripts/build-frontmatter.sh conf/metadata.yaml templates/pdf.yaml conf/pdf.yaml
@scripts/build-frontmatter.sh conf/metadata.yaml templates/frontmatter.tex conf/frontmatter.tex @scripts/build-frontmatter.sh conf/metadata.yaml templates/frontmatter.tex conf/frontmatter.tex
$(PANDOC) --defaults=$(BASE) --defaults=conf/pdf.yaml $(PANDOC) --defaults=$(BASE) --defaults=conf/pdf.yaml
epub: epub:
cat chapters/04_Hardware.base.md lib/md/server_comparison.md > chapters/04_Hardware.md
@mkdir -p build/media @mkdir -p build/media
@scripts/build-frontmatter.sh conf/metadata.yaml templates/epub.yaml conf/epub.yaml
@scripts/build-frontmatter.sh conf/metadata.yaml templates/frontmatter.html conf/frontmatter.html @scripts/build-frontmatter.sh conf/metadata.yaml templates/frontmatter.html conf/frontmatter.html
$(PANDOC) --defaults=$(BASE) --defaults=conf/epub.yaml $(PANDOC) --defaults=$(BASE) --defaults=conf/epub.yaml
html: html:
cat chapters/04_Hardware.base.md lib/md/server_comparison.md > chapters/04_Hardware.md
@mkdir -p build/lib/img build/lib/mathjax build/conf @mkdir -p build/lib/img build/lib/mathjax build/conf
cp -r lib/img build/lib/ cp -r lib/img build/lib/
cp -r lib/diag build/lib/ cp -r lib/diag build/lib/
cp -r lib/mathjax build/lib/ cp -r lib/mathjax build/lib/
cp conf/style.css build/conf/ cp conf/style.css build/conf/
@scripts/build-frontmatter.sh conf/metadata.yaml templates/html.yaml conf/html.yaml
@scripts/build-frontmatter.sh conf/metadata.yaml templates/frontmatter.html conf/frontmatter.html @scripts/build-frontmatter.sh conf/metadata.yaml templates/frontmatter.html conf/frontmatter.html
$(PANDOC) --defaults=$(BASE) --defaults=conf/html.yaml $(PANDOC) --defaults=$(BASE) --defaults=conf/html.yaml
latex: latex:
cat chapters/04_Hardware.base.md lib/md/server_comparison.md > chapters/04_Hardware.md
@mkdir -p build @mkdir -p build
@scripts/build-frontmatter.sh conf/metadata.yaml templates/latex.yaml conf/latex.yaml
@scripts/build-frontmatter.sh conf/metadata.yaml templates/frontmatter.tex conf/frontmatter.tex @scripts/build-frontmatter.sh conf/metadata.yaml templates/frontmatter.tex conf/frontmatter.tex
$(PANDOC) --defaults=$(BASE) --defaults=conf/latex.yaml $(PANDOC) --defaults=$(BASE) --defaults=conf/latex.yaml
markdown: markdown:
cat chapters/04_Hardware.base.md lib/md/server_comparison.md > chapters/04_Hardware.md
@mkdir -p build @mkdir -p build
@scripts/build-frontmatter.sh conf/metadata.yaml templates/markdown.yaml conf/markdown.yaml
@scripts/build-frontmatter.sh conf/metadata.yaml templates/frontmatter-md.html conf/frontmatter-md.html @scripts/build-frontmatter.sh conf/metadata.yaml templates/frontmatter-md.html conf/frontmatter-md.html
$(PANDOC) --defaults=$(BASE) --defaults=conf/markdown.yaml $(PANDOC) --defaults=$(BASE) --defaults=conf/markdown.yaml

4
README.md
View File

@ -30,5 +30,5 @@ make epub
## Getting Started ## Getting Started
Download PDF or HTML version of the b3 book. Which self documents how to use this template: Download PDF or HTML version of the b3 book. Which self documents how to use this template:
- [b3.pdf ](build/b3.pdf) - [b3.pdf ](build/basic-book-builder.pdf)
- [b3.html](build/b3.html) - [b3.html](build/basic-book-builder.html)

BIN
build/b3.epub
View File

Binary file not shown.

BIN
build/basic-book-builder.epub Normal file
View File

Binary file not shown.

39
build/b3.html → build/basic-book-builder.html
View File

@ -4,7 +4,7 @@
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="generator" content="pandoc" /> <meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>00_Introduction</title> <title>Basic Book Builder</title>
<style> <style>
code{white-space: pre-wrap;} code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;} span.smallcaps{font-variant: small-caps;}
@ -106,29 +106,33 @@
<h2 style="text-align:center; font-weight:normal;">A Pandoc Template for building books and articles</h2> <h2 style="text-align:center; font-weight:normal;">A Pandoc Template for building books and articles</h2>
<div style="text-align:center; margin:2em 0;"> <div style="text-align:center; margin:2em 0;">
<img src="lib/img/ACEPLogo.png" alt="Cover illustration" style="max-width:240px;"> <img src="lib/img/UAF-ACEP.png" alt="Cover illustration" style="max-width:350px;">
</div> </div>
<h3 style="text-align:center;">John Haverlack</h3>
<hr style="margin:3em 0;"> <hr style="margin:3em 0;">
<!-- Metadata Page (PDF analog) --> <!-- Metadata Page (PDF analog) -->
<div style="text-align:center; margin-top:5em;"> <div style="text-align:left; margin-top:5em;">
<p><strong>Title</strong>: Basic Book Builder</p> <!-- Metadata Page (PDF analog) -->
<p><strong>Subtitle</strong>: A Pandoc Template for building books and articles</p> <table style="margin-top:5em; width:100%; border-collapse:collapse;">
<p><strong>Affiliation</strong>: Alaska Center for Energy and Power</p> <tbody>
<p><strong>Institution</strong>: University of Alaska Fairbanks</p> <tr><td style="width:30%; font-weight:bold;">Title</td><td>Basic Book Builder</td></tr>
<p><strong>Author</strong>: John Haverlack</p> <tr><td style="font-weight:bold;">Subtitle</td><td>A Pandoc Template for building books and articles</td></tr>
<p><strong>Copyright</strong>: © 2025 Alaska Center for Energy and Power</p> <tr><td style="font-weight:bold;">Affiliation</td><td>Alaska Center for Energy and Power</td></tr>
<p><strong>License</strong>: CC BY-ND 4.0</p> <tr><td style="font-weight:bold;">Institution</td><td>University of Alaska Fairbanks</td></tr>
<p><strong>Version</strong>: 0.0.2</p> <tr><td style="font-weight:bold;">Author</td><td>John Haverlack</td></tr>
<p><strong>Date</strong>: 2025-11-11</p> <tr><td style="font-weight:bold;">Copyright</td><td>© 2025 Alaska Center for Energy and Power</td></tr>
<p><strong>State</strong>: PRE-RELEASE</p> <tr><td style="font-weight:bold;">License</td><td>CC BY-ND 4.0</td></tr>
<p><strong>Source</strong>: https://github.com/jehaverlack/basic-book-builder</p> <tr><td style="font-weight:bold;">Version</td><td>0.0.2</td></tr>
<tr><td style="font-weight:bold;">Date</td><td>2025-11-11</td></tr>
<tr><td style="font-weight:bold;">State</td><td>PRE-RELEASE</td></tr>
<tr><td style="font-weight:bold;">Source</td><td>https://github.com/jehaverlack/basic-book-builder</td></tr>
</tbody>
</table>
</div> </div>
<hr style="margin:4em 0;"> <hr style="margin:4em 0;">
</div> </div>
@ -141,6 +145,9 @@ window.MathJax = {
}; };
</script> </script>
<script src="lib/mathjax/tex-mml-chtml.js"></script> <script src="lib/mathjax/tex-mml-chtml.js"></script>
<header id="title-block-header">
<h1 class="title">Basic Book Builder</h1>
</header>
<nav id="TOC" role="doc-toc"> <nav id="TOC" role="doc-toc">
<h2 id="toc-title">Contents</h2> <h2 id="toc-title">Contents</h2>
<ul> <ul>

839
build/basic-book-builder.md Normal file
View File

@ -0,0 +1,839 @@
---
bibliography:
- lib/zotero.bib
link-citations: true
mainfont: Linux Libertine O
monofont: DejaVu Sans Mono
sansfont: Linux Biolinum O
title: Clear Skies - A Reference Architecture for Resilient Alaskan
Microgrid Cyberinfrastructure
title-block: false
---
<div class="frontmatter">
<!-- Title Page -->
<h1 style="margin-top:3em; font-size:2.4em; text-align:center;">Basic Book Builder</h1>
<h2 style="text-align:center; font-weight:normal;">A Pandoc Template for building books and articles</h2>
<div style="text-align:center; margin:2em 0;">
<img src="lib/img/UAF-ACEP.png" alt="Cover illustration" style="max-height:100px;">
</div>
<hr style="margin:3em 0;">
<!-- Metadata Page (PDF analog) -->
<div style="text-align:left; margin-top:5em;">
<!-- Metadata Page (PDF analog) -->
<table style="margin-top:5em; width:100%; border-collapse:collapse;">
<tbody>
<tr><td style="width:30%; font-weight:bold;">Title</td><td>Basic Book Builder</td></tr>
<tr><td style="font-weight:bold;">Subtitle</td><td>A Pandoc Template for building books and articles</td></tr>
<tr><td style="font-weight:bold;">Affiliation</td><td>Alaska Center for Energy and Power</td></tr>
<tr><td style="font-weight:bold;">Institution</td><td>University of Alaska Fairbanks</td></tr>
<tr><td style="font-weight:bold;">Author</td><td>John Haverlack</td></tr>
<tr><td style="font-weight:bold;">Copyright</td><td>© 2025 Alaska Center for Energy and Power</td></tr>
<tr><td style="font-weight:bold;">License</td><td>CC BY-ND 4.0</td></tr>
<tr><td style="font-weight:bold;">Version</td><td>0.0.2</td></tr>
<tr><td style="font-weight:bold;">Date</td><td>2025-11-11</td></tr>
<tr><td style="font-weight:bold;">State</td><td>PRE-RELEASE</td></tr>
<tr><td style="font-weight:bold;">Source</td><td>https://github.com/jehaverlack/basic-book-builder</td></tr>
</tbody>
</table>
</div>
<hr style="margin:4em 0;">
</div>
- [Introduction](#introduction)
- [Conventions](#conventions)
- [Getting Started](#getting-started)
- [Installing Pre-Requisites](#installing-pre-requisites)
- [Required](#required)
- [Optional](#optional)
- [Editing the Configuration](#editing-the-configuration)
- [Editing the Book](#editing-the-book)
- [Configuration](#configuration)
- [FrontMatter Config](#frontmatter-config)
- [Editing the Content](#editing-the-content)
- [Citations](#citations)
- [Usage: Building the Book](#usage-building-the-book)
- [Example Content](#example-content)
- [SI Conversion Factors](#si-conversion-factors)
- [Physical Constants](#physical-constants)
- [Fine Structure Constant](#fine-structure-constant)
- [Newton’s Law of Gravity](#newtons-law-of-gravity)
- [Relativistic Energy Momentum
Relation](#relativistic-energy-momentum-relation)
- [Planck’s Constant](#plancks-constant)
- [Planck Length](#planck-length)
- [Fine Structure Constant](#fine-structure-constant-1)
- [Sage Code](#sage-code)
- [Terminology](#terminology)
- [Citations](#citations-1)
# Introduction
This is a basic book (or article) builder template based on a Pandoc
build process in conjunction with a number of other tools to generate
PDF, ODT, HTML, LaTex, Markdown, and Epub book output formats from
Markdown source content , which can optionally be edited as an Obsidian
vault.
This book builder template has been curated by John Haverlack.([“John
Haverlack ACEP” n.d.](#ref-JohnHaverlackACEP))
## Conventions
A few callout box styles have been added to easily highlight content.
<div class="callout-established">
**Established Concept**
Einsteins Relativistic Dynamics Equations
*E*<sup>2</sup> = (*m*<sub>0</sub>⋅*c*<sup>2</sup>)<sup>2</sup> + (*p*⋅*c*)<sup>2</sup>
</div>
<div class="callout-proposed">
**Proposed Concept**
With the speed of light, *c* = 1:
*E*<sup>2</sup> = *m*<sub>0</sub><sup>2</sup> + *p*<sup>2</sup>
</div>
<div class="callout-speculative">
**Speculative Concept**
With the speed of light, *c* = 1:
*E*<sup>2</sup> = *m*<sub>0</sub><sup>2</sup> + *p*<sup>2</sup>
</div>
<div class="callout-caution">
**Caution Note**
Beware of this section.
</div>
<div class="callout-warning">
**Warning Note**
Beware of this section.
</div>
<div class="callout-danger">
**Alerts**
Extreme Highlight
</div>
# Getting Started
## Installing Pre-Requisites
For Debian / ZorinOS and likely Ubuntu based systems.
<div class="callout-caution">
**TODO**
It would be nice to roll a setup script to take care of this.
</div>
### Required
#### Pandoc
- https://pandoc.org/
- [Download](https://github.com/jgm/pandoc/releases/tag/3.8.2.1)
<!-- -->
sudo apt install https://github.com/jgm/pandoc/releases/download/3.8.2.1/pandoc-3.8.2.1-1-amd64.deb
#### Code Editor
<div class="callout-established">
**Code Editor**
[VSCodium](https://vscodium.com/) is recommend for privacy
(telemetry/tracking) reasons - https://vscodium.com/
</div>
But any text editor will work. \#### make
sudo apt install make
#### jq and yq
sudo apt install jq yq
#### texlive
sudo apt install texlive texlive-xetex texlive-latex-extra texlive-fonts-recommended texlive-fonts-extra
#### MathJax
- https://www.mathjax.org/
<!-- -->
wget https://registry.npmjs.org/mathjax/-/mathjax-3.2.2.tgz
tar xzf mathjax-3.2.2.tgz
mv package/es5/* lib/mathjax
rm -rf package mathjax-3.2.2.tgz
<div class="callout-caution">
**TODO**
This need to be rolled into a setup script.
</div>
### Optional
The following are not strictly requires to use this book builder
template.
#### Obsidian
<div class="callout-established">
**Highly Recommended**
Editing book chapter content in Obsidian is a very productive means for
editing Markdown source content.
</div>
- https://obsidian.md/
- [Deb
Package](https://github.com/obsidianmd/obsidian-releases/releases/download/v1.9.14/obsidian_1.9.14_amd64.deb)
<!-- -->
sudo apt install https://github.com/obsidianmd/obsidian-releases/releases/download/v1.9.14/obsidian_1.9.14_amd64.deb
#### Zotero
<div class="callout-established">
**Highly Recommended**
If you need to managed citations and references, Zotero integration is
highly recommended.
</div>
- https://www.zotero.org/
<!-- -->
sudo cp ./scripts/deps/zotero.list /etc/apt/sources.list.d/
sudo apt update
sudo apt install zotero
##### Better BibTex for Zotero
Install the Better BibTex Plugin for Zotero - Zotero \> Tool \> Plugins
##### Export citations.bib
- Zotero \> File \> Export Library \> Format: Better BibTeX
- [ ] Keep Updated
- [ ] Save to: \~/Documents/Lib/zotero.bib
- [ ] Symlink your \~/Documents/Lib/Citations.bib to
basic-book-builder/lib/zotero.bib
##### Zotero Connector Browser Plugin
- https://chromewebstore.google.com/detail/zotero-connector/ekhagklcjbdpajgpjgmbionohlpdbjgc
Provides you the ability to auto add Web resources to your Zotero
citation database.
#### lmodern
sudo apt install lmodern
#### epubcheck
sudo apt install epubcheck
#### foliate
An EPub Reader
- https://johnfactotum.github.io/foliate/
<!-- -->
sudo apt install https://github.com/johnfactotum/foliate/releases/download/2.6.4/com.github.johnfactotum.foliate_2.6.4_all.deb
#### calibre
An EPub Reader
- https://calibre-ebook.com
<!-- -->
sudo apt install calibre
## Editing the Configuration
# Editing the Book
### Configuration
There are a number of other config files for each format:
conf/
├── epub-metadata.xml
├── epub_template.html
├── epub.yaml
├── frontmatter_epub.md
├── frontmatter_epub.xhtml
├── frontmatter.html
├── frontmatter.tex
├── header.tex
├── html.yaml
├── latex.yaml
├── markdown.yaml
├── metadata.yaml
├── pandoc.yaml
├── pdf.yaml
├── style.css
└── style_epub.css
#### Main Config Files
- metadata.yaml - Set Title, etc
- pandoc.yaml - Main Pandoc Config \#### Per format Configs
- `pdf.yaml`
- `html.yaml`
- `latex.yaml`
- `epub.yaml`
### FrontMatter Config
There are 2 Version of the FrontMatter for PDF, and HTML bases formats
that set the Title, Author, Verizon, Copyright, etc…
- `frontmatter.tex`
- `frontmatter.html`
- `frontmatter_epub.*` - Work in Progress
> There is probably a better way to do this.
## Editing the Content
To edit the book open the `basic-book-builder` directory as an Obsidian
Vault.
- Edit the Markdown content in the `chapters` directory.
### Citations
> Note: the Zotero database needs configured to export automatically to
> `lib/citations.bib`
To insert a Zotero Citation - Ensure the Zotero App and DB are running
on you system. - Alt + I (to insert citation) - Search for and select
citation reference
## Usage: Building the Book
#### PDF
make pdf
#### HTML
make html
#### LaTex
make latex
#### Markdown
make markdown
#### EPub
> Note: This ePub configuration still needs tuning.
make epub
# Example Content
In *R**ν* the [Planck
Length](https://en.wikipedia.org/wiki/Planck_units#Planck_length) is the
universal unit for measurement of distance, and is defined approximately
to be:
$$\\boxed{L_P=\\sqrt{\\hbar}=5.72928\\times10^{-35}m=1 L}$$
Where 1 *L*, is 1 Planck Length of distance.
### SI Conversion Factors
The following conversion factors can be used to convert observable
quantities of measure from the *SI* system of units to *R**ν* to \~6
significant digits.
| Conversion Factor | Symbol | Value |
|------------------------------|-------------------|--------------------------------------------------------|
| meters to Planck Length | *χ*<sub>*P*</sub> | $1.74542\\times10^{34} \\frac{L}{m}$ |
| seconds to Planck Length | *τ*<sub>*p*</sub> | $5.23264\\times10^{42} \\frac{L}{s}$ |
| mass to Planck Length | *G*<sub>*P*</sub> | $1.62871\\times10^8 \\frac{L}{kg}$ |
| energy to Planck Length | *E*<sub>*P*</sub> | $1.81219\\times10^9 \\frac{L}{J}$ |
| momentum to Planck Length | *P*<sub>*P*</sub> | $5.43280\\times10^{-1} \\frac{L\\cdot s}{kg \\cdot m}$ |
| temperature to Planck Length | *k*<sub>*P*</sub> | $2.501998\\times10^{-14} \\frac{L}{K}$ |
| charge to Planck Length | *C*<sub>*P*</sub> | $1.89007\\times10^{18} \\frac{L}{C}$ |
### Physical Constants
Applying conversion factors from the table above, we can convert SI
values to Reduced Natural Units. For example, performing this analysis
on the the speed of light yields a unit-less number with a value of 1:
$c = 299792458 \\frac{m}{s} = 299792458 \\frac{m}{s} \\cdot 1.74542\\times10^{34} \\frac{L}{m} \\cdot \\frac{1}{5.23264\\times10^{42} \\frac{L}{s}} = 1.00000$
| Quantity | Symbol | SI | *ν* |
|--------------------------------|-------------------|-----------------------------------------------------------------|-----------------------------------------|
| Speed of Light | *c* | $299792458 \\frac{m}{s}$ | 1 |
| Reduced Gravitational Constant | *G*<sub>0</sub> | $8.38659\\times10^{-10} \\frac{m^3}{kg \\cdot s^2}$ | 1 |
| Boltzmann’s Constant | *k* | $k=1.380649\\times10^-23 \\frac{J}{K}$ | 1 |
| Permittivity of Free Space | *ϵ*<sub>*o*</sub> | $8.854187817620\\times10^{-12} \\frac{C^{2}s^2}{kg \\cdot m^3}$ | 1 |
| Permeability of Free Space | *μ*<sub>*o*</sub> | $\\huge{\\frac{1}{\\epsilon\_{o} \\cdot c^{2}}}$ | 1 |
| Reduced Planck’s Constant | ℏ | $1.054571726\\times10^-34 \\frac{kg \\cdot m^2}{s}$ | 1*L*<sup>2</sup> |
| Mass of the Electron | *m*<sub>*e*</sub> | 9.10938 × 10<sup>−31</sup>*k**g* | 1.48366 × 10<sup>−22</sup>*L* |
| Charge of the Electron | *e*<sup>−</sup> |  − 1.60218 × 10<sup>−19</sup>*C* |  − 3.02822 × 10<sup>−1</sup>*L* |
| Unit Cycle | *Θ* | 2*π* = 6.28318... *R**a**d**i**a**n**s* | 1*τ* = 6.28318... *R**a**d**i**a**n**s* |
## Fine Structure Constant
As a consistency check, we compute the *[Fine Structure
Constant](https://en.wikipedia.org/wiki/Fine-structure_constant)* using
Reduced Natural Units which is a unit less ratio that should be
independent of our system of units.
$\\huge{\\alpha=\\frac{e^2}{4\\pi\\epsilon_o\\hbar c}=\\frac{e^2}{2\\tau}=0.00729735≈\\frac{1}{137}}$
#### Dimensional Analysis
The reader should be familiar with high school physics and chemistry
[dimensional
analysis](https://en.wikipedia.org/wiki/Dimensional_analysis).
- 1 *m**e**t**e**r* (*m*) = 100 *c**e**n**t**i**m**e**t**e**r**s* (*c**m*)
- 1 *k**i**l**o**m**e**t**e**r* (*k**m*) = 1000 *m**e**t**e**r**s* (*m*)
- 1 *m**i**l**e* = 5280 *f**e**e**t* (*f**t* *o**r* ′)
- $1\\ foot\\ (ft\\ or\\ ') = 12\\ inches\\ (in\\ or\\ ")$
- $1\\ inch\\ (") = 2.54\\ centimeters\\ (cm)$
How many kilometers are in 1 mile?
$1\\ mile = 1\\ mile \\times \\frac{5280\\ ft}{mile} \\times \\frac{12\\ in}{ft} \\times \\frac{2.54\\ cm}{in}\\times \\frac{1\\ m}{100 cm} \\times \\frac{1\\ km}{1000 m} = \\frac{5280 \\times 12 \\times 2.54}{100 \\times 1000}\\ km = \\frac{160934.40}{100000}\\ km = 1.6\\ km$
Note that each unit in the denominator cancels with one if the numerator
until we are left with only km.
## Newton’s Law of Gravity
The force of gravity (*F*<sub>*g*</sub>) between 2 masses, *m*1 and *m*2
separated by distance *r* is given by [Newton’s Law of
Gravity](https://en.wikipedia.org/wiki/Newton%27s_law_of_universal_gravitation):
$F\_{g} = G \\frac{m\_{1} m\_{2}}{r^{2}}$
Where *G*, is the [Gravitational
Constant](http://en.wikipedia.org/wiki/Gravitational_Constant).
$G = 6.67430 \\times 10^{-11}\\ N\\frac{m^2}{kg^2}$
The strength of gravitational force follow the inverse square law
distributing gravitational flux over the surface area of a sphere
(4*π**r*<sup>2</sup>).
#### Inverse Square Law
Any source of a signal strength (*S*<sub>0</sub>) that radiates
isotropically in 3-dimensional space will distribute that signal
strength (*S*<sub>0</sub>) over the surface area of a sphere
(*S**A* = 4*π**r*) of radius (*r*). Such that the intensity (*I*) at
distance (*r*) is:
$$I(r) = \\frac{S_0}{4 \\pi r^{2}}=\\frac{S_0}{2 \\tau r^{2}}$$
![inverse square law](lib/img/Inverse_square_law.svg.png) \#### *R**ν*
Reduced Gravitational Constant In this version of Newton’s Law of
Gravity we introduce a new constant *G*<sub>0</sub>, the reduced
gravitational constant to accommodate for the factor of 4*π* = 2*τ*
which is has been integrated in the SI version of the gravitational
constant.
$F_g =G \\frac{m\_{1} m\_{2}}{r^{2}}= G_0 \\frac{m\_{1} m\_{2}}{4 \\pi r^{2}}=G_0 \\frac{m\_{1} m\_{2}}{2 \\tau r^{2}}$
Where:
$G = \\frac{G\_{0}}{2\\tau} = 6.67384 \\times 10^{-11} \\frac{N \\cdot m^2}{kg^2}$
Analyzing the units:
$$\\frac{N \\cdot m^2}{kg^2} = \\left( \\frac{\\left( kg \\cdot \\frac{m}{s^2} \\right) \\cdot m^2}{kg^2} \\right)=\\frac{m^3}{s^2 kg}$$
Converting seconds to meters with the SI speed of light as a conversion
factor:
$$\\frac{m^3}{s^2 kg}\\cdot\\frac{1}{c^2}=\\frac{m^3}{s^2 kg}\\cdot\\frac{s^2}{m^2}=\\frac{m}{kg}$$
Thus where space and time are measured in units of meters, the reduced
gravitational constant, is:
$$\\boxed{G_0=\\frac{2\\tau G}{c^2}=\\frac{2\\tau \\cdot 6.67384 \\times 10^{-11}}{299792458^2} \\frac{m}{kg} = 9.33135 \\times 10^-27 \\frac{m}{kg}}$$
> Observation This implies that not only can space an time be measure in
> units of meters, but so can mass.
### Relativistic Energy Momentum Relation
Einsteins [Relativistic Energy
Momentum](https://en.wikipedia.org/wiki/Energy%E2%80%93momentum_relation)
relationship shows a Pythagorean relation between the total energy
(*E*), rest mass (*m*<sub>0</sub>) and momentum (*p*) of a system.
*E*<sup>2</sup> = (*m*<sub>0</sub>⋅*c*<sup>2</sup>)<sup>2</sup> + (*p*⋅*c*)<sup>2</sup>
Where space and time are both measure in units of meters, c=1.
*E*<sup>2</sup> = (*m*<sub>0</sub>)<sup>2</sup> + (*p*)<sup>2</sup>
From this we can see that Energy, Momentum and Mass have equivalent
units.
> *While we do not really know what energy, mass and momentum are we
> know that they are fundamentally “made” out of the same stuff because
> they have the same units.*
##### Objects of mass at rest
For an object at rest with no momentum (*p* = 0) we see Einstein’s
famous equations:
*E* = *m*<sub>0</sub> ⋅ *c*<sup>2</sup>
Or, with *c* = 1, this is much simpler to understand. Energy = Mass
*E* = *m*<sub>0</sub>
##### Zero mass objects moving at the speed of light
And for objects with no mass, like photos, (*m*<sub>0</sub> = 0):
*E* = *p**c*
Or, with *c* = 1, this is much simpler to understand. Energy = Momentum
*E* = *p*
## Planck’s Constant
The [Reduced Planck
constant](https://en.wikipedia.org/wiki/Planck_constant) , ħ, represents
a conversion factor for relating the frequency, *ω* (in 2*π* radians per
second), of a photon to the energy of that photon. This can easily be
seen from the simple but profound relationship:
*E* = ℏ*ω*
Where:
ℏ = 1.054571726 × 10<sup>−34</sup>*J* ⋅ *s*
and
$J \\cdot s = {kg}\\cdot\\frac{m^2}{s}$
> Reduced Planck’s Constant
> $\\hbar = \\frac{h}{2\\pi} = \\frac{h}{\\tau}$
Simplifying our units by converting time and mass to units of meters:
$$\\boxed{\\hbar=1.054571726 \\times 10^{−34} {kg}\\cdot\\frac{m^2}{s}\\cdot\\frac{G_0}{c}=3.282462\\times10^{-69}m^2}$$
Which suggest that the Plank constant can be interpreted as an areas for
which the square root of is suspiciously close to the Plank length:
$$\\boxed{\\sqrt{\\hbar}=\\sqrt{3.282462\\times10^{-69}m^2}=5.72928\\times10^{-35}m}$$
#### Planck Area
The [Planck
Area](https://en.wikipedia.org/wiki/Planck_units#Derived_units) is the
square of the [Planck
Length](https://en.wikipedia.org/wiki/Planck_units#Planck_length).
$l\_{P}= \\sqrt{\\frac{\\hbar G}{c^3}}$
and $l\_{P}^{2}= \\frac{\\hbar G}{c^3}$
In *R**ν* units both *c* and *G*<sub>*o*</sub> are 1.
$l\_{P} = \\sqrt{\\hbar}$
and *l*<sub>*P*</sub><sup>2</sup> = ℏ \## Bekenstein’s Bound After
having recently read *Three Roads to Quantum Gravity* by Lee Smolin, I
now suspect the meaning of this areas is related to the [Bekensteins
Law](https://en.wikipedia.org/wiki/Bekenstein_bound) as applied to a
surface areas surrounding a mass. Where the [thermodynamic
entropy](https://en.wikipedia.org/wiki/Entropy_(statistical_thermodynamics)),
*S*, is proportional to the the enclosed surface area, *A*.
$S=\\frac{1}{4}\\cdot\\frac{A}{G\\hbar}$
$S=\\frac{k c^{3} A}{4 G \\hbar}$
$S \\le \\frac{2\\pi k R E}{\\hbar c} = \\frac{\\tau R k E}{\\hbar c}$
From our new values for *G*<sub>0</sub>and ℏ we can likely rewrite this:
$S=\\frac{\\pi\\cdot A}{\\hbar G_0}$
With the limiting case being at the Plank scale.
$S=\\frac{\\pi\\cdot \\sqrt{\\hbar}}{\\hbar G_0}$
## Planck Length
https://en.wikipedia.org/wiki/Planck_length
The concept of the Planck Length comes from exploring the limits of
Quantum Mechanics and General Relativity. The limits of General
Relativity can be seen a the event horizon of a black hole, described by
the Schwarzschild Radius. And the limits of Quantum Mechanics can be
found in the Compton Wavelength for a given quanta.
The [Schwarzschild
Radius](https://simple.wikipedia.org/wiki/Schwarzschild_radius) is
defined as the distance at which light cannot escape from the
gravitational field of a mass (m):
Classic Derivation.
$r_S=\\frac{2G m}{c^2}$
The reduced [Compton
Wavelength](https://en.wikipedia.org/wiki/Compton_wavelength) represents
a lower limit on the wavelength for quanta that can interact with a
quantum particle with mass (m):
$\\lambda_C=\\frac{h}{m c}$
$\\bar{\\lambda_C}=\\frac{2\\pi\\hbar}{m c}=\\frac{\\tau\\hbar}{m c}$
And set the Schwarzschild Radius equal to the Compton Wavelength:
*r*<sub>*S*</sub> = *λ*<sub>*C*</sub>
$\\frac{2Gm}{c^{2}}=\\frac{h}{m c}$
$m^{2}= \\frac{hc}{2G}$
$m = \\sqrt{\\frac{hc}{2G}}$
$l_P=\\frac{2G\\sqrt{\\frac{hc}{2G}}}{c^2}$
$l_P=\\frac{2G\\sqrt{\\frac{hc}{2G}}}{c^{2}}= \\sqrt{\\frac{2Gh}{c^2}}$
With reduced Compton Wavelength $r_S=\\bar{\\lambda_C}$
$\\frac{2Gm}{c^{2}}=\\frac{\\tau\\hbar}{m c}$
$m^2=\\frac{\\tau\\ \\hbar\\ c}{2G}$
$m = \\sqrt{\\frac{\\tau\\ \\hbar\\ c}{2G}}$
$l_P=\\frac{2G\\sqrt{\\frac{\\tau\\ \\hbar\\ c}{2G}}}{c^2}$
$l_P=\\frac{2G\\sqrt{\\frac{\\tau\\ \\hbar\\ c}{2G}}}{c^{2}}=\\sqrt{\\frac{4\\ \\tau\\ G\\ \\hbar}{c^3}}$
If we reduce the units in these equation to those of mass and time
measured in meters.
$l_P=\\sqrt{4\\tau\\hbar G\_{o}}$
and
$\\lambda_C=\\frac{\\hbar}{m}$
$m=R_s=\\lambda_C=\\frac{\\hbar}{m}$
This is known as the Planck Mass, *M*<sub>*P*</sub>.
$M_P=m=\\sqrt{\\hbar}$
Solving the Compton Wavelength for distance we find the classic Plank
Length:
$\\lambda_C=\\frac{\\hbar}{\\sqrt{\\hbar}}=\\frac{\\sqrt{\\hbar}}{\\sqrt{\\hbar}}\\cdot\\frac{\\hbar}{\\sqrt{\\hbar}}=\\sqrt{\\hbar}=L_P$
Which is in precise agreement with the value we found in above. Thus the
Plank Length is:
$L_P=\\sqrt{\\hbar}=5.72928\\times10^{-35}m$
When we measure distance, time, and mass in units of distance, c=1, and
the Plank Time, *T*<sub>*P*</sub>, is equal to Plank Length,
*L*<sub>*P*</sub>, which is equal to the Plank Mass, *M*<sub>*P*</sub>:
$$\\boxed{L_P=T_P=M_P}$$
| Conversion Factor | Symbol | Value |
|------------------------------|-------------------|--------------------------------------------------------|
| meters to Planck Length | *χ*<sub>*P*</sub> | $1.74542\\times10^{34} \\frac{L}{m}$ |
| seconds to Planck Length | *τ*<sub>*p*</sub> | $5.23264\\times10^{42} \\frac{L}{s}$ |
| mass to Planck Length | *G*<sub>*P*</sub> | $1.62871\\times10^8 \\frac{L}{kg}$ |
| energy to Planck Length | *E*<sub>*P*</sub> | $1.81219\\times10^9 \\frac{L}{J}$ |
| momentum to Planck Length | *P*<sub>*P*</sub> | $5.43280\\times10^{-1} \\frac{L\\cdot s}{kg \\cdot m}$ |
| temperature to Planck Length | *k*<sub>*P*</sub> | $2.501998\\times10^{-14} \\frac{L}{K}$ |
| charge to Planck Length | *C*<sub>*P*</sub> | $1.89007\\times10^{18} \\frac{L}{C}$ |
Applying conversion factors from the table above, we can convert SI
values to Reduced Natural Units.
$c=\\frac{1}{\\sqrt{\\epsilon_o \\mu_o}}$
| Quantity | Symbol | SI | *ν* |
|----------------------------|-------------------|-----------------------------------------------------------------|---------------------------------|
| Speed of Light | *c* | $299792458 \\frac{m}{s}$ | 1 |
| Gravitational Constant | *G*<sub>0</sub> | $8.38659\\times10^{-10} \\frac{m^3}{kg \\cdot s^2}$ | 1 |
| Boltzmann’s Constant | *k* | $k=1.380649\\times10^-23 \\frac{J}{K}$ | 1 |
| Permittivity of Free Space | *ϵ*<sub>*o*</sub> | $8.854187817620\\times10^{-12} \\frac{C^{2}s^2}{kg \\cdot m^3}$ | 1 |
| Permeability of Free Space | *μ*<sub>*o*</sub> | $\\huge{\\frac{1}{\\epsilon\_{o} \\cdot c^{2}}}$ | 1 |
| Planck’s Constant | ℏ | $1.054571726\\times10^-34 \\frac{kg \\cdot m^2}{s}$ | 1*L*<sup>2</sup> |
| Mass of the Electron | *m*<sub>*e*</sub> | 9.10938 × 10<sup>−31</sup>*k**g* | 1.48366 × 10<sup>−22</sup>*L* |
| Charge of the Electron | *e*<sup>−</sup> |  − 1.60218 × 10<sup>−19</sup>*C* |  − 3.02822 × 10<sup>−1</sup>*L* |
## Fine Structure Constant
https://en.wikipedia.org/wiki/Fine-structure_constant As a consistency
check, we compute the *Fine Structure Constant* using Reduced Natural
Units which is a unit less ratio that should be independent of our
system of units.
$\\huge{\\alpha=\\frac{e^2}{4\\pi\\epsilon_o\\hbar c}=\\frac{e^2}{4\\pi}=0.00729735≈\\frac{1}{137}}$
This check confirms that our system of Reduced Natural Units has
internally consistent values for *c*, *ϵ*<sub>*o*</sub>, ℏ and *e*−. And
also *G*<sub>*o*</sub> which was used to computer prior values is also
consistent.
## Sage Code
Unit Analysis computations have been performed with [Sage
Math](https://www.sagemath.org/).
``` bash
# Define constance
one = 1.n(digits=6)
pi = pi.n(digits=6)
tau = 2 * pi
t = tau
# Define the units
meters = var('m')
m = one*meters
seconds = var('s')
s = seconds
kilograms = var('kg')
kg = kilograms
newtons = kg * m / s^2
N = newtons
joules = N * m
J = joules
print("pi =", pi)
print("tau =", t)
# Speed of light in meters/second
speed_of_light = 299792458 * meters/seconds
sol = speed_of_light
c = sol
print("si c =", c)
rnu_c = c / c
print("R\u03BD c =", rnu_c)
# Gravitational Constant
gravitational_constant = 6.67384e-11 * N*(m^2/kg^2)
G = gravitational_constant
print("si G =", G)
rnu_G = 4*pi*G/c^2
Go = rnu_G
print("R\u03BD Go =", Go)
# Planck's Constant
reduced_plancks_constant = 1.054571726e-34 * J*s
h_bar = reduced_plancks_constant
print("si \u210F =", h_bar)
rnu_h_bar = h_bar * Go / c
print("R\u03BD "u"\u210F =", rnu_h_bar)
# Planck Length
rnu_h_bar_str = str(rnu_h_bar)
numerical_part_str = rnu_h_bar_str.split('*')[0]
numerical_part_str = numerical_part_str.strip('()')
numerical_part = float(numerical_part_str)
rnu_sqrt_h_bar = numerical_part^(1/2)
# ^ Sage cannot process sqrt on units... Lame.
lP = rnu_sqrt_h_bar * m
print("R\u03BD \u221A\u210F =", lP)
```
#### Output
pi = 3.14159
tau = 6.28319
si c = 299792458*m/s
Rν c = 1
si G = (6.67384e-11)*m^3/(kg*s^2)
Rν Go = (9.33135e-27)*m/kg
si ℏ = (1.05457e-34)*kg*m^2/s
Rν ℏ = (3.28246e-69)*m^2
Rν √ℏ = (5.72928e-35)*m
si lP = (1.61620e-35)*sqrt(m^2)
Rν lP = (2.77455e-47)*sqrt(m^3/kg)
# Terminology
# Citations
<div id="refs" class="references csl-bib-body hanging-indent">
<div id="ref-JohnHaverlackACEP" class="csl-entry">
“John Haverlack ACEP.” n.d.
https://www.uaf.edu/acep/about/our-team/john-haverlack.php. Accessed
September 30, 2025.
</div>
</div>

BIN
build/b3.pdf → build/basic-book-builder.pdf
View File

Binary file not shown.

570
build/b3.tex → build/basic-book-builder.tex
View File

@ -5,7 +5,7 @@
% %
\documentclass[ \documentclass[
12pt, 12pt,
]{book} ]{article}
\usepackage{amsmath,amssymb} \usepackage{amsmath,amssymb}
\usepackage{lmodern} \usepackage{lmodern}
\usepackage{iftex} \usepackage{iftex}
@ -137,52 +137,116 @@
\newcommand{\CSLLeftMargin}[1]{\parbox[t]{\csllabelwidth}{#1}} \newcommand{\CSLLeftMargin}[1]{\parbox[t]{\csllabelwidth}{#1}}
\newcommand{\CSLRightInline}[1]{\parbox[t]{\linewidth - \csllabelwidth}{#1}\break} \newcommand{\CSLRightInline}[1]{\parbox[t]{\linewidth - \csllabelwidth}{#1}\break}
\newcommand{\CSLIndent}[1]{\hspace{\cslhangindent}#1} \newcommand{\CSLIndent}[1]{\hspace{\cslhangindent}#1}
\usepackage{etoolbox}
\usepackage[most]{tcolorbox} \usepackage[most]{tcolorbox}
\usepackage{graphicx} \usepackage{graphicx}
\usepackage{xparse}
\tcbuselibrary{breakable} \tcbuselibrary{breakable}
% --- Disable floating figures globally ---
\usepackage{float}
\let\origfigure\figure
\let\endorigfigure\endfigure
\renewenvironment{figure}[1][H]{\origfigure[H]}{\endorigfigure}
% --- Colors ---
\usepackage{xcolor}
\definecolor{speculativeback}{RGB}{247,232,255} % #f7e8ff
\definecolor{speculativeframe}{RGB}{139,43,226} % #8b2be2
% --- Left-align all Pandoc tables ---
\usepackage{longtable}
\usepackage{etoolbox}
\makeatletter
\patchcmd\longtable{\par}{\par\raggedright}{}{}
\setlength{\LTleft}{0pt}
\setlength{\LTright}{0pt}
\makeatother
% Helper to show a blank title if empty
\newcommand{\blanktitle}{\mbox{}}
% ========================================================= % =========================================================
% Concept Boxes % Concept Boxes
% ========================================================= % =========================================================
\newtcolorbox{proposedbox}{ \newtcolorbox{infobox}[1][Information]{%
title=Proposed Concept, title=\ifstrempty{#1}{\blanktitle}{#1},
colback=blue!3!white,
colframe=blue!50!black,
colbacktitle=blue!10!white,
fonttitle=\bfseries,
coltitle=black,
enhanced, sharp corners, breakable,
after=\par\vspace{6pt}
}
\newtcolorbox{proposedbox}[1][Proposed Concept]{%
title=\ifstrempty{#1}{\blanktitle}{#1},
colback=blue!5!white, colback=blue!5!white,
colframe=blue!75!black, colframe=blue!75!black,
colbacktitle=blue!15!white, colbacktitle=blue!15!white,
fonttitle=\bfseries, fonttitle=\bfseries,
coltitle=black, coltitle=black,
enhanced, enhanced, sharp corners, breakable,
sharp corners,
breakable,
after=\par\vspace{6pt} after=\par\vspace{6pt}
} }
\newtcolorbox{establishedbox}{ \newtcolorbox{establishedbox}[1][Established Concept]{%
title=Established Concept, title=\ifstrempty{#1}{\blanktitle}{#1},
colback=green!5!white, colback=green!5!white,
colframe=green!75!black, colframe=green!75!black,
colbacktitle=green!15!white, colbacktitle=green!15!white,
fonttitle=\bfseries, fonttitle=\bfseries,
coltitle=black, coltitle=black,
enhanced, enhanced, sharp corners, breakable,
sharp corners,
breakable,
after=\par\vspace{6pt} after=\par\vspace{6pt}
} }
\newtcolorbox{speculativebox}{ \newtcolorbox{speculativebox}[1][Speculative Concept]{%
title=Speculative Concept, title=\ifstrempty{#1}{\blanktitle}{#1},
colback=purple!5!white, colback=speculativeback,
colframe=purple!75!black, colframe=speculativeframe,
colbacktitle=purple!15!white, colbacktitle=speculativeback!80!white, % lighter variant for title bar
fonttitle=\bfseries, fonttitle=\bfseries,
coltitle=black, coltitle=black,
enhanced, enhanced, sharp corners, breakable,
sharp corners,
breakable,
after=\par\vspace{6pt} after=\par\vspace{6pt}
} }
\newtcolorbox{cautionbox}[1][Caution]{%
title=\ifstrempty{#1}{\blanktitle}{#1},
colback=orange!5!white,
colframe=orange!75!black,
colbacktitle=orange!15!white,
fonttitle=\bfseries,
coltitle=black,
enhanced, sharp corners, breakable,
after=\par\vspace{6pt}
}
\newtcolorbox{warningbox}[1][Warning]{%
title=\ifstrempty{#1}{\blanktitle}{#1},
colback=orange!5!white,
colframe=orange!75!black,
colbacktitle=orange!15!white,
fonttitle=\bfseries,
coltitle=black,
enhanced, sharp corners, breakable,
after=\par\vspace{6pt}
}
\newtcolorbox{dangerbox}[1][Danger]{%
title=\ifstrempty{#1}{\blanktitle}{#1},
colback=red!5!white,
colframe=red!75!black,
colbacktitle=red!15!white,
fonttitle=\bfseries,
coltitle=black,
enhanced, sharp corners, breakable,
after=\par\vspace{6pt}
}
\ifLuaTeX \ifLuaTeX
\usepackage{selnolig} % disable illegal ligatures \usepackage{selnolig} % disable illegal ligatures
\fi \fi
@ -191,7 +255,6 @@
\date{} \date{}
\begin{document} \begin{document}
\frontmatter
\renewcommand*\contentsname{Contents} \renewcommand*\contentsname{Contents}
{ {
@ -199,80 +262,398 @@
\setcounter{tocdepth}{3} \setcounter{tocdepth}{3}
\tableofcontents \tableofcontents
} }
\mainmatter
\hypertarget{introduction}{% \hypertarget{introduction}{%
\chapter{Introduction}\label{introduction}} \section{Introduction}\label{introduction}}
This book builder template was currated by John This is a basic book (or article) builder template based on a Pandoc
build process in conjunction with a number of other tools to generate
PDF, ODT, HTML, LaTex, Markdown, and Epub book output formats from
Markdown source content , which can optionally be edited as an Obsidian
vault.
This book builder template has been curated by John
Haverlack.(\protect\hyperlink{ref-JohnHaverlackACEP}{{``John {Haverlack} Haverlack.(\protect\hyperlink{ref-JohnHaverlackACEP}{{``John {Haverlack}
\textbar{} {ACEP}''} n.d.}) \textbar{} {ACEP}''} n.d.})
\begin{quote}
``\emph{If I have seen further it is by standing on the shoulders of
Giants.}''
-- Isaac Newton
\end{quote}
\hypertarget{conventions}{% \hypertarget{conventions}{%
\section{Conventions}\label{conventions}} \subsection{Conventions}\label{conventions}}
In this book we'll use a few conventions. A few callout box styles have been added to easily highlight content.
\hypertarget{new-concepts}{% \begin{establishedbox}[Established Concept]
\subsection{New Concepts}\label{new-concepts}} Einsteins Relativistic Dynamics Equations
As many of the topics discussed in this book are a mix of
\textbf{established} math and physics, \textbf{proposed} dualistic
interpretations of established ideas, and also \textbf{speculative}
ideas that I don't yet know how to address, I wanted a way to clearly
distinguish these concepts. I've come up with the following convention
to highlight these classes of concepts to indicate their level of
mainstream acceptance.
In this book, established concept may be highlighted in green, and
represent mainstream physics or math concepts.
\begin{establishedbox}
Established Concept Einsteins Relativistic Dynamics Equations
\[E^2 = (m_{0} \cdot c^2)^2 + (p \cdot c)^2 \] \[E^2 = (m_{0} \cdot c^2)^2 + (p \cdot c)^2 \]
\end{establishedbox} \end{establishedbox}
New ideas proposed by the author which have not been peer reviewed, \begin{proposedbox}[Proposed Concept]
verified or tested, and should be looked at with scrutiny. With the speed of light, \(c = 1\): \[E^2 = m_{0}^2 + p^2 \]
\begin{proposedbox}
Proposed Concept With the speed of light, \(c = 1\):
\[E^2 = m_{0}^2 + p^2 \]
\end{proposedbox} \end{proposedbox}
Speculative Idea, that the author wonders about, but does not know how \begin{speculativebox}[Speculative Concept]
to demonstrate, or ideas that need further treatment to prove or With the speed of light, \(c = 1\): \[E^2 = m_{0}^2 + p^2 \]
disprove.
\begin{speculativebox}
Speculative Concept With the speed of light, \(c = 1\):
\[E^2 = m_{0}^2 + p^2 \]
\end{speculativebox} \end{speculativebox}
\hypertarget{citation-example}{% \begin{cautionbox}[Caution Note]
\chapter{Citation Example}\label{citation-example}} Beware of this section.
\end{cautionbox}
\begin{warningbox}[Warning Note]
Beware of this section.
\end{warningbox}
\begin{dangerbox}[Alerts]
Extreme Highlight
\end{dangerbox}
\hypertarget{getting-started}{%
\section{Getting Started}\label{getting-started}}
\hypertarget{installing-pre-requisites}{%
\subsection{Installing Pre-Requisites}\label{installing-pre-requisites}}
For Debian / ZorinOS and likely Ubuntu based systems.
\begin{cautionbox}[TODO]
It would be nice to roll a setup script to take care of this.
\end{cautionbox}
\hypertarget{required}{%
\subsubsection{Required}\label{required}}
\hypertarget{pandoc}{%
\paragraph{Pandoc}\label{pandoc}}
\begin{itemize} \begin{itemize}
\tightlist \tightlist
\item \item
Numerical Linear https://pandoc.org/
Algebra(\protect\hyperlink{ref-trefethenNumericalLinearAlgebra2022a}{Trefethen \item
and Bau 2022}) \href{https://github.com/jgm/pandoc/releases/tag/3.8.2.1}{Download}
\end{itemize} \end{itemize}
\hypertarget{best-words-ever}{% \begin{verbatim}
\chapter{Best Words Ever}\label{best-words-ever}} sudo apt install https://github.com/jgm/pandoc/releases/download/3.8.2.1/pandoc-3.8.2.1-1-amd64.deb
\end{verbatim}
Blah blah blah \hypertarget{code-editor}{%
\paragraph{Code Editor}\label{code-editor}}
\begin{establishedbox}[Code Editor]
\href{https://vscodium.com/}{VSCodium} is recommend for privacy
(telemetry/tracking) reasons - https://vscodium.com/
\end{establishedbox}
But any text editor will work. \#\#\#\# make
\begin{verbatim}
sudo apt install make
\end{verbatim}
\hypertarget{jq-and-yq}{%
\paragraph{jq and yq}\label{jq-and-yq}}
\begin{verbatim}
sudo apt install jq yq
\end{verbatim}
\hypertarget{texlive}{%
\paragraph{texlive}\label{texlive}}
\begin{verbatim}
sudo apt install texlive texlive-xetex texlive-latex-extra texlive-fonts-recommended texlive-fonts-extra
\end{verbatim}
\hypertarget{mathjax}{%
\paragraph{MathJax}\label{mathjax}}
\begin{itemize}
\tightlist
\item
https://www.mathjax.org/
\end{itemize}
\begin{verbatim}
wget https://registry.npmjs.org/mathjax/-/mathjax-3.2.2.tgz
tar xzf mathjax-3.2.2.tgz
mv package/es5/* lib/mathjax
rm -rf package mathjax-3.2.2.tgz
\end{verbatim}
\begin{cautionbox}[TODO]
This need to be rolled into a setup script.
\end{cautionbox}
\hypertarget{optional}{%
\subsubsection{Optional}\label{optional}}
The following are not strictly requires to use this book builder
template.
\hypertarget{obsidian}{%
\paragraph{Obsidian}\label{obsidian}}
\begin{establishedbox}[Highly Recommended]
Editing book chapter content in Obsidian is a very productive means for
editing Markdown source content.
\end{establishedbox}
\begin{itemize}
\tightlist
\item
https://obsidian.md/
\item
\href{https://github.com/obsidianmd/obsidian-releases/releases/download/v1.9.14/obsidian_1.9.14_amd64.deb}{Deb
Package}
\end{itemize}
\begin{verbatim}
sudo apt install https://github.com/obsidianmd/obsidian-releases/releases/download/v1.9.14/obsidian_1.9.14_amd64.deb
\end{verbatim}
\hypertarget{zotero}{%
\paragraph{Zotero}\label{zotero}}
\begin{establishedbox}[Highly Recommended]
If you need to managed citations and references, Zotero integration is
highly recommended.
\end{establishedbox}
\begin{itemize}
\tightlist
\item
https://www.zotero.org/
\end{itemize}
\begin{verbatim}
sudo cp ./scripts/deps/zotero.list /etc/apt/sources.list.d/
\end{verbatim}
\begin{verbatim}
sudo apt update
\end{verbatim}
\begin{verbatim}
sudo apt install zotero
\end{verbatim}
\hypertarget{better-bibtex-for-zotero}{%
\subparagraph{Better BibTex for Zotero}\label{better-bibtex-for-zotero}}
Install the Better BibTex Plugin for Zotero - Zotero \textgreater{} Tool
\textgreater{} Plugins
\hypertarget{export-citations.bib}{%
\subparagraph{Export citations.bib}\label{export-citations.bib}}
\begin{itemize}
\tightlist
\item
Zotero \textgreater{} File \textgreater{} Export Library
\textgreater{} Format: Better BibTeX
\item[$\square$]
Keep Updated
\item[$\square$]
Save to: \textasciitilde/Documents/Lib/zotero.bib
\item[$\square$]
Symlink your \textasciitilde/Documents/Lib/Citations.bib to
basic-book-builder/lib/zotero.bib
\end{itemize}
\hypertarget{zotero-connector-browser-plugin}{%
\subparagraph{Zotero Connector Browser
Plugin}\label{zotero-connector-browser-plugin}}
\begin{itemize}
\tightlist
\item
https://chromewebstore.google.com/detail/zotero-connector/ekhagklcjbdpajgpjgmbionohlpdbjgc
\end{itemize}
Provides you the ability to auto add Web resources to your Zotero
citation database.
\hypertarget{lmodern}{%
\paragraph{lmodern}\label{lmodern}}
\begin{verbatim}
sudo apt install lmodern
\end{verbatim}
\hypertarget{epubcheck}{%
\paragraph{epubcheck}\label{epubcheck}}
\begin{verbatim}
sudo apt install epubcheck
\end{verbatim}
\hypertarget{foliate}{%
\paragraph{foliate}\label{foliate}}
An EPub Reader
\begin{itemize}
\tightlist
\item
https://johnfactotum.github.io/foliate/
\end{itemize}
\begin{verbatim}
sudo apt install https://github.com/johnfactotum/foliate/releases/download/2.6.4/com.github.johnfactotum.foliate_2.6.4_all.deb
\end{verbatim}
\hypertarget{calibre}{%
\paragraph{calibre}\label{calibre}}
An EPub Reader
\begin{itemize}
\tightlist
\item
https://calibre-ebook.com
\end{itemize}
\begin{verbatim}
sudo apt install calibre
\end{verbatim}
\hypertarget{editing-the-configuration}{%
\subsection{Editing the Configuration}\label{editing-the-configuration}}
\hypertarget{editing-the-book}{%
\section{Editing the Book}\label{editing-the-book}}
\hypertarget{configuration}{%
\subsubsection{Configuration}\label{configuration}}
There are a number of other config files for each format:
\begin{verbatim}
conf/
├── epub-metadata.xml
├── epub_template.html
├── epub.yaml
├── frontmatter_epub.md
├── frontmatter_epub.xhtml
├── frontmatter.html
├── frontmatter.tex
├── header.tex
├── html.yaml
├── latex.yaml
├── markdown.yaml
├── metadata.yaml
├── pandoc.yaml
├── pdf.yaml
├── style.css
└── style_epub.css
\end{verbatim}
\hypertarget{main-config-files}{%
\paragraph{Main Config Files}\label{main-config-files}}
\begin{itemize}
\tightlist
\item
metadata.yaml - Set Title, etc
\item
pandoc.yaml - Main Pandoc Config \#\#\#\# Per format Configs
\item
\texttt{pdf.yaml}
\item
\texttt{html.yaml}
\item
\texttt{latex.yaml}
\item
\texttt{epub.yaml}
\end{itemize}
\hypertarget{frontmatter-config}{%
\subsubsection{FrontMatter Config}\label{frontmatter-config}}
There are 2 Version of the FrontMatter for PDF, and HTML bases formats
that set the Title, Author, Verizon, Copyright, etc\ldots{}
\begin{itemize}
\tightlist
\item
\texttt{frontmatter.tex}
\item
\texttt{frontmatter.html}
\item
\texttt{frontmatter\_epub.*} - Work in Progress
\end{itemize}
\begin{quote}
There is probably a better way to do this.
\end{quote}
\hypertarget{editing-the-content}{%
\subsection{Editing the Content}\label{editing-the-content}}
To edit the book open the \texttt{basic-book-builder} directory as an
Obsidian Vault.
\begin{itemize}
\tightlist
\item
Edit the Markdown content in the \texttt{chapters} directory.
\end{itemize}
\hypertarget{citations}{%
\subsubsection{Citations}\label{citations}}
\begin{quote}
Note: the Zotero database needs configured to export automatically to
\texttt{lib/citations.bib}
\end{quote}
To insert a Zotero Citation - Ensure the Zotero App and DB are running
on you system. - Alt + I (to insert citation) - Search for and select
citation reference
\hypertarget{usage-building-the-book}{%
\subsection{Usage: Building the Book}\label{usage-building-the-book}}
\hypertarget{pdf}{%
\paragraph{PDF}\label{pdf}}
\begin{verbatim}
make pdf
\end{verbatim}
\hypertarget{html}{%
\paragraph{HTML}\label{html}}
\begin{verbatim}
make html
\end{verbatim}
\hypertarget{latex}{%
\paragraph{LaTex}\label{latex}}
\begin{verbatim}
make latex
\end{verbatim}
\hypertarget{markdown}{%
\paragraph{Markdown}\label{markdown}}
\begin{verbatim}
make markdown
\end{verbatim}
\hypertarget{epub}{%
\paragraph{EPub}\label{epub}}
\begin{quote}
Note: This ePub configuration still needs tuning.
\end{quote}
\begin{verbatim}
make epub
\end{verbatim}
\hypertarget{example-content}{% \hypertarget{example-content}{%
\chapter{Example Content}\label{example-content}} \section{Example Content}\label{example-content}}
In \(R\nu\) the In \(R\nu\) the
\href{https://en.wikipedia.org/wiki/Planck_units\#Planck_length}{Planck \href{https://en.wikipedia.org/wiki/Planck_units\#Planck_length}{Planck
@ -282,7 +663,7 @@ defined approximately to be:
is 1 Planck Length of distance. is 1 Planck Length of distance.
\hypertarget{si-conversion-factors}{% \hypertarget{si-conversion-factors}{%
\subsection{SI Conversion Factors}\label{si-conversion-factors}} \subsubsection{SI Conversion Factors}\label{si-conversion-factors}}
The following conversion factors can be used to convert observable The following conversion factors can be used to convert observable
quantities of measure from the \emph{SI} system of units to \(R\nu\) to quantities of measure from the \emph{SI} system of units to \(R\nu\) to
@ -318,7 +699,7 @@ charge to Planck Length & \(C_P\) &
\end{longtable} \end{longtable}
\hypertarget{physical-constants}{% \hypertarget{physical-constants}{%
\subsection{Physical Constants}\label{physical-constants}} \subsubsection{Physical Constants}\label{physical-constants}}
Applying conversion factors from the table above, we can convert SI Applying conversion factors from the table above, we can convert SI
values to Reduced Natural Units. For example, performing this analysis values to Reduced Natural Units. For example, performing this analysis
@ -364,7 +745,7 @@ Unit Cycle & \(\Theta\) & \(2\pi = 6.28318...\ Radians\) &
\end{longtable} \end{longtable}
\hypertarget{fine-structure-constant}{% \hypertarget{fine-structure-constant}{%
\section{Fine Structure Constant}\label{fine-structure-constant}} \subsection{Fine Structure Constant}\label{fine-structure-constant}}
As a consistency check, we compute the As a consistency check, we compute the
\emph{\href{https://en.wikipedia.org/wiki/Fine-structure_constant}{Fine \emph{\href{https://en.wikipedia.org/wiki/Fine-structure_constant}{Fine
@ -374,7 +755,7 @@ ratio that should be independent of our system of units.
\(\huge{\alpha=\frac{e^2}{4\pi\epsilon_o\hbar c}=\frac{e^2}{2\tau}=0.00729735≈\frac{1}{137}}\) \(\huge{\alpha=\frac{e^2}{4\pi\epsilon_o\hbar c}=\frac{e^2}{2\tau}=0.00729735≈\frac{1}{137}}\)
\hypertarget{dimensional-analysis}{% \hypertarget{dimensional-analysis}{%
\subsubsection{Dimensional Analysis}\label{dimensional-analysis}} \paragraph{Dimensional Analysis}\label{dimensional-analysis}}
The reader should be familiar with high school physics and chemistry The reader should be familiar with high school physics and chemistry
\href{https://en.wikipedia.org/wiki/Dimensional_analysis}{dimensional \href{https://en.wikipedia.org/wiki/Dimensional_analysis}{dimensional
@ -400,7 +781,7 @@ Note that each unit in the denominator cancels with one if the numerator
until we are left with only km. until we are left with only km.
\hypertarget{newtons-law-of-gravity}{% \hypertarget{newtons-law-of-gravity}{%
\section{Newton's Law of Gravity}\label{newtons-law-of-gravity}} \subsection{Newton's Law of Gravity}\label{newtons-law-of-gravity}}
The force of gravity (\(F_g\)) between 2 masses, \(m1\) and \(m2\) The force of gravity (\(F_g\)) between 2 masses, \(m1\) and \(m2\)
separated by distance \(r\) is given by separated by distance \(r\) is given by
@ -420,7 +801,7 @@ distributing gravitational flux over the surface area of a sphere
(\(4\pi r^2\)). (\(4\pi r^2\)).
\hypertarget{inverse-square-law}{% \hypertarget{inverse-square-law}{%
\subsubsection{Inverse Square Law}\label{inverse-square-law}} \paragraph{Inverse Square Law}\label{inverse-square-law}}
Any source of a signal strength (\(S_0\)) that radiates isotropically in Any source of a signal strength (\(S_0\)) that radiates isotropically in
3-dimensional space will distribute that signal strength (\(S_0\)) over 3-dimensional space will distribute that signal strength (\(S_0\)) over
@ -457,7 +838,7 @@ units of meters, but so can mass.
\end{quote} \end{quote}
\hypertarget{relativistic-energy-momentum-relation}{% \hypertarget{relativistic-energy-momentum-relation}{%
\subsection{Relativistic Energy Momentum \subsubsection{Relativistic Energy Momentum
Relation}\label{relativistic-energy-momentum-relation}} Relation}\label{relativistic-energy-momentum-relation}}
Einsteins Einsteins
@ -482,7 +863,7 @@ they have the same units.}
\end{quote} \end{quote}
\hypertarget{objects-of-mass-at-rest}{% \hypertarget{objects-of-mass-at-rest}{%
\paragraph{Objects of mass at rest}\label{objects-of-mass-at-rest}} \subparagraph{Objects of mass at rest}\label{objects-of-mass-at-rest}}
For an object at rest with no momentum (\(p = 0\)) we see Einstein's For an object at rest with no momentum (\(p = 0\)) we see Einstein's
famous equations: famous equations:
@ -491,7 +872,12 @@ famous equations:
Or, with \(c=1\), this is much simpler to understand. Energy = Mass Or, with \(c=1\), this is much simpler to understand. Energy = Mass
\(E = m_0\) \#\#\#\#\# Zero mass objects moving at the speed of light \(E = m_0\)
\hypertarget{zero-mass-objects-moving-at-the-speed-of-light}{%
\subparagraph{Zero mass objects moving at the speed of
light}\label{zero-mass-objects-moving-at-the-speed-of-light}}
And for objects with no mass, like photos, (\(m_{0}= 0\)): And for objects with no mass, like photos, (\(m_{0}= 0\)):
\(E=pc\) \(E=pc\)
@ -501,7 +887,7 @@ Or, with \(c=1\), this is much simpler to understand. Energy = Momentum
\(E=p\) \(E=p\)
\hypertarget{plancks-constant}{% \hypertarget{plancks-constant}{%
\section{Planck's Constant}\label{plancks-constant}} \subsection{Planck's Constant}\label{plancks-constant}}
The \href{https://en.wikipedia.org/wiki/Planck_constant}{Reduced Planck The \href{https://en.wikipedia.org/wiki/Planck_constant}{Reduced Planck
constant} , ħ, represents a conversion factor for relating the constant} , ħ, represents a conversion factor for relating the
@ -532,7 +918,7 @@ which the square root of is suspiciously close to the Plank length:
\[\boxed{\sqrt{\hbar}=\sqrt{3.282462\times10^{-69}m^2}=5.72928\times10^{-35}m}\] \[\boxed{\sqrt{\hbar}=\sqrt{3.282462\times10^{-69}m^2}=5.72928\times10^{-35}m}\]
\hypertarget{planck-area}{% \hypertarget{planck-area}{%
\subsubsection{Planck Area}\label{planck-area}} \paragraph{Planck Area}\label{planck-area}}
The The
\href{https://en.wikipedia.org/wiki/Planck_units\#Derived_units}{Planck \href{https://en.wikipedia.org/wiki/Planck_units\#Derived_units}{Planck
@ -572,7 +958,7 @@ With the limiting case being at the Plank scale.
\(S=\frac{\pi\cdot \sqrt{\hbar}}{\hbar G_0}\) \(S=\frac{\pi\cdot \sqrt{\hbar}}{\hbar G_0}\)
\hypertarget{planck-length}{% \hypertarget{planck-length}{%
\section{Planck Length}\label{planck-length}} \subsection{Planck Length}\label{planck-length}}
https://en.wikipedia.org/wiki/Planck\_length https://en.wikipedia.org/wiki/Planck\_length
@ -721,7 +1107,7 @@ Charge of the Electron & \(e^-\) & \(-1.60218\times10^{-19} C\) &
\end{longtable} \end{longtable}
\hypertarget{fine-structure-constant-1}{% \hypertarget{fine-structure-constant-1}{%
\section{Fine Structure Constant}\label{fine-structure-constant-1}} \subsection{Fine Structure Constant}\label{fine-structure-constant-1}}
https://en.wikipedia.org/wiki/Fine-structure\_constant As a consistency https://en.wikipedia.org/wiki/Fine-structure\_constant As a consistency
check, we compute the \emph{Fine Structure Constant} using Reduced check, we compute the \emph{Fine Structure Constant} using Reduced
@ -736,7 +1122,7 @@ internally consistent values for \(c\), \(\epsilon_o\), \(\hbar\) and
consistent. consistent.
\hypertarget{sage-code}{% \hypertarget{sage-code}{%
\section{Sage Code}\label{sage-code}} \subsection{Sage Code}\label{sage-code}}
Unit Analysis computations have been performed with Unit Analysis computations have been performed with
\href{https://www.sagemath.org/}{Sage Math}. \href{https://www.sagemath.org/}{Sage Math}.
@ -808,7 +1194,7 @@ Unit Analysis computations have been performed with
\end{Shaded} \end{Shaded}
\hypertarget{output}{% \hypertarget{output}{%
\subsubsection{Output}\label{output}} \paragraph{Output}\label{output}}
\begin{verbatim} \begin{verbatim}
pi = 3.14159 pi = 3.14159
@ -825,11 +1211,11 @@ Rν lP = (2.77455e-47)*sqrt(m^3/kg)
\end{verbatim} \end{verbatim}
\hypertarget{terminology}{% \hypertarget{terminology}{%
\chapter{Terminology}\label{terminology}} \section{Terminology}\label{terminology}}
\hypertarget{citations}{% \hypertarget{citations-1}{%
\chapter*{Citations}\label{citations}} \section*{Citations}\label{citations-1}}
\addcontentsline{toc}{chapter}{Citations} \addcontentsline{toc}{section}{Citations}
\hypertarget{refs}{} \hypertarget{refs}{}
\begin{CSLReferences}{1}{0} \begin{CSLReferences}{1}{0}
@ -838,12 +1224,6 @@ Rν lP = (2.77455e-47)*sqrt(m^3/kg)
https://www.uaf.edu/acep/about/our-team/john-haverlack.php. Accessed https://www.uaf.edu/acep/about/our-team/john-haverlack.php. Accessed
September 30, 2025. September 30, 2025.
\leavevmode\vadjust pre{\hypertarget{ref-trefethenNumericalLinearAlgebra2022a}{}}%
Trefethen, Lloyd N., and III David Bau. 2022. \emph{Numerical {Linear
Algebra}: {Twenty-Fifth Anniversary Edition}}. Philadelphia, PA:
{SIAM-Society for Industrial and Applied Mathematics}.
\end{CSLReferences} \end{CSLReferences}
\backmatter
\end{document} \end{document}

BIN
build/lib/img/UAF-ACEP.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 72 KiB

10
conf/epub.yaml
View File

@ -1,14 +1,14 @@
from: markdown from: markdown
to: epub to: epub
output-file: build/b3.epub output-file: build/basic-book-builder.epub
metadata: metadata:
title: "Big Beautiful Book" title: "Basic Book Builder"
author: "John Haverlack" author: "John Haverlack"
date: "2025-11-05" date: "2025-11-11"
rights: "© 2025 — CC BY-ND 4.0" rights: "© 2025 Alaska Center for Energy and Power"
epub-cover-image: lib/img/Revolving_circles.480x480_white.png epub-cover-image: lib/img/UAF-ACEP.png
include-before-body: include-before-body:
- conf/frontmatter_epub.xhtml - conf/frontmatter_epub.xhtml

38
conf/frontmatter-md.html Normal file
View File

@ -0,0 +1,38 @@
<div class="frontmatter">
<!-- Title Page -->
<h1 style="margin-top:3em; font-size:2.4em; text-align:center;">Basic Book Builder</h1>
<h2 style="text-align:center; font-weight:normal;">A Pandoc Template for building books and articles</h2>
<div style="text-align:center; margin:2em 0;">
<img src="lib/img/UAF-ACEP.png" alt="Cover illustration" style="max-height:100px;">
</div>
<hr style="margin:3em 0;">
<!-- Metadata Page (PDF analog) -->
<div style="text-align:left; margin-top:5em;">
<!-- Metadata Page (PDF analog) -->
<table style="margin-top:5em; width:100%; border-collapse:collapse;">
<tbody>
<tr><td style="width:30%; font-weight:bold;">Title</td><td>Basic Book Builder</td></tr>
<tr><td style="font-weight:bold;">Subtitle</td><td>A Pandoc Template for building books and articles</td></tr>
<tr><td style="font-weight:bold;">Affiliation</td><td>Alaska Center for Energy and Power</td></tr>
<tr><td style="font-weight:bold;">Institution</td><td>University of Alaska Fairbanks</td></tr>
<tr><td style="font-weight:bold;">Author</td><td>John Haverlack</td></tr>
<tr><td style="font-weight:bold;">Copyright</td><td>© 2025 Alaska Center for Energy and Power</td></tr>
<tr><td style="font-weight:bold;">License</td><td>CC BY-ND 4.0</td></tr>
<tr><td style="font-weight:bold;">Version</td><td>0.0.2</td></tr>
<tr><td style="font-weight:bold;">Date</td><td>2025-11-11</td></tr>
<tr><td style="font-weight:bold;">State</td><td>PRE-RELEASE</td></tr>
<tr><td style="font-weight:bold;">Source</td><td>https://github.com/jehaverlack/basic-book-builder</td></tr>
</tbody>
</table>
</div>
<hr style="margin:4em 0;">
</div>

9
conf/frontmatter.html
View File

@ -16,8 +16,8 @@
<!-- Metadata Page (PDF analog) --> <!-- Metadata Page (PDF analog) -->
<table style="margin-top:5em; width:100%; border-collapse:collapse;"> <table style="margin-top:5em; width:100%; border-collapse:collapse;">
<tbody> <tbody>
<tr><td style="width:30%; font-weight:bold;">Title</td><td>Clear Skies</td></tr> <tr><td style="width:30%; font-weight:bold;">Title</td><td>Basic Book Builder</td></tr>
<tr><td style="font-weight:bold;">Subtitle</td><td>A Reference Architecture for Resilient Alaskan Microgrid Cyberinfrastructure</td></tr> <tr><td style="font-weight:bold;">Subtitle</td><td>A Pandoc Template for building books and articles</td></tr>
<tr><td style="font-weight:bold;">Affiliation</td><td>Alaska Center for Energy and Power</td></tr> <tr><td style="font-weight:bold;">Affiliation</td><td>Alaska Center for Energy and Power</td></tr>
<tr><td style="font-weight:bold;">Institution</td><td>University of Alaska Fairbanks</td></tr> <tr><td style="font-weight:bold;">Institution</td><td>University of Alaska Fairbanks</td></tr>
<tr><td style="font-weight:bold;">Author</td><td>John Haverlack</td></tr> <tr><td style="font-weight:bold;">Author</td><td>John Haverlack</td></tr>
@ -25,12 +25,13 @@
<tr><td style="font-weight:bold;">License</td><td>CC BY-ND 4.0</td></tr> <tr><td style="font-weight:bold;">License</td><td>CC BY-ND 4.0</td></tr>
<tr><td style="font-weight:bold;">Version</td><td>0.0.2</td></tr> <tr><td style="font-weight:bold;">Version</td><td>0.0.2</td></tr>
<tr><td style="font-weight:bold;">Date</td><td>2025-11-11</td></tr> <tr><td style="font-weight:bold;">Date</td><td>2025-11-11</td></tr>
<tr><td style="font-weight:bold;">State</td><td>PRE-DRAFT</td></tr> <tr><td style="font-weight:bold;">State</td><td>PRE-RELEASE</td></tr>
<tr><td style="font-weight:bold;">Source</td><td>https://github.com/acep-uaf/acep-clear-skies</td></tr> <tr><td style="font-weight:bold;">Source</td><td>https://github.com/jehaverlack/basic-book-builder</td></tr>
</tbody> </tbody>
</table> </table>
</div> </div>
<hr style="margin:4em 0;"> <hr style="margin:4em 0;">
</div> </div>

8
conf/frontmatter.tex
View File

@ -28,8 +28,8 @@
\renewcommand{\arraystretch}{1.3} % row spacing \renewcommand{\arraystretch}{1.3} % row spacing
\setlength{\tabcolsep}{8pt} % column padding \setlength{\tabcolsep}{8pt} % column padding
\begin{tabular}{@{}p{0.28\textwidth}p{0.65\textwidth}@{}} \begin{tabular}{@{}p{0.28\textwidth}p{0.65\textwidth}@{}}
\textbf{Title:} & Clear Skies \\ \textbf{Title:} & Basic Book Builder \\
\textbf{Subtitle:} & A Reference Architecture for Resilient Alaskan Microgrid Cyberinfrastructure \\ \textbf{Subtitle:} & A Pandoc Template for building books and articles \\
\textbf{Affiliation:} & Alaska Center for Energy and Power \\ \textbf{Affiliation:} & Alaska Center for Energy and Power \\
\textbf{Institution:} & University of Alaska Fairbanks \\ \textbf{Institution:} & University of Alaska Fairbanks \\
\textbf{Author:} & John Haverlack \\ \textbf{Author:} & John Haverlack \\
@ -37,8 +37,8 @@
\textbf{License:} & CC BY-ND 4.0 \\ \textbf{License:} & CC BY-ND 4.0 \\
\textbf{Version:} & 0.0.2 \\ \textbf{Version:} & 0.0.2 \\
\textbf{Date:} & 2025-11-11 \\ \textbf{Date:} & 2025-11-11 \\
\textbf{State:} & PRE-DRAFT \\ \textbf{State:} & PRE-RELEASE \\
\textbf{Source:} & https://github.com/acep-uaf/acep-clear-skies \\ \textbf{Source:} & https://github.com/jehaverlack/basic-book-builder \\
\end{tabular} \end{tabular}
\end{center} \end{center}

2
conf/html.yaml
View File

@ -2,7 +2,7 @@
from: markdown from: markdown
to: html5 to: html5
standalone: true standalone: true
output-file: build/b3.html output-file: build/basic-book-builder.html
include-before-body: include-before-body:
- conf/frontmatter.html - conf/frontmatter.html

2
conf/latex.yaml
View File

@ -2,7 +2,7 @@
from: markdown from: markdown
to: latex to: latex
standalone: true standalone: true
output-file: build/b3.tex output-file: build/basic-book-builder.tex
include-in-header: include-in-header:
- conf/header.tex # fonts, tcolorbox, etc. - conf/header.tex # fonts, tcolorbox, etc.

2
conf/markdown.yaml
View File

@ -2,7 +2,7 @@
from: markdown from: markdown
to: gfm to: gfm
standalone: true standalone: true
output-file: build/ClearSkies.md output-file: build/basic-book-builder.md
include-before-body: include-before-body:
- conf/frontmatter-md.html # HTML frontmatter works fine here - conf/frontmatter-md.html # HTML frontmatter works fine here

1
conf/metadata.yaml
View File

@ -1,5 +1,6 @@
title: "Basic Book Builder" title: "Basic Book Builder"
subtitle: "A Pandoc Template for building books and articles" subtitle: "A Pandoc Template for building books and articles"
name: "basic-book-builder"
author: "John Haverlack" author: "John Haverlack"
author-email: "jehaverlack@alaska.edu" author-email: "jehaverlack@alaska.edu"
affiliation: "Alaska Center for Energy and Power" affiliation: "Alaska Center for Energy and Power"

2
conf/pdf.yaml
View File

@ -1,7 +1,7 @@
# pdf.yaml # pdf.yaml
to: pdf to: pdf
pdf-engine: xelatex pdf-engine: xelatex
output-file: build/b3.pdf output-file: build/basic-book-builder.pdf
include-before-body: include-before-body:
- conf/frontmatter.tex - conf/frontmatter.tex

24
templates/epub.yaml Normal file
View File

@ -0,0 +1,24 @@
from: markdown
to: epub
output-file: build/$name$.epub
metadata:
title: "$title$"
author: "$author$"
date: "$date$"
rights: "$copyright$"
epub-cover-image: $logo$
include-before-body:
- conf/frontmatter_epub.xhtml
resource-path:
- .
- lib/img
css:
- conf/style_epub.css
filters:
- filters/callouts-html.lua

38
templates/frontmatter-md.html Normal file
View File

@ -0,0 +1,38 @@
<div class="frontmatter">
<!-- Title Page -->
<h1 style="margin-top:3em; font-size:2.4em; text-align:center;">$title$</h1>
<h2 style="text-align:center; font-weight:normal;">$subtitle$</h2>
<div style="text-align:center; margin:2em 0;">
<img src="$logo$" alt="Cover illustration" style="max-height:100px;">
</div>
<hr style="margin:3em 0;">
<!-- Metadata Page (PDF analog) -->
<div style="text-align:left; margin-top:5em;">
<!-- Metadata Page (PDF analog) -->
<table style="margin-top:5em; width:100%; border-collapse:collapse;">
<tbody>
<tr><td style="width:30%; font-weight:bold;">Title</td><td>$title$</td></tr>
<tr><td style="font-weight:bold;">Subtitle</td><td>$subtitle$</td></tr>
<tr><td style="font-weight:bold;">Affiliation</td><td>$affiliation$</td></tr>
<tr><td style="font-weight:bold;">Institution</td><td>$institution$</td></tr>
<tr><td style="font-weight:bold;">Author</td><td>$author$</td></tr>
<tr><td style="font-weight:bold;">Copyright</td><td>$copyright$</td></tr>
<tr><td style="font-weight:bold;">License</td><td>$license$</td></tr>
<tr><td style="font-weight:bold;">Version</td><td>$version$</td></tr>
<tr><td style="font-weight:bold;">Date</td><td>$date$</td></tr>
<tr><td style="font-weight:bold;">State</td><td>$state$</td></tr>
<tr><td style="font-weight:bold;">Source</td><td>$source$</td></tr>
</tbody>
</table>
</div>
<hr style="margin:4em 0;">
</div>

26
templates/html.yaml Normal file
View File

@ -0,0 +1,26 @@
# conf/html.yaml
from: markdown
to: html5
standalone: true
output-file: build/$name$.html
include-before-body:
- conf/frontmatter.html
metadata:
title: "Basic Book Builder"
title-block: false
# This enables EPUB TOC
toc: true
toc-depth: 3
css:
- conf/style.css
resource-path:
- .
- lib/img
filters:
- filters/callouts-html.lua

20
templates/latex.yaml Normal file
View File

@ -0,0 +1,20 @@
# latex.yaml
from: markdown
to: latex
standalone: true
output-file: build/$name$.tex
include-in-header:
- conf/header.tex # fonts, tcolorbox, etc.
# no include-before-body for LaTeX .tex export
# front matter will be produced only in PDF mode
resource-path:
- .
- lib/img
filters:
- filters/callouts.lua # same filter as PDF, since it emits LaTeX environments
pdf-engine: xelatex

23
templates/markdown.yaml Normal file
View File

@ -0,0 +1,23 @@
# conf/markdown.yaml
from: markdown
to: gfm
standalone: true
output-file: build/$name$.md
include-before-body:
- conf/frontmatter-md.html # HTML frontmatter works fine here
metadata:
title: "Clear Skies - A Reference Architecture for Resilient Alaskan Microgrid Cyberinfrastructure"
title-block: false
toc: true
toc-depth: 3
resource-path:
- .
- lib/img
- lib/diag
filters:
- filters/callouts-html.lua

13
templates/pdf.yaml Normal file
View File

@ -0,0 +1,13 @@
# pdf.yaml
to: pdf
pdf-engine: xelatex
output-file: build/$name$.pdf
include-before-body:
- conf/frontmatter.tex
include-in-header:
- conf/header.tex
filters:
- filters/callouts.lua