Merge pull request #483 from cobordism/refactor-tex-templates

Simplifying TexTemplates and Creating Template Library

Author: leotrs

docs/source/examples.rst

@@ -7,6 +7,7 @@ Examples
    examples/annotations
    examples/plots
    examples/text
+   examples/tex
    examples/formulas
    examples/3d
    examples/camera_settings

docs/source/examples/tex.rst

@@ -0,0 +1,74 @@
+LaTeX
+=================================
+
+.. manim:: Example1LaTeX
+    :save_last_frame:
+
+    class Example1LaTeX(Scene):
+        def construct(self):
+            tex = Tex(r'$\xrightarrow{Hello}$ \LaTeX').scale(3)
+            self.add(tex)
+
+.. manim:: Example2LaTeX
+    :save_last_frame:
+
+    class Example2LaTeX(Scene):
+        def construct(self):
+            tex = Tex(r'$\mathtt{Hello}$ \LaTeX', color=BLUE).scale(3)
+            self.add(tex)
+
+
+.. manim:: Example3LaTeX
+    :save_last_frame:
+
+    class Example3LaTeX(Scene):
+        def construct(self):
+            myTemplate = TexTemplate()
+            myTemplate.add_to_preamble(r"\usepackage{mathrsfs}")
+            tex = Tex(r'$\mathscr{H}ello$ \LaTeX}', tex_template=myTemplate).scale(3)
+            self.add(tex)
+
+
+.. manim:: Example4LaTeX
+    :save_last_frame:
+
+    class Example4LaTeX(Scene):
+        def construct(self):
+            tex = Tex('Hello', '$\\bigstar$', '\LaTeX').scale(3)
+            tex.set_color_by_tex('igsta', RED)
+            self.add(tex)
+
+.. manim:: Example5LaTeX
+    :save_last_frame:
+
+    class Example5LaTeX(Scene):
+        def construct(self):
+            tex = Tex('Hello \LaTeX', 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:: Example6LaTeX
+    :save_last_frame:
+
+    class Example6LaTeX(Scene):
+        def construct(self):
+            tex = Tex('Hello 你好 \LaTeX', tex_template=TexTemplateLibrary.ctex).scale(3)
+            self.add(tex)
+
+

docs/source/reference.rst

@@ -118,6 +118,7 @@ Utilities
    ~utils.space_ops
    ~utils.strings
    ~utils.tex
+   ~utils.tex_templates
    ~utils.tex_file_writing
 
 

example_scenes/advanced_tex_fonts.py

@@ -0,0 +1,141 @@
+from manim import *
+
+# French Cursive LaTeX font example from http://jf.burnol.free.fr/showcase.html
+
+# Example 1 Manually creating a Template
+
+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}
+"""
+)
+
+
+def FrenchCursive(*tex_strings, **kwargs):
+    return Tex(*tex_strings, tex_template=TemplateForFrenchCursive, **kwargs)
+
+
+class TexFontTemplateManual(Scene):
+    """An example scene that uses a manually defined TexTemplate() object to create
+    LaTeX output in French Cursive font"""
+
+    def construct(self):
+        self.add(Tex("Tex Font Example").to_edge(UL))
+        self.play(ShowCreation(FrenchCursive("$f: A \\longrightarrow B$").shift(UP)))
+        self.play(
+            ShowCreation(FrenchCursive("Behold! We can write math in French Cursive"))
+        )
+        self.wait(1)
+        self.play(
+            ShowCreation(
+                Tex(
+                    "See more font templates at \\\\ http://jf.burnol.free.fr/showcase.html"
+                ).shift(2 * DOWN)
+            )
+        )
+        self.wait(2)
+
+
+# Example 2, using a Template from the collection
+
+
+class TexFontTemplateLibrary(Scene):
+    """An example scene that uses TexTemplate objects from the TexFontTemplates collection
+    to create sample LaTeX output in every font that will compile on the local system.
+
+    Please Note:
+    Many of the in the TexFontTemplates collection require that specific fonts
+    are installed on your local machine.
+    For example, choosing the template TexFontTemplates.comic_sans will
+    not compile if the Comic Sans Micrososft font is not installed.
+
+    This scene will only render those Templates that do not cause a TeX
+    compilation error on your system. Furthermore, some of the ones that do render,
+    may still render incorrectly. This is beyond the scope of manim.
+    Feel free to experiment.
+    """
+
+    def construct(self):
+        def write_one_line(template):
+            x = Tex(template.description, tex_template=template).shift(UP)
+            self.play(ShowCreation(x))
+            self.wait(1)
+            self.play(FadeOut(x))
+
+        examples = [
+            TexFontTemplates.american_typewriter,  # "American Typewriter"
+            TexFontTemplates.antykwa,  # "Antykwa Półtawskiego (TX Fonts for Greek and math symbols)"
+            TexFontTemplates.apple_chancery,  # "Apple Chancery"
+            TexFontTemplates.auriocus_kalligraphicus,  # "Auriocus Kalligraphicus (Symbol Greek)"
+            TexFontTemplates.baskervald_adf_fourier,  # "Baskervald ADF with Fourier"
+            TexFontTemplates.baskerville_it,  # "Baskerville (Italic)"
+            TexFontTemplates.biolinum,  # "Biolinum"
+            TexFontTemplates.brushscriptx,  # "BrushScriptX-Italic (PX math and Greek)"
+            TexFontTemplates.chalkboard_se,  # "Chalkboard SE"
+            TexFontTemplates.chalkduster,  # "Chalkduster"
+            TexFontTemplates.comfortaa,  # "Comfortaa"
+            TexFontTemplates.comic_sans,  # "Comic Sans MS"
+            TexFontTemplates.droid_sans,  # "Droid Sans"
+            TexFontTemplates.droid_sans_it,  # "Droid Sans (Italic)"
+            TexFontTemplates.droid_serif,  # "Droid Serif"
+            TexFontTemplates.droid_serif_px_it,  # "Droid Serif (PX math symbols) (Italic)"
+            TexFontTemplates.ecf_augie,  # "ECF Augie (Euler Greek)"
+            TexFontTemplates.ecf_jd,  # "ECF JD (with TX fonts)"
+            TexFontTemplates.ecf_skeetch,  # "ECF Skeetch (CM Greek)"
+            TexFontTemplates.ecf_tall_paul,  # "ECF Tall Paul (with Symbol font)"
+            TexFontTemplates.ecf_webster,  # "ECF Webster (with TX fonts)"
+            TexFontTemplates.electrum_adf,  # "Electrum ADF (CM Greek)"
+            TexFontTemplates.epigrafica,  # Epigrafica
+            TexFontTemplates.fourier_utopia,  # "Fourier Utopia (Fourier upright Greek)"
+            TexFontTemplates.french_cursive,  # "French Cursive (Euler Greek)"
+            TexFontTemplates.gfs_bodoni,  # "GFS Bodoni"
+            TexFontTemplates.gfs_didot,  # "GFS Didot (Italic)"
+            TexFontTemplates.gfs_neoHellenic,  # "GFS NeoHellenic"
+            TexFontTemplates.gnu_freesans_tx,  # "GNU FreeSerif (and TX fonts symbols)"
+            TexFontTemplates.gnu_freeserif_freesans,  # "GNU FreeSerif and FreeSans"
+            TexFontTemplates.helvetica_fourier_it,  # "Helvetica with Fourier (Italic)"
+            TexFontTemplates.latin_modern_tw_it,  # "Latin Modern Typewriter Proportional (CM Greek) (Italic)"
+            TexFontTemplates.latin_modern_tw,  # "Latin Modern Typewriter Proportional"
+            TexFontTemplates.libertine,  # "Libertine"
+            TexFontTemplates.libris_adf_fourier,  # "Libris ADF with Fourier"
+            TexFontTemplates.minion_pro_myriad_pro,  # "Minion Pro and Myriad Pro (and TX fonts symbols)"
+            TexFontTemplates.minion_pro_tx,  # "Minion Pro (and TX fonts symbols)"
+            TexFontTemplates.new_century_schoolbook,  # "New Century Schoolbook (Symbol Greek)"
+            TexFontTemplates.new_century_schoolbook_px,  # "New Century Schoolbook (Symbol Greek, PX math symbols)"
+            TexFontTemplates.noteworthy_light,  # "Noteworthy Light"
+            TexFontTemplates.palatino,  # "Palatino (Symbol Greek)"
+            TexFontTemplates.papyrus,  # "Papyrus"
+            TexFontTemplates.romande_adf_fourier_it,  # "Romande ADF with Fourier (Italic)"
+            TexFontTemplates.slitex,  # "SliTeX (Euler Greek)"
+            TexFontTemplates.times_fourier_it,  # "Times with Fourier (Italic)"
+            TexFontTemplates.urw_avant_garde,  # "URW Avant Garde (Symbol Greek)"
+            TexFontTemplates.urw_zapf_chancery,  # "URW Zapf Chancery (CM Greek)"
+            TexFontTemplates.venturis_adf_fourier_it,  # "Venturis ADF with Fourier (Italic)"
+            TexFontTemplates.verdana_it,  # "Verdana (Italic)"
+            TexFontTemplates.vollkorn_fourier_it,  # "Vollkorn with Fourier (Italic)"
+            TexFontTemplates.vollkorn,  # "Vollkorn (TX fonts for Greek and math symbols)"
+            TexFontTemplates.zapf_chancery,  # "Zapf Chancery"
+        ]
+
+        self.add(Tex("Tex Font Template Example").to_edge(UL))
+
+        for font in examples:
+            try:
+                write_one_line(font)
+            except:
+                print("FAILURE on ", font.description, " - skipping.")
+
+        self.play(
+            ShowCreation(
+                Tex(
+                    "See more font templates at \\\\ http://jf.burnol.free.fr/showcase.html"
+                ).shift(2 * DOWN)
+            )
+        )
+        self.wait(2)

example_scenes/custom_template.tex

@@ -4,21 +4,6 @@
 \usepackage{amsmath}
 \usepackage{amssymb}
 \usepackage[f]{esvect}
-\usepackage{dsfont}
-\usepackage{setspace}
-\usepackage{tipa}
-\usepackage{relsize}
-\usepackage{textcomp}
-\usepackage{mathrsfs}
-\usepackage{calligra}
-\usepackage{wasysym}
-\usepackage{ragged2e}
-\usepackage{physics}
-\usepackage{xcolor}
-\usepackage{microtype}
-\DisableLigatures{encoding = *, family = * }
-%\usepackage[UTF8]{ctex}
-\linespread{1}
 
 \begin{document}
 

example_scenes/customtex.py

@@ -12,8 +12,8 @@ class TexTemplateFromCLI(Scene):
 
     def construct(self):
         text = MathTex(r"\vv{vb}")
-        # text=Tex(r"$\vv{vb}$")
         self.play(Write(text))
+        self.wait(1)
 
 
 class InCodeTexTemplate(Scene):
@@ -22,10 +22,20 @@ class InCodeTexTemplate(Scene):
     """
 
     def construct(self):
