xima/xima-typo3-manual

TYPO3 extension to create editor manuals right in the TYPO3 backend.

1.3.2 2024-10-28 10:37 UTC

Requires

• php: ^8.1
• ext-dom: *
• ext-fileinfo: *
• ext-simplexml: *
• blueways/bw-focuspoint-images: ^4.0
• blueways/bw-icons: dev-12.x-dev || ^3.0.0
• dompdf/dompdf: ^2.0 || ^3.0
• typo3/cms-core: ^12.4
• typo3/cms-rte-ckeditor: ^12.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.52
• helmich/typo3-typoscript-lint: ^3.2
• roave/security-advisories: dev-latest
• saschaegerer/phpstan-typo3: ^1.10
• symfony/translation: ^6.3 || ^7.0
• typo3/cms-base-distribution: ^12.4

GPL-2.0-or-later

• Maik Schneider

README

TYPO3 extension xima_typo3_manual

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.

Features

• 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

Requirements

• TYPO3 12.4 & PHP 8.1+

Installation

Composer

composer require xima/xima-typo3-manual

TER

Download the zip file from TYPO3 extension repository (TER).

Configuration

This extension works like a sitepackege. You can configure it manually or use the installation wizard to create from a preset.

From 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:

Manual 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

Usage

Create a new chapter

Create chapters by adding new pages with the doktype "Manual page":

Add content elements to the pages to fill the chapters:

Link chapters to records

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:

Customization

• Link color and logo: Values of the backend are used: $GLOBALS['EXTENSIONS']['backend']
• Manual title: The websiteTitle of the generated site configuration is used

You want to customize more? Open an issue or create a pull request!

License

This project is licensed under GNU General Public License 2.0 (or later).