root / dotorg / trunk / html / beps / bep_0018.html

Revision 11040, 6.2 kB (checked in by dave, 8 weeks ago)

All HTML docs now reference the new SVN server running at bittorrent.org

Line 
1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
7<title></title>
8<link rel="stylesheet" href="../css/bep.css" type="text/css" />
9</head>
10<body>
11<div class="document">
12
13<div id="upper" class="clear">
14<div id="wrap">
15<div id="header">
16<h1><a href="../index.html">BitTorrent<span>.org</span></a></h1>
17</div>
18<div id="nav">
19<ul>
20<li><a href="../index.html">Home</a></li>
21<li><a href="../introduction.html">For Users</a></li>
22<li><a href="bep_0000.html"><span>For Developers</span></a></li>
23<!-- <li><a href="./blog">Blog</a></li> -->
24<li><a href="http://forum.bittorrent.org"> Forums </li>
25<li><a href="../donate.html">Donate!</a></li>
26</ul>
27</div> <!-- nav -->
28<!-- ### Begin Content ### -->
29<div id="second">
30
31
32
33<table class="rfc2822 docutils field-list" frame="void" rules="none">
34<col class="field-name" />
35<col class="field-body" />
36<tbody valign="top">
37<tr class="field"><th class="field-name">BEP:</th><td class="field-body">18</td>
38</tr>
39<tr class="field"><th class="field-name">Title:</th><td class="field-body">Search Engine Specificiation</td>
40</tr>
41<tr class="field"><th class="field-name">Version:</th><td class="field-body">11031</td>
42</tr>
43<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference external" href="http://svn.bittorrent.org/trac/browser/dotorg/trunk/html/beps/bep_0018.rst">2008-02-28 16:43:58 -0800 (Thu, 28 Feb 2008)</a></td>
44</tr>
45<tr class="field"><th class="field-name">Author:</th><td class="field-body">Richard Choi &lt;rchoi&#32;&#97;t&#32;bittorrent.com&gt;</td>
46</tr>
47<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
48</tr>
49<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
50</tr>
51<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference external" href="http://www.bittorrent.org/beps/bep-0012">text/x-rst</a></td>
52</tr>
53<tr class="field"><th class="field-name">Created:</th><td class="field-body">12-Feb-2008</td>
54</tr>
55<tr class="field"><th class="field-name">Post-History:</th><td class="field-body"></td>
56</tr>
57</tbody>
58</table>
59<hr />
60<div class="contents topic" id="contents">
61<p class="topic-title first">Contents</p>
62<ul class="simple">
63<li><a class="reference internal" href="#rationale" id="id4">Rationale</a></li>
64<li><a class="reference internal" href="#formatting" id="id5">Formatting</a><ul>
65<li><a class="reference internal" href="#opensearchdescription-element" id="id6">OpenSearchDescription element</a></li>
66<li><a class="reference internal" href="#shortname-element" id="id7">ShortName element</a></li>
67<li><a class="reference internal" href="#description-element" id="id8">Description element</a></li>
68<li><a class="reference internal" href="#url-element" id="id9">Url element</a></li>
69</ul>
70</li>
71<li><a class="reference internal" href="#example" id="id10">Example</a></li>
72<li><a class="reference internal" href="#id1" id="id11">References</a></li>
73<li><a class="reference internal" href="#copyright" id="id12">Copyright</a></li>
74</ul>
75</div>
76<div class="section" id="rationale">
77<h1>Rationale</h1>
78<p>The .btsearch file specifies the structure through which the
79client can conduct searches on torrent search engines.  By
80publishing a simple .btsearch file, search engines can easily be
81added to a client's built-in torrent search box.</p>
82</div>
83<div class="section" id="formatting">
84<h1>Formatting</h1>
85<p>The .btsearch file is based on a subset of the broader <a class="reference external" href="http://www.opensearch.org/Specifications/OpenSearch">OpenSearch
86description document</a> <a class="footnote-reference" href="#id2" id="id3">[1]</a>, and consists of the following elements.</p>
87<div class="section" id="opensearchdescription-element">
88<h2>OpenSearchDescription element</h2>
89<p>The root node of the .btsearch document:</p>
90<pre class="literal-block">
91Parent: None
92Requirements: Must appear once as the root node
93</pre>
94</div>
95<div class="section" id="shortname-element">
96<h2>ShortName element</h2>
97<p>Contains a short human-readable name for the search engine:</p>
98<pre class="literal-block">
99Parent: OpenSearchDescription
100Requirements: Must appear exactly once
101</pre>
102</div>
103<div class="section" id="description-element">
104<h2>Description element</h2>
105<p>Contains a human-readable description of the search engine:</p>
106<pre class="literal-block">
107Parent: OpenSearchDescription
108Requirements: Must appear exactly once
109</pre>
110</div>
111<div class="section" id="url-element">
112<h2>Url element</h2>
113<p>Describes structure through which search requests are made:</p>
114<pre class="literal-block">
115Parent: OpenSearchDescription
116Requirements: Must appear exactly once
117Attributes: template - specifies a parameterized template URL for the
118search query, in which {searchTerms} is replaced by the URL-encoded
119user-supplied query.
120</pre>
121</div>
122</div>
123<div class="section" id="example">
124<h1>Example</h1>
125<pre class="literal-block">
126&lt;?xml version=&quot;1.0&quot;?&gt;
127&lt;OpenSearchDescription&gt;
128&lt;ShortName&gt;BitTorrent&lt;/ShortName&gt;
129&lt;Description&gt;Search torrents on BitTorrent.com&lt;/Description&gt;
130&lt;Url template=&quot;http://www.bittorrent.com/search?q={searchTerms}&amp;category=All&quot;/&gt;
131&lt;/OpenSearchDescription&gt;
132</pre>
133</div>
134<div class="section" id="id1">
135<h1>References</h1>
136<table class="docutils footnote" frame="void" id="id2" rules="none">
137<colgroup><col class="label" /><col /></colgroup>
138<tbody valign="top">
139<tr><td class="label"><a class="fn-backref" href="#id3">[1]</a></td><td><a class="reference external" href="http://www.opensearch.org/Specifications/OpenSearch">http://www.opensearch.org/Specifications/OpenSearch</a></td></tr>
140</tbody>
141</table>
142</div>
143<div class="section" id="copyright">
144<h1>Copyright</h1>
145<p>This document has been placed in the public domain.</p>
146<!-- Local Variables:
147mode: indented-text
148indent-tabs-mode: nil
149sentence-end-double-space: t
150fill-column: 70
151coding: utf-8
152End: -->
153</div>
154
155
156</div>
157        <div id="footer">
158<hr/>
159</div>
160
161</div>
162</body>
163</html>
Note: See TracBrowser for help on using the browser.