rename tex to teximg
[ikiwiki.git] / doc / todo / latex.mdwn
1 How about a plugin adding a
2 [[preprocessor_directive|preprocessordirective]] to render some given LaTeX
3 and include it in the page?  This could either render the LaTeX as a PNG via
4 [[debpkg dvipng]] and include the resulting image in the page, or perhaps
5 render via [HeVeA](http://pauillac.inria.fr/~maranget/hevea/index.html),
6 [TeX2page](http://www.ccs.neu.edu/~dorai/tex2page/tex2page-doc.html), or
7 similar. Useful for mathematics, as well as for stuff like the LaTeX version
8 of the ikiwiki [[/logo]].
9
10 ----
11
12 ikiwiki could also support LaTeX as a document type, again rendering to HTML.
13
14 ----
15
16 Conversely, how about adding a plugin to support exporting to LaTeX?
17
18 >> I did some tests with using Markdown and a customized HTML::Latex and html2latex
19 >> and it appears it will work for me now. (I hope to use ikiwiki for many
20 >> to collaborate on a printed book that will be generated at least once per day in PDF format.)
21 >>
22 >> --JeremyReed
23
24 >>> Have a look at [pandoc](http://code.google.com/p/pandoc/).  It can make PDFs via pdflatex. --[[roktas]]
25
26 ----
27
28 [here](http://ng.l4x.org/gitweb/gitweb.cgi?p=ikiwiki.git/.git;a=blob;f=IkiWiki/Plugin/latex.pm) is a first stab at
29 a latex plugin. Examples [here](http://ng.l4x.org/latex/). Currently without image support for hevea. And the latex2html
30 output has the wrong charset and no command line switch to change that. Dreamland.
31
32 ----
33
34 Okay, now is the time for a mid term report i think.
35
36 The LaTeX Plugin for ikiwiki is now usable, except for the security check. This means at the moment the latex code is not validated, but only added into a very basic latex template. and the image is generated via this path: latex -> dvips -> convert (.tex -> .dvi -> .ps -> .png).
37 The resulting .png is moved into the imagefolder. The name of this image is the md5hash of the code the user wrote into the wiki. So on a second run there is no need to recreate this image, if it exists. This will fasten up all but the first generation of the page. 
38 The generation of the image is done in an temporary folder in /tmp created with tempdir from File::Temp. The tmp-folder name is something like: $md5sumdigest.XXXXXXXX. if there is an .tex file already in this dir it will be overwritten. 
39
40 So until now i finished the basic things, now the most important task is to make an good input validation.
41 This is a bit eased since it is not possible to execute shell commands in perl. Furthermore adding additional packages won't work since the code comes from the user is inserted after \begin{document}. Therefore this will result in an error (and this will stop latex from working --> no image is created).
42
43 So my task for the next weeks is to write an good input validation. 
44 I think this progress is okay, since I'll had to learn the last 5-6 weeks for my final exams in university therefore I can't do anything. From now on I have 3 months of freetime and I'll use them to work heavily on this plugin. 
45 So I think I'm inside my own timetable. :)
46
47 ps: Since I found nothere the possibility to upload an file, here is an link to my page where you can have a look. Comments are very welcome ;-)
48 https://www.der-winnie.de/~winnie/gsoc07/tex.pm
49
50 You'll find an demo site here:
51 https://www.der-winnie.de/wiki/opensource/gsoc2007/
52 I'll add some more complex formulas over the days. But this is basically only pure latex. ;-)
53
54 -- Patrick Winnertz
55
56 > Looks like you're very well on schedule.
57
58 > But I wonder: Do you have any plans to work on the latex to html side of
59 > things too? This page kinda combines both uses of latex; creating gifs
60 > for formulas etc, and creating html. Dreamland already has a latex2html
61 > using plugin submitted above, but it still needs some work, and
62 > particularly, needs the same input validation stuff. And then there's the
63 > idea of using html2latex, to convert an ikiwiki site into a book. Any
64 > plans to work on that too? I guess I'm not sure what the scope is of what
65 > you plan to do as part of GSoC.
66
67 >> Yes I plan to write an html -> tex (or pdf) plugin as well. But I think it is better to work first on the first one and complete it and then work and complete the second one. If it is in the scope of GSoC i don't know, but I'll write it since it is fun to write on an Opensource project ;-)
68
69 >> For latex-> html:
70 >> I have the problem that I don't really see the sense to create html code (this means text or charts) from latex code. But if you like I can also add this variant to create html code. In my eyes it is much more important that it is possible to have complex chemical/physical & math formulas on the website without the need to use extern programs. (and upload the pictures manually).
71
72 >>> Well, I suppose someone might just like latex and want to use it as the
73 >>> markup for their wiki, rather than learning markdown. I guess Midnight
74 >>> wanted it enough to write his plugin. But the use case is not too
75 >>> compelling to me either, honestly. --[[Joey]]
76
77 ### code review
78
79 > The main problem I see with the code is that you seem to unnecessarily create a dummy div tag
80 > in preprocess, and then in format you call create(), which generates an img tag. So, why not 
81 > just create the img tag in preprocess?
82
83 >> Mh okay, I'll improve this. 
84
85 Fixed
86
87 > Another problem: Looks like if latex fails to create the image, the user won't be shown any
88 > of its error message, but just "failed to generate image from code". I suspect that in this 
89 > case being able to see the error message would be important.
90
91 >> Yes, that's true. It would be _very_ hard to provide the user the output of latex since this is really very much. For an simple formula as \frac{1}{2} this could be 2 printed out.
92
93 >>> YM 2 printed pages? Yes, I'm familar with latex's insane errors. :-)
94 >>> However, IMHO, it's worth considering this and doing something. Perhaps
95 >>> put the error inside some kind of box in the html so it's delimited
96 >>> from the rest of the page. (Actually, ikiwiki preprocessor directives in
97 >>> general could mark up their errors better.)
98
99 Okay, I'll provide the log as an link in the wiki. But there should be a kind of mechanism how they can be removed. This could lead to an DOS (create via a bot so much nonsense code that the disk is full.)
100
101 Fixed, the log is now provided if latex will fail.
102
103 > The url handling could stand to be improved. Currently it uses $config{url}, so it depends on that being set. Some ikiwiki builds don't have an url set. The thing to do is to use urlto(), to generate a nice relative url from the page to the image. 
104
105 >> Mh... i choose one single dir explizitly since if you use on several pages the same formula  this would really improve the time to generate the formulas and it would waste extra space if you store every formula 3-4 times. But if you really like I'll change this behaviour. 
106
107 >>> No, that makes sense! (My comments about $config{url} still stand
108 >>> though.
109
110 Yes of course, I'll improve the url handling. My comment was only about the several folder ;-)
111
112 Fixed. Now I use urlto and will_render.
113
114 > Another (minor) problem with the url handling is that you put all the images in a "teximages" directory in the toplevel of the wiki. I think it would be better to put each image in the subdirectory for the page that created it. See how the `img` and `sparkline` plugins handle this.
115
116 > It looks like if the tempdir already exists, tempdir() will croak(), thus crashing ikiwiki. It would be good to catch a failure there and fail more gracefully.
117
118 >> Okay, I'll improve this behaviour. Maybe: if tempdir croak rerun it to get another not existing dir? (But only x times so that this is no endless loop, with x maybe = 3). 
119 >> Then it would not be necessary to inform the user about not generating the image. 
120
121 >>> Or just propigate up an error message. If it's failing, someone is
122 >>> probably trying to DOS ikiwiki or something. :-)
123
124 Fixed. I now use eval { create_tmp } and then:  if ($?) { $returncode = 0 } else { save .tex file ... } ...
125
126
127 > I'm not sure why you're sanitising the PATH before calling latex. This could be problimatic on systems where latex is not in /bin or /usr/bin
128
129 >> Okay what do you suggest to use as PATH? 
130 >> I'll have to change the default settings, since we ikiwiki runs in taint mode. (which is good ;-))
131
132 >>> But, ikiwiki already sanitises path and deletes the IFS and CDPATH etc.
133 >>> See ikiwiki.in.
134
135 Fixed. I'll removed these two lines completly.
136
137 -----
138 Okay here an short timetable how I want to proceed further:
139
140 * Until weekend (21-22. July) I'll try to fix all errors above. (done)
141 * From 22.July until 29. July I'll try to set up a first security check
142   My plans are two parts of a security check:
143     * One with an array of blacklisted regular expression. (This would blacklist all the well known and easy to fetch things like \include {/path/to/something} and things like closing the math formula environment ($$). (done)
144     * the second step will be based on Tom::latex, which will help to parse and get a tree view of the code.
145
146 Okay what do you think of this procedure?
147
148 > --[[Joey]]
149
150 >> -- [[PatrickWinnertz]]
151
152 ----
153
154 > It would be nice if it would output image tags with style="height:1em;" so that the formulas scale
155 > with the rest of the text if you change the font size in your browser (ctrl + +/-).
156
157
158 Thanks for the comment.. is fixed. 
159 Mh... not really fixed :S I added it into the return but it is somehow ignored. I'll figure out why.
160
161 -----
162
163 Okay, the last version of the tex plugin for ikiwiki can be downloaded [here](https://www.der-winnie.de/~winnie/gsoc07/tex.pm). 
164
165 > I've looked this over, fixed the indenting, fixed some variable names
166 > ("$foo" is a bad variable name), removed a gratuotuous use of `tie`,
167 > fixed a bug (the first time it was run, it tried to write the png file
168 > before the teximages/ directory existed) and checked the result in.
169
170 > Can you please flesh out [[plugins/teximg]] with
171 > whatever documentation people who know tex will expect to see?
172
173 Okay, I'll fill this up today I think with information about the plugin
174
175 Done. Is that docu fine with you?
176
177 >> Perhaps add some documentation about the kind of tex code that can be
178 >> used, or a link to some documentation so people who don't know latex
179 >> well can figure this out?
180
181 > Also, please review my changes. In particular, I changed the @badthings
182 > array to use qr//, which is much clearer, but it needs to be tested that
183 > I didn't break the checking code when I did it. It would be nice to write
184 > a test case that tries to feed it bad code and makes sure it rejects it.
185
186 I'll test this now on my server. I'll report here later.
187 Okay, checked. it works fine. My blacklist tests were successfull.
188
189 >
190 > Does it really make sense to have an alt tag for the image
191 > that contains the tex code? Will that make any sense when browsing
192 > without images?
193
194 Mh.. For people who know latex very well this would be enough to imagine how the image would look like. 
195 This are of course the minority of people (but I guess also the minority of people are using non-gui browsers).
196
197
198
199 > I'm thinking about renameing the preprocessor directive to teximg.
200 > \[[teximg code="" alt="foo"]] makes sense.. Would it make sense to rename
201 > the whole plugin, or do you think that other tex stuff should go in this
202 > same plugin?
203
204 I'll think over this until I'm at work ;) Only for rendering images... not for generating .tex files .../wiki/
205 the name is all the same i think. If you like teximg better than switch :)
206
207
208 > Note: I removed the style= attribute, since as I've told you, the
209 > htmlsanitizer strips those since they can be used to insert javascript. I
210 > put in a class=teximage instead; the style sheet could be modified to
211 > style that, if you want to send a patch for that.
212
213 Ah yes.. sorry forgot to update the plugin in my public_html folder %-). This was my last change in this plugin :) Sorry.
214
215
216
217 > --[[Joey]]
218
219 [[tag soc]]
220 [[tag wishlist]]