PHPackages                             heineref/kirby-helpsection - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. heineref/kirby-helpsection

ActiveKirby-plugin[Utility & Helpers](/categories/utility)

heineref/kirby-helpsection
==========================

This plugin allows Panel users to display help how to work in the Panel, which can be called up directly in the Panel by clicking on the question-mark-icon in the Panel menu on the left.

00PHP

Since Nov 20Pushed 9mo agoCompare

[ Source](https://github.com/HeinerEF/kirby-helpsection)[ Packagist](https://packagist.org/packages/heineref/kirby-helpsection)[ RSS](/packages/heineref-kirby-helpsection/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependenciesVersions (1)Used By (0)

Helpsection
===========

[](#helpsection)

Adds the Panel view **`Helpsection`** to display help for Panel users.

The Panel view *may* look like this: [![Kirby Helpsection](docs/kirby-helpsection.png)](docs/kirby-helpsection.png)This shows a *possible* content for the **`Helpsection`**, which can be customized and translated like normal pages in the Panel.

This plugin "**Helpsection**" allows users to access detailed explanations of Panel input via a special menu item in the main Panel menu. Users who are logged into the Panel can access the content, which they can call directly in the Panel by clicking on the *question-mark-icon* in the Panel menu on the left, which is highlighted in white in the above visible image.

Due to changes in Kirby version **5.0**, the *previously* created versions of this plugin are no longer usable, which I used on all websites I developed before to provide detailed input help in the Panel. Therefore, I have created a new plugin version that is compatible with Kirby version 5.x and possibly higher versions.

This plugin displays the contents of the Helpsection on *multilingual websites* in the current **input language** of the Panel user in the panel, if this language is available in the content at "**/content/helpsection**". When the input language is changed, the user usually has to refresh the help section.

Installation
------------

[](#installation)

### Download

[](#download)

[Download](https://github.com/heineref/kirby-helpsection/archive/master.zip) the contents of this repository as Zip file.

Rename the **extracted** folder to `heineref_helpsection` and copy it into the `site/plugins/` directory in your Kirby project. If it does not exist, create a new directory `site/plugins/` first. This file `README.md` therefore receives the path `site/plugins/heineref_helpsection/README.md`.

### Composer

[](#composer)

```
composer require heineref/kirby-helpsection

```

### Git submodule

[](#git-submodule)

If you have used git in your project before:

```
git submodule add https://github.com/heineref/kirby-helpsection.git site/plugins/heineref_helpsection

```

Setup
-----

[](#setup)

Copy the example structure in [examples/content](examples/) to your content folder.

It looks like:

```
content
  helpsection
    docindex.txt
    1_overview
      cheatsheet.txt
      1_kirby
        cheatsheet_info.txt
      2_another-info
        cheatsheet_info.txt
    2_details
      cheatsheet.txt
      1_intro
        cheatsheet_item.txt
      2_formats
        cheatsheet_item.txt
        0_bold
          cheatsheet_item.txt
        0_headlines
          cheatsheet_item.txt
        0_link
          cheatsheet_item.txt

```

After the copy you can edit the content of the help pages (add, change, move or delete every help page or change their content or title) while logged in to the Panel with the "**admin**" role (look at "*options: read*" and "*options: update*" of the blueprint file `site/plugins/heineref_helpsection/blueprints/docindex.yml` and the other blueprints of this Plugin). If you want/need to change these permissions, copy these blueprints to the path “site/blueprints/pages” and change them there so that they remain unchanged when this plugin is updated.

Edit the pages in the Panel at "**/helpsection**" (an *unlisted* page).

### Hint

[](#hint)

It may be, that you have to make changes in the blueprint file "**`site/blueprints/site.yml`**" to show the **unlisted** page "**/helpsection**" with the blueprint **docindex.yml** at the dashboard (start page) of the Panel, e.g. if you have started with the Kirby-Starterkit ().

Options
-------

[](#options)

All options require **`HeinerEF.helpsection.`** as prefix.

**`contentfolder`**

- default: `helpsection`
- the content of this folder is loaded into the help view of the Panel

Requirements
------------

[](#requirements)

This plugin was built using **Kirby 5.x**.

It will not work on earlier versions. Therefor look at

Disclaimer
----------

[](#disclaimer)

This plugin is provided "**as is**" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment.

License
-------

[](#license)

[MIT](LICENSE.md)

It is not permitted to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any form of hate speech.

Credits
-------

[](#credits)

- [Bastian Allgeier](https://github.com/bastianallgeier) for the kirby reference page
- [Christian Zehetner](https://github.com/amteich/kirby-helpsection) for this plugin (for Kirby 3.x)
- [Nico Hoffmann](https://github.com/distantnative) for his help, how to update the k3-plugin to Kirby 5.x

###  Health Score

16

—

LowBetter than 4% of packages

Maintenance41

Moderate activity, may be stable

Popularity0

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity13

Early-stage or recently created project

 Bus Factor1

Top contributor holds 53.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/219549291?v=4)[HeinerEF](/maintainers/HeinerEF)[@HeinerEF](https://github.com/HeinerEF)

---

Top Contributors

[![seehat](https://avatars.githubusercontent.com/u/818248?v=4)](https://github.com/seehat "seehat (42 commits)")[![HeinerEF](https://avatars.githubusercontent.com/u/219549291?v=4)](https://github.com/HeinerEF "HeinerEF (32 commits)")[![afbora](https://avatars.githubusercontent.com/u/3393422?v=4)](https://github.com/afbora "afbora (2 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")[![gearsdigital](https://avatars.githubusercontent.com/u/965069?v=4)](https://github.com/gearsdigital "gearsdigital (1 commits)")

---

Tags

heinerefhelphelpsectionkirby-cmskirby-pluginkirby5panelpanel-help

### Embed Badge

![Health badge](/badges/heineref-kirby-helpsection/health.svg)

```
[![Health](https://phpackages.com/badges/heineref-kirby-helpsection/health.svg)](https://phpackages.com/packages/heineref-kirby-helpsection)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)