This extension is a sitepackage, designed for the creation of user manuals. Administrators can easily create chapters by adding TYPO3 page records with a special doktype.
- Backend module with preview
- Associate individual chapters to TYPO3 records for easy access
- Directly open chapters in a modal while editing records
- PDF download
- Annotate screenshots with image editor: See bw_focuspoint_images
- TYPO3 system icons available in RTE: See bw_icons
- TYPO3 12+ & PHP 8.1+
composer require xima/xima-typo3-manualDownload the zip file from TYPO3 extension repository (TER).
This extension works like a sitepackege. You can configure it manually or use the installation wizard to create from a preset.
When opening the Manual modal the first time, you will be asked to create a new manual from a preset. This will create a new page tree with the necessary configuration:
- Start with creating a new page in the page tree
- Select Type "Manual page"
- Check "Use as Root Page"
- Include static PageTS "XIMA Manual"
- Create new Root-TypoScript template for this page and include static TypoScript of this extension
Create chapters by adding new pages with the doktype "Manual page":
Add content elements to the pages to fill the chapters:
You can link chapters to records by selecting the record types in the Related records tab of manual pages and text elements:
If manual elements are found while editing a record, a dropdown button will appear in the doc header. These links are opened in a modal:
- Link color and logo: Values of the backend are
used:
$GLOBALS['EXTENSIONS']['backend'] - Manual title: The
websiteTitleof the generated site configuration is used
You want to customize more? Open an issue or create a pull request!
Please have a look at CONTRIBUTING.md.
This project is licensed under GNU General Public License 2.0 (or later).