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.

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

  1. Install the bundle using composer

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

  3. Add the styles and scripts to your template

  4. Add user guide classes to your application

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.

  1. 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

PHP Build Version
Package Version
Requires php Version >=8.2
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
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 norvutec/userguide contains the following files

Loading the files please wait ....