辅助功能扩展选项

mathjax包含几个扩展,旨在支持那些需要辅助技术的人,比如屏幕阅读器。见 辅助功能组件 页了解更多详细信息。下面列出了控制这些扩展的选项。

由于辅助功能扩展由MathJax上下文菜单的设置控制,因此您可以使用 上下文菜单选项 来控制是否启用它们。以下设置可用于 禁用 扩展名,以防它们是自动加载的,但这些不是控制是否加载扩展名本身的设置。这是由菜单设置控制的:

MathJax = {
  options: {
    menuOptions: {
      settings: {
        assistiveMml: true;   // true to enable assitive MathML
        collapsible: false;   // true to enable collapsible math
        explorer: false;      // true to enable the expression explorer
      }
    }
  }
};

请注意,没有对语义丰富的控制 本身 ,但它是通过启用可折叠数学或表达式资源管理器自动启用的。

尽管您可以使用 加载程序选项 ,最好使用上面的man u选项,这样如果用户关闭了扩展,他们就不会因为加载他们不会使用的扩展而招致网络和启动成本。


语义丰富扩展选项

此扩展协调mathjax输出中由扩展过程生成的语义信息的创建和嵌入,以供其他扩展使用。

这个 semantic-enrich 扩展将两个操作添加到文档的默认值 renderActions 对象: enrich 执行语义丰富的操作,以及 attachSpeech 将语音(如果正在生成)附加到输出的操作。

配置块

MathJax = {
  options: {
    enableEnrichment: true,   // false to disable enrichment
    sre: {
      speech: 'none',         // or 'shallow', or 'deep'
      domain: 'mathspeak',    // speech rules domain
      style: 'default',       // speech rules style
      locale: 'en'            // the language to use (en, fr, es, de, it)
    },
    enrichError: (doc, math, err) => doc.enrichError(doc, math, err),  // function to call if enrichment fails
  }
};

选项说明

enableEnrichment: true

此设置控制是否将语义充实应用于页面中数学的内部MathML表示。这是由上下文菜单的设置自动控制的,因此您不必自己调整它。但是,如果 semantic-enrich 组件已经自动加载,您不需要它。

sre: {...}

这个挡路为语音规则引擎设置配置值,该引擎是MathJAX语义丰富特性的基础。请参阅 SRE documentation 了解更多详细信息。

enrichError: (doc, math, err) => doc.enrichError(doc, math, err)

此设置提供了一个函数,当语义丰富过程由于某种原因失败时将调用该函数。默认情况下,调用MathDocument的 enrichError() 方法,该方法只在浏览器控制台窗口中打印一条警告消息。原始(未浓缩的)MathML将用于表达式的输出。您可以通过提供一个函数来覆盖默认的tbehavior,该函数可以做任何您想做的事情,比如记录错误,或者用包含错误消息的Alterntiave MathML替换原始的MathML。

注解

从版本3.1.3开始, enrichSpeech 选项已重命名为 speechsre 配置的挡路。


复杂性扩展选项

此扩展生成复杂度度量,并插入允许用户通过单击基于该度量的表达式来折叠表达式的元素。使用 'a11y/complexity' 配置扩展的mathjax配置块。

这个 complexity 扩展名添加 complexity 对文档默认值的操作 renderActions 对象。

配置块

MathJax = {
  options: {
    enableComplexity: true,       // set to false to disable complexity computations
    makeCollapsible: true         // insert mactions to allow collapsing
  }
};

选项说明

enableComplexity: true

此设置控制 complexity 扩展是否运行。该值由上下文菜单的设置自动控制,因此您不必自己调整它。但是,如果 complexity 组件已自动加载,您不需要它。

makeCollapsible: true

此设置确定扩展名是否将插入 <maction> 允许复杂表达式“折叠”的元素,以便它们占用更少的空间,并生成更易于收听的压缩语音字符串。如果为False,则不会更改表达式,但如果元素是可折叠的,则会(在内部)对其进行标记。

开发人员选项

identifyCollapsible: true

此设置确定为表达式中的每个元素计算的复杂度数字是否应考虑折叠。如果为true,则可折叠元素的父元素将获得反映要折叠的可折叠元素的复杂性。如果为假,则复杂性假设不会发生崩溃。

Collapse: Collapse

这个 Collapse 用于创建 <maction> 折叠复杂表达式所需的元素。这允许您创建 Collapse 把它交给文件。

ComplexityVisitor: ComplexityVisitor

这个 ComplexityVisitor 对象类,用于管理复杂性值的计算。这允许您创建 ComplexityVisitor 把它交给文件。


资源管理器扩展选项

此扩展提供了对页内表达式的交互式探索的支持。见 辅助功能 有关此操作的详细信息,请参阅第页。

这个 explorer 扩展名添加 explorable 对文档默认值的操作 renderActions 对象。

配置块

