TexTemplate

限定名称: manim.utils.tex.TexTemplate

class TexTemplate(tex_compiler='latex', output_format='.dvi', documentclass='\\documentclass[preview]{standalone}', preamble='\\usepackage[english]{babel}\n\\usepackage{amsmath}\n\\usepackage{amssymb}', placeholder_text='YourTextHere', post_doc_commands='')

基础：object

TeX 模板用于创建 Tex 和 MathTex 对象。

方法

add_to_document	在TeX模板的begin{document}之后添加文本，例如\boldmath。
add_to_preamble	将文本添加到TeX模板的前言部分（例如定义、包）。
copy	创建TeX模板实例的深拷贝。
from_file	通过读取文件内容创建一个实例。
get_texcode_for_expression	将表达式逐字插入到TeX模板中。
get_texcode_for_expression_in_env	将表达式插入到包裹在\begin{environment}和\end{environment}中的TeX模板中。

属性

body	整个TeX模板。
documentclass	定义文档类的命令，例如 \documentclass[preview]{standalone}。
output_format	编译后生成的输出格式，例如 .dvi 或 .pdf。
placeholder_text	文档中将被渲染表达式替换的文本。
post_doc_commands	文本（定义、命令）将在\begin{document}之后立即插入，例如\boldmath。
序言	文档的前言部分，即位于\documentclass和\begin{document}之间的部分。
tex_compiler	要使用的TeX编译器，例如latex、pdflatex或lualatex。

Parameters:

• tex_compiler (str)

• output_format (str)

• documentclass (str)

• 前言 (str)

• placeholder_text (str)

• post_doc_commands (str)

_body: str = ''

自定义主体，可以从文件设置。

add_to_document(txt)

在TeX模板的begin{document}之后添加文本，例如\boldmath。

Parameters:

txt (str) – 包含要添加的文本的字符串。

Return type:

自我

add_to_preamble(txt, prepend=False)

将文本添加到TeX模板的前言部分（例如定义、包）。文本可以插入到前言的开头或结尾。

Parameters:

• txt (str) – 包含要添加的文本的字符串，例如 \usepackage{hyperref}。

• prepend (bool) – 文本是否应添加到前言的开头，即在 \documentclass 之后。 默认情况下，文本会添加到前言的末尾，即在 \begin{document} 之前。

Return type:

自我

property body: str

整个TeX模板。

copy()

创建TeX模板实例的深拷贝。

Return type:

自我

documentclass: str = '\\documentclass[preview]{standalone}'

定义文档类的命令，例如 \documentclass[preview]{standalone}。

classmethod from_file(file='tex_template.tex', **kwargs)

通过读取文件内容创建一个实例。

在此实例上使用add_to_preamble和add_to_document方法将不会产生任何效果，因为正文是从文件中读取的。

Parameters:

• 文件 (StrPath)

• kwargs (任意)

Return type:

自我

get_texcode_for_expression(expression)

将表达式逐字插入到TeX模板中。

Parameters:

expression (str) – 包含要排版的表达式的字符串，例如 $\sqrt{2}$

Returns:

基于当前模板的LaTeX代码，包含给定的expression并准备好进行排版

Return type:

str

get_texcode_for_expression_in_env(expression, environment)

将表达式插入到包裹在\begin{environment}和\end{environment}中的TeX模板中。

Parameters:

• expression (str) – 包含要排版的表达式的字符串，例如 $\sqrt{2}$。

• 环境 (str) – 包含表达式应在其中排版的字符串，例如 align*。

Returns:

基于模板的LaTeX代码，包含其环境中的给定表达式，准备进行排版

Return type:

str

output_format: str = '.dvi'

编译后生成的输出格式，例如 .dvi 或 .pdf。

placeholder_text: str = 'YourTextHere'

文档中将被渲染表达式替换的文本。

post_doc_commands: str = ''

文本（定义、命令）将在\begin{document}之后立即插入，例如\boldmath。

preamble: str = '\\usepackage[english]{babel}\n\\usepackage{amsmath}\n\\usepackage{amssymb}'

文档的前言部分，即位于\documentclass和\begin{document}之间的部分。

tex_compiler: str = 'latex'

要使用的TeX编译器，例如latex、pdflatex或lualatex。