PHP Classes

PHP Online Help System: Get site help topics from file defined with macros

Recommend this page to a friend!
     
  Info   View files Files   Install with Composer Install with Composer   Download Download   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
StarStarStar 50%Total: 284 All time: 7,565 This week: 131Up
Version License PHP version Categories
php-help 1.0GNU General Publi...5.1.2PHP 5, Content management, Templates
Description 

Author

Mark Cole

This class can get site help topics from file defined with macros.

It can parse a help file that contains multiple help text for different site topics.

The class can extract specific topics as HTML by processing the macros replacing values defined by user defined variables, calling given callback functions, and including snippets and external files specified in the help file.

Innovation Award
PHP Programming Innovation award nominee
June 2014
Number 2		 Many sites offer contextual help to the users by providing explanations of the context based on topics.

This class provides a solution to extract topical help information from help files that use specific macro language.

The class can process the help file and rendered topic information as HTML pages.

Manuel Lemos
Picture of Mark Cole
  Performance   Level  
Name: Mark Cole <contact>
Classes: 1 package by
Country: United Kingdom

Level 1 Star

 Innovation award
Innovation award
Nominee: 1x

  Files folder image Files (6)  
File Role Description
Accessible without login Plain text file helpdocs.php Example Example code displays PHPHelp Documentation
Accessible without login Plain text file LICENCE.TXT Lic. GNU Licence
Plain text file phphelp.class.php Class PHP Help Class
Accessible without login Plain text file phphelp.hxt Doc. Documentation in the form of a PHPHelp help file.
Accessible without login Plain text file phphelp.txt Doc. Plain text documentation
Accessible without login Plain text file snippets.txt Data Snippets file (part of example)

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.
Install with Composer Install with Composer
Downloadphp-help-2014-05-26.zip 46KB
Downloadphp-help-2014-05-26.tar.gz 43KB
Install with ComposerInstall with Composer
 Version Control Unique User Downloads Download Rankings  
 0%
Total:284
This week:0
All time:7,565
This week:131Up
 User Ratings  
 
 All time
Utility:62%StarStarStarStar
Consistency:62%StarStarStarStar
Documentation:62%StarStarStarStar
Examples:62%StarStarStarStar
Tests:-
Videos:-
Overall:50%StarStarStar
Rank:2754
  

  Applications that use this package  
No pages of applications that use this class were specified.

Add link image If you know an application of this package, send a message to the author to add a link here.