Changeset 1711 for plugins/latexrender
- Timestamp:
- 10/25/09 10:54:24 (14 years ago)
- Location:
- plugins/latexrender/doc
- Files:
-
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
plugins/latexrender/doc/LISEZMOI.html
r1545 r1711 8 8 </head> 9 9 <body> 10 <p>Le plugin LaTeXrender est une extension destinée à permettre à un serveur web hébergeant une installation de Dotclear 2 et une installation de [tex]\LaTeX[/tex] (un traitement de texte dont un des points forts est la représentation des mathématiques et très utilisé pour publier dans le domaine de la recherche scientifique) d'afficher (sous forme d'image) des morceaux de texte composés en [tex]\LaTeX[/tex]. Il est livré avec une zone de réglages pour choisir les chemins ses programmes auxiliaires.</p>11 <p>Ce plugin est d'une part une conversion d'une classe déjà existante (la classe <a hreflang="en" href="http://www.mayer.dial.pipex.com/tex.htm">latexrender</a>, écrite en PHP pour un tas de supports) ;d'autre part, j'ai simplifié la classe (un bon nombre de choses sont complètement simplifiables dans le cadre restreint de Dotclear 2) mais aussi amélioré l'algorithme de choix de décalage vertical (lui-même ajouté par Mike Boyle) et introduit une gestion des couleurs (des gens utilisent des fonds sombres, et les équations en noir sur noir ou en noir sur bleu nuit, ce n'est pas très lisible).</p>10 <p>Le plugin LaTeXrender est une extension destinée à permettre à un serveur web hébergeant une installation de Dotclear 2 et une installation de [tex]\LaTeX[/tex] (un traitement de texte dont un des points forts est la représentation des mathématiques et très utilisé pour publier dans le domaine de la recherche scientifique) d'afficher (sous forme d'image) des morceaux de texte composés en [tex]\LaTeX[/tex]. Il est livré avec une zone de réglages pour choisir les chemins de ses programmes auxiliaires.</p> 11 <p>Ce plugin est d'une part une conversion d'une classe déjà existante (la classe <a hreflang="en" href="http://www.mayer.dial.pipex.com/tex.htm">latexrender</a>, écrite en PHP pour un tas de supports), d'autre part, j'ai simplifié la classe (un bon nombre de choses sont complètement simplifiables dans le cadre restreint de Dotclear 2) mais aussi amélioré l'algorithme de choix de décalage vertical (lui-même ajouté par Mike Boyle) et introduit une gestion des couleurs (des gens utilisent des fonds sombres, et les équations en noir sur noir ou en noir sur bleu nuit, ce n'est pas très lisible).</p> 12 12 <hr class="separator" /> 13 13 <p class="pluginlocation">La page de maintenance de cette extension est à cette adresse : <a href="/post/latexrender">http://jean-christophe.dubacq.fr/post/latexrender</a>.</p> … … 17 17 Paramètres en tant que <strong>super-administrateur</strong>, et 18 18 remplissez les chemins d'accès aux divers exécutables ([tex]\LaTeX[/tex] 19 et la suite ImageMagick ; les valeurs par défautsdoivent être19 et la suite ImageMagick ; les valeurs par défaut doivent être 20 20 suffisantes pour la plupart des installations) ainsi que quelques 21 21 paramètres supplémentaires (dans le menu Extensions). Les paramètres 22 doivent être évidents 22 doivent être évidents ; si ce n'est pas le cas, soumettez un rapport de 23 23 bug.</p> 24 24 <div class="photo"><a href="/public/photos/dotclear/latexrender-admin.png"><img src="/public/photos/dotclear/.latexrender-admin_m.jpg" alt="Interface d'administration de LaTeXrender" title="Interface d'administration de LaTeXrender" /></a><div class="legende">Interface d'administration de LaTeXrender</div></div> … … 33 33 les plateformes d'hébergement spécifiques doivent pouvoir le fournir 34 34 sans beaucoup d'efforts (entreprise, laboratoire, particulier 35 auto-hébergé) 35 auto-hébergé) : ce sont des logiciels extrêmement courants sous Linux.</p> 36 36 <p>Il faut pour que cette extension fonctionne utiliser l'extension <a href="/post/stacker">stacker</a>. Une 37 37 solution sans cette extension est à l'étude, mais elle sera forcément 38 38 incompatible avec plusieurs autres extensions qui redéfinissent l'accès 39 au contenu des billets (note : comme l'auteur en utilise plusieurs, il40 considère ce cicomme un bug).</p>39 au contenu des billets (note : comme l'auteur en utilise plusieurs, il 40 considère cela comme un bug).</p> 41 41 <p class="version">La version courante de cette extension est 0.9.3 (local svn 400).</p><p class="licence">Cette extension est sous la licence <a href="http://www.gnu.org/licenses/lgpl-2.1.html" hreflang="en">GPL version 2.0</a>.</p> 42 42 <h3>Utilisation</h3> 43 43 <h4>Utilisation basique</h4> 44 <p>L'utilisation e n est souple, il suffit de taper son texte44 <p>L'utilisation est souple, il suffit de taper son texte 45 45 [tex]\LaTeX[/tex] entre deux 46 46 pseudos-balises <code>[tex]...[/tex]</code>. Par exemple, 47 47 [tex]$\displaystyle\int_{0}^{1}\frac{x^{4}\left(1-x\right)^{4}}{1+x^{2}}dx 48 48 =\frac{22}{7}-\pi$[/tex].</p> 49 <p>NB : en mode wiki, il faut passer temporairement en mode HTML pour que ça marche (un bug a été ouvert pour rendre cette procédure plus facile):</p>49 <p>NB : en mode wiki, il faut passer temporairement en mode HTML pour que ça marche (un rapport de bug a été ouvert pour rendre cette procédure plus facile) :</p> 50 50 <pre class="code"> 51 51 ///html … … 53 53 /// 54 54 </pre> 55 <p>Les équations sont représentées sous forme d'image ,et le code [tex]\LaTeX[/tex] est55 <p>Les équations sont représentées sous forme d'image et le code [tex]\LaTeX[/tex] est 56 56 donné comme titre de l'image.</p> 57 57 <div class="photo"><a href="/public/photos/dotclear/latexrender-exemple.png"><img src="/public/photos/dotclear/latexrender-exemple.png" alt="Exemple de rendu de LaTeXrender" title="Exemple de rendu de LaTeXrender" /></a><div class="legende">Exemple de rendu de LaTeXrender</div></div> … … 60 60 code doivent être composés en mode horizontal (si on veut composer en 61 61 mode vertical, par exemple des grandes équations, plusieurs 62 paragraphes ..., il faut encadrer le tout par un62 paragraphes…, il faut encadrer le tout par un 63 63 <code>\begin{minipage}{500px}...\end{minipage}</code>). C'est une restriction de 64 64 [tex]\LaTeX[/tex], pas de l'extension.</p> … … 66 66 dans un sous-répertoire <code>latexrender/images</code>.</p> 67 67 <h4>Gestion des couleurs</h4> 68 <p>La classe d'origine ne savait pas gérer des couleurs 68 <p>La classe d'origine ne savait pas gérer des couleurs : le texte était 69 69 toujours rendu en noir (sur fond transparent dans les dernières 70 70 versions). Certains thèmes sont de couleur sombre, ce qui rendait 71 71 l'extension inutilisable. Il est possible d'indiquer à LaTeXrender la 72 72 couleur dominante dans laquelle on veut que les équations soient rendues 73 pour qu'elles apparaissent sur la page. Par exemple, sur cette page, le thème d'origine <em>Grey Silence</em> ne fait aucun traitement spécifique, mais le thème <em>LIPN-hiver</em> était enblanc sur noir.</p>73 pour qu'elles apparaissent sur la page. Par exemple, le thème <em>Grey Silence</em> ne nécessite aucun traitement spécifique, mais le thème <em>LIPN-hiver</em> réclame du blanc sur noir.</p> 74 74 <p>Si vous choisissez la méthode de génération <em>avec couleur</em> 75 (qui nécessite un ImageMagick plus récent 76 ImageMagick 6.2.4 02/10/07 Q16), vous pourrez utiliser cette possibilité 77 ;il suffit d'ajouter dans l'un des75 (qui nécessite un ImageMagick plus récent ; ça fonctionne au moins avec 76 ImageMagick 6.2.4 02/10/07 Q16), vous pourrez utiliser cette possibilité ; 77 il suffit d'ajouter dans l'un des 78 78 fichiers de votre thème (juste avant la fin qui est normalement ?>) 79 79 l'expression <code>$core->theme_color='FFFFFF';</code>. Cette ligne peut être 80 80 ajoutée avant la dernière ligne de <code>_public.php</code> ou <code>_prepend.php</code>. Si aucun 81 81 de ces fichiers n'est présent, un fichier <code>_public.php</code> constitué d'une 82 seule ligne peut être ajouté :</p>82 seule ligne peut être ajouté :</p> 83 83 <pre class="code"><?php $core->theme_color='FFFFFF'; ?></pre> 84 84 <p>FFFFFF est à remplacer par la <a href="http://www.commentcamarche.net/html/htmlcouleurs.php3" hreflang="fr">couleur voulue en hexadécimal</a> (ici, blanc; 85 85 jaune est FFFF00, rouge est FF0000...).</p> 86 <div class="bug"><h3>Pour signaler un bug ou aider cette extension</h3><p>Le mieux est de me contacter <a href="http://jean-christophe.dubacq.fr/pages/Contact">par courrier</a> (pour un bug) ou de laisser un commentaire (pour dire que vous avez testé cette extension). En cas de mise à jour, je modifierai ce billet.</p></div><div class="changelog"><h3>Liste des changements</h3><p>Note : ce journal est non-exhaustif, généré automatiquement, en anglais, et sans doute non-informatif avant 2009.</p><ul><li>Local SVN release 400 (jcdubacq,2009-10-03)<ul> <li>Bump version number (oops)</li> </ul></li> <li>Local SVN release 369 (jcdubacq,2009-04-30)<ul> <li>Clean code</li> <li>Lift for the admin backend</li> <li>New screenshot</li> </ul></li> <li>Local SVN release 348 (jcdubacq,2009-04-22)<ul> <li>Fix documentation</li> </ul></li> <li>Local SVN release 346 (jcdubacq,2009-04-22)<ul> <li>Fix licence block, reindent</li> <li>Switch to LGPL 2.1 in order to keep the original licence</li> </ul></li> <li>Local SVN release 333 (jcdubacq,2009-04-18)<ul> <li>Allow for public path to be an absolute path, release</li> </ul></li> <li>Local SVN release 303 (jcdubacq,2009-01-27)<ul> <li>Fix locales</li> </ul></li> <li>Local SVN release 297 (jcdubacq,2009-01-26)<ul> <li>Adapt to version 0.3 of stacker (behavior initStacker)</li> </ul></li> <li>Local SVN release 292 (jcdubacq,2009-01-22)<ul> <li>Update documentation, release new version 0.6</li> </ul></li> <li>Local SVN release 259 (jcdubacq,2008-11-18)<ul> <li>Fix public url usage in admin area</li> </ul></li> <li>Local SVN release 205 (jcdubacq,2008-07-24)<ul> <li>Add documentation, new version</li> </ul></li> <li>Local SVN release 187 (jcdubacq,2008-07-09)<ul> <li>Add admin page, rewrite latexrender class to better fit the needs of DC2</li> </ul></li> <li>Local SVN release 168 (jcdubacq,2008-05-06)<ul> <li>Order plugins and themes</li> </ul></li> <li>Local SVN release 47 (jcdubacq,2008-02-15)<ul> <li>Add latexrender plugin</li> </ul></li></ul></div>86 <div class="bug"><h3>Pour signaler un bug ou aider cette extension</h3><p>Le mieux est de me contacter <a href="http://jean-christophe.dubacq.fr/pages/Contact">par courrier</a> (pour un bug) ou de laisser un commentaire (pour dire que vous avez testé cette extension). En cas de mise à jour, je modifierai cette aide.</p></div><div class="changelog"><h3>Liste des changements</h3><p>Note : ce journal est non-exhaustif, généré automatiquement, en anglais, et sans doute non-informatif avant 2009.</p><ul><li>Local SVN release 400 (jcdubacq,2009-10-03)<ul> <li>Bump version number (oops)</li> </ul></li> <li>Local SVN release 369 (jcdubacq,2009-04-30)<ul> <li>Clean code</li> <li>Lift for the admin backend</li> <li>New screenshot</li> </ul></li> <li>Local SVN release 348 (jcdubacq,2009-04-22)<ul> <li>Fix documentation</li> </ul></li> <li>Local SVN release 346 (jcdubacq,2009-04-22)<ul> <li>Fix licence block, reindent</li> <li>Switch to LGPL 2.1 in order to keep the original licence</li> </ul></li> <li>Local SVN release 333 (jcdubacq,2009-04-18)<ul> <li>Allow for public path to be an absolute path, release</li> </ul></li> <li>Local SVN release 303 (jcdubacq,2009-01-27)<ul> <li>Fix locales</li> </ul></li> <li>Local SVN release 297 (jcdubacq,2009-01-26)<ul> <li>Adapt to version 0.3 of stacker (behavior initStacker)</li> </ul></li> <li>Local SVN release 292 (jcdubacq,2009-01-22)<ul> <li>Update documentation, release new version 0.6</li> </ul></li> <li>Local SVN release 259 (jcdubacq,2008-11-18)<ul> <li>Fix public url usage in admin area</li> </ul></li> <li>Local SVN release 205 (jcdubacq,2008-07-24)<ul> <li>Add documentation, new version</li> </ul></li> <li>Local SVN release 187 (jcdubacq,2008-07-09)<ul> <li>Add admin page, rewrite latexrender class to better fit the needs of DC2</li> </ul></li> <li>Local SVN release 168 (jcdubacq,2008-05-06)<ul> <li>Order plugins and themes</li> </ul></li> <li>Local SVN release 47 (jcdubacq,2008-02-15)<ul> <li>Add latexrender plugin</li> </ul></li></ul></div> 87 87 <h3>Travail restant à faire</h3> 88 88 <ul><li>Faire une version qui ne dépend pas de l'extension <code>stacker</code></li> … … 90 90 <li>Gérer les couleurs des thèmes indépendamment des thèmes</li> 91 91 <li>Travailler avec Sacha pour fournir une version client/serveur de 92 latexrender qui sait fournir l'image et le décalage ,et avec des92 latexrender qui sait fournir l'image et le décalage et avec des 93 93 conditions de sécurité suffisantes (le calcul des images peut être 94 94 coûteux ou risqué si n'importe qui peut le faire).</li> -
plugins/latexrender/doc/LISEZMOI.txt
r1545 r1711 5 5 la recherche scientifique) d'afficher (sous forme d'image) des morceaux de texte 6 6 composés en [tex]\LaTeX[/tex]. Il est livré avec une zone de réglages pour 7 choisir les chemins ses programmes auxiliaires.7 choisir les chemins de ses programmes auxiliaires. 8 8 9 9 Ce plugin est d'une part une conversion d'une classe déjà existante (la classe 10 [1]latexrender, écrite en PHP pour un tas de supports) ;d'autre part, j'ai10 [1]latexrender, écrite en PHP pour un tas de supports), d'autre part, j'ai 11 11 simplifié la classe (un bon nombre de choses sont complètement simplifiables 12 12 dans le cadre restreint de Dotclear 2) mais aussi amélioré l'algorithme de choix … … 24 24 zone d'administration Extensions > LaTeXrender > Paramètres en tant que 25 25 super-administrateur, et remplissez les chemins d'accès aux divers exécutables 26 ([tex]\LaTeX[/tex] et la suite ImageMagick ; les valeurs par défautsdoivent être26 ([tex]\LaTeX[/tex] et la suite ImageMagick ; les valeurs par défaut doivent être 27 27 suffisantes pour la plupart des installations) ainsi que quelques paramètres 28 supplémentaires (dans le menu Extensions). Les paramètres doivent être évidents 29 ;si ce n'est pas le cas, soumettez un rapport de bug.28 supplémentaires (dans le menu Extensions). Les paramètres doivent être évidents; 29 si ce n'est pas le cas, soumettez un rapport de bug. 30 30 31 31 L'extension nécessite une installation sur le serveur de latex et du paquet … … 40 40 solution sans cette extension est à l'étude, mais elle sera forcément 41 41 incompatible avec plusieurs autres extensions qui redéfinissent l'accès au 42 contenu des billets (note : comme l'auteur en utilise plusieurs, il considère43 ce cicomme un bug).42 contenu des billets (note : comme l'auteur en utilise plusieurs, il considère 43 cela comme un bug). 44 44 45 45 La version courante de cette extension est 0.9.3 (local svn 400). … … 51 51 --- Utilisation basique --- 52 52 53 L'utilisation e n est souple, il suffit de taper son texte [tex]\LaTeX[/tex]53 L'utilisation est souple, il suffit de taper son texte [tex]\LaTeX[/tex] 54 54 entre deux pseudos-balises [tex]...[/tex]. Par exemple, 55 55 [tex]$\displaystyle\int_{0}^{1}\frac{x^{4}\left(1-x\right)^{4}}{1+x^{2}}dx 56 56 =\frac{22}{7}-\pi$[/tex]. 57 57 58 NB: en mode wiki, il faut passer temporairement en mode HTML pour que ça marche 59 (un bug a été ouvert pour rendre cette procédure plus facile): 58 NB : en mode wiki, il faut passer temporairement en mode HTML pour que ça marche 59 (un ticket a été ouvert pour rendre cette procédure plus facile) : 60 60 61 ///html 61 62 [tex]$(a+b)^2=a^2+2ab+b^2$[/tex] 62 63 /// 63 64 64 Les équations sont représentées sous forme d'image ,et le code [tex]\LaTeX[/tex]65 Les équations sont représentées sous forme d'image et le code [tex]\LaTeX[/tex] 65 66 est donné comme titre de l'image. 66 67 … … 68 69 autorisées (pas de \special, par exemple), les morceaux de code doivent être 69 70 composés en mode horizontal (si on veut composer en mode vertical, par exemple 70 des grandes équations, plusieurs paragraphes ..., il faut encadrer le tout par un71 des grandes équations, plusieurs paragraphes…, il faut encadrer le tout par un 71 72 \begin{minipage}{500px}...\end{minipage}). C'est une restriction de 72 73 [tex]\LaTeX[/tex], pas de l'extension. … … 82 83 possible d'indiquer à LaTeXrender la couleur dominante dans laquelle on veut que 83 84 les équations soient rendues pour qu'elles apparaissent sur la page. Par 84 exemple, sur cette page, le thème d'origine Grey Silence ne faitaucun85 traitement spécifique, mais le thème LIPN-hiver était enblanc sur noir.85 exemple, le thème Grey Silence ne nécessite aucun 86 traitement spécifique, mais le thème LIPN-hiver réclame du blanc sur noir. 86 87 87 88 Si vous choisissez la méthode de génération avec couleur (qui nécessite un … … 91 92 l'expression $core->theme_color='FFFFFF';. Cette ligne peut être ajoutée avant 92 93 la dernière ligne de _public.php ou _prepend.php. Si aucun de ces fichiers n'est 93 présent, un fichier _public.php constitué d'une seule ligne peut être ajouté :94 présent, un fichier _public.php constitué d'une seule ligne peut être ajouté : 94 95 <?php $core->theme_color='FFFFFF'; ?> 95 96 96 FFFFFF est à remplacer par la [6]couleur voulue en hexadécimal (ici, blanc ;97 jaune est FFFF00, rouge est FF0000 ...).97 FFFFFF est à remplacer par la [6]couleur voulue en hexadécimal (ici, blanc ; 98 jaune est FFFF00, rouge est FF0000…). 98 99 99 100 === Pour signaler un bug ou aider cette extension === … … 101 102 Le mieux est de me contacter [7]par courrier (pour un bug) ou de laisser un 102 103 commentaire (pour dire que vous avez testé cette extension). En cas de mise à 103 jour, je modifierai ce billet.104 jour, je modifierai ce fichier. 104 105 105 106 === Liste des changements === … … 143 144 * Gérer les couleurs des thèmes indépendamment des thèmes 144 145 * Travailler avec Sacha pour fournir une version client/serveur de latexrender 145 qui sait fournir l'image et le décalage ,et avec des conditions de sécurité146 qui sait fournir l'image et le décalage et avec des conditions de sécurité 146 147 suffisantes (le calcul des images peut être coûteux ou risqué si n'importe qui 147 148 peut le faire).
Note: See TracChangeset
for help on using the changeset viewer.