PHP download

Download the PHP package kuriousagency/craft-user-manual without Composer

On this page you can find all versions of the php package kuriousagency/craft-user-manual. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download kuriousagency/craft-user-manual
More information about kuriousagency/craft-user-manual
Files in kuriousagency/craft-user-manual

Vendor kuriousagency
Package craft-user-manual
Short Description Craft User Manual allows developers (or even content editors) to provide CMS documentation using Craft's built-in sections (singles, channels, or structures) to create a `User Manual` or `Help` section directly in the control panel.
License MIT

Keywords cms Craft craftcms craft-plugin usermanual

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 craft-user-manual

Craft User Manual plugin for Craft CMS 3.x

Craft User Manual allows developers (or even content editors) to provide CMS documentation using Craft's built-in sections (singles, channels, or structures) to create a "User Manual" or "Help" section directly in the control panel.

Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.

Installation

To install the plugin, follow these instructions.

Open your terminal and go to your Craft project:
```
cd /path/to/project
```

Then tell Composer to load the plugin:

composer require kuriousagency/craft-user-manual

In the Control Panel, go to Settings → Plugins and click the “Install” button for usermanual.
Select the section the plugin should use as the User Manual page in the CP.
- (Optional) - Replace the plugin's name to something your user's will understand.
- (Optional) - Use more than the default body fieldhandle by setting up custom template overrides.
Click the User Manual link in the CP nav.

Configuration

All settings may be optionally configured using a config file. The values, contained in config.php, are described below:

pluginNameOverride

Intuitive, human-readable plugin name for the end user.

templateOverride

For more control over the output, you may optionally override the default template.

Path is relative to ../craft/templates/.

section

Entries in this section must have associated urls.

Some notes

The plugin currently only pulls in the body field from each entry in the selected section, unless you're using a template override.
While the User Manual section works best with Structures, you can certainly get away with using a one-off Single.
If you're running Craft Client or Craft Pro make sure your content editors don't have permission to edit whatever section you've selected to use as your User Manual
Only sections with entry URLs may be used as your User Manual section.

Thanks

This plugin was inspired by the team over at 70kft for their work on Craft-Help. While their plugin is definitely more flexible in terms of writing custom markdown in separate files, we wanted to create something that would make it easier for anyone to edit documentation without making any changes to the server. This works particularly well for larger projects where more than one person (especially non-devs) are writing documentation for how to use the CMS.

Releases

2.0.1 - Merging in @mgburns fix for deprecation warnings.
2.0.0 - Merging in @jcdarwin's Craft3 port. Craft3 version of Craft User Manual.
1.1.1 - Adding in RTL language support
1.1.0 - Merging in @timkelty's work which includes template overrides, updated error prompts, and other misc improvements
1.0.1 - Adding support for plugin custom icons in Craft 2.5
1.0.0 - Initital release of Craft User Manual.

We hope this plugin is useful, and we'd love to hear any suggestions or issues you may have. @erskinerob.

Brought to you by Rob Erskine

All versions of craft-user-manual with dependencies

PHP Build Version

Package Version

Version 3.0.0 Release 28. Jun 2024
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of craft-user-manual from vendor kuriousagency

Requires craftcms/cms Version ^4.0.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 kuriousagency/craft-user-manual contains the following files

Loading the files please wait ....