Dependencies
============

Required Products
------------------

* Plone 2.0.5 or more
* Archetypes >= 1.3.3
* ATContentTypes >= 0.2.0

  
Additional requirements for further functionality
--------------------------------------------------

* AttachmentField >= 1.3
* PloneExFile >= 3.2
* ImageTag_CorePatch >= 0.3 for generating proper thumbnails (http://www.zope.org/Members/bowerymarc/ImageTag_CorePatch)

You need to have both AttachmentField AND PloneExFile to use file indexing and file preview.

Installation
============
  
Installing ATContentTypes
-------------------------

* Unpack it into your Zope Products Folder
* Restart
* Transform CMF content with  switchCMF2ATCT (Set ATCT as default content types)
  
Installing PloneArticle
-----------------------
    
* Unpack it into your Zope Products Folder
* Restart Zope
* Use Plone Setup -> Plone Configuration -> Add/Remove Products
  to install PloneArticle. You can also use the portal_quickinstaller
  in the ZMI.
* Now you can add a Plone Article through the Plone Interface.

Migration
---------
  
We provide a migration script for PloneArticle 2.05 (or -) under plone 2.
  
* Install PloneArticle
*  In ZMI, go in portal_article
*  In Migrate Tab 
  
  *  Image type: Image
  *  Attachment type: File 
  
Image type defines the content type that will be used to transform old article images.
Attachment type is the content type that will be used to transform old article attachments.
  
When migrating you have 3 choices :

1- Create external images. Check it if you want to create external images.
All images in the old article are transfomed into the Image content type.
    
2- Create external attachments. Check it if you want to create external attachments.
All images in the old article are transfomed into the File content type.
    
3- Dry run, do not really migrate, it is a simulation of migration, 
so you can check the log if all is ok.

Overview
========

  PloneArticle : A Plone Document that can incorporate images and attachments
  and that allows you to choose from different layout models.

  Behaves mostly like the standard Plone Document type. When you add a Plone
  Article, you can enter the name, title, description and text information.

  When you look at the Plone Article, the images will appear in the right
  column as a thumbnail and optionally with their title. When you click on
  the thumbnail, a popup window will appear with the image at its actual size.
  Attachments will be listed below the article for download in rows of three.

  You will notice two tabs that don't exist on the standard Plone Document:
  images and attachments.

    The Images Tab:

      This interface shows the Images that you have uploaded to the article, and
      allows you to add new images as well as deleting them. Images can have an
      optional title. The position of images as they will appear in the right
      column of the Plone Article View can be changed with up and down arrows
      that allow you to individually move images up or down one step.
    
      Thanks to the ImageTag hotfix, Images are shown as a thumbnail on all
      pages, and only when you click on them, a popup window will appear with
      the original size of the image.
    
    Attachments Tab:
    
      This interface shows the Attachments that you have uploaded to the article,
      and allows you to add new attachments as well as deleting them. If no title
      is given, the name of the uploaded file is taken in its place. 

    Links Tab:
    
      This interface shows the Links that you have added to the article,
      and allows you to add new links as well as deleting them.

    The Models Tab:

      Here you can choose from the stock layout models that come with PloneArticle,
      and also the models that you have created somewhere in the skins path.

Additional tools
----------------

  Articles summary

    A Page Template called 'plonearticle_summary' is provided as an example to have a
    brief summary of the five most recent published articles in a website, along
    with their first image if available.

  Article tool

    An article tool (portal_article) is installed by the installer. It provides a
    few configuration options so that you can customize PloneArticle's behaviour.

  Lock support

    An optional lock support can be enabled in the article tool. If enabled, any
    authorized user (ie. having edit permission) must LOCK an article to edit it.
    Only the user who locked the article, the Reviewer and the Manager can UNLOCK
    an article. A locked article cannot be edited but apart from this you can
    do anything you want on it.


Performance issues
------------------

  PloneArticle has been tuned so 
  that caching is efficient.

  Thumbnail tags

    Thumbnail tags displayed in an article can be cached by a RAMCacheManager,
    for the plonearticle_get_thumb_tag() PythonScript with 'image_id' as variable parameter.

    
Addition for new content types developers
-----------------------------------------
 
  There is an external method to unindex content types contained in PloneArticle. 
  This external method is called : unindex_plonearticle_contents
  You can find this script in Extensions/toolbox.py
  
