Welcome to the Hub-It documentation. This document will give you an outline of the functionality and purpose of hubit. It will also explain all the features of hubit.
Hub-It Functionality:
Hub-It can used it two ways. One is the single site. It would let you pull in simple 0.91 and 1.0 RDF and xml feeds. The second use is for large-scale sites that contain a collection of website. Skip to the features section if you only need hubit for a simple rdf or xml feed. You will also never need to click on the "Hub Feed" titled links.
Hub-it was designed to allow a collection of sites to be organized in a tree structure.
Simple Example.
L1 - Lever One phpwebsite
L2 - Lever Two phpwebsite
L3 - Lever Three phpwebsite
This tree will allow large-scale announcement posting on a large tree of sites.
Lets say one of your L1 sites posts a new announcement. With Hub-It running
on all of your sites it will allow your level two sites to pick up the new announcement
as soon as it is made. This in turn will let you level three site pick up the
level two announcements. Each level two and three site can have one or more
sub-trees. You may also have a L4, L5, ... Why do you arrange sites this way?
Well this allows you to have an announcement from one of your departments to
automatically appear on the top-level site. Sites may be set to cache data for
a short time to help with large traffic load too. There time may be set from
0 minutes (no cache) and up. This feed may then be filtered to have lets say
announcements from today or last one,two,three,... announcements per department.
There can be many different options for hub feeds. You may also have it pull
any amount you want up to 50 announcements. An announcement in a feed contains
a title, link to full announcement, description, and time/date. Any phpWebSite
1.0 feed will have all data not just link and title. They will need to have
phpwebsite 0.8.2 or greater.
Features:
Add Feed - This allows you to point at any 0.91 or 1.0 RDF or xml feed. If the feed is a 1.0 RDF phpwebsite feed you will also be able to get a specified number of items.
Add Hub Feed- To receive you simple type in the site URL. This only works with other L2 or above hubit sites. Add a site with a normal type of feed in the add feed menu item. You will then get a list of the available feeds from the URL you entered. After picking one it will add it to the main list of feeds on the front hubit menu.
Create Hub Feed - This allows you to create, edit or delete the hub data you will transmit. This will be for L2 and up levels. This is where the process of combining hubs comes in for higher levels.
Arrange Feeds - This allows you to do many things with your feeds. First there are two display options one, display only active feeds and two, and display all feeds. This allows to you fully manage your feeds off and then just turn them on so you do not mess up the layout of your site while you are managing feeds. You have four places to display a feed. You may also use the bottom select boxes to move selected feeds around or order feeds. Feeds that are active will be automatically displayed accordant to the block location and order. All of this is done for you just use the arrange feed section. You may also multi-select feeds with the Ctrl key or select all between with the Shift key. You may use the order select box to move individual items around.
List of feeds - This lists the feeds you have installed at the bottom of the main admin hubit page. This list contains the Site info and the ability to activate/deactivate, edit, and delete feeds
Hub-It Options:
Display name - This is the name that is displayed in the top of the location
box.
Blocks per line - This is where you set how man columns you want the appropriate location. Left and right are limited to one.
Number of items - This allows you to set how many items you get and display from any phpwebsite 1.0 feed.
Cache time - This sets the amount of time you will have feed data cached in the sql server before it checks again. Set to 0 if you do not want cache.
Clear Cache - After switching some feeds off you can have items that stay in the cache table. You may want to clear the cache every once in a while after managing feeds. Also REMEMBER if you site starts acting up when you are working on it clear the cache.
Hubit master server - Later there will be master server that any hubit can get new RDF feed links. This will include a phpwebsite powered list and also a list of other RDF or xml feeds. For now there is a link to install a large list of feeds to start out with.
Hub-It Template information:
Hub-It has a very powerful temple system. This system allows you to layout all of the information in whatever way you like. To make a template you will need to know the following. You do not have to have all the tags in the template. If you just do not want {TIME} for example just take the {TIME} string out of the template.
All template files are in the template folder in hubit.
template_1_short_box.tpl :
This file allows you to set what is displayed when the site draws a standard
box.
template_1_short_layout.tpl:
This file allows you to set how the looped information looks like for all your
site info in a standard box.
template_1_long_box.tpl:
This file allows you to set what is displayed when the site draws a detailed
box.
template_1_long_layout.tpl:
This file allows you to set how the looped information looks like for all your
site info in a detailed box.
template_1_hubit_break.tpl:
This is what is displayed when a hubit category name is detected in the feed.
In these files you will find tags with {} around them. You use these tags to show what information you want in the template call. Here is a list of what they output.
{BOXTITLE} - This is the Feed Name.
{CONTENT} - This is the section that the list of info is added in.
{LINK} - This is the url link to the item.
{TITLE} - This is the title of the item
{DATE} - This is the date of the item.
{TIME} - This is the time of the item.
{DESC} - This is the description of the item.
{NAME} - This is the hub category name. This should only show up in hubit_break.