root / dotorg / v9 / html / beps / bep_0018.html

Revision 10904, 6.0 kB (checked in by dave, 11 months ago)

generated html.

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="../donate.html">Donate!</a></li>
25</ul>
26</div> <!-- nav -->
27<!-- ### Begin Content ### -->
28<div id="second">
29
30
31
32<table class="rfc2822 docutils field-list" frame="void" rules="none">
33<col class="field-name" />
34<col class="field-body" />
35<tbody valign="top">
36<tr class="field"><th class="field-name">BEP:</th><td class="field-body">18</td>
37</tr>
38<tr class="field"><th class="field-name">Title:</th><td class="field-body">Search Engine Specificiation</td>
39</tr>
40<tr class="field"><th class="field-name">Version:</th><td class="field-body">10858</td>
41</tr>
42<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference external" href="https://svn.bittorrent.com/trac.cgi/browser/dotorg/trunk/html/beps/bep_0018.rst">2008-02-15 17:35:59 -0800 (Fri, 15 Feb 2008)</a></td>
43</tr>
44<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>
45</tr>
46<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
47</tr>
48<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
49</tr>
50<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>
51</tr>
52<tr class="field"><th class="field-name">Created:</th><td class="field-body">12-Feb-2008</td>
53</tr>
54<tr class="field"><th class="field-name">Post-History:</th><td class="field-body"></td>
55</tr>
56</tbody>
57</table>
58<hr />
59<div class="contents topic" id="contents">
60<p class="topic-title first">Contents</p>
61<ul class="simple">
62<li><a class="reference internal" href="#rationale" id="id4">Rationale</a></li>
63<li><a class="reference internal" href="#formatting" id="id5">Formatting</a><ul>
64<li><a class="reference internal" href="#opensearchdescription-element" id="id6">OpenSearchDescription element</a></li>
65<li><a class="reference internal" href="#shortname-element" id="id7">ShortName element</a></li>
66<li><a class="reference internal" href="#description-element" id="id8">Description element</a></li>
67<li><a class="reference internal" href="#url-element" id="id9">Url element</a></li>
68</ul>
69</li>
70<li><a class="reference internal" href="#example" id="id10">Example</a></li>
71<li><a class="reference internal" href="#id1" id="id11">References</a></li>
72</ul>
73</div>
74<div class="section" id="rationale">
75<h1>Rationale</h1>
76<p>The .btsearch file specifies the structure through which the
77client can conduct searches on torrent search engines.  By
78publishing a simple .btsearch file, search engines can easily be
79added to a client's built-in torrent search box.</p>
80</div>
81<div class="section" id="formatting">
82<h1>Formatting</h1>
83<p>The .btsearch file is based on a subset of the broader <a class="reference external" href="http://www.opensearch.org/Specifications/OpenSearch">OpenSearch
84description document</a> <a class="footnote-reference" href="#id2" id="id3">[1]</a>, and consists of the following elements.</p>
85<div class="section" id="opensearchdescription-element">
86<h2>OpenSearchDescription element</h2>
87<p>The root node of the .btsearch document:</p>
88<pre class="literal-block">
89Parent: None
90Requirements: Must appear once as the root node
91</pre>
92</div>
93<div class="section" id="shortname-element">
94<h2>ShortName element</h2>
95<p>Contains a short human-readable name for the search engine:</p>
96<pre class="literal-block">
97Parent: OpenSearchDescription
98Requirements: Must appear exactly once
99</pre>
100</div>
101<div class="section" id="description-element">
102<h2>Description element</h2>
103<p>Contains a human-readable description of the search engine:</p>
104<pre class="literal-block">
105Parent: OpenSearchDescription
106Requirements: Must appear exactly once
107</pre>
108</div>
109<div class="section" id="url-element">
110<h2>Url element</h2>
111<p>Describes structure through which search requests are made:</p>
112<pre class="literal-block">
113Parent: OpenSearchDescription
114Requirements: Must appear exactly once
115Attributes: template - specifies a parameterized template URL for the
116search query, in which {searchTerms} is replaced by the user-supplied
117query.
118</pre>
119</div>
120</div>
121<div class="section" id="example">
122<h1>Example</h1>
123<pre class="literal-block">
124&lt;?xml version=&quot;1.0&quot;?&gt;
125&lt;OpenSearchDescription&gt;
126&lt;ShortName&gt;BitTorrent&lt;/ShortName&gt;
127&lt;Description&gt;Search torrents on BitTorrent.com&lt;/Description&gt;
128&lt;Url template=&quot;http://www.bittorrent.com/search?q={searchTerms}&amp;category=All&quot;/&gt;
129&lt;/OpenSearchDescription&gt;
130</pre>
131<!-- Local Variables:
132mode: indented-text
133indent-tabs-mode: nil
134sentence-end-double-space: t
135fill-column: 70
136coding: utf-8
137End: -->
138</div>
139<div class="section" id="id1">
140<h1>References</h1>
141<table class="docutils footnote" frame="void" id="id2" rules="none">
142<colgroup><col class="label" /><col /></colgroup>
143<tbody valign="top">
144<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>
145</tbody>
146</table>
147</div>
148
149
150</div>
151        <div id="footer">
152<hr/>
153</div>
154
155</div>
156</body>
157</html>
Note: See TracBrowser for help on using the browser.