start tutorial for Opytex

This commit is contained in:
Lafrite 2015-09-13 07:21:42 +02:00
parent 17b4db0db5
commit f8ad55e9fb
1 changed files with 81 additions and 1 deletions

View File

@ -1,2 +1,82 @@
Utilisation de Opytex
=====================
#####################
Surcharge sur latex
===================
Opytex ajoute deux commandes "latex" pour inclure du code Python interprété dans les documents.
Commande *\Block*
----------------
Cette commande permet d'exécuter du code python qui ne sera pas afficher dans le document tex produit.
.. code-block:: latex
Je peux déclarer des variables
\Block{set a = 1}
\Block{set b = 2}
Et même faire des calculs
\Block{set c = a + b}
Mais rien ne sera affiché.
Ce qui produira le document suivant
.. code-block:: latex
Je peux déclarer des variables
Et même faire des calculs
Mais rien ne sera affiché.
Commande *\Var*
---------------
Cette commande va exécuter du code python qui sera ensuite inclut dans le document tex produit.
.. code-block:: latex
Je peux afficher des nombres \Var{2}, \Var{2+3} ...
Et si j'ai enregistré une variable \Block{a = 1}, je peux ensuite l'afficher \Var{a}.
Ce qui produira le document suivant
.. code-block:: latex
Je peux afficher des nombres 2, 5 ...
Et si j'ai enregistré une variable, je peux ensuite l'afficher 1.
Quelques commandes supplémentaires
==================================
Comme Opytex utilise le moteur de template Jinja2, la notion de filtre peut être utilisée.
Filtres qui marchenet bien avec pyMath
-----------------------------------
- *calculus*: Mettre en forme un calcul
.. code-block:: latex
On commence par définir une expression,
\Block{set e = Expression("1 + 2*3")}
et on veut détailler sa simplification
\begin{eqnarray*}
\Var{e.simplify().explain()|calculus(name = 'e')}
\end{eqnarray*}
Ce qui produira le document suivant
.. code-block:: latex
On commence par définir une expression,
et on veut détailler sa simplification
\begin{eqnarray*}
e & = & 1 + 2 \times 3 \\
e & = & 1 + 6 \\
e & = & 7
\end{eqnarray*}