Ext: sg_documentation

License: GNU GPL, Version 2

Repository: https://gitlab.sgalinski.de/typo3/sg_documentation

Please report bugs here: https://gitlab.sgalinski.de/typo3/sg_documentation

TYPO3 version: >7.6

About

The extension sg_documentation provides the possibility to read the documentations of used extensions in the TYPO3 Backend. by augmenting the Help section with a User Documentation button, which opens the project documentation. The actual documentation is generated from Markdown files which are located in the Resources directory of sg_documentation.

Backend

You need to click on the help icon in the TYPO3 backend to open a new menu. In this menu you find the option User Documentation, which will open the rendered markdown file.

Usage

If you want to extend the documentation for the backend users you can simply write new documentation in Markdown or reference the new documentation in the default Markdown file README.md.

If you want to extend the documentation for the backend users you can simply write new documentation in Markdown or reference the new documentation in the default Markdown file README.md.

You can find the default Markdown file in the Folder `Resources/Private/Markdown/` of the sg_documentation extension.

Reference Markdown from a Git repository

The sg_documentation is able to link to a Git repository and dynamically retrieve the README.md Markdown from the master branch. The repository itself must be hosted on the sgalinski gitlab server.

To retrieve the Markdown, you need to supply the following in the plugin settings:

Reference other Markdown

  • Link to the Git repository (i.e. )
  • Git username
  • Git password

Reference other Markdown

sg_documentation is able to link other markdown files and render them. For this you have to use a special notation in your Markdown:

[Link name]{Link/to/the/markdown.md}

Now it can happen that you don't have the Markdown file in the subfolder of `Resources/Private/Markdown/`, but in another extension, then you can write the link like this:

[Link name]{EXT:extension_key/Path/to/the/markdown.md}

Or if you want to link to an external Markdown link, then you can set the additional atribute `absolute`:

[cebe markdown]{https://raw.githubusercontent.com/cebe/markdown/master/README.md|absolute=1}

Include other Markdown

This extension is able to include other markdown file content within the current markdown. For this you have to use a special marker:

{include=Link/to/the/markdown.md}

In case of lists you can specify the level depth where the content will be included, using an integer parameter in the include marker representing the list level:

* List Item 1
* List Item 2
  * Sublist Item 1
  {include=Link/to/the/list1.md|1}
  * Sublist Item 2
    * Sublist Item 3
    {include=Link/to/the/list2.md|2}

Extension Menu

In your markdown files you can also include a loaded extension menu by using this marker:

{extensionMenu}

The list level parameter mentioned above can also be applied to this marker:

* Link Item 1
* Link Item 2
  * Sublist Item 1
  {extensionMenu|1}
  * Sublist Item 2
    * Sublist Item 3
    {extensionMenu|2}

Acknowledgement

We use the markdown parser of Carsten Brandt. So we would like to thank him for providing this nice PHP library.

A super fast, highly extensible markdown parser for PHP