Completely type hint template functions and switch to named arguments

This commit is contained in:
Alex Cabal 2025-03-04 16:08:55 -06:00
parent 6108b5e53d
commit 124e8343fc
125 changed files with 542 additions and 450 deletions

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'A Basic Standard Ebooks Source Folder', 'manual' => true, 'highlight' => 'contribute', 'description' => 'All Standard Ebooks source folders have the same basic structure, described here.']) ?>
<?= Template::Header(title: 'A Basic Standard Ebooks Source Folder', isManual: true, highlight: 'contribute', description: 'All Standard Ebooks source folders have the same basic structure, described here.') ?>
<main>
<article id="a-basic-standard-ebooks-source-folder">
<h1>A Basic Standard Ebooks Source Folder</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'Collections Policy', 'highlight' => 'contribute', 'description' => 'Standard Ebooks only accepts certain kinds of ebooks for production and hosting. This is the full list.']) ?>
<?= Template::Header(title: 'Collections Policy', highlight: 'contribute', description: 'Standard Ebooks only accepts certain kinds of ebooks for production and hosting. This is the full list.') ?>
<main>
<article>
<hgroup>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'Common Issues When Working on Public Domain Ebooks', 'manual' => true, 'highlight' => 'contribute', 'description' => 'A list of common issues encountered when converting from public domain transcriptions.']) ?>
<?= Template::Header(title: 'Common Issues When Working on Public Domain Ebooks', isManual: true, highlight: 'contribute', description: 'A list of common issues encountered when converting from public domain transcriptions.') ?>
<main>
<article>
<h1>Common Issues When Working on Public Domain Ebooks</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'How to Choose and Create a Cover Image', 'manual' => true, 'highlight' => 'contribute', 'description' => 'A guide to choosing, clearing, and formatting your cover image.']) ?>
<?= Template::Header(title: 'How to Choose and Create a Cover Image', isManual: true, highlight: 'contribute', description: 'A guide to choosing, clearing, and formatting your cover image.') ?>
<main class="manual">
<article class="step-by-step-guide">
<h1>How to Choose and Create a Cover Image</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'How to Conquer Complex Drama Formatting', 'manual' => true, 'highlight' => 'contribute', 'description' => 'A guide to formatting any complex plays or dramatic dialog sections.']) ?>
<?= Template::Header(title: 'How to Conquer Complex Drama Formatting', isManual: true, highlight: 'contribute', description: 'A guide to formatting any complex plays or dramatic dialog sections.') ?>
<main class="manual">
<article class="step-by-step-guide">
<h1>How to Conquer Complex Drama Formatting</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'How to Create Figures for Music Scores', 'manual' => true, 'highlight' => 'contribute', 'description' => 'A guide to producing SVG figures of music notation.']) ?>
<?= Template::Header(title: 'How to Create Figures for Music Scores', isManual: true, highlight: 'contribute', description: 'A guide to producing SVG figures of music notation.') ?>
<main class="manual">
<article class="step-by-step-guide">
<h1>How to Create Figures for Music Scores</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'How to Create SVGs from Maps with Several Colors', 'manual' => true, 'highlight' => 'contribute', 'description' => 'A guide to producing SVG from images such as maps with more than a single color.']) ?>
<?= Template::Header(title: 'How to Create SVGs from Maps with Several Colors', isManual: true, highlight: 'contribute', description: 'A guide to producing SVG from images such as maps with more than a single color.') ?>
<main class="manual">
<article class="step-by-step-guide">
<h1>How to Create SVGs from Maps with Several Colors</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'How to Review an Ebook Production for Publication', 'manual' => true, 'highlight' => 'contribute', 'description' => 'A guide to proofread and review an ebook production for publication.']) ?>
<?= Template::Header(title: 'How to Review an Ebook Production for Publication', isManual: true, highlight: 'contribute', description: 'A guide to proofread and review an ebook production for publication.') ?>
<main class="manual">
<article class="step-by-step-guide">
<h1>How to Review an Ebook Production for Publication</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'How to Structure and Style Large Poetic Productions', 'manual' => true, 'highlight' => 'contribute', 'description' => 'A guide to formatting poetry collections, long narrative poems, and unusual poetic features.']) ?>
<?= Template::Header(title: 'How to Structure and Style Large Poetic Productions', isManual: true, highlight: 'contribute', description: 'A guide to formatting poetry collections, long narrative poems, and unusual poetic features.') ?>
<main class="manual">
<article class="step-by-step-guide">
<h1>How to Structure and Style Large Poetic Productions</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'How-to Guides For Difficult Productions', 'manual' => true, 'highlight' => 'contribute', 'description' => 'Guides on how to produce more difficult productions.']) ?>
<?= Template::Header(title: 'How-to Guides For Difficult Productions', isManual: true, highlight: 'contribute', description: 'Guides on how to produce more difficult productions.') ?>
<main>
<article>
<h1>How-to Guides</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'Things to Look Out For When Proofreading', 'manual' => true, 'highlight' => 'contribute', 'description' => 'A list of things to look out for when proofreading.']) ?>
<?= Template::Header(title: 'Things to Look Out For When Proofreading', isManual: true, highlight: 'contribute', description: 'A list of things to look out for when proofreading.') ?>
<main>
<article>
<h1>Things to Look Out For When Proofreading</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'Get Involved', 'highlight' => 'contribute', 'description' => 'Details on how to contribute your time and talent to the volunteer-driven Standard Ebooks project.']) ?>
<?= Template::Header(title: 'Get Involved', highlight: 'contribute', description: 'Details on how to contribute your time and talent to the volunteer-driven Standard Ebooks project.') ?>
<main>
<article class="has-hero">
<hgroup>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'Producing an Ebook for Standard Ebooks', 'highlight' => 'contribute', 'description' => 'A high-level outline of the process of producing an ebook for Standard Ebooks.']) ?>
<?= Template::Header(title: 'Producing an Ebook for Standard Ebooks', highlight: 'contribute', description: 'A high-level outline of the process of producing an ebook for Standard Ebooks.') ?>
<main>
<article>
<h1>Producing an Ebook for Standard Ebooks</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'Producing an Ebook, Step by Step', 'manual' => true, 'highlight' => 'contribute', 'description' => 'A detailed step-by-step description of the complete process of producing an ebook for Standard Ebooks, start to finish.']) ?>
<?= Template::Header(title: 'Producing an Ebook, Step by Step', isManual: true, highlight: 'contribute', description: 'A detailed step-by-step description of the complete process of producing an ebook for Standard Ebooks, start to finish.') ?>
<main class="manual">
<article class="step-by-step-guide">
<h1>Producing an Ebook, Step by Step</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'Report Errors Upstream', 'highlight' => 'contribute', 'description' => 'Our guide to reporting errors to Gutenberg and other sources.']) ?>
<?= Template::Header(title: 'Report Errors Upstream', highlight: 'contribute', description: 'Our guide to reporting errors to Gutenberg and other sources.') ?>
<main>
<article>
<h1>Report Errors Upstream</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'Report Errors', 'highlight' => 'contribute', 'description' => 'How to report a typo or error youve found in a Standard Ebooks ebook.']) ?>
<?= Template::Header(title: 'Report Errors', highlight: 'contribute', description: 'How to report a typo or error youve found in a Standard Ebooks ebook.') ?>
<main>
<article>
<h1>Report Errors</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'Research Spreadsheets', 'highlight' => 'contribute', 'description' => 'A list of spreadsheets created and used by Standard Ebooks producers.']) ?>
<?= Template::Header(title: 'Research Spreadsheets', highlight: 'contribute', description: 'A list of spreadsheets created and used by Standard Ebooks producers.') ?>
<main>
<article>
<h1>Research Spreadsheets</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'Tips for Editors and Proofreaders', 'manual' => true, 'highlight' => 'contribute', 'description' => 'A list of tips and tricks for people whod like to proofread a Standard Ebooks ebook.']) ?>
<?= Template::Header(title: 'Tips for Editors and Proofreaders', isManual: true, highlight: 'contribute', description: 'A list of tips and tricks for people whod like to proofread a Standard Ebooks ebook.') ?>
<main>
<article>
<h1>Tips for Editors and Proofreaders</h1>

