-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.html
482 lines (401 loc) · 15.1 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.11: http://docutils.sourceforge.net/" />
<title></title>
<style type="text/css">
/*
:Author: David Goodger ([email protected])
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document">
<!-- -*- Mode: rst -*- -->
<!-- -*- Mode: rst -*- -->
<!-- |PyDviUrl|
|PyDviHomePage|_
|PyDviDoc|_
|PyDvi@github|_
|PyDvi@readthedocs|_
|PyDvi@readthedocs-badge|
|PyDvi@pypi|_ -->
<!-- .. _PyDvi@github: https://github.com/FabriceSalvaire/PyDVI -->
<!-- .. _PyDvi@readthedocs: http://pydvi.readthedocs.org -->
<!-- .. _PyDvi@pypi: https://pypi.python.org/pypi/PyDVI -->
<!-- End -->
<!-- -*- Mode: rst -*- -->
<!-- an extended version of pdfTeX using Lua as an embedded scripting language -->
<!-- A DVI-to-PNG converter -->
<!-- End -->
<div class="section" id="pydvi">
<h1>PyDvi</h1>
<p>The official PyDvi Home Page is located at <a class="reference external" href="http://fabricesalvaire.github.io/PyDVI">http://fabricesalvaire.github.io/PyDVI</a></p>
<p>The latest documentation build from the git repository is available at readthedocs.org <a class="reference external" href="http://pydvi.readthedocs.org/en/latest"><img alt="PyDvi@readthedocs-badge" src="https://readthedocs.org/projects/pydvi/badge/?version=latest" /></a></p>
<p>Written by <a class="reference external" href="http://fabrice-salvaire.pagesperso-orange.fr">Fabrice Salvaire</a>.</p>
<p><a class="reference external" href="https://travis-ci.org/FabriceSalvaire/PyDVI"><img alt="PyDvi build status @travis-ci.org" src="https://travis-ci.org/FabriceSalvaire/PyDVI.svg?branch=master" /></a></p>
<hr class="docutils" />
<img alt="https://raw.github.com/FabriceSalvaire/PyDvi/master/doc/sphinx/source/images/dvi-gl-viewer.scaled.png" src="https://raw.github.com/FabriceSalvaire/PyDvi/master/doc/sphinx/source/images/dvi-gl-viewer.scaled.png" />
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="introduction">
<h1>Introduction</h1>
<!-- link to TUG -->
<!-- library versus module -->
<p>PyDvi is a <a class="reference external" href="http://python.org">Python</a> library to read and process DVI (DeVice Independent) files, the native output
of the famous TeX typesetting program implemented by <a class="reference external" href="http://www-cs-faculty.stanford.edu/~uno">Donald E. Knuth</a>.</p>
<p>PyDvi is also able to read most of the file formats associated to the TeX world like packed font,
virtual font, TeX font metric, font map and font encoding. It can also read Adobe Font Metrics files.</p>
<p>Basically a DVI file describes the layout of a page by a list of opcodes that interact with a
register machine to update the position on the page, to load fonts and to paint glyphs and rules. In
short it contains the glyphs and their positions on the page. Since TeX was designed to layout the
series of books <em>The Art of Computer Programming</em> at the beginning of the eighties, it focuses on
texts and mathematical expressions. Thus DVI is much simpler than Postscript or its successor PDF
which are designed for graphics. However we can extend the capabilities of DVI using the <em>special</em>
opcode which can contain any text like Postscript snippets.</p>
<p>A DVI stream can come from a file or a TeX daemon in order to render TeX inputs on-the-fly.</p>
<p>The DVI parser of PyDvi builds a program from a DVI stream that could be later processed by the
provided DVI machine which is designed to be subclassed by the user.</p>
<p>The source code includes an experimental DVI viewer as exemple which uses the OpenGL API for the
rendering and thus feature an hardware accelerated rendering. PyDvi and the viewer can be used as a
platform to experiment complex text rendering on GPU.</p>
<p>The source code includes also a clone of the dvipng tool to render DVI to PNG image. This tool is
mainly intended to check the compliance of PyDvi by image comparison.</p>
<!-- The aim of PyDvi is multiple -->
<p>PyDvi can be used for several purpose, we will review them in the followings:</p>
<p>TeX is a major and historical typesetting program. PyDvi can serve to read and process its output
using Python. The user can be a curious pearson who want to lean TeX or somebody interested by TeX
postprocessing.</p>
<p>TeX is one of the oldest computer program still in activity. The reason is quite simple, these
algorithms do the right job, its ecosystem is rich and its code is not so simple. Thus nobody
succeeds to reimplement it up to now, excepted its mathematical layout algorithms by the <a class="reference external" href="http://www.mathjax.org">MathJax</a>
Javascript library which is intended to bring Mathematical layout to web browser. Before the
delivery of Mathjax, the only solution to render properly mathematical content was to generate an
image using a program like <a class="reference external" href="http://savannah.nongnu.org/projects/dvipng">dvipng</a>. It is what does the engine of Wikipedia behind the scene.
Usually these programs like <a class="reference external" href="http://asymptote.sourceforge.net">Asymptote</a> or <a class="reference external" href="https://ece.uwaterloo.ca/~aplevich/Circuit_macros">Circuit_macros</a> generate the graphics as a PDF
document and then include this document in a LaTeX document which contains the labels placed at
absolute positions in the page. With PyDvi we can try another approach which consists to send TeX
content to a daemon and get back the glyphs and their positions. <a class="reference external" href="http://matplotlib.org">Matplotlib</a> uses this approach to
render LaTeX labels.</p>
<!-- -*- Mode: rst -*- -->
<!-- End -->
<!-- End -->
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="installation">
<span id="installation-page"></span><h1>Installation</h1>
<p>The installation of PyDvi by itself is quite simple. However it will be easier to get the
dependencies on a Linux desktop.</p>
<div class="section" id="dependencies">
<h2>Dependencies</h2>
<p>PyDvi requires the following dependencies:</p>
<blockquote>
<ul class="simple">
<li><a class="reference external" href="http://python.org">Python</a></li>
<li><a class="reference external" href="http://www.numpy.org">Numpy</a></li>
<li><a class="reference external" href="https://github.com/rougier/freetype-py">freetype-py</a> for Type1 font rendering</li>
</ul>
</blockquote>
<p>The OpenGL DVI viewer requires these additional dependencies:</p>
<blockquote>
<ul class="simple">
<li><a class="reference external" href="http://www.riverbankcomputing.co.uk/software/pyqt/intro">pyqt</a></li>
<li><a class="reference external" href="https://github.com/FabriceSalvaire/PyOpenGLng">PyOpenGLng</a></li>
</ul>
</blockquote>
<p>The DVI to PNG tool requires these additional dependencies:</p>
<blockquote>
<ul class="simple">
<li><a class="reference external" href="http://pillow.readthedocs.org/en/latest/index.html">pillow</a></li>
</ul>
</blockquote>
<p>Also it is recommanded to have these Python modules:</p>
<blockquote>
<ul class="simple">
<li>pip</li>
<li>virtualenv</li>
</ul>
</blockquote>
<p>For development, you will need in addition:</p>
<blockquote>
<ul class="simple">
<li><a class="reference external" href="http://sphinx-doc.org">Sphinx</a></li>
</ul>
</blockquote>
</div>
<div class="section" id="installation-from-pypi-repository">
<h2>Installation from PyPi Repository</h2>
<p>PyDvi is made available on the <a class="reference external" href="https://pypi.python.org/pypi">PyPI</a> repository at <a class="reference external" href="https://pypi.python.org/pypi/PyDVI">https://pypi.python.org/pypi/PyDVI</a></p>
<p>Run this command to install the last release:</p>
<pre class="code sh literal-block">
pip install PyDvi
</pre>
</div>
<div class="section" id="installation-from-source">
<h2>Installation from Source</h2>
<p>The PyDvi source code is hosted at <a class="reference external" href="https://github.com/FabriceSalvaire/PyDVI">https://github.com/FabriceSalvaire/PyDVI</a></p>
<p>To clone the Git repository, run this command in a terminal:</p>
<pre class="code sh literal-block">
git clone git@github.com:FabriceSalvaire/PyDvi.git
</pre>
<p>Then to build and install PyDvi run these commands:</p>
<pre class="code sh literal-block">
python setup.py build
python setup.py install
</pre>
<!-- End -->
<!-- End -->
</div>
</div>
</div>
</body>
</html>