PHP Classes
elePHPant
Icontem

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

Recommend this page to a friend!
  Info   View files View files (6)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2014-05-26 (2 years ago) RSS 2.0 feedStarStarStar 53%Total: 272 All time: 7,285 This week: 842Up
Version License PHP version Categories
php-help 1.0GNU General Publi...5.1.2PHP 5, Content management, Templates
Description Author

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
  Performance   Level  
Name: Mark Cole <contact>
Classes: 1 package by
Country: United Kingdom United Kingdom
Innovation award
Innovation award
Nominee: 1x

  Files folder image Files  
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)

 Version Control Unique User Downloads Download Rankings  
 0%
Total:272
This week:0
All time:7,285
This week:842Up
 User Ratings  
 
 All time
Utility:66%StarStarStarStar
Consistency:66%StarStarStarStar
Documentation:66%StarStarStarStar
Examples:66%StarStarStarStar
Tests:-
Videos:-
Overall:53%StarStarStar
Rank:1861