Documentation

Documentation

Table of Contents

Constants

LWT_CSS_FILES  = array('src/css/css_charts.css', 'src/css/feed_wizard.css', 'src/css/gallery.css', 'src/css/jplayer.css', 'src/css/jquery-ui.css', 'src/css/jquery.tagit.css', 'src/css/styles.css')
LWT_JS_FILES  = array('src/js/audio_controller.js', 'src/js/third_party/countuptimer.js', 'src/js/jq_feedwizard.js', 'src/js/text_events.js', 'src/js/jq_pgm.js', 'src/js/overlib_interface.js', 'src/js/pgm.js', 'src/js/translation_api.js', 'src/js/unloadformcheck.js', 'src/js/third_party/sorttable.js', 'src/js/user_interactions.js')

Functions

markdown_converter()  : string
Convert a markdown file to HTML and return the result.
markdown_integration()  : void
Prepapre the integration of a Markdown file into info.html.
minifyJS()  : string
Minify a JavaScript file and outputs the result to js/
minifyCSS()  : string
Minify a JavaScript file and outputs the result to css/
minifyAllJS()  : string
Minify all JavaScript files
minifyAllCSS()  : void
Minify all Cascading-Style Sheet (CSS) files
regenerateSingleTheme()  : void
Regenerate a single theme.
regenerateThemes()  : void
Find and regenerate all themes. CSS is minified while other files are copied.
minify_everything()  : void
One-do-all command to minify all your JS, CSS, and regenerate themes.

Constants

LWT_CSS_FILES

public array<string|int, string> LWT_CSS_FILES = array('src/css/css_charts.css', 'src/css/feed_wizard.css', 'src/css/gallery.css', 'src/css/jplayer.css', 'src/css/jquery-ui.css', 'src/css/jquery.tagit.css', 'src/css/styles.css')

LWT_CSS_FILES All the paths of CSS files to be minified.

LWT_JS_FILES

public array<string|int, string> LWT_JS_FILES = array('src/js/audio_controller.js', 'src/js/third_party/countuptimer.js', 'src/js/jq_feedwizard.js', 'src/js/text_events.js', 'src/js/jq_pgm.js', 'src/js/overlib_interface.js', 'src/js/pgm.js', 'src/js/translation_api.js', 'src/js/unloadformcheck.js', 'src/js/third_party/sorttable.js', 'src/js/user_interactions.js')

LWT_JS_FILES All the paths of JS files to be minified.

Tags
since
2.10.0-fork

Adds src/js/overlib_interface.js and src/js/text_events.js

Functions

markdown_converter()

Convert a markdown file to HTML and return the result.

markdown_converter(string $file_path) : string
Parameters
$file_path : string

Full path for the file to use, including extension.

Return values
string

An HTML-formatted string

markdown_integration()

Prepapre the integration of a Markdown file into info.html.

markdown_integration(string $file_path) : void

Headers are incremented by one level. File name become an ID.

Parameters
$file_path : string

Full path for the file to use, including extension (should be ".md")

minifyJS()

Minify a JavaScript file and outputs the result to js/

minifyJS(string $path, string $outputPath) : string
Parameters
$path : string

Input file path with extension.

$outputPath : string

Output file path with extension

Tags
since
2.2.2-fork

Relative paths in the returned content is the same as the saved content.

Return values
string

Minified content

minifyCSS()

Minify a JavaScript file and outputs the result to css/

minifyCSS(string $path, string $outputPath) : string
Parameters
$path : string

Input file path with extension.

$outputPath : string

Output file path with extension

Tags
since
2.2.2-fork

Relative paths in the returned content is the same as the saved content.

Return values
string

Minified content

minifyAllJS()

Minify all JavaScript files

minifyAllJS() : string
Tags
since
2.0.3-fork
since
2.3.0-fork

JS code is "combined" above being minified: only one file is outputted.

Return values
string

Minified code

minifyAllCSS()

Minify all Cascading-Style Sheet (CSS) files

minifyAllCSS() : void
Tags
since
2.0.3-fork

regenerateSingleTheme()

Regenerate a single theme.

regenerateSingleTheme(string $parent_folder, string $theme_folder) : void
Parameters
$parent_folder : string

Path to the parent folder (I. E. src/themes/)

$theme_folder : string

Name of the theme folder

regenerateThemes()

Find and regenerate all themes. CSS is minified while other files are copied.

regenerateThemes() : void

Nested folders are ignored.

minify_everything()

One-do-all command to minify all your JS, CSS, and regenerate themes.

minify_everything() : void

        
On this page

Search results