Download the PHP package norvutec/userguide without Composer
On this page you can find all versions of the php package norvutec/userguide. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download norvutec/userguide
More information about norvutec/userguide
Files in norvutec/userguide
Package userguide
Short Description Tool for creating userguides for your application inside of the page.
License proprietary
Homepage https://norvutec.de
Informations about the package userguide
UserGuide Bundle
Bundle for Symfony for creating user guides inside your application.
The user guides are displayed inside the application inside the template.
Requirements
The bundle requires assets to be installed in the public directory.
Installation
-
Install the bundle using composer
-
Add the bundle to the kernel (if not using symfony/flex)
-
Add the styles and scripts to your template
- Add user guide classes to your application
The
add(Selector, Content, Options)
-Method have to be called in the correct order for the guide. TheSelector
is a javascript selector to select the element in the DOM. You can use all available syntaxes forquerySelector
. The guide will use the first element found for the steps link.
- Include start button inside of your template (optional) (TODO)
Configuration / Overrides
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
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
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
endswith: [id$=foo] startswith[id^=foo]
override tooltip.html.twig
All versions of userguide with dependencies
symfony/console Version 7.*
symfony/flex Version ^2
symfony/form Version 7.*
symfony/framework-bundle Version 7.*
symfony/runtime Version 7.*
symfony/serializer Version 7.*
symfony/translation Version 7.*
symfony/twig-bundle Version 7.*
symfony/yaml Version 7.*
twig/extra-bundle Version ^2.12|^3.0
twig/twig Version ^2.12|^3.0