Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

added some words to documentation LaTeX examples (#558)

Arond3ff3fef08c3
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
index e710c840d..d592786be 100644
--- a/docs/source/examples.rst
+++ b/docs/source/examples.rst
@@ -6,7 +6,6 @@ Examples
examples/shapes_images_positions
examples/annotations
examples/plots
- examples/text
examples/tex
examples/formulas
examples/3d
diff --git a/docs/source/examples/tex.rst b/docs/source/examples/tex.rst
index 7a1c0f00f..a64505931 100644
--- a/docs/source/examples/tex.rst
+++ b/docs/source/examples/tex.rst
@@ -1,5 +1,54 @@
+Text and LaTeX
+===============
+
+
+Text
+--------------
+The simplest way to add text to you animation is to use the :class:`~.Text` class. It uses the Cairo library to render text.
+A newer addition to manim is the :class:`~.PangoText` class, which uses the Pango library.
+
+The Text() mobject
++++++++++++++++++++
+
+.. manim:: Example1Text
+ :save_last_frame:
+
+ class Example1Text(Scene):
+ def construct(self):
+ text = Text('Hello world').scale(3)
+ self.add(text)
+
+For more examples, see: :class:`~.Text`.
+
+The PangoText() mobject
++++++++++++++++++++++++
+
+The :class:`~.PangoText` mobject uses the Pango library to render text. Use this whenever you want to use non-English alphabets like `你好` or `こんにちは` or `안녕하세요` or `مرحبا بالعالم`.
+
+
LaTeX
-=================================
+-------------------
+
+The Tex() mobject
++++++++++++++++++++
+Just as you can use :class:`~.Text` to add text to your videos, you can use :class:`~.Tex` to insert LaTeX.
+
+.. manim:: ExampleLaTeX
+ :save_last_frame:
+
+ class ExampleLaTeX(Scene):
+ def construct(self):
+ tex = Tex(r'\LaTeX').scale(3)
+ self.add(tex)
+
+Note that we are using a raw string (``r'---'``) instead of a regular string (``'---'``).
+This is because TeX code uses a lot of special characters - like ``\`` for example -
+that have special meaning within a regular python string. An alternative would have
+been to write ``\\`` as in ``Tex('\\LaTeX')``.
+
+The MathTex() mobject
+++++++++++++++++++++++
+Anything enclosed in ``$`` signs is interpreted as maths-mode:
.. manim:: Example1LaTeX
:save_last_frame:
@@ -9,14 +58,45 @@ LaTeX
tex = Tex(r'$\xrightarrow{Hello}$ \LaTeX').scale(3)
self.add(tex)
+Whereas in a :class:`~.MathTex` mobject everything is math-mode by default and you would use ``\text{}`` to
+insert regular text:
+
+.. manim:: Example1bLaTeX
+ :save_last_frame:
+
+ class Example1bLaTeX(Scene):
+ def construct(self):
+ tex = MathTex(r'\xrightarrow{Hello}\text{ \LaTeX}').scale(3)
+ self.add(tex)
+
+LaTeX commands and keyword arguments
++++++++++++++++++++++++++++++++++++++
+We can use any standard LaTeX commands in the AMS maths packages. For example the ``mathtt`` text type.
+
.. manim:: Example2LaTeX
:save_last_frame:
class Example2LaTeX(Scene):
def construct(self):
- tex = Tex(r'$\mathtt{Hello}$ \LaTeX', color=BLUE).scale(3)
+ tex = Tex(r'$\mathtt{Hello}$ \LaTeX').scale(3)
+ self.add(tex)
+
+On the manim side, the :class:`~.Tex` class also accepts attributes to change the appearance of the output.
+This is very similar to the :class:`~.Text` class. For example, the ``color`` keyword changes the color of the TeX mobject:
+
+.. manim:: Example2bLaTeX
+ :save_last_frame:
+
+ class Example2bLaTeX(Scene):
+ def construct(self):
+ tex = Tex(r'Hello \LaTeX', color=BLUE).scale(3)
self.add(tex)
+Extra LaTeX Packages
++++++++++++++++++++++
+Some commands require special packages to be loaded into the TeX template. For example,
+to use the ``mathscr`` script, we need to add the ``mathrsfs`` package. Since this package isn't loaded
+into manim's tex template by default, we add it manually:
.. manim:: Example3LaTeX
:save_last_frame:
@@ -25,50 +105,62 @@ LaTeX
def construct(self):
myTemplate = TexTemplate()
myTemplate.add_to_preamble(r"\usepackage{mathrsfs}")
- tex = Tex(r'$\mathscr{H}ello$ \LaTeX}', tex_template=myTemplate).scale(3)
+ tex = Tex(r'$\mathscr{H} \rightarrow \mathbb{H}$}', tex_template=myTemplate).scale(3)
self.add(tex)
+Substrings and parts
++++++++++++++++++++++
+The TeX mobject can accept multiple strings as arguments. Afterwards you can refer to the individual
+parts either by their index (like ``tex[1]``), or you can look them up by (parts of) the tex code like
+in this example where we set the color of the ``\bigstar`` using :func:`~.set_color_by_tex`:
.. manim:: Example4LaTeX
:save_last_frame:
class Example4LaTeX(Scene):
def construct(self):
- tex = Tex('Hello', '$\\bigstar$', '\LaTeX').scale(3)
+ tex = Tex('Hello', r'$\bigstar$', r'\LaTeX').scale(3)
tex.set_color_by_tex('igsta', RED)
self.add(tex)
+LaTeX Maths Fonts - The Template Library
+++++++++++++++++++++++++++++++++++++++++++++
+Changing fonts in LaTeX when typesetting mathematical formulae is a little bit more tricky than
+with regular text. It requires changing the template that is used to compile the tex code.
+Manim comes with a collection of :class:`~.TexFontTemplates` ready for you to use. These templates will all work
+in maths mode:
+
.. manim:: Example5LaTeX
:save_last_frame:
class Example5LaTeX(Scene):
def construct(self):
- tex = Tex('Hello \LaTeX', tex_template=TexFontTemplates.french_cursive).scale(3)
+ tex = Tex(r'$f: A \rightarrow B$', tex_template=TexFontTemplates.french_cursive).scale(3)
self.add(tex)
-.. manim:: Example5bLaTeX
- :save_last_frame:
-
- class Example5bLaTeX(Scene):
- def construct(self):
- templateForFrenchCursive = TexTemplate(
- preamble=r"""
- \usepackage[english]{babel}
- \usepackage{amsmath}
- \usepackage{amssymb}
- \usepackage[T1]{fontenc}
- \usepackage[default]{frcursive}
- \usepackage[eulergreek,noplusnominus,noequal,nohbar,nolessnomore,noasterisk]{mathastext}
- """)
- tex = Tex('Hello \LaTeX', tex_template=templateForFrenchCursive).scale(3)
- self.add(tex)
+Manim also has a :class:`~.TexTemplateLibrary` containing the TeX templates used by 3Blue1Brown. One example
+is the ctex template, used for typesetting Chinese. For this to work, the ctex LaTeX package
+must be installed on your system. Furthermore, if you are only typesetting Text, you probably do not
+need :class:`~.Tex` at all, and should use :class:`~.Text` or :class:`~.PangoText` instead.
.. manim:: Example6LaTeX
:save_last_frame:
class Example6LaTeX(Scene):
def construct(self):
- tex = Tex('Hello 你好 \LaTeX', tex_template=TexTemplateLibrary.ctex).scale(3)
+ tex = Tex('Hello 你好 \\LaTeX', tex_template=TexTemplateLibrary.ctex).scale(3)
self.add(tex)
+Aligning formulae
+++++++++++++++++++
+A :class:`~.MathTex` mobject is typeset in the LaTeX ``align*`` environment. This means you can use the ``&`` alignment
+character when typesetting multiline formulae:
+
+.. manim:: Example7LaTeX
+ :save_last_frame:
+
+ class Example7LaTeX(Scene):
+ def construct(self):
+ tex = MathTex(r'f(x) &= 3 + 2 + 1\\ &= 5 + 1 \\ &= 6').scale(2)
+ self.add(tex)
diff --git a/docs/source/examples/text.rst b/docs/source/examples/text.rst
deleted file mode 100644
index d27e294ff..000000000
--- a/docs/source/examples/text.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-Text
-=================================
-
-.. manim:: Example1Text
- :save_last_frame:
-
- class Example1Text(Scene):
- def construct(self):
- text = Text('Hello world').scale(3)
- self.add(text)
-
-This is an example that illustrates how to use the :class:`~.Text` class.
-
-In case you want to use other alphabets like `你好` or `こんにちは` or `안녕하세요` or `مرحبا بالعالم`, you can have a look at :class:`~.PangoText`