From ded3617fc69cbaf9874797c3ad08f2323bcfecdd Mon Sep 17 00:00:00 2001 From: Nicolas Date: Sun, 13 Apr 2025 12:18:28 +0200 Subject: [PATCH] capital/small letters for latex in the readme fixed --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0c39e53..a61ce28 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Description Pyladoc is a python package for programmatically generating HTML and -PDF/LaTex output. This package targets specifically applications where reports +PDF/LaTeX output. This package targets specifically applications where reports or results with Pandas-tables and Matplotlib-figures are generated programmatically to be displayed as website and as PDF document without any manual formatting steps. @@ -11,31 +11,31 @@ This package focuses on the "Document in Code" approach for cases where a lot of calculations and data handling is done but not a lot of document text needs to be displayed. -As backend for PDF generation LaTex is used. There are excellent engines for +As backend for PDF generation LaTeX is used. There are excellent engines for rendering HTML to PDF available, but even if there is no requirement for an accurate typesetting, placing programmatically content of variable -composition and sizes on fixed size pages without manual intervention +composition and element sizes on fixed size pages without manual intervention is a hard problem that LaTeX is very capable of. ## Example outputs The following documents are generated by [tests/test_rendering_example_doc.py](tests/test_rendering_example_doc.py): - HTML: [test_html_render.html](https://html-preview.github.io/?url=https://github.com/Nonannet/pyladoc/blob/main/tests/out/test_html_render.html) -- PDF: [test_latex_render.pdf](https://raw.githubusercontent.com/Nonannet/pyladoc/refs/heads/main/tests/out/test_latex_render.pdf) +- PDF: [test_latex_render.pdf](https://raw.githubusercontent.com/Nonannet/pyladoc/refs/heads/main/tests/out/test_LaTeX_render.pdf) ### Sported primitives - Text (can be Markdown or HTML formatted) - Headings - Tables (Pandas, Markdown or HTML) - Matplotlib figures -- LaTex equations +- LaTeX equations - Named references for figures, tables and equation ### Key Features -- HTML and PDF/LaTex rendering of the same document +- HTML and PDF/LaTeX rendering of the same document - Single file output including figures - Figure and equation embedding in HTML by inline SVG, SVG in Base64 or PNG in Base64 -- Figure embedding in LaTex as PGF/TikZ +- Figure embedding in LaTeX as PGF/TikZ ### Usage Scenarios - Webservices