iFAQMaker | ||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
htmlfaq
FAQ Generator
Field Summary | ||
private array | $block Content of the parsed input file, splitted into blocks | |
private integer | $blocks Number of blocks created | |
private array | $input Content of the parsed input file (one line per cell) | |
private string | $toc Type of the TOC: "ol", "ul" or "" (no TOC) | |
private string | $toclist Content of the TOC (to be parsed into {toc}) |
Constructor Summary | ||
void | faq(string $tpl_dir, string $tpl_file, string $toc) Constructor: Setting up the templates |
Method Summary | ||
void | acronyms(string $filename) Read in acronym definitions | |
private void | fileRead(string $filename) Read the input file | |
void | parseInput(string $filename) Parse input text into blocks. | |
void | parseOutput() Output the text | |
string | regexp_pattern_file(string $name) Read list of keywords from a given file and set them up as regexp pattern All keywords will be matched as "strings" only (i. | |
string | regexp_pattern_word_file(string $name) Read list of keywords from a given file and set them up as regexp pattern All keywords will be matched as "whole words" only (i. | |
void | register_filefunc(string $function_name) Register a function whose (only) parameter references a file relative to the script (mainly used for the HiLite PlugIns) | |
void | set_nav(string $name, string $content) Set template variables. | |
private void | textReplace() Replace variables and translations | |
void | wiki(boolean $enable) Enable/Disable Wiki replacement | |
void | wikidef(string $filename) Read in Wiki definitions |
Field Detail |
private array $block
Content of the parsed input file, splitted into blocks
private integer $blocks
Number of blocks created
private array $input
Content of the parsed input file (one line per cell)
private string $toc
Type of the TOC: "ol", "ul" or "" (no TOC)
private string $toclist
Content of the TOC (to be parsed into {toc})
Constructor Detail |
void faq(string $tpl_dir, string $tpl_file, string $toc)
Constructor: Setting up the templates
tpl_dir
- Directory containing the HTML template filestpl_file
- Filename of the template file to usetoc
- style of the "table of contents" (ul|ol), empty for no tocMethod Detail |
void acronyms(string $filename)
Read in acronym definitions
filename
- private void fileRead(string $filename)
Read the input file
filename
- void parseInput(string $filename)
Parse input text into blocks. Blocks start with a line containing only the "block header", which looks like "
[<blockname>|level|hname]", where:
filename
- input file namevoid parseOutput()
Output the text
string regexp_pattern_file(string $name)
Read list of keywords from a given file and set them up as regexp pattern All keywords will be matched as "strings" only (i.e. also as part of other words) Used for the hilite plugins
name
- of the file holding the keywords, one by linestring regexp_pattern_word_file(string $name)
Read list of keywords from a given file and set them up as regexp pattern All keywords will be matched as "whole words" only (i.e. not as part of other words) Used for the hilite plugins
name
- of the file holding the keywords, one by linevoid register_filefunc(string $function_name)
Register a function whose (only) parameter references a file relative to the script (mainly used for the HiLite PlugIns)
function_name
- void set_nav(string $name, string $content)
Set template variables. Wrapper around pagemaker::t::set_var
name
- name of template variablecontent
- value of template variableprivate void textReplace()
Replace variables and translations
void wiki(boolean $enable)
Enable/Disable Wiki replacement
enable
- void wikidef(string $filename)
Read in Wiki definitions
filename
- iFAQMaker | ||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This document was generated by phpdocgen 0.16.
Copyright © 2002-03 Stéphane GALLAND (under the GNU General Public License)