raptus.article.table 2.0b7

Provides a table component for articles

Introduction

You have a site where you have a lot of tables to be displayed and styled, then this package is for you. It provides a generic way to create tables in articles.

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

Content

• Provides a table content type for raptus.article

Components

• raptus.article.table.right

• raptus.article.table.left

• raptus.article.table.full

Dependencies

• archetypes.schemaextender

• raptus.article.core

Installation

To install raptus.article.table 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.table 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.table on a separate line, like this:

eggs =
    Plone
    raptus.article.table

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.table either by adding it to the zcml list in your buildout or by including it in another package’s configure.zcml.

Usage

Add table

You may now add tables in your article. Click the “Add new” menu and select “Table” in the pull down menu. You get the standard plone form to add your table.

Configure your table

Tables consist of a fixed column definition which may be set either per table or globally in the table configlet. Every table needs either a global definition or a local one to work.

Components

Navigate to the “Components” tab of your article, select one of the table components and press “save and view”. Note that at least one table has to be contained in the article in which this component is active.

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

Components

plone.abovecontentbody

• raptus.article.table.right

• raptus.article.table.left

plone.belowcontentbody

• raptus.article.table.full

Interfaces

file: interfaces.py

• ITables (Provider for tables contained in an article)

  • getTables - method (Returns a list of tables (catalog brains))

• IRows (Provider for rows contained in a table)

  • getRows - method (Returns a list of rows (catalog brains))

• IDefinitions (Handles table definitions)

  • getDefinition - method (Returns the definition)

  • getAvailableDefinitions - method (Returns a dict of definitions available for this article)

  • addDefinition - method (Adds a new global definition)

  • removeDefinition - method (Removes a global definition)

• IDefinition (Definition provider for tables)

  • getCurrentDefinition - method (Returns the definition for this article)

• ITable (Marker interface for the table content type)

• IRow (Marker interface for the row content type)

• IType (A column type)

  • structure - method (Whether the value has to be rendered as structure or not)

  • modifier - method (Returns the modified value)

  • field - method (Returns the ExtensionField to be used in the SchemaExtender)

Changelog

2.0b7 (2011-08-25)

• Added info message to column configuration popup and fixed bug where multiple save button appeared

• Added string normalization for column name to prevent exceptions when using non ascii characters

• Replaced text field for defining the table style by a drop down fed by a property in portal properties

• Improved descriptions of style and columns field in table content type to illustrate the override mechanism if a table definition is selected

2.0b6 (2011-08-05)

• Fixed TableColumnsField (KeyError when saving columns)

2.0b5 (2011-08-05)

• Improved configlet and added table columns widget for table content type

• Added image and file types

• Added possibility to define cell and heading classes per column

• Added possibility to define a colspan for columns

2.0b4 (2010-11-10)

• Added French translations

• Updated German translations

2.0b3 (2010-10-21)

• Updated readme and manual

2.0b2 (2010-10-20)

• First public release