PHPackages                             xima/xima-typo3-manual - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. xima/xima-typo3-manual

ActiveTypo3-cms-extension[Utility &amp; Helpers](/categories/utility)

xima/xima-typo3-manual
======================

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

2.0.5(5mo ago)516.1k—9%3[8 PRs](https://github.com/xima-media/xima-typo3-manual/pulls)GPL-2.0-or-laterPHPPHP ^8.2CI passing

Since Oct 20Pushed 2mo ago5 watchersCompare

[ Source](https://github.com/xima-media/xima-typo3-manual)[ Packagist](https://packagist.org/packages/xima/xima-typo3-manual)[ Docs](https://www.xima.de)[ RSS](/packages/xima-xima-typo3-manual/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (18)Versions (56)Used By (0)

[![Extension icon](Resources/Public/Icons/Extension.svg)](Resources/Public/Icons/Extension.svg)

TYPO3 extension `xima_typo3_manual`
===================================

[](#typo3-extension-xima_typo3_manual)

[![Latest version](https://camo.githubusercontent.com/ebd18eaea13874d4849cb7817213189b2e74510a78d04cc76d8d02cabee81e3a/68747470733a2f2f7479706f332d6261646765732e6465762f62616467652f78696d615f7479706f335f6d616e75616c2f76657273696f6e2f736869656c64732e737667)](https://camo.githubusercontent.com/ebd18eaea13874d4849cb7817213189b2e74510a78d04cc76d8d02cabee81e3a/68747470733a2f2f7479706f332d6261646765732e6465762f62616467652f78696d615f7479706f335f6d616e75616c2f76657273696f6e2f736869656c64732e737667)[![Supported TYPO3 versions](https://camo.githubusercontent.com/8709e91513ea903f85cc9ac714b61d7665147815739014d2bf2b61d1b7d097eb/68747470733a2f2f7479706f332d6261646765732e6465762f62616467652f78696d615f7479706f335f6d616e75616c2f7479706f332f736869656c64732e737667)](https://extensions.typo3.org/extension/xima_typo3_manual)[![Total downloads](https://camo.githubusercontent.com/03686595c2f0c8fe962d64bc7784f2224eef2a064bd51cad757cfc149c5e1204/68747470733a2f2f7479706f332d6261646765732e6465762f62616467652f78696d615f7479706f335f6d616e75616c2f646f776e6c6f6164732f736869656c64732e737667)](https://camo.githubusercontent.com/03686595c2f0c8fe962d64bc7784f2224eef2a064bd51cad757cfc149c5e1204/68747470733a2f2f7479706f332d6261646765732e6465762f62616467652f78696d615f7479706f335f6d616e75616c2f646f776e6c6f6164732f736869656c64732e737667)[![Composer](https://camo.githubusercontent.com/12b3d5b58f8d10461387b32b056033b6a3e99311a995ece442e2866adff4e2ca/68747470733a2f2f7479706f332d6261646765732e6465762f62616467652f78696d615f7479706f335f6d616e75616c2f636f6d706f7365722f736869656c64732e737667)](https://packagist.org/packages/xima/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.

[![Backend Preview](./Documentation/Images/backend_preview.png)](./Documentation/Images/backend_preview.png)

Features
--------

[](#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](https://extensions.typo3.org/extension/bw_focuspoint_images)
- TYPO3 system icons available in RTE: See [bw\_icons](https://extensions.typo3.org/extension/bw_icons)

Requirements
------------

[](#requirements)

- TYPO3 12+ &amp; PHP 8.1+

Installation
------------

[](#installation)

### Composer

[](#composer)

```
composer require xima/xima-typo3-manual
```

### TER

[](#ter)

[![TER version](https://camo.githubusercontent.com/ebd18eaea13874d4849cb7817213189b2e74510a78d04cc76d8d02cabee81e3a/68747470733a2f2f7479706f332d6261646765732e6465762f62616467652f78696d615f7479706f335f6d616e75616c2f76657273696f6e2f736869656c64732e737667)](https://extensions.typo3.org/extension/xima_typo3_manual)

Download the zip file from [TYPO3 extension repository (TER)](https://extensions.typo3.org/extension/xima_typo3_manual).

Configuration
-------------

[](#configuration)

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

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

[![Backend Topbar](./Documentation/Images/backend_topbar.png)](./Documentation/Images/backend_topbar.png)[![Backend Installation](./Documentation/Images/backend_installation.png)](./Documentation/Images/backend_installation.png)

### Manual 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
-----

[](#usage)

### Create a new chapter

[](#create-a-new-chapter)

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

[![Create_new_chapter](./Documentation/Images/usage_pagetree.png)](./Documentation/Images/usage_pagetree.png)

Add content elements to the pages to fill the chapters:

[![Add_content_elements](./Documentation/Images/usage_content_elements.png)](./Documentation/Images/usage_content_elements.png)

### Link chapters to records

[](#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:

[![Link_chapters_to_records](./Documentation/Images/backend_linking.png)](./Documentation/Images/backend_linking.png)

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:

[![Open_chapter_in_modal](./Documentation/Images/usage_dropdown.png)](./Documentation/Images/usage_dropdown.png)

Customization
-------------

[](#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

Contribute
----------

[](#contribute)

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

Please have a look at [`CONTRIBUTING.md`](CONTRIBUTING.md).

License
-------

[](#license)

This project is licensed under [GNU General Public License 2.0 (or later)](LICENSE.md).

###  Health Score

53

—

FairBetter than 97% of packages

Maintenance79

Regular maintenance activity

Popularity33

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity69

Established project with proven stability

 Bus Factor1

Top contributor holds 97.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~51 days

Recently: every ~42 days

Total

15

Last Release

164d ago

Major Versions

1.3.3 → v13.x-dev2025-06-16

PHP version history (2 changes)v1.0.0PHP ^8.2

v1.1.0PHP ^8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/04b105eb2ade5d364c2ae93a9a012d591594eaa3ad54d252db70856d1c293d5d?d=identicon)[m.schneider](/maintainers/m.schneider)

---

Top Contributors

[![maikschneider](https://avatars.githubusercontent.com/u/696865?v=4)](https://github.com/maikschneider "maikschneider (194 commits)")[![Jeggle-s](https://avatars.githubusercontent.com/u/38358202?v=4)](https://github.com/Jeggle-s "Jeggle-s (2 commits)")[![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4)](https://github.com/renovate[bot] "renovate[bot] (1 commits)")[![tgaertner](https://avatars.githubusercontent.com/u/2931506?v=4)](https://github.com/tgaertner "tgaertner (1 commits)")[![ysoxima](https://avatars.githubusercontent.com/u/74920396?v=4)](https://github.com/ysoxima "ysoxima (1 commits)")

---

Tags

typo3typo3-cms-extension

###  Code Quality

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/xima-xima-typo3-manual/health.svg)

```
[![Health](https://phpackages.com/badges/xima-xima-typo3-manual/health.svg)](https://phpackages.com/packages/xima-xima-typo3-manual)
```

###  Alternatives

[b13/assetcollector

Add CSS and SVG files and strings as inline style tag/inline svg to the html code.

10118.4k](/packages/b13-assetcollector)[mfd/ai-filemetadata

Automatically generates FAL metadata for files by means of public LLMs

1142.1k](/packages/mfd-ai-filemetadata)[mautic/mautic-typo3

Add-on TYPO3 extension that enhances the "EXT:marketing\_automation" TYPO3 extension by connecting it to the Mautic Marketing Automation platform: Determine "Persona" from Mautic segments. Also provides additional services e.g. language synchronisation between Mautic and TYPO3.

236.3k](/packages/mautic-mautic-typo3)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
