Improve page toc

kanboard · Sep 16, 2023 · e8649fe · e8649fe
1 parent 3d7ceb2
commit e8649fe
Show file tree

Hide file tree

Showing 52 changed files with 68 additions and 10 deletions.
diff --git a/content/en/introduction.md b/content/en/introduction.md
@@ -1,5 +1,6 @@
 ---
 title: What is Kanban?
+toc: true
 ---
 
 ## Introduction
@@ -46,9 +47,9 @@ For example, you may have a lead time of 100 days but only have to work 1 hour t
 - Multiple phases, each column represents a step
 - Bring focus and avoid multitasking by setting a work-in-progress limit per column
 
-### Kanban vs Scrum
+## Kanban vs Scrum
 
-## Scrum
+### Scrum
 
 - Sprints are time-boxed, usually 2 or 4 weeks
 - Do not allow changes during the iteration

diff --git a/content/en/v1/admin/_index.md b/content/en/v1/admin/_index.md
@@ -1,5 +1,5 @@
 ---
-title: Running Kanboard
+title: Administration
 description: Installing and configuring Kanboard on your own server
 ---
 

diff --git a/content/en/v1/admin/cronjob.md b/content/en/v1/admin/cronjob.md
@@ -1,5 +1,6 @@
 ---
 title: Cronjob Configuration
+toc: true
 ---
 
 To work properly, Kanboard requires that a background job run on a daily

diff --git a/content/en/v1/admin/debian.md b/content/en/v1/admin/debian.md
@@ -1,5 +1,6 @@
 ---
 title: Debian Installation
+toc: true
 ---
 
 {{< hint type="danger" >}}

diff --git a/content/en/v1/admin/email.md b/content/en/v1/admin/email.md
@@ -1,5 +1,6 @@
 ---
 title: Email Configuration
+toc: true
 ---
 
 User Settings

diff --git a/content/en/v1/admin/installation.md b/content/en/v1/admin/installation.md
@@ -1,5 +1,6 @@
 ---
 title: Installation Instructions
+toc: true
 aliases:
     - /en/latest/admin_guide/installation.html
     - /en/1.2.24/admin_guide/installation.html

diff --git a/content/en/v1/admin/mysql.md b/content/en/v1/admin/mysql.md
@@ -1,5 +1,6 @@
 ---
 title: MySQL/MariaDB
+toc: true
 ---
 
 By default Kanboard use Sqlite to stores its data. However it's possible

diff --git a/content/en/v1/admin/performances.md b/content/en/v1/admin/performances.md
@@ -1,5 +1,6 @@
 ---
 title: Performances
+toc: true
 ---
 
 According to your configuration, some features can slow down the usage

diff --git a/content/en/v1/admin/plugins.md b/content/en/v1/admin/plugins.md
@@ -1,5 +1,6 @@
 ---
 title: Plugins Installation
+toc: true
 aliases:
     - /en/latest/admin_guide/plugins.html
     - /en/1.2.24/admin_guide/plugins.html

diff --git a/content/en/v1/admin/postgresql.md b/content/en/v1/admin/postgresql.md
@@ -1,5 +1,6 @@
 ---
 title: Postgresql
+toc: true
 ---
 
 By default, Kanboard use Sqlite to store its data but it's also possible

diff --git a/content/en/v1/admin/reverse_proxy_authentication.md b/content/en/v1/admin/reverse_proxy_authentication.md
@@ -1,5 +1,6 @@
 ---
 title: Reverse Proxy Authentication
+toc: true
 ---
 
 This authentication method is often used for

diff --git a/content/en/v1/admin/rhel.md b/content/en/v1/admin/rhel.md
@@ -1,5 +1,6 @@
 ---
 title: Installation on RedHat/Centos/Oracle Linux Enterprise
+toc: true
 ---
 
 {{< hint type="warning" >}}

diff --git a/content/en/v1/admin/security.md b/content/en/v1/admin/security.md
@@ -1,5 +1,6 @@
 ---
 title: Security
+toc: true
 ---
 
 General Advices

diff --git a/content/en/v1/admin/sqlite.md b/content/en/v1/admin/sqlite.md
@@ -1,5 +1,6 @@
 ---
 title: Sqlite
+toc: true
 ---
 
 Kanboard uses Sqlite by default to store its data.

diff --git a/content/en/v1/admin/ubuntu.md b/content/en/v1/admin/ubuntu.md
@@ -1,5 +1,6 @@
 ---
 title: Ubuntu Installation
+toc: true
 ---
 
 {{< hint type="danger" >}}

diff --git a/content/en/v1/admin/upgrade.md b/content/en/v1/admin/upgrade.md
@@ -1,5 +1,6 @@
 ---
 title: Upgrading to a New Version
+toc: true
 aliases:
     - /en/latest/admin_guide/upgrade.html
     - /en/1.2.24/admin_guide/upgrade.html

diff --git a/content/en/v1/admin/url_rewriting.md b/content/en/v1/admin/url_rewriting.md
@@ -1,6 +1,7 @@
 ---
 title: URL Rewriting
 slug: url-rewriting