-        tpl = TexTemplate()
-        tpl.append_package(["esvect", ["f"]])
-        config["tex_template"] = tpl
+        # Create a new template
+        myTemplate = TexTemplate()
 
-        # text=Tex(r"$\vv{vb}$")
-        text = MathTex(r"\vv{vb}")
+        # Add packages to the template
+        myTemplate.add_to_preamble(r"\usepackage{esvect}")
+
+        # Set the compiler and output format (default: latex and .dvi)
+        # possible tex compilers: "latex", "pdflatex", "xelatex", "lualatex", "luatex"
+        # possible output formats: ".dvi",  ".pdf", and ".xdv"
+        myTemplate.tex_compiler = "pdflatex"
+        myTemplate.output_format = ".pdf"
+
+        # To use this template in a Tex() or MathTex() object
+        # use the keyword argument tex_template
+        text = MathTex(r"\vv{vb}", tex_template=myTemplate)
         self.play(Write(text))
+        self.wait(1)

manim/__init__.py

@@ -79,3 +79,4 @@
 from .utils.space_ops import *
 from .utils.strings import *
 from .utils.tex import *
+from .utils.tex_templates import *

manim/mobject/svg/tex_mobject.py

@@ -27,6 +27,7 @@
 from ...utils.strings import split_string_list_to_isolate_substrings
 from ...utils.tex_file_writing import tex_to_svg_file
 from ...utils.color import BLACK
