← Back to branch summary

~ubuntu-branches/ubuntu/precise/ipe/precise

« back to all changes in this revision

Viewing changes to build/doc/manual_42.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve M. Robbins
  • Date: 2009-12-11 21:22:35 UTC
  • mfrom: (4.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20091211212235-5iio4nzpra64snab
Tags: 7.0.10-1
http://bugs.debian.org/551192
* New upstream.  Closes: #551192.
  - New build-depends: libcairo2-dev, liblua5.1-0-dev, gsfonts
  - patches/config.diff: Remove.  Upstream build system replaced.
  - Runtime lib package changed to libipe7.0.10 from libipe1c2a
  - Devel package renamed to libipe-dev (from libipe1-dev)
  - Package ipe depends on lua5.1 due to ipe-update-master.

* rules: Re-write to use dh.

Show diffs side-by-side

added added

removed removed

Lines of Context:
build/doc/manual_42.html
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
   "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml">
 
5
<!-- XML file produced from file: manual.tex
 
6
     using Hyperlatex v 2.6 (c) Otfried Cheong
 
7
     on Emacs 22.2.1, Wed Dec  9 15:44:23 2009 -->
 
8
<head>
 
9
<title>Ipe Manual -- 9.1 The &lt;ipe&gt; element</title>
 
10
 
 
11
<style type="text/css">
 
12
.maketitle { text-align : center }
 
13
div.abstract { margin-left: 20%; margin-right: 10%; }
 
14
h3.abstract  { text-align : center }
 
15
div.verse, div.quote, div.quotation {
 
16
  margin-left : 10%; 
 
17
  margin-right : 10%;
 
18
}
 
19
</style>
 
20
 
 
21
<link rel="stylesheet"
 
22
        href="manual.css" type="text/css"><meta http-equiv="Content-Type" 
 
23
        content="text/html; charset=UTF-8">
 
24
</head>
 
25
<body bgcolor="#ffffe6">
 
26
<table width="100%" cellpadding=0 cellspacing=2><tr>
 
27
    <td bgcolor="#99ccff"><a href="manual_43.html"><img border="0" alt="9.2 The &lt;page&gt; element" src="next.png"></a></td><td bgcolor="#99ccff"><a href="manual_41.html"><img border="0" alt="9 The Ipe file format" src="up.png"></a></td><td bgcolor="#99ccff"><img alt="" src="blank.png"></td><td align="center" bgcolor="#99ccff" width="100%"><b>9.1 The <tt>&lt;ipe&gt;</tt> element</b></td></tr></table>
 
28
<h2>9.1 The <tt>&lt;ipe&gt;</tt> element</h2>
 
29
 
 
30
<h4><a name="id1">Attributes</a></h4>
 
31
<dl><dt><b>version</b><dd> (required) The value (a number, e.g.&nbsp;70103 for
 
32
  Ipelib&nbsp;7.1.3) indicates the earliest Ipelib version that can
 
33
  interpret the document. Ipe will refuse to load documents that
 
34
  require a version larger than its own, and may refuse to load
 
35
  documents that are too old (and which will have to be converted
 
36
  using a separate program).
 
37
<dt><b>creator</b><dd> (optional) indicates the program that created the file
 
38
  and is not interpreted by Ipe at all.
 
39
</dl>
 
40
 
 
41
<h4><a name="id2">Contents</a></h4>
 
42
<ol><li>An <code>&lt;info&gt;</code> element (optional),
 
43
<li>a <code>&lt;preamble&gt;</code> element (optional),
 
44
<li>a series of <code>&lt;bitmap&gt;</code> and <code>&lt;ipestyle&gt;</code> elements
 
45
  (optional),
 
46
<li>a series of <code>page</code> elements.
 
47
</ol>
 
48
<p>The <code>&lt;ipestyle&gt;</code> elements form a "cascade", with the
 
49
<em>last</em> <code>&lt;ipestyle&gt;</code> element becoming the <em>top-level</em>
 
50
style sheet.  When symbolic names are looked up, the style sheets are
 
51
checked from top to bottom.  Ipe always appends the built-in standard
 
52
style sheet at the bottom of the stack.
 
53
 
 
54
<h3><a name="id3">9.1.1 The <tt>&lt;info&gt;</tt> element</a></h3>
 
55
 
 
56
<h4><a name="id4">Attributes</a></h4>
 
57
<dl><dt><b>title</b><dd> (optional) document title,
 
58
<dt><b>author</b><dd> (optional) document author,
 
59
<dt><b>subject</b><dd> (optional) document subject,
 
60
<dt><b>keywords</b><dd> (optional) document keywords,
 
61
<dt><b>pagemode</b><dd> (optional) the only value understood by Ipe is
 
62
  <code>fullscreen</code>, which causes the document to be opened in full
 
63
  screen mode in PDF readers.
 
64
<dt><b>created</b><dd> (optional) creation time in PDF format,
 
65
  e.g.&nbsp;"D:20030127204100".
 
66
<dt><b>modified</b><dd> (optional) modification time in PDF format,
 
67
<dt><b>numberpages</b><dd> (optional) if the value is <code>yes</code>, then Ipe
 
68
  will save PDF documents with visible page numbers on each page.
 
69
</dl> 
 
70
<p>This element must be empty.
 
71
 
 
72
<h3><a name="id5">9.1.2 The <tt>&lt;preamble&gt;</tt> element</a></h3>
 
73
<p>This element has no attributes. Its contents is LaTeX source code,
 
74
to be used as the LaTeX preamble when running LaTeX to process
 
75
the text objects in the document. It should <em>not</em> contain a
 
76
<code>\documentclass</code> command, but can contain <code>\usepackage</code>
 
77
commands and macro definitions.
 
78
 
 
79
<h3><a name="id6">9.1.3 The <tt>&lt;bitmap&gt;</tt> element</a></h3>
 
80
<p>Each <code>&lt;bitmap&gt;</code> element defines a bitmap to be used by
 
81
<code>&lt;image&gt;</code> objects. 
 
82
 
 
83
<h4><a name="id7">Attributes</a></h4>
 
84
<dl><dt><b>id</b><dd> (required)
 
85
  the value must be an integer that will define the bitmap throughout
 
86
  the Ipe document,
 
87
<dt><b>width</b><dd> (required) integer width in pixels,
 
88
<dt><b>height</b><dd> (required) integer height in pixels,
 
89
<dt><b>ColorSpace</b><dd> (required) possible values are "DeviceGray",
 
90
"DeviceRGB", and "DeviceCMYK",
 
91
<dt><b>BitsPerComponent</b><dd> (required) value must be <i>8</i>,
 
92
<dt><b>ColorKey</b><dd> (optional) an RGB color in hexadecimal, indicating the
 
93
  transparent color (only suppored for "DeviceRGB" color space),
 
94
<dt><b>length</b><dd> (required unless there is no filter) the number of bytes
 
95
of image data,
 
96
<dt><b>Filter</b><dd> (optional) possible values are "FlateDecode" or
 
97
"DCTDecode" to indicate a compressed image (the latter is used for
 
98
JPEG images).
 
99
<dt><b>encoding</b><dd> (optional) possible value is "base64" to indicate
 
100
  that the image data is base64-encoded (not in hexadecimal).
 
101
</dl>
 
102
<p>The contents of the <code>&lt;bitmap&gt;</code> element is the image data, either
 
103
base64-encoded or in hexadecimal format.  White space between bytes is
 
104
ignored.  If no filter is specified, pixels are stored row by row,
 
105
with rows padded to a full byte boundary.
 
106
<p>Note that images with color maps are not supported, and such support
 
107
is not planned. (The <em>Insert image</em> ipelet does allow you to
 
108
insert images with color maps, but they are stored as 24-bit images.
 
109
Since the data is compressed, this does not seriously increase the
 
110
image data size.)
 
111
<hr />
 
112
<table width="100%" cellpadding=0 cellspacing=2><tr>
 
113
    <td bgcolor="#99ccff"><a href="manual_43.html"><img border="0" alt="9.2 The &lt;page&gt; element" src="next.png"></a></td><td bgcolor="#99ccff"><a href="manual_41.html"><img border="0" alt="9 The Ipe file format" src="up.png"></a></td><td bgcolor="#99ccff"><img alt="" src="blank.png"></td><td align="center" bgcolor="#99ccff" width="100%"><b>9.1 The <tt>&lt;ipe&gt;</tt> element</b></td></tr></table></body></html>