PHPackages                             norvutec/userguide - 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. norvutec/userguide

ActiveSymfony-bundle[Utility & Helpers](/categories/utility)

norvutec/userguide
==================

Tool for creating userguides for your application inside of the page.

1.0.1(1y ago)059proprietaryPHPPHP >=8.2

Since Sep 3Pushed 1y ago1 watchersCompare

[ Source](https://github.com/NorvuTec/userguide)[ Packagist](https://packagist.org/packages/norvutec/userguide)[ Docs](https://norvutec.de)[ RSS](/packages/norvutec-userguide/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (11)Versions (3)Used By (0)

UserGuide Bundle
================

[](#userguide-bundle)

Bundle for Symfony for creating user guides inside your application.
The user guides are displayed inside the application inside the template.

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

[](#requirements)

The bundle requires assets to be installed in the public directory.

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

[](#installation)

1. Install the bundle using composer

```
composer require norvutec/userguide
```

2. Add the bundle to the kernel (if not using symfony/flex)

```
// config/bundles.php
return [
    // ...
    Norvutec\UserguideBundle\NorvutecUserguideBundle::class => ['all' => true],
];
```

3. Add the styles and scripts to your template

```
{% block stylesheets %}
    {{ parent() }}

{% endblock %}

{% block javascripts %}
    {{ parent() }}
    {{ userGuideJavascript() }}
{% endblock %}
```

4. Add user guide classes to your application

```
class InvoiceFormUserGuide extends UserGuide {

    public function name(): string
    {
        return "invoiceform";
    }

    public function configure(UserGuideBuilder $builder): void {
        $builder
            ->route("app_accounting_invoice_new") # Main Route for the guide
            ->alternateRoute("app_accounting_invoice_edit") # Alternate Route for the guide
            ->add("[id$=form_invoiceNo]", "Insert Number of invoice here") # Add a step to the guide
            ->add("[id$=form_customer]", "Select customer here"); # Add a step to the guide
    }
}
```

> The `add(Selector, Content, Options)`-Method have to be called in the correct order for the guide. The `Selector` is a javascript selector to select the element in the DOM. You can use all available syntaxes for `querySelector`. The guide will use the first element found for the steps link.

5. Include start button inside of your template (optional) (TODO)

```
{{ userGuideButton() }}
```

Configuration / Overrides
-------------------------

[](#configuration--overrides)

### Path Security

[](#path-security)

The user guide bundle contains a path for listing all available user guides. This path is not secured by default.
All routes are starting with `/userguide/` and are named with `userguide_`.

### Templates

[](#templates)

`javascript_loader.html.twig` Holds the Script-Tag for the userguide.js and the auto-continue of the userguide. (Loaded by `userGuideJavascript()`)
`tooltip.html.twig` Is the displayed tooltip of the userguide

### Styles

[](#styles)

All styles are located in the `css/userguide.css` file. Just override the styles in your own css file.
Alternatively you can override the template and include your own styles.

TODO INFOS FÜR MICH
===================

[](#todo-infos-für-mich)

endswith: \[id$=foo\] startswith\[id^=foo\]

override tooltip.html.twig

###  Health Score

29

—

LowBetter than 57% of packages

Maintenance40

Moderate activity, may be stable

Popularity8

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~124 days

Total

2

Last Release

543d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1498099?v=4)[CosmoHDx](/maintainers/cosmohdx)[@cosmohdx](https://github.com/cosmohdx)

---

Top Contributors

[![cosmohdx](https://avatars.githubusercontent.com/u/1498099?v=4)](https://github.com/cosmohdx "cosmohdx (41 commits)")

### Embed Badge

![Health badge](/badges/norvutec-userguide/health.svg)

```
[![Health](https://phpackages.com/badges/norvutec-userguide/health.svg)](https://phpackages.com/packages/norvutec-userguide)
```

###  Alternatives

[kimai/kimai

Kimai - Time Tracking

4.8k9.0k1](/packages/kimai-kimai)[easycorp/easyadmin-bundle

Admin generator for Symfony applications

4.3k17.9M388](/packages/easycorp-easyadmin-bundle)[2lenet/crudit-bundle

The easy like Crud'it Bundle.

1616.4k14](/packages/2lenet-crudit-bundle)[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.5k5.9M737](/packages/sylius-sylius)[oro/platform

Business Application Platform (BAP)

645143.5k115](/packages/oro-platform)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

585.6M574](/packages/shopware-core)

PHPackages © 2026

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