View file

@ -1,4 +1,4 @@
<?= Template::Header(['title' => 'Uncategorized Art Resources', 'highlight' => 'contribute', 'description' => 'A list of US-PD art books for use when conducting cover art research.']) ?>
<?= Template::Header(title: 'Uncategorized Art Resources', highlight: 'contribute', description: 'A list of US-PD art books for use when conducting cover art research.') ?>
<main>
<article id="a-basic-standard-ebooks-source-folder">
<h1>Uncategorized Art Resources</h1>

View file

@ -3,7 +3,7 @@ $beginnerEbooks = Ebook::GetByIsWantedAndDifficulty(Enums\EbookPlaceholderDiffic
$intermediateEbooks = Ebook::GetByIsWantedAndDifficulty(Enums\EbookPlaceholderDifficulty::Intermediate);
$advancedEbooks = Ebook::GetByIsWantedAndDifficulty(Enums\EbookPlaceholderDifficulty::Advanced);
?>
<?= Template::Header(['title' => 'Wanted Ebooks', 'highlight' => 'contribute', 'description' => 'A list of ebooks the Standard Ebooks editor would like to see produced, including suggestions for first-time producers.']) ?>
<?= Template::Header(title: 'Wanted Ebooks', highlight: 'contribute', description: 'A list of ebooks the Standard Ebooks editor would like to see produced, including suggestions for first-time producers.') ?>
<main>
<article>
<h1>Wanted Ebooks</h1>
@ -18,13 +18,13 @@ $advancedEbooks = Ebook::GetByIsWantedAndDifficulty(Enums\EbookPlaceholderDiffic
<h2>For your first production</h2>
<p>If nothing on the list below interests you, you can pitch us something else youd like to work on.</p>
<p>First productions should be on the shorter side (less than 100,000 words maximum) and without too many complex formatting issues like illustrations, significant endnotes, letters, poems, etc. Most short plain fiction novels fall in this category.</p>
<?= Template::WantedEbooksList(['ebooks' => $beginnerEbooks, 'showPlaceholderMetadata' => Session::$User?->Benefits->CanEditEbookPlaceholders]) ?>
<?= Template::WantedEbooksList(ebooks: $beginnerEbooks, showPlaceholderMetadata: Session::$User->Benefits->CanEditEbookPlaceholders ?? false) ?>
<h2>Moderate-difficulty productions</h2>
<?= Template::WantedEbooksList(['ebooks' => $intermediateEbooks, 'showPlaceholderMetadata' => Session::$User?->Benefits->CanEditEbookPlaceholders]) ?>
<?= Template::WantedEbooksList(ebooks: $intermediateEbooks, showPlaceholderMetadata: Session::$User->Benefits->CanEditEbookPlaceholders ?? false) ?>
<h2>Advanced productions</h2>
<?= Template::WantedEbooksList(['ebooks' => $advancedEbooks, 'showPlaceholderMetadata' => Session::$User?->Benefits->CanEditEbookPlaceholders]) ?>
<?= Template::WantedEbooksList(ebooks: $advancedEbooks, showPlaceholderMetadata: Session::$User->Benefits->CanEditEbookPlaceholders ?? false) ?>
<h2 id="verne">Jules Verne</h2>
<p>Verne has a complex publication and translation history. Please review these notes before starting any Verne books.</p>