docs/_site/features.html in chatterbot-2.0.5 vs docs/_site/features.html in chatterbot-2.1.0
- old
+ new
@@ -7,19 +7,19 @@
<title>chatterbot : Basic Features</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>
@@ -359,69 +337,88 @@
<h2>Basic Features
</h2>
</div>
-<p>Here's a list of some of the commonly-used methods in the Chatterbot DSL:</p>
+<p>Here’s a list of some of the commonly-used methods in the Chatterbot DSL:</p>
-<p><strong>search</strong> -- You can use this to perform a search on Twitter:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">search("'surely you must be joking'") do |tweet|
- reply "#USER# I am serious, and don't call me Shirley!", tweet
+<p><strong>search</strong> – You can use this to perform a search on Twitter:</p>
+
+<pre><code>search("'surely you must be joking'") do |tweet|
+ reply "#USER# I am serious, and don't call me Shirley!", tweet
end
-</code></pre></div>
+</code></pre>
+
<p>By default, Chatterbot keeps track of the last time you ran the bot,
and it will only search for new tweets.</p>
-<p><strong>replies</strong> -- Use this to check for replies and mentions:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">replies do |tweet|
- reply "#USER# Thanks for contacting me!", tweet
+<p><strong>replies</strong> – Use this to check for replies and mentions:</p>
+
+<pre><code>replies do |tweet|
+ reply "#USER# Thanks for contacting me!", tweet
end
-</code></pre></div>
+</code></pre>
+
<p>Note that the string <strong>#USER#</strong> is automatically replaced with the
username of the person who sent the original tweet. Also, Chatterbot
will only return tweets that were sent since the last run of the bot.</p>
-<p><strong>tweet</strong> -- send a Tweet out for this bot:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">tweet "I AM A BOT!!!"
-</code></pre></div>
-<p><strong>reply</strong> -- reply to another tweet:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">reply "THIS IS A REPLY TO #USER#!", original_tweet
-</code></pre></div>
-<p><strong>retweet</strong> -- Chatterbot can retweet tweets as well:</p>
-<div class="highlight"><pre><code class="language-rb" data-lang="rb"> <span class="n">search</span> <span class="s2">"xyzzy"</span> <span class="k">do</span> <span class="o">|</span><span class="n">tweet</span><span class="o">|</span>
- <span class="n">retweet</span><span class="p">(</span><span class="n">tweet</span><span class="o">[</span><span class="ss">:id</span><span class="o">]</span><span class="p">)</span>
- <span class="k">end</span>
-</code></pre></div>
-<p><strong>blacklist</strong> -- you can use this to specify a list of users you don't
+<p><strong>tweet</strong> – send a Tweet out for this bot:</p>
+
+<pre><code>tweet "I AM A BOT!!!"
+</code></pre>
+
+<p><strong>reply</strong> – reply to another tweet:</p>
+
+<pre><code>reply "THIS IS A REPLY TO #USER#!", original_tweet
+</code></pre>
+
+<p><strong>retweet</strong> – Chatterbot can retweet tweets as well:</p>
+
+<p><code>rb
+ search "xyzzy" do |tweet|
+ retweet(tweet[:id])
+ end
+</code></p>
+
+<p><strong>blacklist</strong> – you can use this to specify a list of users you don’t
want to interact with. If you put the following line at the top of
your bot:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">blacklist "user1, user2, user3"
-</code></pre></div>
+
+<pre><code>blacklist "user1, user2, user3"
+</code></pre>
+
<p>None of those users will trigger your bot if they come up in a
search. However, if a user replies to one of your tweets or mentions
your bot in a tweet, you will still receive that tweet when checking
for replies.</p>
-<p><strong>exclude</strong> -- similarly, you can specify a list of words/phrases
- which shouldn't trigger your bot. If you use the following:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">exclude "spam"
-</code></pre></div>
-<p>Any tweets or mentions with the word 'spam' in them will be ignored by
+<p><strong>exclude</strong> – similarly, you can specify a list of words/phrases
+ which shouldn’t trigger your bot. If you use the following:</p>
+
+<pre><code>exclude "spam"
+</code></pre>
+
+<p>Any tweets or mentions with the word ‘spam’ in them will be ignored by
the bot. If you wanted to ignore any tweets with links in them (a wise
precaution if you want to avoid spreading spam), you could call:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">exclude "http://"
-</code></pre></div>
-<p>The library actually comes with a pre-defined list of 'bad words'
+
+<pre><code>exclude "http://"
+</code></pre>
+
+<p>The library actually comes with a pre-defined list of ‘bad words’
which you can exclude by default by calling:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">exclude bad_words
-</code></pre></div>
-<p>The word list is from Darius Kazemi's
+
+<pre><code>exclude bad_words
+</code></pre>
+
+<p>The word list is from Darius Kazemi’s
<a href="https://github.com/dariusk/wordfilter">wordfilter</a>.</p>
<p><strong>whitelist</strong></p>
-<p><strong>followers</strong> -- get a list of your followers. This is an experimental
+<p><strong>followers</strong> – get a list of your followers. This is an experimental
feature but should work for most purposes.</p>
<p><strong>follow</strong></p>
<p><strong>profile_text</strong>
@@ -436,10 +433,12 @@
</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>