Download the PHP package macopedia/typo3-interactive-tour without Composer

On this page you can find all versions of the php package macopedia/typo3-interactive-tour. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package typo3-interactive-tour

TYPO3 Interactive Backend Tours

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

Key Features

Feature Description
Interactive Tours Short, guided tours through different TYPO3 backend modules and features.
YAML-Based Configuration Easy setup of tours and steps through YAML files (Configuration/Tours).
Standalone and Module-Bound Tours Tours can run automatically or when users access specific modules.
Extensible Developers can define custom tours for their own extensions.
Backend Module Manage tours, view progress, manually start tours, and disable automatic tour launches through the Guide module (accessible via the Help group).
Dashboard Widget Quickly view tour completion progress and access the Guide module.

Integration

Uses Driver.js 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

First, install the extension via Composer:

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

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:

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

Detailed documentation covers configuration options, tour setup, and usage guidance.\ It is available in the documentation section of this repository.

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:

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

We aim to integrate this functionality into TYPO3 core or an official TYPO3 vendor extension.

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!

All versions of typo3-interactive-tour with dependencies

PHP Build Version
Package Version
Requires symfony/http-foundation Version *
typo3/cms-lowlevel Version ^13
typo3/cms-setup Version ^13
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package macopedia/typo3-interactive-tour contains the following files

Loading the files please wait ....