Skip to content

Commit

Permalink
fixed package distribution
Browse files Browse the repository at this point in the history
  • Loading branch information
hvelarde committed May 21, 2012
1 parent cdc8809 commit aa9d273
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 64 deletions.
4 changes: 3 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
include README.rst
include *.txt

recursive-include src *
recursive-include docs *

global-exclude *pyc
60 changes: 0 additions & 60 deletions README.rst

This file was deleted.

1 change: 1 addition & 0 deletions README.rst
60 changes: 60 additions & 0 deletions README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
===============
collective.nitf
===============

.. contents:: Table of Contents

Overview
--------

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.

Requirements
------------

* Plone >= 4.1
* Dexterity_ >= 1.2.1

Usage
-----
TBD

Helper views
^^^^^^^^^^^^

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

Validating
^^^^^^^^^^

You can validate the output of the @@nitf and @@newsml 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.

.. _Dexterity: http://pypi.python.org/pypi/plone.app.dexterity
.. _IPTC: http://www.iptc.org/
.. _NewsCodes: http://www.iptc.org/NewsCodes/
.. _NewsML: http://www.newsml.org/
.. _NITF: http://www.nitf.org/
.. _`NITF Document Type Definition`: http://www.iptc.org/std/NITF/3.5/specification/nitf-3-5.dtd
.. _`XHTML Ruby Module`: http://www.iptc.org/std/NITF/3.5/specification/xhtml-ruby-1.mod
.. _`XML validation`: http://www.xmlvalidation.com/

4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[distutils]
index-servers =
pypi
ploneorg
pypi
ploneorg
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import os

version = '1.0dev'
long_description = open("README.rst").read() + "\n" + \
long_description = open("README.txt").read() + "\n" + \
open(os.path.join("docs", "INSTALL.txt")).read() + "\n" + \
open(os.path.join("docs", "CREDITS.txt")).read() + "\n" + \
open(os.path.join("docs", "HISTORY.txt")).read()
Expand Down

0 comments on commit aa9d273

Please sign in to comment.