Download the PHP package heineref/kirby-helpsection without Composer

On this page you can find all versions of the php package heineref/kirby-helpsection. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package kirby-helpsection

Kirby Plugin: Helpsection

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

The Panel view may look like this:

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 can be called up 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

Download

Download 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

Git submodule

If you have used git in your project before:

Setup

Copy the example structure in examples/content to your content folder.

It looks like:

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

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 (https://github.com/getkirby/starterkit).

Options

All options require HeinerEF.helpsection. as prefix.

contentfolder

Requirements

This plugin was built using Kirby 5.x.

It will not work on earlier versions. Therefor look at https://github.com/amteich/kirby-helpsection

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

MIT

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

All versions of kirby-helpsection with dependencies

PHP Build Version
Package Version
Requires getkirby/composer-installer Version ^1.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package heineref/kirby-helpsection contains the following files

Loading the files please wait ...