From 9e3e41f946a3b518f4af78f3d97c5dd7d56bf04a Mon Sep 17 00:00:00 2001
From: Ismael Carnales <icarnales@gmail.com>
Date: Thu, 9 Jul 2009 11:29:04 -0300
Subject: [PATCH] added more newitem documentation in proposed

---
 docs/proposed/index.rst          |  1 +
 docs/proposed/newitem-fields.rst | 72 +++++++++++++++++++++++++++
 docs/proposed/newitem.rst        | 84 +++++++++++++++++++++++---------
 3 files changed, 135 insertions(+), 22 deletions(-)
 create mode 100644 docs/proposed/newitem-fields.rst

diff --git a/docs/proposed/index.rst b/docs/proposed/index.rst
index 1f06e8170..45b1041c4 100644
--- a/docs/proposed/index.rst
+++ b/docs/proposed/index.rst
@@ -16,6 +16,7 @@ also contain outdated information, as it's not revised so frequently.
    :maxdepth: 1
 
    newitem
+   newitem-fields
    spiders
 
 
diff --git a/docs/proposed/newitem-fields.rst b/docs/proposed/newitem-fields.rst
new file mode 100644
index 000000000..c96f93758
--- /dev/null
+++ b/docs/proposed/newitem-fields.rst
@@ -0,0 +1,72 @@
+.. _ref-newitem-fields:
+
+====================
+Item Field Reference
+====================
+
+.. module:: scrapy.contrib_exp.newitem.fields
+
+Field options
+=============
+
+``default``
+-----------
+
+.. attribute:: Field.default
+
+The default value for the field.
+
+
+Field types
+===========
+
+``BooleanField``
+----------------
+
+.. class:: BooleanField
+
+A true/false field.
+
+``DateField``
+-------------
+
+.. class:: DateField
+
+A date, represented in Python by a ``datetime.date`` instance.
+
+``DateTimeField``
+-----------------
+
+.. class:: DateTimeField
+
+A date with time, represented in Python by a ``datetime.datetime`` instance.
+
+``DecimalField``
+---------------
+
+.. class:: DecimalField
+
+A fixed-precision decimal number, represented in Python by a :class:`~decimal.Decimal` instance.
+
+``FloatField``
+--------------
+
+.. class:: FloatField
+
+A floating-point number represented in Python by a ``float`` instance.
+
+``IntegerField``
+----------------
+
+.. class:: IntegerField
+
+An integer.
+
+``StringField``
+---------------
+
+A text field.
+
+.. class:: StringField
+
+
diff --git a/docs/proposed/newitem.rst b/docs/proposed/newitem.rst
index 5a6f3adc5..0812d033a 100644
--- a/docs/proposed/newitem.rst
+++ b/docs/proposed/newitem.rst
@@ -1,39 +1,79 @@
+.. _topic-items:
+
 =====
 Items
 =====
 
-The goal of the scraping process is to obtain Items (aka Scraped Items) from
-scraped pages.
+The goal of the scraping process is to obtain scraped items from scraped pages.
 
-Scrapy represent this using a model with fields for Items, much like you'll do
-in an ORM.
+ScrapedItem
+===========
 
-Let's see an example::
+.. class:: scrapy.item.ScrapedItem
+
+In Scrapy the items are represented by a :class:`scrapy.item.ScrapedItem`
+(almost an empty class) or any subclass of it.
+
+To use :class:`scrapy.item.ScrapedItem` you simply instantiate it and use
+instance attributes to store the information.
+
+   >>> from scrapy.item import ScrapedItem
+   >>> item = ScrapedItem()
+   >>> item.headline = 'Headline'
+   >>> item.content = 'Content'
+   >>> item.published = '2009-07-08'
+   >>> item
+   ScrapedItem({'headline': 'Headline', 'content': 'Content', 'published': '2009-07-08'})
+
+Or you can use your own class to represent items, just be sure it inherits from
+:class:`scrapy.item.ScrapedItem`.
+
+.. _topic-newitem:
+
+More advanced items
+===================
+
+.. class:: scrapy.contrib_exp.newitem.Item(ScrapedItem)
+
+Scrapy provides :class:`scrapy.contrib_exp.newitem.Item` (a subclass of
+:class:`scrapy.item.ScrapedItem`) that works like a form with fields to store
+the item's data.
+
+To use this items you first define the item's fields as class attributes::
+
+   from scrapy.contrib_exp.newitem import Item
+   from scrapy.contrib_exp.newitem import fields
 
    class NewsItem(Item):
-       url = StringField()
-       headline = StringField()
-       summary = StringField()
-       content = StringField()
-       published = DateField()
+       headline = fields.StringField()
+       content = fields.StringField()
+       published = fields.DateField()
+
+And then you instantiate the item and assign values to its fields, which will be
+converted to the expected Python types depending of their class::
+
+   >>> item = NewsItem()
+   >>> item.headline = 'Headline'
+   >>> item.content = 'Content'
+   >>> item.published = '2009-07-08'
+   >>> item
+   NewsItem({'headline': 'Headline', 'content': 'Content', 'published': datetime.date(2009, 7, 8)})
+
+Each field accepts a ``default`` argument, that sets the default value of the field.
+
+You can see the built-in field types in the :ref:`ref-newitem-fields`.
 
 Using this may seen complicated at first, but gives you much power over scraped
 data, like assigning defaults for fields that are not present in some pages,
-performing validation, etc.
+:ref:`topic-newitem-adaptors`, etc.
 
-To use Items you instantiate them and then assign values to their attributes,
-they will be converted to the expected Python types depending of the field
-kind::
+.. _topic-newitem-adaptors:
 
-   ni = NewsItem()
-   ni.url = 'http://www.news.com/news/1'
-   ni.summary = 'Summary'
-   ni.content = 'Content'
-   ni.published = '2009-02-28'
+=============
+Item Adaptors
+=============
 
-============
-ItemAdaptors
-============
+.. class:: scrapy.contrib_exp.newitem.adaptors.ItemAdaptor
 
 As you probably want to scrape the same kind of Items from many sources
 (different websites, RSS feeds, etc.), Scrapy implements ItemAdaptors, they