aboutsummaryrefslogtreecommitdiffstats
path: root/src/documentation/content/xdocs/examples.xml
blob: a9367012a5cc7b378bb19bca118095769eaffe3a (plain)
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
<?xml version="1.0" standalone="no"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
    "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd">

<document>
  <header>
    <title>Examples</title>
    <version>$Revision$</version>
  </header>
  <body>
    <section>
      <title>Example Documents Using FOP</title>
      <p>
        These examples have been rendered using FOP:
      </p>
    <table>
      <caption>Generated examples</caption>
      <tr>
        <th>Description</th>
        <th>XSL-FO file</th>
        <th>PDF result</th>
      </tr>
      <tr>
        <td>default font characters</td>
        <td><link href="fo/fonts.fo">fonts.fo</link></td>
        <td><link href="fo/fonts.fo.pdf">fonts.fo.pdf</link></td>
      </tr>
    </table>
    <p>Other basic examples on the use of XSL-FO can be found in the FOP distribution in
       the subdirectory xml-fop/examples/fo. You can start transformation of all fo files into pdf
       files by starting xml-fop/examples/fo/runtests (only source distribution). The resulting test
       files can be found in xml-fop/examples/fo/tests
    </p>
    <p>At the moment the following files are part of the distribution:</p>
    <ul>
      <li>simple.fo - a very simple file which gives use a first impression of the structure of an XSL-FO file
      </li>
      <li>normal.fo - a simple file showing the use of a 2 level of headings, normal text and a header.
      </li>
      <li>table.fo - some table examples
      </li>
      <li>list.fo - a short tutorial how to use list fo's and properties
      </li>
      <li>images.fo - shows how to embed GIF and JPEG images into the XSL-FO file using external-graphic.
      </li>
      <li>border.fo - a not so simple example how to use borders in tables
      </li>
      <li>extensive.fo - a longer test file containing a lot of different flow objects and properties.
          A good candidate to test your bugfix or new FOP code.
      </li>
      <li>leader.fo - shows different uses of fo:leader, p.e. as rule or in a table of content
      </li>
      <li>normalex.fo - shows the use of computed property values
      </li>
      <li>inhprop.fo - shows the use of inherited property values
      </li>
      <li>instream.fo - shows the use of fo:instream-foreign-object together with SVG
      </li>
      <li>textdeko.fo - shows the use of the property text-decoration
      </li>
      <li>readme.fo - uses an old version of FOP documentation for a longer example
      </li>
    </ul>
      <p>Also, in the directory examples/fo/pagination you will find a suite of examples showing the use
          of XSL-FO pagination.
      </p>
      <p>
Developers will find the first steps to a test suite for all implemented
formatting objects and properties in xml-fop/test/xml/.
      </p>
	</section>
          <section>
            <title>Images Examples</title>
            <p>
Embedding images in FO:
            </p>
  <table>
    <caption>Images in FO</caption>
    <tr>
      <th>description</th>
      <th>fo file</th>
      <th>pdf result</th>
    </tr>
    <tr>
      <td>align in larger viewport</td>
      <td><link href="fo/align.fo">align.fo</link></td>
      <td><link href="fo/align.fo.pdf">align.fo.pdf</link></td>
    </tr>
    <tr>
      <td>align in smaller viewport</td>
      <td><link href="fo/align2.fo">align2.fo</link></td>
      <td><link href="fo/align2.fo.pdf">align2.fo.pdf</link></td>
    </tr>
    <tr>
      <td>scaling image</td>
      <td><link href="fo/size.fo">size.fo</link></td>
      <td><link href="fo/size.fo.pdf">size.fo.pdf</link></td>
    </tr>
  </table>
      <p>Look also into the directory examples/fo/svg. There you find some very extensive SVG examples.
      </p>
          </section>
          <section>
            <title>Instream Foreign Object Examples</title>
            <p>
Instream Foreign Object images in FO, there are more on the
<link href="dev/svg.html">SVG Page</link>:
            </p>
  <table>
    <caption>Embedding instream-foreign-object</caption>
    <tr>
      <th>description</th>
      <th>fo file</th>
      <th>pdf result</th>
    </tr>
    <tr>
      <td>embedding svg in viewport</td>
      <td><link href="fo/embed.fo">embed.fo</link></td>
      <td><link href="fo/embed.fo.pdf">embed.fo.pdf</link></td>
    </tr>
  </table>
  </section>
  </body>
</document>