libzeitgeist-doc 0.3.18-1ubuntu3 / usr / share / gtk-doc / html / zeitgeist-1.0 / zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html

This file is indexed.

/usr/share/gtk-doc/html/zeitgeist-1.0/zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html is in libzeitgeist-doc 0.3.18-1ubuntu3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Mimetype mapping and URI comprehension: API Documentation for the Zeitgeist Client Library</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="API Documentation for the Zeitgeist Client Library">
<link rel="up" href="ch02.html" title="Utility Functions">
<link rel="prev" href="ch02.html" title="Utility Functions">
<link rel="next" href="zeitgeist-1.0-Timestamp-handling.html" title="Timestamp handling">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch02.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="zeitgeist-1.0-Timestamp-handling.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.top_of_page"></a>Mimetype mapping and URI comprehension</span></h2>
<p>Mimetype mapping and URI comprehension</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-register-mimetype" title="zeitgeist_register_mimetype ()">zeitgeist_register_mimetype</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-register-mimetype-regex" title="zeitgeist_register_mimetype_regex ()">zeitgeist_register_mimetype_regex</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-interpretation-for-mimetype" title="zeitgeist_interpretation_for_mimetype ()">zeitgeist_interpretation_for_mimetype</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-register-uri-scheme" title="zeitgeist_register_uri_scheme ()">zeitgeist_register_uri_scheme</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-manifestation-for-uri" title="zeitgeist_manifestation_for_uri ()">zeitgeist_manifestation_for_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="zeitgeist-register-mimetype"></a><h3>zeitgeist_register_mimetype ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
zeitgeist_register_mimetype (<em class="parameter"><code>const <span class="type">gchar</span> *mimetype</code></em>,
                             <em class="parameter"><code>const <span class="type">gchar</span> *interpretation_uri</code></em>);</pre>
<p>Associate a mimetype with a given interpretation type. Registered mimetypes
can be looked up with <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-interpretation-for-mimetype" title="zeitgeist_interpretation_for_mimetype ()"><code class="function">zeitgeist_interpretation_for_mimetype()</code></a>. You can
register a regular expression as mimetype if you instead of this function
invoke <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-register-mimetype-regex" title="zeitgeist_register_mimetype_regex ()"><code class="function">zeitgeist_register_mimetype_regex()</code></a>.</p>
<p>Mimetypes are first looked up by their exact name and then if none is
found the regular expressions will be checked as fallbacks.</p>
<p>This library will install a wide range a common mimetypes for you, so unless
you have very specific needs you will normally not have to call this
function.</p>
<p>See the list of common</p>
<a class="link" href="zeitgeist-1.0-Interpretation-Ontology.html" title="Interpretation Ontology">interpretation types</a>.
<div class="refsect3">
<a name="id-1.3.2.5.2.9"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>mimetype</p></td>
<td class="parameter_description"><p>A mimetype string. Fx. <span class="emphasis"><em>text/plain</em></span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interpretation_uri</p></td>
<td class="parameter_description"><p>A URI defining the interpretation type to associate with <em class="parameter"><code>mimetype</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-register-mimetype-regex"></a><h3>zeitgeist_register_mimetype_regex ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
zeitgeist_register_mimetype_regex (<em class="parameter"><code>const <span class="type">gchar</span> *mimetype_regex</code></em>,
                                   <em class="parameter"><code>const <span class="type">gchar</span> *interpretation_uri</code></em>);</pre>
