Generates properly baselined images and HTML code from LaTeX formulas.
Project description
based_latex
Generates properly baselined images and HTML code from LaTeX formulas.
Installation
pip install based_latex
Requirements
This package requires a LaTeX distribution, as well as the ImageMagick package.
Usage
Use the function based_latex.save_latex_image(expression, path)
to save a LaTeX image of the formula in expression
at path
. This function also returns two variables prefix
and suffix
with which you can construct the proper HTML code to embed the image, by simply concatenating prefix + image_url + suffix
import based_latex
prefix, suffix = based_latex.save_latex_image("\\frac{n^2+1}{n!}", "formula.png")
# Image is now saved at formula.png
print(prefix + "formula.png" + suffix)
# <span class="latex" style="position:relative;display:inline-block;vertical-align:0;width:2.125em;height:1.1406em;margin-bottom:0.4062em;"><img style="position:absolute;top:0;left:0;width:100%;height:200%;margin:0;padding:0;border-style:none;border:0;" src="formula.png"/></span>
Some optional parameters of based_latex.save_latex_image
, with their respective default elements, are:
density = 512
This parameter is used by ImageMagick's convert
command, and is proportional to the generated image's resolution.
factor = 1
HTML code is normally generated to match the element's font, multiplied by factor
.
class_name = "latex"
The wrapping <span>
element has this css class.
include_static_style = True
The generated HTML code can usually be embedded without any extra work. However, you may wish to factor out some of the style to avoid repeated CSS code. In that case you may set include_static_style = False
and add this CSS code to your page's header:
img.latex { /* replace latex by the value of class_name */
object-fit:cover;
object-position:0 0;
}
process_timeout = 2
This is the timeout of the pdflatex
and convert
(from ImageMagick) commands. After this timeout, the function will raise an exception if, for example, your formula happens to have a syntax error.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for based_latex-0.0.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29d4525f52549501cbbb7c050f87a404a09ff8e9c33f93a8da9494e7ee758bae |
|
MD5 | 79b5731dc054b19fa788c4c044b98a38 |
|
BLAKE2b-256 | 787075988823b9b1c0770556926391be488274f702a46074830154a8a1ec9171 |