Aggregator Help

May 2007, version 1.0

© 2007, Pixel Media Pty. Ltd. Unless otherwise stated, permission is granted to copy, distribute and/or modify this document, with no invariant sections, no added text or covers, under the terms of the GNU Free Documentation License - version 1.2 or later, published by the Free Software Foundation.

A copy of the GNU Free Documentation License can be found at http://www.gnu.org/licenses/fdl.html.

Aggregator Content

Aggregate “hidden” pages

This setting forces Aggregator to list child pages that have their visibility set to 'hidden'. If this setting is off, 'hidden' child pages will not appear in your aggregator list.

Generate thumbnail from first image

If you turn this setting on, Aggregator will search the contents of every child page for an image. If it finds an image, it will make a thumbnail of it, which it will add to the list. Once this option is switched on, the other options in this section take effect. If this option is off, the other settings are ignored. If no image is found in a child page, no thumbnail is generated.

Maximum thumbnail size

This setting is only effective if you've turned on 'Generate Thumbnail from first image'. This specifies the maximum width and height that the thumbnail will be – in pixels. The thumbnail is generated by scaling the original image proportionately.

Use first image of class

Usually, if 'Generate thumbnail from first image' is on, Aggregator will accept the first image it finds in the child page, as the 'original' image for its thumbnail. If a class name is entered here, however, Aggregator will look for the first image on the page which also has this class style applied to it. This is useful to force Aggregator to look for a special type of image in your page – not just any first image – which you can specify manually. In order to use this feature, you must:

  1. use a template that has at least 1 custom class style which you can apply to images
  2. use a WYSIWYG editor that allows you to apply class styles to image elements – such as the excellent “Xinha”
  3. enter the class name in this Aggregator setting
  4. apply the class style to an image on the page

The name you enter here must be the class style name, without the leading '.' (dot). So, if the class name is “.specialimage”, you would simply enter here “specialimage”. If no image that has this class style applied is found, no thumbnail is generated.

Include page title

If ticked, Aggregator will include in its listings the Page Title of every child page.

Extract a page summary

If selected, Aggregator will try to find some information inside the contents of every child page, which it will list as a 'summary' for that page. The other settings in this section only take effect if this is switched on – otherwise, they are ignored.

Find summary element by tag

Aggregator will search for the first html element in the content of the child's page, which is of the specified type, and will use it as the summary for that page. This can be used in conjunction with the 'Find element summary by class' setting, to force Aggregator to find an element that is both of a certain type, and a certain class style. This setting is ignored, if 'Extract a page summary' has not been ticked. If no element in found in the child's contents of the specified type, no summary is generated.

Find summary element by class

Aggregator will search for the first html element in the content of the child's page, which has the specified style class applied to it, and will use it as the summary for that page. This can be used in conjunction with the 'Find element summary by tag' setting, to force Aggregator to find an element that is both of a certain type, and a certain class style. This setting is ignored, if 'Extract a page summary' has not been ticked. If no element in found in the child's contents of the specified type, no summary is generated.

Remove HTML from summary

if the summary element contains other html elements – for instance, horizontal rules, images, tables, bold, etc. - these may disrupt the layout of the Aggregator list. Turning this option on will force Aggregator to remove all html markup from the summary element, leaving only plain text to be displayed.

Aggregator Layout

Number of lines per page

Specifies the maximum number of lines your Aggregator list should have per page. The maximum number of items you entire list will have per page will be: lines per page x items per line.

Number of items per line

Specifies the maximum number of items per line your aggregator list should have. The maximum number of items you entire list will have per page will be: lines per page x items per line.

Apply this class to all list items

You may enter the name – without the leading “.” (dot) – of a css class style that will be applied to every item in the list. Applying a css class style to the items makes it easier for you to customise the appearance of your Aggregator list – by specifying appropriate styles in your template's stylesheet

Assign this id to this aggregator

You may enter a unique id that will be given to the Aggregator list. Assigning an id to the Aggregator may help you target and style different Aggregators in your stylesheet.

Show pages browser at top/bottom

If your aggregator list will need more than one page, you can display a 'pages browser', to allow visitors to navigate between the pages in the list. The pages browser can be displayed either at the top of the list, at the bottom, or at both ends. If your aggregator list will only ever have 1 page, you may wish to hide the pages browser, by turning both options off.