+toc: true
 ---
 
 Kanboard is able to work indifferently with URL rewriting enabled or

diff --git a/content/en/v1/admin/windows.md b/content/en/v1/admin/windows.md
@@ -1,5 +1,6 @@
 ---
 title: Installation on Microsoft Windows Server
+toc: true
 ---
 
 {{< hint type="warning" >}}

diff --git a/content/en/v1/admin/workers.md b/content/en/v1/admin/workers.md
@@ -1,5 +1,6 @@
 ---
 title: Background Workers
+toc: true
 ---
 
 {{< hint type="warning" >}}

diff --git a/content/en/v1/api/_index.md b/content/en/v1/api/_index.md
@@ -3,6 +3,7 @@ title: API Reference
 linktitle: API
 description: JSON-RPC API Reference
 sectionToc: true
+toc: true
 aliases:
     - /en/latest/api/index.html
 ---

diff --git a/content/en/v1/api/examples.md b/content/en/v1/api/examples.md
@@ -1,5 +1,6 @@
 ---
 title: API Examples
+toc: true
 ---
 
 Example with cURL

diff --git a/content/en/v1/dev/tests.md b/content/en/v1/dev/tests.md
@@ -1,5 +1,6 @@
 ---
 title: Automated Tests
+toc: true
 ---
 
 [PHPUnit](https://phpunit.de/) is used to run automated tests on Kanboard.

diff --git a/content/en/v1/dev/translations.md b/content/en/v1/dev/translations.md
@@ -1,5 +1,6 @@
 ---
 title: Translations
+toc: true
 ---
 
 How to translate Kanboard to a new language?

diff --git a/content/en/v1/dev/webhooks.md b/content/en/v1/dev/webhooks.md
@@ -1,5 +1,6 @@
 ---
 title: Webhooks
+toc: true
 ---
 
 Webhooks are useful to perform actions with external applications.

diff --git a/content/en/v1/plugins/authentication_architecture.md b/content/en/v1/plugins/authentication_architecture.md
@@ -1,5 +1,6 @@
 ---
 title: Authentication Architecture
+toc: true
 ---
 
 Kanboard provides a flexible and pluggable authentication architecture.

diff --git a/content/en/v1/plugins/authentication_providers.md b/content/en/v1/plugins/authentication_providers.md
@@ -1,5 +1,6 @@
 ---
 title: Authentication Providers
+toc: true
 ---
 
 New authentication backends can be written with very few lines of code.

diff --git a/content/en/v1/plugins/authorization.md b/content/en/v1/plugins/authorization.md
@@ -1,5 +1,6 @@
 ---
 title: Authorization Architecture
+toc: true
 ---
 
 Kanboard supports multiple roles at the application level and at the project level.

diff --git a/content/en/v1/plugins/automatic_actions.md b/content/en/v1/plugins/automatic_actions.md
@@ -1,5 +1,6 @@
 ---
 title: Adding Automatic Actions
+toc: true
 ---
 
 Adding a new automatic action is pretty simple.

diff --git a/content/en/v1/plugins/avatar.md b/content/en/v1/plugins/avatar.md
@@ -1,5 +1,6 @@
 ---
 title: Avatar Providers
+toc: true
 ---
 
 Registration

diff --git a/content/en/v1/plugins/events.md b/content/en/v1/plugins/events.md
@@ -1,5 +1,6 @@
 ---
 title: Using Events
+toc: true
 ---
 
 Kanboard use internally the [Symfony EventDispatcher component](https://symfony.com/doc/2.3/components/event_dispatcher/index.html) to manage internal events.

diff --git a/content/en/v1/plugins/external_links.md b/content/en/v1/plugins/external_links.md
@@ -1,5 +1,6 @@
 ---
 title: External Link Providers
+toc: true
 ---
 
 This functionality allows you to link a task to additional items stored on another system.

diff --git a/content/en/v1/plugins/external_tasks.md b/content/en/v1/plugins/external_tasks.md
@@ -1,5 +1,6 @@
 ---
 title: External Task Providers
+toc: true
 ---
 
 Kanboard can be used to manage tasks stored in another system. For example, an external system can be a bug tracker or any kind of ticketing software. In this way, you can use Kanboard to manage external tasks in the same way as native tasks.

diff --git a/content/en/v1/plugins/group_providers.md b/content/en/v1/plugins/group_providers.md
@@ -1,5 +1,6 @@
 ---
 title: Custom Group Providers
+toc: true
 ---
 
 Kanboard is able to load groups from an external system. This feature is mainly used for project permissions.

diff --git a/content/en/v1/plugins/helpers.md b/content/en/v1/plugins/helpers.md
@@ -1,5 +1,6 @@
 ---
 title: Registering new helpers
+toc: true
 ---
 
 Helper skeleton:

diff --git a/content/en/v1/plugins/ldap_client.md b/content/en/v1/plugins/ldap_client.md
@@ -1,5 +1,6 @@
 ---
 title: LDAP Library
+toc: true
 ---
 
 To facilitate LDAP integration, Kanboard has its own LDAP library. This library can perform common operations.

diff --git a/content/en/v1/plugins/mail_transports.md b/content/en/v1/plugins/mail_transports.md
@@ -1,5 +1,6 @@
 ---
 title: Mail Transport
+toc: true
 ---
 
 By default Kanboard supports 3 standards mail transports:

diff --git a/content/en/v1/plugins/metadata.md b/content/en/v1/plugins/metadata.md
@@ -1,5 +1,6 @@
 ---
 title: Metadata
+toc: true
 ---
 
 You can attach metadata for each project, task, user or for the whole

diff --git a/content/en/v1/plugins/notifications.md b/content/en/v1/plugins/notifications.md
@@ -1,5 +1,6 @@
 ---
 title: Add Notification Types with Plugins
+toc: true
 ---
 
 You can send notifications to almost any system by adding a new type.

diff --git a/content/en/v1/plugins/overrides.md b/content/en/v1/plugins/overrides.md
@@ -1,5 +1,6 @@
 ---
 title: Plugin Overrides
+toc: true
 ---
 
 Override HTTP Content Security Policy

diff --git a/content/en/v1/plugins/registration.md b/content/en/v1/plugins/registration.md
@@ -1,5 +1,6 @@
 ---
 title: Plugin Registration
+toc: true
 ---
 
 Project skeleton generator

diff --git a/content/en/v1/plugins/routes.md b/content/en/v1/plugins/routes.md
@@ -1,5 +1,6 @@
 ---
 title: Custom Routes
+toc: true
 ---
 
 When URL rewriting is enabled, you can define custom routes from your plugins.

diff --git a/content/en/v1/plugins/schema_migrations.md b/content/en/v1/plugins/schema_migrations.md
@@ -1,5 +1,6 @@
 ---
 title: Plugin Schema Migrations
+toc: true
 ---
 
 Kanboard executes database migrations automatically for you. Migrations

diff --git a/content/en/v1/user/automatic_actions.md b/content/en/v1/user/automatic_actions.md
@@ -1,5 +1,6 @@
 ---
 title: Automatic Actions
+toc: true
 ---
 
 To minimize user interaction, Kanboard support automated actions.

diff --git a/content/en/v1/user/keyboard_shortcuts.md b/content/en/v1/user/keyboard_shortcuts.md
@@ -1,6 +1,7 @@
 ---
 title: Keyboard Shortcuts
 slug: keyboard-shortcuts
+toc: true
 ---
 
 Keyboard shortcuts availability depends on the current page.

diff --git a/content/en/v1/user/markdown_syntax.md b/content/en/v1/user/markdown_syntax.md
@@ -1,5 +1,6 @@
 ---
 title: Markdown Syntax
+toc: true
 ---
 
 Kanboard use the [Markdown syntax](http://en.wikipedia.org/wiki/Markdown) for comments or task descriptions.

diff --git a/content/en/v1/user/subtasks.md b/content/en/v1/user/subtasks.md
@@ -1,5 +1,6 @@
 ---
 title: Subtasks
+toc: true
 ---
 
 Subtasks are useful to split the work of a task.

diff --git a/content/en/v1/user/swimlanes.md b/content/en/v1/user/swimlanes.md
@@ -1,5 +1,6 @@
 ---
 title: Swimlanes
+toc: true
 ---
 
 Swimlanes are horizontal separations in your board. 

diff --git a/content/en/v1/user/time_tracking.md b/content/en/v1/user/time_tracking.md
@@ -1,5 +1,6 @@
 ---
 title: Time Tracking
+toc: true
 ---
 
 Time tracking information can be defined at the task level or at the subtask level.

diff --git a/layouts/_default/section.html b/layouts/_default/section.html
@@ -5,6 +5,7 @@
     <main>
         <h1>{{ .Title }}</h1>
         {{ partial "breadcrumb.html" . }}
+        {{ partial "toc.html" . }}
         <article>
             {{ .Content }}
             {{ if .Params.sectionToc }}

diff --git a/layouts/_default/single.html b/layouts/_default/single.html
@@ -8,15 +8,10 @@
                 <h1>{{ .Title }}</h1>
                 {{ partial "breadcrumb.html" . }}
             </header>
-            {{ if .Params.toc }}
-            <aside class="table-of-contents">
-                <h2>Table of Contents</h2>
-                {{.TableOfContents}}
-            </aside>
-            {{ end }}
+            {{ partial "toc.html" . }}
             <section>{{ .Content }}</section>
         </article>
     </main>
+    {{ partial "footer.html" . }}
 </body>
-{{ partial "footer.html" . }}
 </html>
diff --git a/layouts/partials/toc.html b/layouts/partials/toc.html
@@ -0,0 +1,5 @@
+{{ if and (gt .WordCount 200 ) (.Params.toc) }}
+<aside class="table-of-contents">
+    {{ .TableOfContents }}
+</aside>
+{{ end }}