+from ...utils.tex import TexTemplate
 
 TEX_MOB_SCALE_FACTOR = 0.05
 
@@ -57,20 +58,21 @@ class SingleStringMathTex(SVGMobject):
         "height": None,
         "organize_left_to_right": False,
         "alignment": "",
-        "type": "tex",
-        "template": None,
+        "tex_environment": "align*",
+        "tex_template": None,
     }
 
     def __init__(self, tex_string, **kwargs):
         digest_config(self, kwargs)
-        if self.template is None:
-            self.template = kwargs.get("tex_template", config["tex_template"])
+        if self.tex_template is None:
+            self.tex_template = kwargs.get("tex_template", config["tex_template"])
+
         assert isinstance(tex_string, str)
         self.tex_string = tex_string
         file_name = tex_to_svg_file(
             self.get_modified_expression(tex_string),
-            self.type,
-            tex_template=self.template,
+            environment=self.tex_environment,
+            tex_template=self.tex_template,
         )
         SVGMobject.__init__(self, file_name=file_name, **kwargs)
         if self.height is None:
@@ -190,6 +192,7 @@ def construct(self):
         "arg_separator": " ",
         "substrings_to_isolate": [],
         "tex_to_color_map": {},
+        "tex_environment": "align*",
     }
 
     def __init__(self, *tex_strings, **kwargs):
@@ -310,7 +313,7 @@ class Tex(MathTex):
     CONFIG = {
         "alignment": "\\centering",
         "arg_separator": "",
-        "type": "text",
+        "tex_environment": None,
     }
 
 

manim/utils/module_ops.py

@@ -6,6 +6,7 @@
 import os
 import sys
 import types
+import re
 
 
 def get_module(file_name):