.. _menu-options:

####################### Contextual Menu Options #######################

The ui/menu component implements the contextual menu that you get when you right-click (or control-click) on a typeset expression. The settings in the menu are "sticky", which means that they are saved from page to page and session to session (though they are web-site specific, so each web site has its own saved settings).

As a page author, you can alter the default settings of the menu by using the menuOptions block of the options section of your MathJax configuration, as described below.

The ui/menu component adds a :ref:render action <document-renderActions> called addMenu that attaches the menu event handlers to the typeset output. (It also adds a second render action called checkLoading that mediates the loading of extensions needed by the contextual menu. For example, when the assistive :ref:explorer-component component is first activated, MathJax may need to load the a11y/explorer component; this render action makes sure that has happened before any math is typeset.)

If you want to disable the contextual menu, you can set the :attr:enableMenu option to false.

The Configuration Block

.. code-block:: javascript

MathJax = {
  options: {
    enableMenu: true,          // set to false to disable the menu
    menuOptions: {
      settings: {
        showSRE: false;        // true to include semantic attributes in MathML output
        showTex: false;        // true to include original LaTeX commands in MathML output
        texHints: true,        // put TeX-related attributes on MathML
        semantics: false,      // put original format in <semantic> tag in MathML
        zoom: 'NoZoom',        // or 'Click' or 'DoubleClick' as zoom trigger
        zscale: '200%',        // zoom scaling factor
        renderer: 'CHTML',     // or 'SVG'
        alt: false,            // true if ALT required for zooming
        cmd: false,            // true if CMD required for zooming
        ctrl: false,           // true if CTRL required for zooming
        shift: false,          // true if SHIFT required for zooming
        scale: 1,              // scaling factor for all math
        overflow: 'Scroll',    // how to handle math that is wider than its container
        breakInline: true,     // true to allow automatic line breaks with in-line math
        inTabOrder: true,      // true if tabbing includes math

        enrich: true,          // true if semantic-enrichment should be performed
        collapsible: false,    // true if complex math should be collapsible
        assistiveMml: true,    // true if hidden assistive MathML should be generated for screen readers

        // also these a11y options from the explorer extension

        speech: true,               // switch on speech output
        braille: true,              // switch on Braille output
        subtitles: true,            // show speech as a subtitle
        viewBraille: false,         // display Braille output as subtitles
        help: true,                 // include "press h for help" messages on focus
        roleDescription: 'math',    // the role description to use for math expressions
        voicing: false,             // switch on speech output

        backgroundColor: 'Blue',    // color for background of selected sub-expression
        backgroundOpacity: .2,      // opacity for background of selected sub-expression
        foregroundColor: 'Black',   // color to use for text of selected sub-expression
        foregroundOpacity: 1,       // opacity for text of selected sub-expression

        highlight: 'None',          // type of highlighting for collapsible sub-expressions
        treeColoring: false,        // tree color expression

        magnification: 'None',      // type of magnification
        magnify: '400%',            // percentage of magnification of zoomed expressions

        infoType: false,            // show semantic type on mouse hovering
        infoRole: false,            // show semantic role on mouse hovering
        infoPrefix: false,          // show speech prefixes on mouse hovering
      },
      annotationTypes: {
        TeX: ['TeX', 'LaTeX', 'application/x-tex'],
        StarMath: ['StarMath 5.0'],
        Maple: ['Maple'],
        ContentMathML: ['MathML-Content', 'application/mathml-content+xml'],
        OpenMath: ['OpenMath']
      }
    }
  }
};

.. note::

The a11y options in the :data:settings section above control the :data:a11y settings of the :ref:explorer-component. The settings here override the ones in the :data:options.a11y configuration block when the menu extension is loaded, so you should use the values here to control those settings in that case.

Option Descriptions

.. _menu-enableMenu: .. describe:: enableMenu: true

This controls whether the MathJax contextual menu will be added to the typeset mathematics or not.

.. _menu-settings: .. describe:: settings: {...}

These settings give the default menu settings for the page, though a user can change them using the menu. These are described in the comments in the example above, and in the :ref:explorer-options section.

.. _menu-annotationTypes: .. describe:: annotationTypes: {...}

These are the settings for the "Annotation" submenu of the "Show Math As" menu. If the <math> root element has a <semantics> child that contains one of the specified annotation formats, the source will be available via the "Show Math As" and "Copy to Clipboard" menus. Each format has a list of possible encodings. For example, the line

.. code-block:: javascript

  TeX: ['TeX', 'LaTeX', 'application/x-tex']

maps an annotation with an encoding of TeX, LaTeX, or application/x-tex to the "TeX" entry in the "Annotation" sub-menus.

Developer Options

.. code-block:: javascript

MathJax = {
  options: {
    MenuClass: Menu,
    menuOptions: {
      jax: {
        CHTML: null,
        SVG: null
      }
    }
  }
};

.. _menu-MenuClass: .. describe:: menuClass: Menu

The Menu object class to use for creating the menu. This allows you to create a subclass of Menu and pass that to the document in pace of the default one.

.. _menu-jax: .. describe:: jax: {CHTML: null, SVG: null}

This lists the input and output jax instances to be used for the different output formats. These will get set up automatically by the menu code if you don't specify one, so it is only necessary to set these if you want to manage the options specially.

|-----|