README.fop
1 -------------------
2 JEuclid FOP plug-in
3 -------------------
4
5Installation
6
7* Pre-requesites
8
9 The JEuclid FOP plug-in is tightly integrated with FOP development, it will
10 therefore only work with specific versions of FOP. For this version you need:
11
12 * FOP 0.95beta or 0.95
13
14* Actual installation
15
16 Copy the these files into your fop's lib/ directory
17
18 * jeuclid-core-x.x.x.jar
19
20 * jeuclid-fop-x.x.x.jar
21
22 []
23
24 If you have downloaded the full JEuclid distribution, these files can be found in the
25 repo/ sub-directory.
26
27 That's it! Enjoy MathML support in FOP.
28
29** Installation in Ubuntu
30
31 If you use the prepacked version of fop from Ubuntu, the following
32 procedure is known to work:
33
34 * copy jeuclids jars to <<</usr/share/java>>>
35
36 * create links from jeuclid-fop-x.x.x.jar to jeuclid-fop.jar, same for -core.
37
38 * add the line <<<find_jars jeuclid-core jeuclid-fop>>> to /usr/bin/fop
39
40 []
41
42 This method requires modification of directories which are in the care of
43 your distribution. If you know a better method, please let us know!
44
45** Other Distributions
46
47 Other distributions may provide the fop jars in a different fashion. If you
48 have detailed installation instructions, please let us know.
49
50Usage
51
52* External MathML Documents
53
54 External Documents may be referenced using \<fo:external-graphic\>. Both ODF and
55 plain MathML formulas are supported.
56
57 There is (per design choice) no support for the .fo context when a MathML
58 document is referenced as an external graphic.
59
60* Inline MathML Documents
61
62 Inline MathML is supported through the \<fo:instream-foreign-object\> tag. The
63 actual math content must use the "http://www.w3.org/1998/Math/MathML" name
64 space.
65
66 MathML specified inline will take the following attributes from the
67 surrounding .fo context:
68
69 * Font size
70
71 * Font color
72
73 * Background color
74
75 * Name of the fonts used.
76
77 Please note: The names of the fonts from the context are used to display the
78 "normal" mathvariant. In the case of FOPs default, this uses a sans-serif
79 font, whereas the MathML specification suggests to use a serif font. If you
80 wish to override this behavior, please specify a sans-serif font in the
81 font-family for the instream-foreign-object.
82
83Example Document
84
85 An example document is available (in the JEuclid-fop distribution) in the
86 example/ sub-directory.
87