Package: collective.nitf
Table of ContentsLife, the Universe, and EverythingMostly HarmlessDon’t PanicInstallationUpgrading from 1.x to 2.xBehaviorsHelper viewsDevelopmentShare and EnjoyChangelog2.1.1 (2021-04-15)2.1.0 (2020-12-23)2.1b4 (2017-10-18)2.1b3 (2017-07-05)2.1b2 (2017-06-12)2.1b1 (2017-02-16)2.0b4 (2016-11-03)2.0b3 (2016-09-12)2.0b2 (2016-07-27)2.0b1 (2016-02-29)2.0a1 (2015-09-30)Life, the Universe, and EverythingNews 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, theIPTCdeveloped XML standards to
define the content and structure of news articles.NITF,NewsMLandNewsCodesare 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 HarmlessGot an idea? Found a bug? Let us know byopening a support ticket.Don’t PanicInstallationTo enable this product in a buildout-based installation:Edit your buildout.cfg and addcollective.nitfto the list of eggs to install:[buildout]
...
eggs =
    collective.nitfAfter 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 tocollective.nitfand click the ‘Activate’ button.Upgrading from 1.x to 2.xWarningUpgrades to version 2.x are only supported from latest version of branch 1.x.You have to be aware of the following changes when migrating from version 1.x to 2.x:Package is no longer compatible with Plone 4.2Latest Sectionable NITF portlet was disabled and will be completely removed in version 3.0;
