PHPackages macopedia/typo3-interactive-tour - 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 & Helpers](/categories/utility) 4. / 5. macopedia/typo3-interactive-tour ActiveTypo3-cms-extension[Utility & Helpers](/categories/utility) macopedia/typo3-interactive-tour ================================ An interactive tour through the TYPO3 backend. v1.0.2(11mo ago)131.8k↓14.3%2[1 PRs](https://github.com/macopedia/typo3-interactive-tour/pulls)GPL-2.0-or-laterCSSCI passing Since Jun 16Pushed 11mo ago4 watchersCompare [ Source](https://github.com/macopedia/typo3-interactive-tour)[ Packagist](https://packagist.org/packages/macopedia/typo3-interactive-tour)[ RSS](/packages/macopedia-typo3-interactive-tour/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (3)Dependencies (5)Versions (5)Used By (0) TYPO3 Interactive Backend Tours =============================== [](#typo3-interactive-backend-tours) Introduction ------------ [](#introduction) This TYPO3 extension provides an interactive guide for new and existing backend users, offering step-by-step tours to familiarize them with the TYPO3 interface quickly. It originated as a community-selected project in the Community Budget Ideas Q1 2025 initiative. Main Goals ---------- [](#main-goals) - Help users (developers, integrators, editors) quickly learn TYPO3 backend functionalities - Allow extension developers to easily define their own interactive tours Key Features ------------ [](#key-features) FeatureDescriptionInteractive ToursShort, guided tours through different TYPO3 backend modules and features.YAML-Based ConfigurationEasy setup of tours and steps through YAML files (`Configuration/Tours`).Standalone and Module-Bound ToursTours can run automatically or when users access specific modules.ExtensibleDevelopers can define custom tours for their own extensions.Backend ModuleManage tours, view progress, manually start tours, and disable automatic tour launches through the Guide module (accessible via the Help group).Dashboard WidgetQuickly view tour completion progress and access the Guide module.Integration ----------- [](#integration) Uses [Driver.js](https://driverjs.com) as a core library for rendering tooltips and tour popups. Custom solutions were developed to handle TYPO3's iframe-based module rendering. (Special thanks to Mateusz Gdula, Macopedia!) Usage ----- [](#usage) First, install the extension via Composer: ``` composer req macopedia/typo3-interactive-tour ``` This single step should be sufficient to get the extension up and running. After installation, tours will start automatically when the related modules are accessed (provided that any defined tour permissions are met). The list of all available tours can be found in the `Guide` module, accessible via the `Help` section in the top bar. Please note that you must have the appropriate access permissions to view this module. Creating Your Own Tours ----------------------- [](#creating-your-own-tours) This package allows you to create interactive tours for the TYPO3 backend by defining them in YAML files. To create a custom tour, simply add a YAML file in your package's `Configuration/Tours/` directory with a structure similar to the example below: ``` identifier: vendor/sampleTour title: "LLL:EXT:vendor-sample-tour/Resources/Private/Language/locallang.xlf:tour.vendor.sampleTour.title" description: "LLL:EXT:vendor-sample-tour/Resources/Private/Language/locallang.xlf:tour.vendor.sampleTour.description" moduleName: "web_layout" isStandalone: false steps: - title: "Welcome" content: "Welcome to the TYPO3 backend tour. This step introduces the main interface." target: "#welcome-section" side: "top" align: "center" - title: "LLL:EXT:vendor-sample-tour/Resources/Private/Language/locallang.xlf:tour.vendor.sampleTour.step2.title" content: "LLL:EXT:vendor-sample-tour/Resources/Private/Language/locallang.xlf:tour.vendor.sampleTour.step2.content" target: ".navigation-menu" side: "right" align: "center" events: onShow: - event: "click" target: ".nav-item" delayAfter: 200 onExit: - event: "click" target: ".nav-item" ``` Define one tour per YAML file. The tour `identifier` should be unique and follow the format `vendor/tourName`. For a list of all available tour, step and event options, please refer to the documentation. Documentation ------------- [](#documentation) Detailed documentation covers configuration options, tour setup, and usage guidance. It is available in the documentation section of this repository. Contributing ------------ [](#contributing) We welcome contributions to this project! If you have ideas, bug fixes, or enhancements, please submit a pull request or open an issue on the GitHub repository.\\ If you would like to help to translate the extension into your language, you can either: - Create a pull request with your translation files in the `Resources/Private/Language/` directory - Visit our project on [Crowdin](https://crowdin.com/project/typo3-extension-interactive-to) and contribute translations there Known Issues ------------ [](#known-issues) Determining the relevance of tour steps based on user permissions and visibility is challenging due to TYPO3's flexibility. A deeper integration and permission-checking logic may be needed, pending discussions with TYPO3 core developers. More explicit element identifiers would simplify tour creation and reliability. Future Plans ------------ [](#future-plans) We aim to integrate this functionality into TYPO3 core or an official TYPO3 vendor extension. Special Thanks -------------- [](#special-thanks) Thank you to the TYPO3 community for supporting this initiative through the Community Budget Ideas Q1 2025, and to everyone who provided invaluable feedback and assistance! **Enjoy creating your interactive TYPO3 backend tours!** ### Health Score 36 — LowBetter than 82% of packages Maintenance52 Moderate activity, may be stable Popularity28 Limited adoption so far Community14 Small or concentrated contributor base Maturity40 Maturing project, gaining track record Bus Factor1 Top contributor holds 80% 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 ~0 days Total 3 Last Release 336d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/e44feab70b3b53b27178be962a8b5474af354f85292f2a662f015f022fdd3c11?d=identicon)[tmotyl](/maintainers/tmotyl) --- Top Contributors [![soee](https://avatars.githubusercontent.com/u/1798417?v=4)](https://github.com/soee "soee (16 commits)")[![EvilBMP](https://avatars.githubusercontent.com/u/540478?v=4)](https://github.com/EvilBMP "EvilBMP (2 commits)")[![tmotyl](https://avatars.githubusercontent.com/u/515397?v=4)](https://github.com/tmotyl "tmotyl (2 commits)") --- Tags interactivecmsmodulesbackendtutorialguidetypo3tourwalkthrough ### Code Quality Code StylePHP CS Fixer ### Embed Badge ![Health badge](/badges/macopedia-typo3-interactive-tour/health.svg) ``` [![Health](https://phpackages.com/badges/macopedia-typo3-interactive-tour/health.svg)](https://phpackages.com/packages/macopedia-typo3-interactive-tour) ``` ### Alternatives [typo3/cms-composer-installers TYPO3 CMS Installers 6113.7M52](/packages/typo3-cms-composer-installers)[koninklijke-collective/my-redirects TYPO3 Extension: Redirects management 17152.4k](/packages/koninklijke-collective-my-redirects)[codingfreaks/cf-cookiemanager Manage cookies, scripts, and GDPR compliance on your Typo3 website with CodingFreaks Typo3 Cookie Manager. Customize cookie banners, streamline workflow, and enhance user experience. Ensure GDPR compliance and take control of cookie management with our Typo3 cookie management extension. Visit the official Typo3 Documentation page to learn more. 1625.8k](/packages/codingfreaks-cf-cookiemanager)[t3kit/theme-t3kit Base Theme fot t3kit project 2410.2k](/packages/t3kit-theme-t3kit)[3m5/typo3-enhanced-backend Improves the user experience (UI/UX), provides customization options for editors and enhances the look and feel of TYPO3 backend. 105.1k](/packages/3m5-typo3-enhanced-backend) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)