MathJax = {
  options: {
    enableExplorer: true,                // set to false to disable the explorer
    a11y: {
      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

      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
      flame: false,                      // color collapsible sub-expressions
      hover: false,                      // show collapsible sub-expression on mouse hovering

      treeColoring: false,               // tree color expression

      magnification: 'None',             // type of magnification
      magnify: '400%',                   // percentage of magnification of zoomed expressions
      keyMagnifier: false,               // switch on magnification via key exploration
      mouseMagnifier: false,             // switch on magnification via mouse hovering
      align: 'top',                      // placement of magnified expression

      infoType: false                    // show semantic type on mouse hovering
      infoRole: false,                   // show semantic role on mouse hovering
      infoPrefix: false,                 // show speech prefixes on mouse hovering
    }
  }
};

选项说明

enableExplorer: true

此设置控制 explorer 扩展是否运行。该值由上下文菜单的设置自动控制,因此您不必自己调整它。但是,如果 explorer 组件已自动加载,您不需要它。

A11Y选项大致属于以下四类之一:

语音选项

speech: true

设置是否生成语音输出。默认情况下,将为页面上的每个表达式计算语音,并在资源管理器启动后输出。

braille: true

设置是否为表达式生成和输出盲文。

subtitles: true

此选项指示所选子表达式的语音字符串在探索时是否将显示为表达式下的副标题。

viewBraille: false

此选项指示探索时是否在表达式下显示盲文输出。

注解

从版本3.1.3开始, speechRules 选项被分成两个独立的选项, domainstyle ,在 sre 配置的挡路。请参阅 语义丰富扩展选项 上面有更多信息。

突出显示选项

foregroundColor: 'Black'

这将指定在表达式探索期间用于选定子表达式的文本的颜色。颜色应从下列选项中选择: 'Blue''Red''Green''Yellow''Cyan''Magenta''White''Black' .

foregroundOpacity: 1

这表示用于选定子表达式文本的不透明度。

backgroundColor: 'Blue'

这将指定在表达式探索期间用于选定子表达式的背景色。颜色应从下列选项中选择: 'Blue''Red''Green''Yellow''Cyan''Magenta''White''Black' .

backgroundOpacity: .2

这表示用于选定子表达式的背景色的不透明度。

highlight: 'None'

选择用于显示可折叠子表达式的特定荧光笔。选择是 'None''Flame''Hover' .

flame: false

此标志打开Flame Highlighter,它将永久亮显可折叠子表达式,嵌套可折叠表达式的背景将连续变暗。

hover: false

这将打开鼠标指针悬停在可折叠子表达式上时高亮显示可折叠子表达式的悬停高光器。

注意,两者都有 'hover''flame' 设置为true可能会导致意外的副作用。

treeColoring: false

此设置启用树着色,通过赋予相邻符号不同的、理想的对比前景颜色,可以直观地区分表达式。

放大选项

magnification: 'None'

此选项指定用于放大子表达式的特定放大镜。选择是 'None''Keyboard''Mouse' .

magnify: '400%'

这将提供在表达式探索期间显示缩放的子表达式时用于缩放的子表达式的放大因子(以百分比表示)。默认值为400%。

keyMagnifier: false

在键盘浏览表达式期间打开子表达式的缩放。

mouseMagnifier: false

通过鼠标指针悬停打开子表达式的缩放。

注意,同时使用 'keyMagnifier''mouseMagnifier 一起会导致不必要的副作用。

align: 'top'

此设置指示在表达式探索期间显示缩放的子表达式时,将在何处放置所选子表达式的缩放版本。

语义信息选项

语义信息探索者是一个功能,当鼠标指针悬停在子表达式上时,它显示子表达式的一些语义信息。注意,多个信息探索者协作良好。

infoType: false

激活调查子表达式语义类型的资源管理器。类型是表达式的不可变属性,它独立于表达式在公式中的特定位置。但是,请注意,类型可能会根据文档的主题区域而更改。

infoRole: false

激活资源管理器以显示子表达式的语义角色,该子表达式依赖于其在整个表达式中的上下文。

infoPrefix: false

激活与子表达式位置相关的前缀信息的资源管理器。例子是 'exponent''radicand' 等。这些也将在与语音输出的交互式探索中宣布。

有关这些概念的更多详细信息,请参见 Speech Rule Engine .

注解

虽然多个基于键盘的勘探技术可以很好地协同工作,并且可以很容易地同时使用,但打开多个基于鼠标的勘探工具可能会导致工具的意外交互,并且通常会产生不可预知的副作用。

辅助MML扩展选项

这个扩展将可视化隐藏的MathML添加到MathJax的输出中,一些屏幕阅读器可以为其提供声音。见 屏幕阅读器支持 有关如何工作的详细信息。

这个 assisitive-mml 扩展包含在所有组合的组件中,并且在默认情况下是活动的,所以屏幕阅读器用户不需要做任何事情来激活它。有一个菜单项控制是否插入辅助MathML,因此可视用户可以根据需要将其关闭。

扩展会将操作添加到文档的默认设置中 renderActions 对象,该对象执行MathML插入。您可以使用以下配置禁用该功能。

MathJax = {
  options: {
    enableAssistiveMml: false
  }
};