you should remove all Latest Sectionable NITF portlets from your site before upgradingPackage no longer depends on GrokPackage no longer depends oncollective.z3cform.widgets;
you should uninstall that dependency manually if there is no other package depending on it on your sitePackage no longer depends onplone.app.referenceablebehavior;
theIReferenceablebehavior included there is no longer assigned by defaultThe character counter is no longer availableWe useSwiperas the framework for the slideshow view.The following views are available for a News Article:view,slideshow_viewandtext_only_viewView templates were completely refactored and support for semantic markup was added;
the default view displays a bigger imageThe following behaviors are assigned by default to the News Article content type:plone.app.relationfield.behavior.IRelatedItemsandcollective.nitf.behaviors.interfaces.ISectionA new permissioncollective.nitf: Setupis available to access the control panel configlet and is assigned by default toManagerandSite AdministratorrolesStatic resources are now namednitf.cssandnitf.js(easier to debug at the browser)An upgrade step is available to remove old resources, rename the views, and reindex all News Articles to reflect changes.
The upgrade step will not remove theplone.app.referenceablebehavior.referenceable.IReferenceablebehavior if applied.BehaviorsThis package includes a behavior calledcollective.nitf.behaviors.interfaces.ISection.
By applying it to a Dexterity-based content type you will get a new field calledsection.Helper viewsAll 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 likeXML validation.You may use theNITF Document Type Definitionversion 3.5 and theXHTML Ruby Moduleassociated with it.DevelopmentWe use Webpack to process static resources on this package.
Webpack processes LESS and JS files, minifies the resulting CSS and JS, and optimizes all images.
The final JS file is also a UMD package, which provides compatibility with most popular script loaders.To contribute, you should start the instance in one shell and start Webpack watcher on another with the following command:$bin/npm_watchThen go towebpack/appfolder and edit LESS and JS files;
Webpack watcher will automatically create the final resources in the right place.There are also other commands added to handle more complex scenarios.
The following command will set the buildout node installation in the system PATH, this way you can use Webpack as described on Webpack docs.$bin/webpack_envThe following command generates JS and CSS without the minify step (it can be used to check the code being generated in a human readable way).$bin/npm_devThe following command rebuilds static files and exit (insted of keep watching the changes):$bin/npm_buildShare and Enjoycollective.nitfwould not have been possible without the contribution of
the following people:Cleber J. SantosFranco PellegriniGonzalo AlmeidaHéctor VelardeJoaquín RosalesJuan A. DíazJuan Pablo GiménezMarcos F. RomeroSilvestre HuensÉrico AndreiRodrigo Ferreira de SouzaWolfgang Beyer (Mandelbrot image setused in tests)You can find an updated list of package contributors onGitHub.Development sponsored by Open Multimedia.ChangelogThere’s a frood who really knows where his towel is.2.1.1 (2021-04-15)Add a transaction note for upgradeStep v2003, available atUndotab in/in the ZMI, to make review easier after running since it can modify thousands of objects. (complements#232).
[idgserpro]2.1.0 (2020-12-23)WarningThis version disables usage of Latest Sectionable NITF portlet.
Remove manually all Latest Sectionable NITF portlets before upgrading.
This version removes tile registration/removal;
you must depend on plone.app.tiles >= 3.0.0 to avoid issues withcollective.nitftile.Remove SearchableText from metadata of catalog (fix#232).
[idgserpro]Fix rendering plone.belowcontenttitle.contents when adding a Link or a File inside a nitf content and plone.app.contenttypes is installed (fix#228)
[idgserpro]Fix AttributeError: query when running upgradeStep 1008 (fix#226)
[idgserpro]Fix error when creating Plone Site, when collective.nitf is available (fix#233).
[idgserpro]Remove dependency on Cycle2;
If you don’t have other package depending on collective.js.cycle2 you are safe to uninstall it (closes#200).
[rodfersou]Remove needless tile registration/removal when using plone.app.tiles >= 3.0.0.
[hvelarde]Manage deprecation of CMFQuickInstallerTool on Plone >= 5.1;
[hvelarde]Better handling of package uninstall.
[hvelarde]Fix package dependencies.
[hvelarde]Small code refactor to increase future Python 3 compatibility;
add dependency onsix.
[hvelarde]Latest Sectionable NITF portlet was disabled and will be completely removed in version 3.0.
[hvelarde]2.1b4 (2017-10-18)SearchableTextindex for News Article content type now includes object keywords (fixesbrasil.gov.portal#155).
[hvelarde]2.1b3 (2017-07-05)Add NITF tile for collective.cover when upgrading to 2.x (closes#205).
[idgserpro]Removerelatable_content_typesregistry record when upgrading to 2.x (closes#208).
[idgserpro]2.1b2 (2017-06-12)Do not create a link toNoneon the tile.
[hvelarde]Fix upgrade process between versions 1.x and 2.x;
check documentation on migration for more information (closes#198).
[rodfersou, hvelarde]2.1b1 (2017-02-16)Handle corner case when upgrade step for 1008 found a collection with no query defined.
[hvelarde]Simplify slideshow template to avoid depending on context id;
this solves an issue when id ends with “.html”.
[rodfersou]Refactor static resources.
[rodfersou]Add classes to HTML elements on tile for easy visual customization.
[agnogueira]Remove dependency on plone.directives.form and latest traces of Grok.
[hvelarde]Fix exception getting image size withImageScalingadapter (refs.sc.social.like #87).
[rodfersou]2.0b4 (2016-11-03)Do not try to create scales on news article with no lead image;
this was causing issues in some Collection view methods and in collective.cover’s Collection tile (fixes#178).
[hvelarde]2.0b3 (2016-09-12)Fix issue in NITF tile that was causing an exception when dropping content into it (fixes#175).
[rodfersou]2.0b2 (2016-07-27)ThegetImage()andimageCaption()methods of theNITFclass are deprecated and will be removed on next release;
useimage()andmedia_caption()instead.
[hvelarde]Fix issue withcollective.nitf.imageviewlet raisingAttributeErrorwhen plone.app.contenttypes is installed (closes#169).
[hvelarde]Use<p>tag to display the News Article subtitle to avoid warnings on validation.
[hvelarde]Fix exception when syndicalize NITF (closes#161).
[rodfersou]Fix tile date format.
[hvelarde]Avoid rising exceptions when content referenced in tile is not available (fixes#154).
[hvelarde, rodfersou]Remove hard dependency on plone.app.referenceablebehavior as Archetypes is no longer the default framework in Plone 5.
Under Plone < 5.0 you should now explicitly add it to theeggspart of your buildout configuration to avoid issues while upgrading.
[hvelarde]2.0b1 (2016-02-29)Show title of news article asaltattribute on tile’s image.
[hvelarde]Fix upgrade step to work with both, Archetypes and Dexterity-based collections.
[rodfersou]2.0a1 (2015-09-30)WarningUpgrades are supported only from release 1.0b3.Make control panel configlet accesible to Site Administrator role (closes#137).
[hvelarde]Load Cycle2 resources from the JS registry if available (closes#133).
[hvelarde]Fix display of byline and refactor override ofdocumentbylineviewlet;
avoid performance issues when having many users by memoizing expensive call to Membership tool (fixes#128).
[hvelarde, rodfersou]Replace slideshow framework machinery;
we useCycle2now instead ofGalleria.
Don’t forget do uninstall and remove collective.js.galleria if you no longer depend on it on your site (closes#116).
[rodfersou, hvelarde]Fix default values for genre and urgency fields (closes#118).
[rodfersou]Add NITF tile for collective.cover (closes#123).
[hvelarde]Reimplement section field as a behavior (closes#98).
[hvelarde]Drop support of Plone 4.2.
[hvelarde]Remove dependency on collective.z3cform.widgets.
Don’t forget do uninstall and remove the package if you no longer depend on it on your site.
[hvelarde]Update package i18n and Spanish and Brazilian Portuguese translations.
[hvelarde]Restore default binding on Link content type at uninstall time.
[hvelarde]AddCurrentas default value for available_genres andGeneralas
default value for available_sections.
[hvelarde]Character counter code was removed from package; this should be
reimplemented using collective.js.charcount (closes#75).
[hvelarde]Package was cleaned by removing some dependencies,
deprecated methods on default view,
unused macros from templates,
and needless resources, scripts and styles.
[marcosfromero, hvelarde]Remove all javascript from templates, create new nitf.js and use
jsregistry (closes#94). [marcosfromero]Add confirmation overlay before removing an image in media.pt
(closes#85). [marcosfromero]Add required script library in media.pt to prevent image not loading
when editing in overlay (closes#84). [marcosfromero]Fields were reordered to enhance user experience on adding/editing content:
‘location’ field is now above ‘body text’ and ‘urgency’ is below ‘genre’.
[hvelarde]Reimplementkeywordsanddocumentbylineviewlets with semantic markup and
support for news article byline for INITF interface.
[jpgimenez, hvelarde, cleberjsantos]Refactor templates to implement semantic markup to annotate news-specific
metadata using rNews, schema.org and RDFa (closes#47).
[jpgimenez, marcosfromero, hvelarde]Add plone.app.relationfield as a dependency; this is needed for Dexterity
to proper handle relations (closes#71). [jpgimenez]Remove five.grok dependency, will easy the mainteinance and the
extendibility of the package. [jpgimenez]Changes image link behavior in view.pt for mobile devices
(closes#62). [marcosfromero]