PHP Classes

PHP User Guide: Display pages of a user guide using templates

Recommend this page to a friend!
  Info   View files Documentation   Screenshots Screenshots   View files View files (40)   DownloadInstall with Composer Download .zip   Reputation   Support forum (1)   Blog (1)    
Last Updated Ratings Unique User Downloads Download Rankings
2022-09-22 (2 months ago) RSS 2.0 feedNot yet rated by the usersTotal: 62 This week: 6All time: 10,181 This week: 135Up
Version License PHP version Categories
userguide 1.0.0GNU General Publi...5HTML, PHP 5, Content management, Temp...
Description Author

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.

Innovation Award
PHP Programming Innovation award nominee
September 2022
Number 5
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.

Manuel Lemos
Picture of Vinicius Marques de Souza
Name: Vinicius Marques de ... <contact>
Classes: 2 packages by
Country: Brazil Brazil
Age: 46
All time rank: 4368350 in Brazil Brazil
Week rank: 27 Up2 in Brazil Brazil Up
Innovation award
Innovation award
Nominee: 2x

Winner: 1x

Details

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.

Requirements

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 git@github.com: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

Manage settings

Edit config.php to change default settings.

Manage you menu items

Edit menus.php to change menu items.

Manage templates

Edit templates locate inside templates folder.

See in action

User guide running here.

Screenshots  
  • homepage
  • mainpage
  • submenu
  • syntax1
  • syntax2
  Files folder image Files  
File Role Description
Files folder imageassets (3 directories)
Files folder imageclass (2 files)
Files folder imagetemplates (21 files)
Accessible without login Plain text file config.php Conf. Auxiliary script
Accessible without login Plain text file index.php Appl. Application script
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file menus.php Appl. Application script
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  assets  
File Role Description
Files folder imagecss (4 files)
Files folder imagefonts (3 files)
Files folder imagejs (5 files)

  Files folder image Files  /  assets  /  css  
File Role Description
  Accessible without login Plain text file bootstrap.min.css Data Auxiliary data
  Accessible without login Plain text file plugin.css Data Auxiliary data
  Accessible without login Plain text file responsive.css Data Auxiliary data
  Accessible without login Plain text file style.css Data Auxiliary data

  Files folder image Files  /  assets  /  fonts  
File Role Description
  Accessible without login Plain text file fa-brands-400.svg Data Auxiliary data
  Accessible without login Plain text file fa-regular-400.svg Data Auxiliary data
  Accessible without login Plain text file fa-solid-900.svg Data Auxiliary data

  Files folder image Files  /  assets  /  js  
File Role Description
  Accessible without login Plain text file bootstrap.min.js Data Auxiliary data
  Accessible without login Plain text file jquery.js Data Auxiliary data
  Accessible without login Plain text file main.js Data Auxiliary data
  Accessible without login Plain text file plugin.js Data Auxiliary data
  Accessible without login Plain text file popper.min.js Data Auxiliary data

  Files folder image Files  /  class  
File Role Description
  Plain text file Menu.class.php Class Class source
  Plain text file Page.class.php Class Class source

  Files folder image Files  /  templates  
File Role Description
  Accessible without login Plain text file about.tpl Data Auxiliary data
  Accessible without login Plain text file body.tpl Data Auxiliary data
  Accessible without login Plain text file breadcrumb.tpl Data Auxiliary data
  Accessible without login Plain text file copyright.tpl Data Auxiliary data
  Accessible without login Plain text file disclaimer.tpl Data Auxiliary data
  Accessible without login Plain text file footer.tpl Data Auxiliary data
  Accessible without login Plain text file header.tpl Data Auxiliary data
  Accessible without login Plain text file index.tpl Data Auxiliary data
  Accessible without login Plain text file manual-menu.tpl Data Auxiliary data
  Accessible without login Plain text file menu.tpl Data Auxiliary data
  Accessible without login Plain text file privacy.tpl Data Auxiliary data
  Accessible without login Plain text file syntax.tpl Data Auxiliary data
  Accessible without login Plain text file topic1.download.tpl Data Auxiliary data
  Accessible without login Plain text file topic1.intro.tpl Data Auxiliary data
  Accessible without login Plain text file topic1.tpl Data Auxiliary data
  Accessible without login Plain text file topic1.updates.tpl Data Auxiliary data
  Accessible without login Plain text file topic2.intro.tpl Data Auxiliary data
  Accessible without login Plain text file topic2.item1.tpl Data Auxiliary data
  Accessible without login Plain text file topic2.item2.tpl Data Auxiliary data
  Accessible without login Plain text file topic2.submenu.tpl Data Auxiliary data
  Accessible without login Plain text file topic2.tpl Data Auxiliary data

 Version Control Unique User Downloads Download Rankings  
 88%
Total:62
This week:6
All time:10,181
This week:135Up