docs/_site/setup.html in chatterbot-2.0.5 vs docs/_site/setup.html in chatterbot-2.1.0
- old
+ new
@@ -7,19 +7,19 @@
<title>chatterbot : Authorizing Your Bot</title>
<meta name="description" content="twitter bots in ruby">
<link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
- <link rel="stylesheet" href="/css/syntax.css">
- <link rel="stylesheet" href="/css/main.css">
+ <link rel="stylesheet" href="/chatterbot/css/syntax.css">
+ <link rel="stylesheet" href="/chatterbot/css/main.css">
</head>
<body>
<div class="container">
<div class=row-fluid>
<div id=header class=span12>
- <h4><a class=brand href="/">chatterbot</a>
+ <h4><a class=brand href="/chatterbot/">chatterbot</a>
<small>twitter bots in ruby</small>
</h4>
</div>
@@ -28,11 +28,11 @@
<div class=row-fluid>
<div id=navigation class=span2>
<ul class="nav nav-list">
- <li><a href="/">Home</a></li>
+ <li><a href="/chatterbot/">Home</a></li>
<li class=nav-header>Getting Started</li>
@@ -54,11 +54,11 @@
<li data-order="">
- <a href="/examples.html">Examples</a>
+ <a href="/chatterbot/examples.html">Examples</a>
</li>
@@ -80,11 +80,11 @@
<li data-order="">
- <a href="/setup.html">Authorizing Your Bot</a>
+ <a href="/chatterbot/setup.html">Authorizing Your Bot</a>
</li>
@@ -95,18 +95,14 @@
-
-
-
-
<li data-order="">
- <a href="/walkthrough.html">Walkthrough</a>
+ <a href="/chatterbot/walkthrough.html">Walkthrough</a>
</li>
@@ -117,21 +113,21 @@
<li data-order="">
- <a href="/advanced.html">Advanced Features</a>
+ <a href="/chatterbot/advanced.html">Advanced Features</a>
</li>
<li data-order="">
- <a href="/configuration.html">Configuration</a>
+ <a href="/chatterbot/configuration.html">Configuration</a>
</li>
@@ -141,11 +137,11 @@
<li data-order="">
- <a href="/deploying.html">Running your Bot</a>
+ <a href="/chatterbot/deploying.html">Running your Bot</a>
</li>
@@ -155,11 +151,11 @@
<li data-order="">
- <a href="/features.html">Basic Features</a>
+ <a href="/chatterbot/features.html">Basic Features</a>
</li>
@@ -178,16 +174,10 @@
-
- <li data-order="">
-
- <a href="/streaming.html">Streaming API</a>
-
- </li>
@@ -195,14 +185,10 @@
-
-
-
-
<li class=nav-header>Developers</li>
@@ -216,11 +202,11 @@
<li data-order="">
- <a href="/contributing.html">Contributing</a>
+ <a href="/chatterbot/contributing.html">Contributing</a>
</li>
@@ -262,14 +248,10 @@
-
-
-
-
<li class=nav-header>Resources</li>
@@ -303,11 +285,11 @@
<li data-order="">
- <a href="/other-tools.html">Other Tools</a>
+ <a href="/chatterbot/other-tools.html">Other Tools</a>
</li>
@@ -328,14 +310,10 @@
-
-
-
-
<li data-order="">
<a href="https://dev.twitter.com/rest/public">Twitter API docs</a>
@@ -361,88 +339,101 @@
</h2>
</div>
<p>Getting a bot running on Twitter can be a little tricky. Twitter uses
a something called <a href="https://dev.twitter.com/oauth">OAuth</a> to validate
-requests, but it's a little more complicated than just specifying a
+requests, but it’s a little more complicated than just specifying a
username/password.</p>
<ul>
-<li><p>Login to Twitter with your bot account</p></li>
-<li><p>Go to <a href="https://apps.twitter.com/app/new">https://apps.twitter.com/app/new</a></p></li>
-<li><p>Fill out the form. You need to put a name, description, and Website
-URL, although the URL doesn't need to exist. <img
-src="/images/01-create-application.png" /></p></li>
-<li><p>Save the form, and then click on the Permissions tab. You will need
-to specify what level of access is needed for your bot. <img
-src="/images/02-application-permissions.png" /> You have three
+ <li>
+ <p>Login to Twitter with your bot account</p>
+ </li>
+ <li>
+ <p>Go to https://apps.twitter.com/app/new</p>
+ </li>
+ <li>
+ <p>Fill out the form. You need to put a name, description, and Website
+URL, although the URL doesn’t need to exist. <img src="./images/01-create-application.png" /></p>
+ </li>
+ <li>
+ <p>Save the form, and then click on the Permissions tab. You will need
+to specify what level of access is needed for your bot. <img src="./images/02-application-permissions.png" /> You have three
choices here: Read only, Read and Write, and Read and Write and
-access DMs. If your bot isn't actually ever going to post to Twitter
-(for example, if you're just running a search to find interesting
+access DMs. If your bot isn’t actually ever going to post to Twitter
+(for example, if you’re just running a search to find interesting
tweets), you can choose read-only. Otherwise, you should pick
read/write, or read/write/DMs. Chatterbot has limited support for
handling Direct Messages, but if you can imagine a situation where
-you might want to handle them, you should pick this option.</p></li>
-<li><p><em>NOTE:</em> When you try and save this form, there's a good chance that
+you might want to handle them, you should pick this option.</p>
+ </li>
+ <li>
+ <p><em>NOTE:</em> When you try and save this form, there’s a good chance that
you will get an error that tells you to add a mobile phone to your Twitter
-profile. It will look a lot like this: <img src="/images/03-mobile-number.png" /></p></li>
-</ul>
+profile. It will look a lot like this: <img src="./images/03-mobile-number.png" /></p>
-<p>You can add your number here: <a href="https://twitter.com/settings/devices">https://twitter.com/settings/devices</a></p>
+ <p>You can add your number here: https://twitter.com/settings/devices</p>
-<p>After you add the number, Twitter will ask you to send them a text
- message. Once you do this, you can finish updating the settings for
- your application. Later, we'll remove the mobile number.</p>
+ <p>After you add the number, Twitter will ask you to send them a text
+message. Once you do this, you can finish updating the settings for
+your application. Later, we’ll remove the mobile number.</p>
+ </li>
+</ul>
-<p>Once you've registered your application, you have two options. You can
+<p>Once you’ve registered your application, you have two options. You can
create access tokens for your bot via Twitter, or you can run the
<code>chatterbot-register</code> script. Running the script will take care of
-creating a template file for your bot, but if you don't want to do
+creating a template file for your bot, but if you don’t want to do
that, here are the steps for doing this manually:</p>
<ul>
-<li> click the 'Keys and Access Tokens' link. You should see this: <img src="/images/04-access-token.png" /></li>
-<li>click the 'Create my access token' link. </li>
-<li>It might take a few minutes for Twitter to actually generate the
+ <li>click the ‘Keys and Access Tokens’ link. You should see this: <img src="./images/04-access-token.png" /></li>
+ <li>click the ‘Create my access token’ link. </li>
+ <li>It might take a few minutes for Twitter to actually generate the
token. You can refresh the page a couple times until they are there,
-then you can copy the keys into your application. There's four keys
+then you can copy the keys into your application. There’s four keys
you will need for your bot, and a couple different ways to save
them:</li>
</ul>
<p><strong>In a separate YAML config file</strong>. Create a file named botname.yaml
- -- the botname part must match your bot's username EXACTLY. Put the
+ – the botname part must match your bot’s username EXACTLY. Put the
following contents, pasting the credential values that you just
generated:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text"> ---
+
+<p><code>
+ ---
:consumer_secret: Consumer Secret (API Secret) GOES HERE
:consumer_key: Consumer Key (API Key) GOES HERE
:token: Access Token GOES HERE
:secret: Access Token Secret GOES HERE
-</code></pre></div>
+</code></p>
+
<p><strong>in the script</strong>. Add some lines to your bot script like this:
<code>
-consumer_key 'Consumer Secret (API Secret)'
-consumer_secret 'Consumer Key (API Key)'
-secret 'Access Token Secret'
-token 'Access Token'
+consumer_key 'Consumer Secret (API Secret)'
+consumer_secret 'Consumer Key (API Key)'
+secret 'Access Token Secret'
+token 'Access Token'
</code></p>
-<p><strong>in a database</strong>. If you've setup chatterbot to use a database, you
+<p><strong>in a database</strong>. If you’ve setup chatterbot to use a database, you
can store your configuration info in the <strong>config</strong> table.</p>
<p><strong>NOTE</strong> At this point, you can remove the phone number from the bot
- account if you like. From your bot's account, click 'Settings' ->
- 'Mobile' -> 'Delete my phone'.</p>
+ account if you like. From your bot’s account, click ‘Settings’ ->
+ ‘Mobile’ -> ‘Delete my phone’.</p>
</div>
</div>
<div class=row-fluid>
<div id=footer class=span12>
- Documentation for <a href="https://github.com/muffinista/chatterbot">chatterbot</a>
+ <!--
+Documentation for <a href="https://github.com/muffinista/chatterbot">chatterbot</a>
+-->
</div>
</div>
</div>