TexTemplate

完整名称: manim.utils.tex.TexTemplate

class TexTemplate(tex_compiler='latex', description='', 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 (添加到文档)	在 begin{document} 之后立即将文本添加到 TeX 模板，例如 \boldmath。
add_to_preamble (添加到序言)	将文本添加到 TeX 模板的序言（例如定义、包）。
copy (复制)	创建 TeX 模板实例的深拷贝。
from_file (从文件创建)	通过读取文件内容创建实例。
get_texcode_for_expression (获取表达式的Tex代码)	将表达式逐字插入到 TeX 模板中。
get_texcode_for_expression_in_env (在环境中获取表达式的Tex代码)	将表达式插入到 TeX 模板中，并用 \begin{environment} 和 \end{environment} 包裹。

属性

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

参数:

• tex_compiler (str)

• description (str)

• output_format (str)

• documentclass (str)

• preamble (str)

• placeholder_text (str)

• post_doc_commands (str)

_body: str = ''

自定义正文，可以从文件中设置。

add_to_document(txt)

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

参数:

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

返回类型:

自身

add_to_preamble(txt, prepend=False)

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

参数:

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

• prepend (bool) – 文本是否应添加到序言的开头，即紧随 \documentclass 之后。默认为添加到序言的末尾，即紧随 \begin{document} 之前。

返回类型:

自身

property body: str

整个 TeX 模板。

copy()

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

返回类型:

自身

description: str = ''

模板的描述

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

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

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

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

在此实例上使用 add_to_preamble 和 add_to_document 方法将无效，因为正文是从文件读取的。

参数:

• file (StrPath)

• kwargs (Any)

返回类型:

自身

get_texcode_for_expression(expression)

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

参数:

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

返回:

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

返回类型:

str

get_texcode_for_expression_in_env(expression, environment)

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

参数:

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

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

返回:

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

返回类型:

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。