raptus.article.reference 2.0b6

Provides support for internal or external references on nested articles.

Introduction

You have a site where you would like to list some internal or external references but you are not able to present them in a nice way. With raptus.article.reference you can do it.

The following features for raptus.article are provided by this package:

Fields

• Provides support for internal or external references on nested articles

Dependencies

• archetypes.schemaextender

• raptus.article.nesting

Installation

To install raptus.article.reference into your Plone instance, locate the file buildout.cfg in the root of your Plone instance directory on the file system, and open it in a text editor.

Add the actual raptus.article.reference add-on to the “eggs” section of buildout.cfg. Look for the section that looks like this:

eggs =
    Plone

This section might have additional lines if you have other add-ons already installed. Just add the raptus.article.reference on a separate line, like this:

eggs =
    Plone
    raptus.article.reference

Note that you have to run buildout like this:

$ bin/buildout

Then go to the “Add-ons” control panel in Plone as an administrator, and install or reinstall the “raptus.article.default” product.

Note that if you do not use the raptus.article.default package you have to include the zcml of raptus.article.reference either by adding it to the zcml list in your buildout or by including it in another package’s configure.zcml.

Usage

Edit an article which is contained in another. You will now have the new options “Internal reference” and “External reference” in your tab “settings”. Add your reference press “save”. The link on the specific article displayed by the components listing sub articles now refers to the specified reference. The following packages provide components respecting the reference setting:

• raptus.article.listings

• raptus.article.contentfader

• raptus.article.contentflow

• raptus.article.randomcontent

Copyright and credits

raptus.article is copyrighted by Raptus AG and licensed under the GPL. See LICENSE.txt for details.

Developer Manual

Note: You find a developer manual for raptus.article at raptus.article.core. Please have look there if you need more information.

Code overview

Interfaces

file: interfaces.py

• IReference (Provider for internal and external references on an article)

  • getReferenceURL - method (Returns the URL or path of the reference)

  • getReference - method (Returns the referenced object, if available)

Schema extender

file: extender.py

• ArticleExtender - for IArticle

Changelog

2.0b6 (2010-11-10)

• Added French translations

2.0b5 (2010-10-24)

• Set zip_safe flag to False

2.0b4 (2010-10-21)

• Updated readme and manual

2.0b3 (2010-10-20)

• First public release