File: extpfeil.rst

package info (click to toggle)
mathjax-docs 3.2%2B20240903-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,184 kB
  • sloc: python: 31; javascript: 28; sh: 20; makefile: 8
file content (63 lines) | stat: -rw-r--r-- 1,982 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.. _tex-extpfeil:

########
extpfeil
########

The `extpfeil` extension adds more macros for producing extensible
arrows, including ``\xtwoheadrightarrow``, ``\xtwoheadleftarrow``,
``\xmapsto``, ``\xlongequal``, ``\xtofrom``, and a non-standard
``\Newextarrow`` for creating your own extensible arrows.  The latter
has the form

.. describe:: \\Newextarrow{\\cs}{lspace,rspace}{unicode-char}

    where ``\cs`` is the new control sequence name to be defined,
    ``lspace`` and ``rspace`` are integers representing the amount of
    space (in suitably small units) to use at the left and right of
    text that is placed above or below the arrow, and ``unicode-char``
    is a number representing a unicode character position in either
    decimal or hexadecimal notation.

For example

.. code-block:: latex

   \Newextarrow{\xrightharpoonup}{5,10}{0x21C0}

defines an extensible right harpoon with barb up.  Note that MathJax
knows how to stretch only a limited number of characters, so you may
not actually get a stretchy character this way.  The characters that
can be stretched may also depend on the font you have selected.

This extension is loaded automatically when the `autoload` extension
is used.  To load the `extpfeil` extension explicitly, add
``'[tex]/extpfeil'`` to the ``load`` array of the ``loader`` block of
your MathJax configuration, and add ``'extpfeil'`` to the ``packages``
array of the ``tex`` block.

.. code-block:: javascript

   window.MathJax = {
     loader: {load: ['[tex]/extpfeil']},
     tex: {packages: {'[+]': ['extpfeil']}}
   };

Alternatively, use ``\require{extpfeil}`` in a TeX expression to load it
dynamically from within the math on the page, if the `require`
extension is loaded.

-----


.. _tex-extpfeil-commands:


extpfeil Commands
-----------------

The `extpfeil` extension implements the following macros:
``\Newextarrow``, ``\xlongequal``, ``\xmapsto``, ``\xtofrom``, ``\xtwoheadleftarrow``, ``\xtwoheadrightarrow``


|-----|