getting-started.html
6.64 KB
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
<!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">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Getting started — PHPRtfLite v1.x documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.x',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="PHPRtfLite v1.x documentation" href="index.html" />
<link rel="next" title="Document settings" href="document-settings.html" />
<link rel="prev" title="Feature overview" href="feature-overview.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="document-settings.html" title="Document settings"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="feature-overview.html" title="Feature overview"
accesskey="P">previous</a> |</li>
<li><a href="index.html">PHPRtfLite v1.x documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="getting-started">
<h1>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
<div class="section" id="autoloading">
<h2>Autoloading<a class="headerlink" href="#autoloading" title="Permalink to this headline">¶</a></h2>
<p>You can choose if you want to use the PHPRtfLite autoloader or handle loading PHPRtfLite classes on your own. In most cases you are already using a class loading strategy and just need to add PHPRtfLite to it, which is recommended. For a quick start you may use the shipped PHPRtfLite autoloader.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="k">require_once</span> <span class="s1">'/path/to/your/library/PHPRtfLite.php'</span><span class="p">;</span>
<span class="c1">// registers PHPRtfLite autoloader (spl)</span>
<span class="nx">PHPRtfLite</span><span class="o">::</span><span class="na">registerAutoloader</span><span class="p">();</span>
<span class="c1">// rtf document instance</span>
<span class="nv">$rtf</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PHPRtfLite</span><span class="p">();</span>
</pre></div>
</div>
</div>
<div class="section" id="hello-world-example">
<h2>Hello world example<a class="headerlink" href="#hello-world-example" title="Permalink to this headline">¶</a></h2>
<p>This is a short “Hello world” example:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// rtf document instance</span>
<span class="nv">$rtf</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PHPRtfLite</span><span class="p">();</span>
<span class="c1">// add section</span>
<span class="nv">$sect</span> <span class="o">=</span> <span class="nv">$rtf</span><span class="o">-></span><span class="na">addSection</span><span class="p">();</span>
<span class="c1">// write text</span>
<span class="nv">$sect</span><span class="o">-></span><span class="na">writeText</span><span class="p">(</span><span class="s1">'Hello world!'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">PHPRtfLite_Font</span><span class="p">(),</span> <span class="k">new</span> <span class="nx">PHPRtfLite_ParFormat</span><span class="p">());</span>
<span class="c1">// save rtf document to hello_world.rtf</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">save</span><span class="p">(</span><span class="s1">'hello_world.rtf'</span><span class="p">);</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Getting started</a><ul>
<li><a class="reference internal" href="#autoloading">Autoloading</a></li>
<li><a class="reference internal" href="#hello-world-example">Hello world example</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="feature-overview.html"
title="previous chapter">Feature overview</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="document-settings.html"
title="next chapter">Document settings</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/getting-started.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="document-settings.html" title="Document settings"
>next</a> |</li>
<li class="right" >
<a href="feature-overview.html" title="Feature overview"
>previous</a> |</li>
<li><a href="index.html">PHPRtfLite v1.x documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, sigmaz.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>