Skip to content

Commit

Permalink
fix some typos in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mcarter committed Jul 5, 2010
1 parent 774cd82 commit b89fe34
Show file tree
Hide file tree
Showing 8 changed files with 111 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/build/html/_sources/intro.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The Solution

This code works in *all* browsers, and it will always use the best communication mechanism possible.

..sourcecode:: html
.. sourcecode:: html

<script src="http://example.com:8000/static/Orbited2.js"></script>

Expand All @@ -43,7 +43,7 @@ Orbited Veterans

For all of you Orbited veterans who aren't so sure about writing WebSocket servers, and you just want to keep using trusty old Orbited.TCPSocket (but with performance and usability improvments) -- don't worry!

.. source:: html
.. sourcecode:: html

<script src="Orbited2.js"></script>

Expand Down
7 changes: 4 additions & 3 deletions docs/build/html/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,8 @@ <h3>The Problem<a class="headerlink" href="#the-problem" title="Permalink to thi
<div class="section" id="the-solution">
<h3>The Solution<a class="headerlink" href="#the-solution" title="Permalink to this headline"></a></h3>
<p>This code works in <em>all</em> browsers, and it will always use the best communication mechanism possible.</p>
<p>..sourcecode:: html</p>
<blockquote>
&lt;script src=&#8221;<a class="reference external" href="http://example.com:8000/static/Orbited2.js">http://example.com:8000/static/Orbited2.js</a>&#8220;&gt;&lt;/script&gt;</blockquote>
<div class="highlight-html"><div class="highlight"><pre><span class="nt">&lt;script </span><span class="na">src=</span><span class="s">&quot;http://example.com:8000/static/Orbited2.js&quot;</span><span class="nt">&gt;&lt;/script&gt;</span></pre></div>
</div>
<div class="highlight-javascript"><div class="highlight"><pre><span class="nx">Orbited2</span><span class="p">.</span><span class="nx">WebSocket</span><span class="p">.</span><span class="nx">install</span><span class="p">({</span>
<span class="nx">protocolVersion</span><span class="o">:</span> <span class="s2">&quot;hixie76&quot;</span><span class="p">,</span>
<span class="p">})</span>
Expand All @@ -134,6 +133,8 @@ <h3>The Solution<a class="headerlink" href="#the-solution" title="Permalink to t
<div class="section" id="orbited-veterans">
<h3>Orbited Veterans<a class="headerlink" href="#orbited-veterans" title="Permalink to this headline"></a></h3>
<p>For all of you Orbited veterans who aren&#8217;t so sure about writing WebSocket servers, and you just want to keep using trusty old Orbited.TCPSocket (but with performance and usability improvments) &#8211; don&#8217;t worry!</p>
<div class="highlight-html"><div class="highlight"><pre><span class="nt">&lt;script </span><span class="na">src=</span><span class="s">&quot;Orbited2.js&quot;</span><span class="nt">&gt;&lt;/script&gt;</span></pre></div>
</div>
<div class="highlight-javascript"><div class="highlight"><pre><span class="kd">var</span> <span class="nx">sock</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Orbited2</span><span class="p">.</span><span class="nx">TCPSocket</span><span class="p">({</span> <span class="nx">orbitedUri</span><span class="o">:</span> <span class="s2">&quot;http://127.0.0.1:8000&quot;</span> <span class="p">})</span>
<span class="nx">sock</span><span class="p">.</span><span class="nx">open</span><span class="p">(</span><span class="s2">&quot;irc.freenode.org&quot;</span><span class="p">,</span> <span class="mi">6667</span><span class="p">);</span>
<span class="nx">sock</span><span class="p">.</span><span class="nx">onopen</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added docs/source/builder/__init__.pyc
Binary file not shown.
Binary file added docs/source/builder/builders.pyc
Binary file not shown.
Binary file added docs/source/builder/util.pyc
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/source/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The Solution

This code works in *all* browsers, and it will always use the best communication mechanism possible.

..sourcecode:: html
.. sourcecode:: html

<script src="http://example.com:8000/static/Orbited2.js"></script>

Expand All @@ -43,7 +43,7 @@ Orbited Veterans

For all of you Orbited veterans who aren't so sure about writing WebSocket servers, and you just want to keep using trusty old Orbited.TCPSocket (but with performance and usability improvments) -- don't worry!

.. source:: html
.. sourcecode:: html

<script src="Orbited2.js"></script>

Expand Down
102 changes: 102 additions & 0 deletions docs/source/intro.rst~
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
============
Introduction
============

Overview
========

Orbited2's purpose is to ease the development of Websocket-based applications by normalizing the protocol and api across varying browser and server implementations.


#. Choose a WebSocket server framework/library (like node.js, or eventlet.)
#. Write a WebSocket application.
#. Deploy Orbited2. It will put a normalized Websocket API in *all* browsers.



The Problem
-----------

WebSocket is a far better real-time web protocol than anything we've seen so far, but it only works in a couple of the latest browsers. Additionally, the protocol is so new that it changes very quickly; a WebSocket application you write today might well stop working tomorrow. Further compounding the problem are the multitude of entrenched intermediaries, namely forward proxies, reverse proxies, firewalls, virus scanners, and more -- these obstacles will intercept and deny WebSocket connections.

The Solution
------------

This code works in *all* browsers, and it will always use the best communication mechanism possible.

..sourcecode:: html

<script src="http://example.com:8000/static/Orbited2.js"></script>


.. sourcecode:: javascript

Orbited2.WebSocket.install({
protocolVersion: "hixie76",
})

var ws = new WebSocket('ws://example.com/app')


Orbited Veterans
----------------

For all of you Orbited veterans who aren't so sure about writing WebSocket servers, and you just want to keep using trusty old Orbited.TCPSocket (but with performance and usability improvments) -- don't worry!

.. source:: html

<script src="Orbited2.js"></script>


.. sourcecode:: javascript

var sock = new Orbited2.TCPSocket({ orbitedUri: "http://127.0.0.1:8000" })
sock.open("irc.freenode.org", 6667);
sock.onopen = function() {
sock.send('NICK mcarter\r\n');
}
//etc


Installation
============

Orbited2 is written in python and depends on setuptools for installation. The fastest way to install hookbox is to type:

.. sourcecode:: none

# easy_install orbited2


If you are missing python or setuptools, please refer to the following links:

* `install python <http://python.org/download>`_
* `install setuptools <http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions>`_

To confirm your installation succeeded, type:

.. sourcecode:: none

# orbited2 --help

Github
======

The development version of Orbited2 is located on github:

* http://github.com/mcarter/orbited2

You can get a copy of the latest source by cloning the repository:

.. sourcecode:: none

# git clone git://github.com/mcarter/orbited2.git


To install Orbited2 from source, ensure you have python and setuptools, then run:


.. sourcecode:: none

# cd orbited2/daemon
# python setup.py install

0 comments on commit b89fe34

Please sign in to comment.