https://github.com/in2code-de/in2help

Show your online help as iframe included in the own TYPO3 backend
https://github.com/in2code-de/in2help

Last synced: 2 months ago
JSON representation

Show your online help as iframe included in the own TYPO3 backend

• Host: GitHub
• URL: https://github.com/in2code-de/in2help
• Owner: in2code-de
• Created: 2019-04-08T12:14:36.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2025-02-14T14:21:16.000Z (5 months ago)
• Last Synced: 2025-04-24T01:15:59.728Z (2 months ago)
• Language: PHP
• Size: 280 KB
• Stars: 1
• Watchers: 10
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Extension in2help

## What does it do?

The extension adds a module to the help section in the backend of

your installation. You can define a page ID, which is loaded into this module.

The idea is, that you can provide your editors an entry point, into the

editors documentation.

Basically you write the documentation about content elements and functions in

the backend and use the frontend rendering to display it.

## Screenshots

![screenshot_module.png](Documentation/Images/screenshot_module.png "Show a documentation in the backend of TYPO3")

## Configuration

The extension configuration can be set up in the extension configuration.

Options:

* PID of help page: basic.helpPid (int+) -> the PID of the page which

contains the documentation.

## Tips

### Adjust page rendering

In order to provide the best experience for your editors, you should try to keep

the header of your layout small. You could hide elements, which are just

ornaments.

### Provide user / page TS to set this module as starting point

You can set up PageTS or UserTS to force users, to get this module as start

module.

setup.override.startModule = web_in2help

## Changelog

| Version   | Date       | State  | Description                                            |

|-----------|------------|--------|--------------------------------------------------------|

| 7.0.1     | 2024-10-02 | Bugfix | Make module accessible for normal editors              |

| 7.0.0     | 2023-02-27 | Task   | Release for TYPO3 v12                                  |

| 6.0.1     | 2022-06-23 | Bugfix | Remove vendor name from registerModule                 |

| 6.0.0 !!! | 2022-06-23 | Task   | Support for TYPO3 11 and 10 (9 is dropped now)         |

| 5.0.1     | 2021-05-19 | Task   | Add github workflow; add extensionkey to composer.json |

| 5.0.0     | 2020-04-24 | Task   | Release for TYPO3 10.4                                 |

| 4.0.0     | 2019-04-08 | Task   | Release for TYPO3 9.5                                  |

## Breaking changes

### Updating fom earlier versions to 6

We just changed the configuration key in LocalConfiguration.php from `designPatternPid` to `helpPid` because this

extension is used to show documentations while it was once created to show a designPattern.