AutoTweet NG User Documentation (Pro and free version)
Version 3.2, Revision Date: 28.02.2010
This document describes the basic functionality and key features of the 1stMovers AutoTweet NG (next generation) extensions. The AutoTweet product series posts the title and url for new Joomla articles, forum posts etc. automatically as status messages to twitter and/or Facebook (pro version). All AutoTweet extensions are under GPL 2.0.
This documentation contains instructions for the free and the commercial (Pro) version of the AutoTweet NG component. The usage of both versions is similar. The Pro version adds support for Facebook and has some extra features. All available plugins are working with the free and the Pro version.
Features
- All plugins are customizable: account, category/section to post for, link position, show section/category, post private articles, post modified articles, exclude sections/categories, use title or text for message, additional static text (e.g. for hashtags), short url service provider (is.gd, bit.ly) etc.
- Works with sh404sef, JoomSEF, AceSEF and - of course - Joomla! embedded SEF support.
- Automatic support for short URLs.
- Automatic message resending: Sometimes you will get an error message when posting. This can happen from time to time when twitter or Facebook is overloaded or the API is down. AutoTweet resends the status message automatically if there is an error on api site.
- AutoTweet posts also later published or republished articles.
- AutoTweet NG comes with a backend component. The component logs all posted messages (including error and pending messages) and you can manage and resend this messages in the components backend.
- AutoTweet NG supports now articles with present publish date. (This articles are posted automatically to twitter when published by Joomla or you can post them manually from AutoTweet NG component backend.)
Extra features in Pro version
- Support for Facebook (works with personal profile, Facebook pages and Facebook groups).
- Manually mode: All generated status messages are stored in the AutoTweet database and must be published manually by the admin from the backend.
- Support for SEF URLs also when post (article etc.) is saved from the backend. Tested with Joomla! core SEF, sh404SEF, JoomSEF (since version 1.1) and AceSEF (since version 1.2).
- Post to Facebook pages as the page itself with the page account (and not as the user with the personal account). (since version 1.1)
Available AutoTweet NG extensions
AutoTweet NG consists of a (main) component and several plugins. With the component you can manage the posted messages, including error und pending messages. The component provides also the basic services for the plugins. The AutoTweet NG Extension-Plugins handles the message posting for the different extensions like Kunena, K2 etc. All Extension-Plugins needs the AutoTweet NG Component (free or pro) to work.
- AutoTweet NG Component: The main component. Message handling and basic services.
- AutoTweet NG Automator-Plugin (is also shipped as part of the component package): Automatic post attempts for pending messages.
- AutoTweet NG Content-Extension (is also shipped as part of the component package): Extends AutoTweet for Joomla core content articles.
- AutoTweet NG Kunena-Extension: Extends AutoTweet for Kunena forum posts.
- AutoTweet NG K2-Extension: Extends AutoTweet for K2 article manager.
- AutoTweet NG Phoca Download-Extension: Extends AutoTweet for Phoca Download and posts a message for new/changed downloads.
- AutoTweet NG Eventlist-Extension: Extends AutoTweet for Eventlist and posts a message for new/changed events.
- AutoTweet NG SimpleCalendar-Extension: Extends AutoTweet for SimpleCalendar and posts a message for new/changed events.
- AutoTweet NG Sobi2-Extension: Extends AutoTweet for Sobi2 article manager and posts a message for new/changed articles.
- AutoTweet NG Remository-Extension: Extends AutoTweet for Remository download manager and posts a message for new/updated downloads.
- AutoTweet NG VirtueMart-Extension: Extends AutoTweet for VirtueMart shop system and posts a message for new/updated products.
- AutoTweet NG QuickFAQ-Extension: Extends AutoTweet for QuickFAQ and posts a message for new/updated FAQ entrys.
- AutoTweet NG MyBlog-Extension: Extends AutoTweet for MyBlog and posts a message for new/updated blog entrys.
- AutoTweet NG Latest Module: Shows the latest posts in admin cpanel and has an option to toggle manually mode. This module works with the pro version only!
More plugins will come in the future.
All AutoTweet NG extensions can be installed/updated by the standard Joomla installation procedure. Please install first the AutoTweet NG Component and then the needed plugins. The Content-Extension and the Automator-Plugin are packaged and installed/updated automatically with the main component. All other extensions (plugins, modules) must be downloaded and installed separately.
Requirements
All AutoTweet NG extensions have the following requirements:
- PHP 5
- PHP cURL support
- Joomla 1.5.4+
The AutoTweet NG extension plugins have special requirements:
- All plugins needs AutoTweet NG Component (free or pro) to work.
- Some plugins need other extensions to work (e. g. AutoTweet NG Kunena needs the Kunena forum extension).
AutoTweet needs access to some domains/URLs to work:
- "twitter.com" (api.twitter.com) for posting to twitter.
- "facebook.com" for posting to Facebook (pro version).
- "bit.ly" or/and "is.gd" for short url service.
- "1st-movers.com" for automatic version checks (the component checks for new versions on the server).
It is possible that your provider has restricted access to one or all of this URLs or that some firewall rules conflicts with the access to this URLs. If you have problems accessing these URLs please contact your admin and/or provider/host.
Installation
You should make a backup of your files and database before you install/upgrade extensions!
- Download AutoTweed NG Component package (free or pro).
- Install AutoTweed NG Component package with the Joomla! installer (File: com_autotweet.zip). The Content-Extension and the Automator-Plugin are installed automatically meanwhile component installation. The Automator-Plugin is enabled automatically. The Content-Extension is disabled after installation to prevent accidental posts.
- Open AutoTweet NG Component in the backend and configure the component in the parameters window.
- Check the plugin options and enable the Content-Extension (if needed).
- Donwload the other AutoTweet NG Extension-Plugins you needed and install them (File: plg_autotweet[extension].zip). Go to the plugin options and do the configuration. Don't forget to enable the plugins.
Upgrade
You should make a backup of your files and database before you install/upgrade extensions!
Information about new available versions you will find also in the information window of the AutoTweet NG component in Joomla backend.
For all versions (components and plugins) with date 09.02.2010 (2010-02-09) or newer, I have implemented a new upgrade procedure. It is no longer necessary to uninstall old versions of the component or plugins. You can just use the Joomla! installer to upgrade:
- Check for dependencies: Sometimes you have to update also the component when updating an extension plugin (and vice versa). Information about version dependencies you can find in the change logs (download area) on 1st-movers.com.
- Download the newest version of AutoTweed NG Component package (free or pro).
- Upgrade AutoTweed NG Component package with the Joomla! installer (File: com_autotweet.zip). This is same as installing AutoTweet (Upgrade is detected and done automatically!). The Content-Extension and the Automator-Plugin are updated automatically meanwhile component installation. The Automator-Plugin is enabled automatically. The state of the Content-Extension is unchanged.
- Open AutoTweet NG Component in the backend and check the configuration in the parameters window. (Sometimes there are new or changed options.)
- Check the plugin options (Automator-Plugin, Content-Extension).
- Do the same procedure for other plugins when upgrade is needed. Plugins are disabled after the upgrade to prevent accidental posts. So you have to enable it manually!
This procedure works also when you upgrade from free to Pro version!
Sometimes you will have problems/error message with file permissions. In this case contact your admin or uninstall the old version before installing the new. When you do this, it is NOT necessary to remove the AutoTweet database tables (manually)!
Configuration
For all configuration options you will get some help if you move the mouse pointer over the field title.
AutoTweet NG Component
Select (in admin backend) the AutoTweet NG Component (Components/AutoTweet) and open the parameters window.
- Twitter channel (Username, Password): If you will post to twitter enable this channel and enter you twitter account data.
- Facebook channel (Facebook user id): If you will post to Facebook enable this channel and enter your Facebook user id. You can post to a personal profile, to a Facebook (business/fan) page or to a Facebook group. If you will post to a page or group, you must also enter the Facebook page or group id. You must also authorize AutoTweet on Facebook. Please read first the additional information to activate AutoTweet for Facebook to get information about authorizing and Facebook page/group id.
- URL handling: The article URL can be showed at the beginning or end of the twitter status message.
- Automatic resend attempts: AutoTweet resends the status message automatically if there is an error on api site. Here you can change the number of resend attempts. Change this parameter only if you have problems sending to twitter (increase attempts) or with the performance of your site (decrease attempts).
- Message/Database cleanup: For performance reasons it is essential to cleanup the AutoTweet database periodically. The automatic cleanup function removes all messages older than the specified number of days. Normally you should NOT deactivate this function!
- Short URLs: Disable this service ONLY, if you have problems with the short URLs (broken links, problems accessing the article from message link...) If you will use the service from bit.ly you need an account there and you can see your statistics at bit.ly.
- Transmitting mode (only available in the Pro version): If you enable the manually mode, status massages are not sended automatically to the service (twitter, Facebook, ...) when saved/published. Status messages are stored and you can send them later manually from AutoTweet backend.
- Version checks: If you have problems or warnings on AutoTweet NG Information site (in backend), you can disable version checking and the file autotweet.ini will no longer loaded from the 1st-movers.com server (Of course you will not get information about new versions if this option is disabled).
- Debugging and test (use this only for test purposes): If debugging mode is enabled, you will get more info about sending attempts and return codes. The debug info is shown on top of the page when a message is sended to twitter or Facebook.
AutoTweet NG Automator-Plugin
You must enable the plugin to get it work.
Options (since version 1.1):
- Max. nr of posts: Max. number of pending posts sendet by the Automator-Plugin in one time/call. (Max. 5 posts for performance reasons.)
- Interval in seconds: Interval for the post attempts of the Automator-Plugin. This means the plugin checks all X seconds for new pending posts. Min. is 120 seconds for performance reasons.
AutoTweet NG Extension-Plugins
The Extension-Plugins has similar configuration options (not each option is available for each plugin):
- Sections/Categories to post for: Select Sections/Categories which will be source of articles. The field conditions are connected by OR! (If nothing is set, all articles will be posted!).
- Excluded Sections/Categories: Specify exclusions for article posting. Exclusions has priority over all other settings! (If fields are empty, nothing is excluded).
- Post private: You can post private articles. Off course users has to login to read the linked article.
- Post modified: You can post also modified (edited) articles.
- Show section/category: You can show the section and/or category at the beginning of the message and you can selected, if you will add a '#' for hashtag support in front of category/section name. Remember: The message can have a maximum of 140 characters and will be truncated at the end! Hashtags are not supported by all channels (e.g. Facebook ignores hashtags).
- Use title or text: If your titles are not good for posting to twitter you can also use the first X chars from the article text. Enter the number of chars (from title or text) for use with message (min. 10 max. 140 chars). Remember: A message has not more than 140 chars and will be truncated. If you use static text (hashtags) or category/section names they also need space...
- Additional text/hashtags: AutoTweet can insert metakey data automatically as hashtags in the message (If no metakey data is available, AutoTweet uses also the static text if entered). Also you can use only a static text. Hashtags are not supported by all channels (e.g. Facebook ignores hashtags).
- Post replys: If this option is set to Yes also replys to articles/posts are posted.
- Post only for usertype: Send only articles posted by a specific type of user (registered users, admis/moderators).
To activate AutoTweet for Facebook, you have to do a little bit more work as for twitter activation. This is normal behavior with Facebook. I have done my best to make this as easy as possible for you.
Authorize application and grant the extended permissions
When you will use the Facebook support (only available in the Pro version) then you must authorize the AutoTweet application on Facebook and grant the extended permission publish_stream and offline_access to the application. You can do this manually on Facebook or AutoTweet can guide you (recommended):
- Go to the AutoTweet backend and select the tab Services.
- Click the link Add/Authorize Facebook application and grant/change permissions for AutoTweet on Facebook under Service specific functions.
- Login to Facebook, authorize the application and grant the requested permissions.
- Read and check the information/instructions on the AutoTweet Facebook canvas site.
- If you will post to a Facebook page you must also grant the extended permissions for the page. Follow the instructions on the AutoTweet Facebook canvas site, click on Grant extended permissions for Facebook page and grant the requested permissions for the page.
- Enable the Facebook channel in AutoTweet NG Pro component preferences and enter (copy/paste) the displayed Facebook user id and - if you will post to a page or group - the displayed page or group id.
The Extension-Plugins works quietly in the background. For the usage of the backend component I will give you some hints:
Fields
You can sort the table by clicking on the field name in the head of the table.
- Date posted: This is the date the article is published from Joomla and stored in the AutoTweet database log.
- Publish date: This is the date the message is send to twitter/Facebook. (For pending articles with present date the publish date is in the future.)
- Article ID: This is the ID of the original Joomla article, forum post etc.
- State: success, error (manual resend attempt is possible), pending (manual or automatic resend by AutoTweet NG Automator-Plugin is possible)
Additional information
- Pending messages are waiting for posting. In most cases they has a present/future publish date. If you have enable the AutoTweet NG Automator-Plugin this messages are automatically send when the publish date is reached. You can also do manual send attempts.
- Messages with error state are not automatically resendet by AutoTweet NG Automator-Plugin. When the reason for the problem is solved, you can resend them manually.
Functions
In the top of the AutoTweet NG admin screen you will find some buttons:
- Publish: Send the selected messages to all enabled channels.
- Publish all: Sends all messages with state 'error' or 'pending'.
- Delete: Removes the selected messages from AutoTweet log database.
- Parameters: Opens a window with the components parameters/options.
- Help: Opens the AutoTweet online help in a separate window.
- Free version: When article is posted from admin backend, no SEF support is available and normal URL is used (This is an issue of Joomla and not of the plugin: in backend no SEF support is available at all). The Pro version supports also SEF URLs when articles etc. are posted from admin backend.
|