|Last Updated|| ||Ratings|| ||Unique User Downloads|| ||Download Rankings|
|2022-09-22 (6 months ago) ||Not yet rated by the users||Total: 66 ||All time: 10,167 This week: 171|
This package can display pages of a user guide using templates.
It provides classes to render HTML pages from templates using the Smarty package.
The package also generates HTML for menus that allow users to navigate through different pages of the guide using links that point to the same PHP script that causes all the pages of the user guide but uses different templates to define the content of each page of the guide.
|Documentation is important for projects of any kind to help users learn how to use those projects when they do not know how to use them or have doubts.
A good practice to provide project documentation is to have a user guide that presents all the aspects that may be useful for the project users.
This package provides a solution to help users of any project to generate documentation from templates.
It also allows the definition of navigation menus that configure the package to provide the structure to render the different parts of the project user guide.
Web User Manual
This is a very simple application that allows you to quickly create and modify your product's user manual.
Written in PHP, it provides an responsible interface for creating pages based on CSS style sheets using Smarty PHP.
Apache with PHP 7.1 to 8.1
How to get working
Install apache and php.
Clone this project:
To get the latest stable version:
git clone firstname.lastname@example.org:vmsouza/userguide.git
Access userguide folder and run:
$ cd userguide
$ git clone https://github.com/smarty-php/smarty.git
$ mkdir templates_c
$ chmod a+rwx templates_c
Edit config.php to change default settings.
Manage you menu items
Edit menus.php to change menu items.
Edit templates locate inside templates folder.
See in action
User guide running here.
||Applications that use this package
No pages of applications that use this class were specified.
If you know an application of this package, send a message to the author to add a link here.