<?xml version="1.0" encoding="iso-8859-1" ?>
<?xml-stylesheet type="text/xsl" href="/template/template.php" ?>
<!DOCTYPE theshtick  [
	<!ENTITY nbsp   "&#160;">
	<!ENTITY copy   "&#169;">
	<!ENTITY reg    "&#174;">
	<!ENTITY trade  "&#8482;">
	<!ENTITY mdash  "&#8212;">
	<!ENTITY ldquo  "&#8220;">
	<!ENTITY rdquo  "&#8221;">
	<!ENTITY pound  "&#163;">
	<!ENTITY yen    "&#165;">
	<!ENTITY euro   "&#8364;">
	<!ATTLIST html
		  sitehome   CDATA        #IMPLIED
	>
]>
<html sitehome="yes">
<head>
<title>The Shtick Auto-Twitter for Nucleus</title>
</head>
<body>
<h1>
The Shtick
<span><img src="./icon.png" alt="The Shtick Auto-Twitter for Nucleus" class="icon"/></span>
<span class="subheader">Auto-Twitter for Nucleus</span>
</h1>
<div id="content">
	<div><label>Current Version:</label> 0.3.2</div>
	<div><a href="NP_AutoTwitter_0.3.2.zip">Download</a></div>
	<div><a href="/news/index.php?itemid=1337">Discuss</a></div>
	<div><a href="./download_archive.php">Download Archive</a></div>

	<div class="subcontent">
		<h2>Server Requirements</h2>
		<ul>
		<li><a href="http://us2.php.net/curl">The Client URL (cURL) Library</a> for PHP. (Most servers with PHP have this, but if there's a problem, this might be
		something to check into.)</li>
		<li><a href="http://www.php.net/">PHP 5.2.x</a></li>
		<li>PHP sessions need to be enabled.</li>
		<li>OpenSSL</li>
		</ul>
	</div>

	<div class="subcontent">
		<h2>Upgrade</h2>
		<p>To upgrade The Shtick Auto-Twitter for Nucleus perform the following steps:</p>

		<ol>
		<li>Download the plugin's ZIP archive. <em>(See link above.)</em></li>
		<li>Unzip the plugin to obtain the file, <code>NP_AutoTwitter.php</code>, and the folder, <code>autotwitter</code>.</li>
		<li>Copy <code>NP_AutoTwitter.php</code> and <code>autotwitter</code> to <code>nucleus/plugins/</code> in your nucleus installation folder (on your webserver), overwriting the existing plugin file.</li>
		<li>Visit your Nucleus-managed website.</li>
		<li>Log in as an administrator.</li>
		<li>Visit the administrative console of your Nucleus-managed website.</li>
		<li>In the side-bar on the left-hand side of the screen, click on the "plugins" link. (This should bring up the Manage Plugins page.)</li>
		<li>Find the installed plugin in the list of plugins and click on the "edit options" link. (There should be only one option on the page that appears, with the value set to "No".)</li>
		<li>Set the option's value to "Yes".</li>
		<li>Click on the "Save Options" button.</li>
		<li>In the side-bar on the left-hand side of the screen, click on the "plugins" link. (This should bring up the Manage Plugins page.)</li>
		<li>Click on the "Update subscription list" button.</li>
		</ol>

		<p>After performing these steps The Shtick Auto-Twitter for Nucleus should be upgraded.</p>
	</div>

	<div class="subcontent">
		<h2>Installation</h2>
		<p>To install The Shtick Auto-Twitter for Nucleus perform the following steps:</p>

		<ol>
		<li>Download the plugin's ZIP archive. <em>(See link above.)</em></li>
		<li>Unzip the plugin to obtain the file, <code>NP_AutoTwitter.php</code>, and the folder, <code>autotwitter</code>.</li>
		<li>Copy <code>NP_AutoTwitter.php</code> and <code>autotwitter</code> to <code>nucleus/plugins/</code> in your nucleus installation folder (on your webserver).</li>
		<li>Visit your Nucleus-managed website.</li>
		<li>Log in as an administrator.</li>
		<li>Visit the administrative console of your Nucleus-managed website.</li>
		<li>In the side-bar on the left-hand side of the screen, click on the "plugins" link. (This should bring up the Manage Plugins page.)</li>
		<li>From the page that comes up, scroll down to the "Install New Plugin" section near the bottom.</li>
		<li>Select AutoTwitter from the drop-down menu in this section and then click on the "Install Plugin" button.</li>
		</ol>

		<p>After performing these steps The Shtick Auto-Twitter for Nucleus should be installed.
		This can be verified by finding it in the list of installed plugins that begins at the top of the page.</p>
	</div>

	<div class="subcontent">
		<h2>Instructions</h2>
		<p>The first thing one needs in order for a user to make use The Shtick Auto-Twitter for Nucleus, is a
		<a href="http://www.twitter.com/">Twitter</a> account. Once this basic necessity is provided for a user,
		the user needs to authorize The Shtick Auto-Twitter for Nucleus to post tweets to their account. This
		is done from the plugins page. The plugins page is available from the sidebar in the nucleus admin area.
		Once on this page, find the listing for The Shtick Auto-Twitter for Nucleus and click on the "admin" link
		for this plugin. This page provides a link which should be clicked on to take you to the Twitter website,
		where you will be asked to authorize the application.</p>

		<h3>Turning on Auto-Twittering.</h3>
		<p>Once tweeting has been authorized, a user can turn on and off auto-twittering on comments from
		their profile page. To turn on and off auto-twittering for blog entries, a blog administrator should visit
		the "settings" page for the blog. A checkbox is provided from the blog settings page to enable or disable
		auto-twittering.</p>

		<p>Only bloggers who have authorized the plugin to tweet to their account will have tweets automatically
		posted.</p>

		<h3>Customization</h3>
		<p>The Shtick Auto-Twitter for Nucleus provides the ability to customize the format of tweets using tweet
		templates. The tweet template for comments can be specified in the user's profile page, whereas the blog
		entry tweet template can be specified in the blog settings page.</p>

		<p>With the template, the text of the tweet is specified, and three wildcards can be used to make the
		tweets specific to the blog entry they relate to. The default tweet template for a blog comment is as follows:</p>

		<p><code>Commented on %##BLOGNAME##% - %##URL##%</code></p>

		<p>%##BLOGNAME##% and %##URL##% are both wildcards. There are three wildcards total. These wildcards,
		along with their replacements, are as follows.</p>

		<ul>
		<li>%##BLOGNAME##% - The name of the blog.</li>
		<li>%##TITLE##% - The title of the relevant item.</li>
		<li>%##URL##% - The url of the relevant item.</li>
		</ul>
	</div>
</div>
</body>
</html>