Renderer support
| Package | MathJax | KaTeX | XeTeX |
|---|---|---|---|
braket | MathJax: Full | KaTeX: Full | XeTeX: None |
physics | MathJax: Full | KaTeX: Full | XeTeX: Full |
Syntax#
\ketm{a}math contentArgspec m — one mandatory argument. In braket. Reading argspecs
\kets*starm{a}math contentArgspec s m — one optional and one mandatory argument. In physics. Reading argspecs
Examples#
Package variants#
In TeXForm#
TeXForm parses this entry as prefix syntax; the package determines its argument specification.
Expands to (braket)#
\ket{#1} {\vert {#1} \rangle}MathJax reads #1 with GetArgument, so a single token can be used without braces.
Expands to (physics)#
\ket{#1} \left\vert{#1}\right\rangleThis is the unstarred rewrite. The starred form \ket*{#1} reparses as \vert{#1}\rangle.
Expand ket to an explicit bar and angle-bracket fence form.
\ket{#1} \left\vert #1 \right\rangleEquivalent forms#
{\vert {#1} \rangle}exact\left\vert{#1}\right\rangleexactEquivalent to the unstarred form.
\vert{#1}\rangleexactEquivalent to the starred form.
See also#
\bmodbase\bmqtyphysics\boxedams\brabraket\Brabraket\flatfracphysics\iffbase\imathbbbboldx\imathbfbbbboldx\impliedbyams\impliesams\itextbbbboldx\itextbfbbbboldx\jmathbbbboldx\jmathbfbbbboldx\jtextbbbboldx\jtextbfbbbboldx\Ketbraket\ketbrabraket\Ketbrabraket\LaTeXbase\mathstrutbase\matrixdeterminantphysics\mdetphysics\modbase\pmbbase\pmodbase\pmqtyphysics\Pmqtyphysics\podbase\qcphysics\qcommaphysics\Residuephysics\sbmqtyphysics\skewbase\smdetphysics\spmqtyphysics\sPmqtyphysics\stackbinbase\stackrelbase\substackams\svmqtyphysics\TeXbase\textbfbase\textitbase\textnormalbase\textrmbase\textsfbase\textttbase\textupbase\varinjlimams\varliminfams\varlimsupams\varprojlimams\vmqtyphysics\zeromatrixphysics\zmatphysics
Test cases#
| Input | Case | MathJax | KaTeX | XeTeX |
|---|---|---|---|---|
\ket{a} | Positive · baseline | Pass | Pass | Fail |
\ket a | Positive · bare[0] | Pass | Pass | Fail |
| Input | Case | MathJax | KaTeX | XeTeX |
|---|---|---|---|---|
\ket{a} | Positive · baseline | Pass | Pass | Pass |
\ket*{a} | Positive · vary:s[0] | Pass | Pass | Pass |
\ket a | Positive · bare[1] | Pass | Pass | Pass |