<p>Associate a range of mimetypes with a given interpretation type.
Registered mimetypes can be looked up with
<a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-interpretation-for-mimetype" title="zeitgeist_interpretation_for_mimetype ()"><code class="function">zeitgeist_interpretation_for_mimetype()</code></a>. If you only need to register one
specific mimetype it is more efficient if you instead of this function
call <a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-register-mimetype" title="zeitgeist_register_mimetype ()"><code class="function">zeitgeist_register_mimetype()</code></a>.</p>
<p>Mimetypes are first looked up by their exact name and then if none is
found the regular expressions will be checked as fallbacks.</p>
<p>This library will install a wide range a common mimetypes for you, so unless
you have very specific needs you will normally not have to call this
function.</p>
<p>See the list of common</p>
<a class="link" href="zeitgeist-1.0-Interpretation-Ontology.html" title="Interpretation Ontology">interpretation types</a>.
<div class="refsect3">
<a name="id-1.3.2.5.3.9"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>mimetype_regex</p></td>
<td class="parameter_description"><p>A regular expression matching a certain range of mimetypes.
Fx. <span class="emphasis"><em>text/.*</em></span> to match all
<span class="emphasis"><em>text</em></span> sub types.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interpretation_uri</p></td>
<td class="parameter_description"><p>A URI defining the interpretation type to associate with
the matched mimetypes</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-interpretation-for-mimetype"></a><h3>zeitgeist_interpretation_for_mimetype ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
zeitgeist_interpretation_for_mimetype (<em class="parameter"><code>const <span class="type">gchar</span> *mimetype</code></em>);</pre>
<p>Look up the interpretation type associated with <em class="parameter"><code>mimetype</code></em>
. Please see the
list of common</p>
<a class="link" href="zeitgeist-1.0-Interpretation-Ontology.html" title="Interpretation Ontology">interpretation types</a>.
<div class="refsect3">
<a name="id-1.3.2.5.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mimetype</p></td>
<td class="parameter_description"><p>A mimetype string. Fx. <span class="emphasis"><em>text/plain</em></span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.2.5.4.7"></a><h4>Returns</h4>
<p> A URI defining the interpretation type associated with <em class="parameter"><code>mimetype</code></em>
or
<code class="literal">NULL</code> in case <em class="parameter"><code>mimetype</code></em>
is unknown.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-register-uri-scheme"></a><h3>zeitgeist_register_uri_scheme ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
zeitgeist_register_uri_scheme (<em class="parameter"><code>const <span class="type">gchar</span> *uri_scheme</code></em>,
                               <em class="parameter"><code>const <span class="type">gchar</span> *manifestation_type</code></em>);</pre>
<p>Associate a URI scheme with a given manifestation type.
You can find the manifestation type of a given URI by passing it to
<a class="link" href="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.html#zeitgeist-manifestation-for-uri" title="zeitgeist_manifestation_for_uri ()"><code class="function">zeitgeist_manifestation_for_uri()</code></a>.</p>
<p>This library will install a range a common URI schemes for you, so unless
you have very specific needs you will normally not have to call this
function.</p>
<p>See the list of common</p>
<a class="link" href="zeitgeist-1.0-Manifestation-Ontology.html" title="Manifestation Ontology">manifestation types</a>.
<div class="refsect3">
<a name="id-1.3.2.5.5.8"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>uri_scheme</p></td>
<td class="parameter_description"><p>A URI scheme such as <span class="emphasis"><em>http://</em></span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="zeitgeist-manifestation-for-uri"></a><h3>zeitgeist_manifestation_for_uri ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
zeitgeist_manifestation_for_uri (<em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>);</pre>
<p>Look up a manifestation type for a given URI. Eg. if you pass in
<span class="emphasis"><em>file:///tmp/foo.txt</em></span> you will get back
<a class="link" href="zeitgeist-1.0-Manifestation-Ontology.html#ZEITGEIST-NFO-FILE-DATA-OBJECT:CAPS" title="ZEITGEIST_NFO_FILE_DATA_OBJECT"><span class="type">ZEITGEIST_NFO_FILE_DATA_OBJECT</span></a>.</p>
<p>See the list of common</p>
<a class="link" href="zeitgeist-1.0-Manifestation-Ontology.html" title="Manifestation Ontology">manifestation types</a>.
<div class="refsect3">
<a name="id-1.3.2.5.6.7"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>A URI</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.2.5.6.8"></a><h4>Returns</h4>
<p> A manifestation type for <em class="parameter"><code>uri</code></em>
or <code class="literal">NULL</code> in case no suitable
manifestation type is known</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="zeitgeist-1.0-Mimetype-mapping-and-URI-comprehension.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.