eqhl

Release 0.2

A highlighting system to explain equations and their components easily

Homepage PyPI

License
ISC
Install
pip install eqhl==0.2

Documentation

EQHL

A tool for explaining equations.

Installation

pip install eqhl

Structure

An Equation object contains a list of Term and HLTerm. HLTerm is an equation term that displays a tool tip and is highlighted when hovered over. It takes two arguments, the first is the LaTeX math to be displayed via KaTeX, the second is the tooltip to display. Highlight color is chosen automatically from six pre-defined colors that are cycled through. A Term only takes LaTeX math and is used for un-emphasized characters and terms, such as equal signs.

Usage

To create an Equation, pass a list of Term and HLTerm as follows:

newtons_second = Equation([HLTerm(r'\vec{F}', 'Force'), Term('='), HLTerm('m', 'Mass'), HLTerm(r'\vec{a}', 'Acceleration')])

Note the usage of r'raw string literals' to avoid LaTeX backslash commands being interpreted as an escape character.

Webpages

There are four things you need to do to put an equation on your webpage:

  1. Install KaTeX on the page
  2. Make sure that KaTeX is told to render math on the page, this can be done with JavaScript: renderMathInElement(document.body);, more info here.
  3. Put eqhl.css somewhere appropriate and add it to your document's <head>: <link type="text/css" rel="stylesheet" href="eqhl.css">
  4. Add the HTML generated by the Python file to your webpage

Customization

Using SASS

The recommended way to customize is to install the sassc SASS compiler, edit eqhl.sass and then run make. Color variables can be changed at the top of the file.

Using CSS

Without SASS, edit eqhl.css and modify colors directly.

Stats

Dependencies
0
Dependent packages
0
Dependent repositories
0
Total releases
2
Latest release
First release
Stars
0
Forks
0
Contributors
0
SourceRank
6

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

0.2
0.1

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2021-02-15 04:33:54 UTC

Login to resync this project