From 102ac855b51db17f011ec1b11501cee77325695c Mon Sep 17 00:00:00 2001
From: Sebastian Meyer <sebastian@informathekar.de>
Date: Sat, 10 Feb 2024 18:51:27 +0100
Subject: [PATCH] Rework documentation templates

---
 .phpdoc/template/components/sidebar.html.twig |  2 +-
 .phpdoc/template/components/toc.html.twig     | 19 +++++++++++++++
 .phpdoc/template/css/custom.css.twig          |  3 +++
 .phpdoc/template/index.html.twig              | 24 +++++++++++++++++++
 4 files changed, 47 insertions(+), 1 deletion(-)
 create mode 100644 .phpdoc/template/components/toc.html.twig
 create mode 100644 .phpdoc/template/css/custom.css.twig
 create mode 100644 .phpdoc/template/index.html.twig

diff --git a/.phpdoc/template/components/sidebar.html.twig b/.phpdoc/template/components/sidebar.html.twig
index 1e60bee..7201879 100644
--- a/.phpdoc/template/components/sidebar.html.twig
+++ b/.phpdoc/template/components/sidebar.html.twig
@@ -6,7 +6,7 @@
     {% for version in project.versions %}
         {% for toc in version.tableOfContents %}
         <section class="phpdocumentor-sidebar__category">
-            <h2 class="phpdocumentor-sidebar__category-header">{{ toc.name|capitalize }}</h2>
+            <h2 class="phpdocumentor-sidebar__category-header">{{ toc.name|title }}</h2>
                 {% for root in toc.roots %}
                     {{ toc(root, 'components/menu.html.twig', 1) }}
                 {% endfor %}
diff --git a/.phpdoc/template/components/toc.html.twig b/.phpdoc/template/components/toc.html.twig
new file mode 100644
index 0000000..7ff0a75
--- /dev/null
+++ b/.phpdoc/template/components/toc.html.twig
@@ -0,0 +1,19 @@
+{% for version in project.versions %}
+    {% for toc in version.tableOfContents|filter(toc => toc.name|lower == "documentation" or toc.name|lower == "packages") %}
+        <h4 id="toc-{{ toc.name|lower }}">{{ toc.name|title }}</h4>
+        <dl class="phpdocumentor-table-of-contents">
+        {% for root in toc.roots %}
+            <dt class="phpdocumentor-table-of-contents__entry -{{ toc.name|lower|trim('s', 'right') }}">
+                <a href="{{ root.url }}">{{ root.title|shortFQSEN }}</a>
+            </dt>
+            {% if root.children.count > 0 %}
+            <dd>
+            {% for child in root.children %}
+                <a href="{{ child.url }}">{{ child.title|shortFQSEN }}</a><br/>
+            {% endfor %}
+            </dd>
+            {% endif %}
+        {% endfor %}
+        </dl>
+    {% endfor %}
+{% endfor %}
diff --git a/.phpdoc/template/css/custom.css.twig b/.phpdoc/template/css/custom.css.twig
new file mode 100644
index 0000000..38deeae
--- /dev/null
+++ b/.phpdoc/template/css/custom.css.twig
@@ -0,0 +1,3 @@
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-documentation:before {
+    content: 'D';
+}
diff --git a/.phpdoc/template/index.html.twig b/.phpdoc/template/index.html.twig
new file mode 100644
index 0000000..1dc4618
--- /dev/null
+++ b/.phpdoc/template/index.html.twig
@@ -0,0 +1,24 @@
+{% extends 'base.html.twig' %}
+
+{% block content %}
+<section>
+    <ul class="phpdocumentor-breadcrumbs">
+        <li><a href>Home</a></li>
+    </ul>
+
+    <h2 class="phpdocumentor-content__title">PHP Basics</h2>
+
+    <p class="phpdocumentor-summary">A collection of generic classes and useful traits for PHP projects.</p>
+
+    <p>The package currently contains classes for <a href="packages/Basics-DataStructures.html">type-sensitive data
+    structures</a>, <a href="packages/Basics-ErrorHandlers.html">error and exception handlers</a>, multiple
+    <a href="packages/Basics-InterfaceTraits.html">traits implementing standard interfaces</a>, and more generic
+    <a href="packages/Basics-Traits.html">traits for common use cases</a>. They share the same design principles like
+    property and method naming schema, highest <a href="https://psalm.dev/">Psalm</a> and <a href="https://phpstan.org/">PHPStan</a> coding standards and full <a href="https://www.php-fig.org/psr/psr-12/">PSR-12</a>
+    compliance to make sure they can be combined and easily re-used in other projects.</p>
+
+    <h3 id="toc">Table of Contents</h3>
+
+    {% include('components/toc.html.twig') %}
+</section>
+{% endblock %}