Skip to main content.

Setting Options

Umm provides flags to turn various features on or off. These flags can either be set to apply to all pages which use a given installation of Umm, or to a single page.

In order to set this options, open up either localconfig.php or the individual file where you'd like to set a given flag. In localconfig.php, find the string name for the option, and change its entry in the $default array.

$default['string name'] = true;

To set the variable on a per-page basis, simply set the appropriate variable. (See Using Umm ) Note that per-page configuration will only work if the appropriate entry in $per_file is set to true.

$variable_name = false;

^ TOP

Available Options



Document Caching
Allows Umm to cache transformed documents to speed serving of pages tailored to particular browsers. This can provide a speed improvement for static pages, but will not work for dynamic pages. Thus, it is recommended to turn it on by default, but allow page authors to turn off this option on a per-file basis.
string name in localconfig.php: 'document caching' variable name for per-page config: $cache_page
Database Images
If this is turned on, Umm will store rendered MathML images in a database, and use a PHP script to send this images to page visitors. If this is turned off, Umm will store the images as individual files in a common directory, and point visitors directly to the files. The latter is much faster.
string name in localconfig.php: 'database images' variable name for per-page config: $database_images
Show Log
If this is turned on, any page output by Umm will include a list of the errors and events which occurred while serving that page, as well as the options used while generating that page. This can be a useful tool for finding problems in pages which use Umm, but it is undesirable to allow page visitors to view this output. It is recommended that you turn this feature off by default, but allow page authors to change it on a per-page basis for debugging.
string name in localconfig.php: 'show log' variable name for per-page config: $show_log
Evaluate All CSS
Umm can match the style of a rendered block of MathML to the style of the surrounding page by evaluating the page's CSS. When this option is turned on, Umm will evaluate the CSS in any imported CSS files, <style>...</style> blocks, or style attributes. However, this can be very time-consuming for large pages or pages which contain a lot of CSS.
string name in localconfig.php: 'eval all css' variable name for per-page config: $eval_all_css
Evaluate Style Attributes
If you do not want to evaluate all the CSS in a page, you can select this to only evaluated the style attributes of the <math> elements. This allows page authors to still customize the style of rendered MathML images, and even manually match them to the rest of the page. This is meant to provide a compromise between performance issues and the quality of the transformed pages.
string name in localconfig.php: 'eval style attrs' variable name for per-page config: $eval_style_attrs
Match Font Family
When processing the CSS of a page, Umm can also track the font-family property and use it to match the font family of the math notation to the surrounding text. Umm will select the first alternative, and attempt to render the MathML using that family. However, this can cause unexpected results if the font is not present on the server.
This feature is not implemented for the GTKMathView renderer, and will not work properly in the WebEQ renderer for fonts which do not have subpixel hinting.
string name in localconfig.php: 'match font family' variable name for per-page config: $match_font_family
Use PHP DOM
In PHP 4, using the DOM module is very costly in memory and processing power. However, several features of Umm, such as CSS evaluation, rely on the DOM. This option allows you to turn the DOM on or off.
string name in localconfig.php: 'use dom' variable name for per-page config: $use_dom