markdown2Mathjax

markdown2Mathjax jest prosty pakiet, który umożliwia korzystanie stylu lateks matematyki generowane przez MathJax w połączeniu z popularnym formacie wyprzedaży. & Nbsp; Istnieją dwie implementacje obniżki w python, ten pakiet jest przeznaczony do stosowania w szerszym zakresie i aktywnie utrzymywane z dwóch, zwany markdown2. Typowe zastosowanie jest następujący:
#! / Usr / bin / env python
z markdown2Mathjax importu sanitizeInput, reconstructMath
z markdown2 importu obniżki
tmp = sanitizeInput (sometxt)
markdedDownText = Przecena (tmp [0])
finalOutput = reconstructMath (markedDownText, tmp [1])
(Gdzie "sometxt" to ciąg znaków zawierający tekst Markdown + MathJax).
instalacji
markdown2Mathjax jest hostowany na PyPI, więc mogą być instalowane ze źródeł, za pomocą:
tar zxvf markdown2Mathjax-x.x.x.tar.gz
cd markdown2Mathjax-x.x.x
python setup.py install
lub przy użyciu pip (lub easy_install jeśli wolisz):
pip install markdown2Mathjax
Zastosowanie
Domyślnie, matematyka jest oznaczony przez pojedyncze znaki na rolkach $ matematyki i dwuosobowych $$ znaki dla równań. Jednakże wszystkie łańcuchy wytyczenie mogą być wykorzystywane przez zmianę argumenty opcjonalne funkcje sanitizeInput i reconstructMath. Należy pamiętać, że domyślnie MathJax nie używa pojedynczych dolarów znaki do oddzielania inline matematyki, więc jeśli używasz ustawień domyślnych dla tego pakietu, trzeba będzie zlecić MathJax traktować go odpowiednio.
Wyjaśnienie
Funkcja sanitizeInput znajdzie wszystkie wystąpienia matematyki (jak określono dostarczonych ograniczniki) i zastępuje je z zastępczy. Ten zastępczy może być określona przez użytkownika, ale zaleca się korzystania z dostarczonego domyślną "$ $ 0". Zastępczy musi być coś, co nie będzie przetwarzane przez obniżki, i nigdy nie będzie produkowany przez obniżki. Pierwszy z tych wymogów jest dość łatwe do spełnienia, drugi może być nieco bardziej subtelny. Jeśli zastępczy już istnieje w dostarczonej tekst użytkownika, należy zauważyć, przez sanitizeInput i być sama, kiedy przebudowa matematyki po przetworzeniu wyprzedaży.
Za każdym razem, ważne blok matematyki napotyka i zastąpić zastępczy, matematyka jest zapisany na liście (zwane CodeBlocks), który jest następnie zwracany przez funkcję sanitizeInput. Każdy wpis CodeBlocks jest poprzedzona 0 (w dosłownym tego wystąpienia zastępczego w tekście), a 1 dla inline matematyki lub 2 odrębnego równania.
Odkażane ciąg od sanitizeInput mogą być oznaczone przez obniżki bez obawy o swoje matematyka jest zniekształcone. Wreszcie reconstructMath zastępuje każdy z symboli zastępczych w oznaczonym się tekstem z odpowiednim bloku kodu. Ten ostatni html mogą być wyświetlane z odpowiednim MathJax javascript nagłówki.
Innym sposobem, aby myśleć o to, niż reconstructMath jest w zasadzie odwrotność sanitizeInput. Więc bez przecen pomiędzy, nic nie powinno zmienić między nimi (z wyjątkiem, gdy reconstructMath ma również pewne dodatkowe oczyszczanie z CodeBlocks matematycznych). To jest:
tmp = sanitizeInput (test)
reconstructMath (tmp [0], tmp [1]) Test ==
należy zawsze oceniać true

Wymagania .

• Python