A Dexterity-based content type inspired on the News Industry Text Format specification
Python RobotFramework CSS JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
src/collective
.coveragerc
.csslintrc
.gitignore
.travis.yml
CHANGES.rst
CONTRIBUTORS.rst
MANIFEST.in
README.rst
bootstrap.py
buildout.cfg
setup.cfg
setup.py

README.rst

collective.nitf

Life, the Universe, and Everything

News articles in Plone are instances of the 'News Item' content type: they can contain a title, a description, a body text, an image and some basic metadata. If you publish a couple of items from time to time, this is fine.

But suppose you have to publish dozens of items everyday... How do you tell your readers who they are about? What do they cover? Where do they took place? And, more important, how do you classify them? How do you organize them? How do you tell your readers which ones are newsworthy?

To solve these, and other issues, the IPTC developed XML standards to define the content and structure of news articles. NITF, NewsML and NewsCodes are among these standards and they support the classification, identification and description of a huge number of news articles characteristics.

NITF is intended to structure independent news articles and this package aims to implement a content type inspired by the specification.

Mostly Harmless

Got an idea? Found a bug? Let us know by opening a support ticket.

Don't Panic

Installation

To enable this product in a buildout-based installation:

  1. Edit your buildout.cfg and add collective.nitf to the list of eggs to install:

    [buildout]
    ...
    eggs =
        collective.nitf
    

After updating the configuration you need to run ''bin/buildout'', which will take care of updating your system.

Go to the 'Site Setup' page in a Plone site and click on the 'Add-ons' link.

Check the box next to collective.nitf and click the 'Activate' button.

Note

You may have to empty your browser cache and save your resource registries in order to see the effects of the product installation.

Behaviors

This package includes a behavior called collective.nitf.behaviors.interfaces.ISection. By applying it to a Dexterity-based content type you will get a new field called section.

Helper views

All news articles provide @@nitf and @@newsml views that are available although are not registered.

You can validate the output of the those views using services like XML validation.

You may use the NITF Document Type Definition version 3.5 and the XHTML Ruby Module associated with it.

Internals

collective.nitf uses Cycle2 slideshow plugin for jQuery and it can load its resources from the Plone JS registry if they are present there.

If you're using collective.nitf with other packages that use Cycle2 also (like sc.photogallery or covertile.cycle2), it is highly recommended that you register those resources to load them once and avoid conflicts.

You can use a jsregistry.xml file that includes the following:

<javascript id="++resource++collective.js.cycle2/jquery.cycle2.min.js"
    cacheable="True" compression="none" cookable="True" enabled="True" />
<javascript id="++resource++collective.js.cycle2/jquery.cycle2.carousel.min.js"
    cacheable="True" compression="none" cookable="True" enabled="True" />
<javascript id="++resource++collective.js.cycle2/jquery.cycle2.swipe.min.js"
    cacheable="True" compression="none" cookable="True" enabled="True" />