Merge branch '0.5'

MANIFEST.in

@@ -9,4 +9,6 @@ recursive-include docs *.html *.css *.js *.png *.gif
 
 recursive-include supertagging *.py
 recursive-include supertagging/sql/ *.sql
-recursive-include supertagging/templates/ *.html
+recursive-include supertagging/templates/ *.html
+
+prune example

doc_src/Makefile

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
+SPHINXOPTS    = -a
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build

doc_src/getting_started.rst

@@ -5,61 +5,116 @@ Getting Started
 
 If you have not installed SuperTagging yet, go to the :ref:`installation` page.
 
+Create basic settings
+*********************
+
+In your ``settings.py`` file:
+
+.. code-block:: python
+	
+	SUPERTAGGING_SETTINGS = {
+	    'ENABLED': True,
+	    'DEBUG': True,
+	}
+
+
 Setting up OpenCalais API
 *************************
 
 Go to `OpenCalais <http://www.opencalais.com/>`_'s website and register for 
-an api key, and in your settings.py file::
+an api key, and in your ``settings.py`` file, alter ``SUPERTAGGING_SETTINGS``\ :
 
-    SUPERTAGGING_CALAIS_API_KEY = "YOUR API KEY"
+.. code-block:: python
+	
+	SUPERTAGGING_SETTINGS = {
+	    'ENABLED': True,
+	    'DEBUG': True,
+	    'OPEN_CALAIS': {
+	        'API_KEY': 'YOUR_API_KEY',
+	    }
+	}
 
 
 Setting up models to be tagged
 ******************************
 
 You will need to decide which models and which fields in those models you 
-will want SuperTagging to mark for tagging.
+will want SuperTagging to mark for tagging:
 
 .. code-block:: python
 
-    SUPERTAGGING_MODULES = {
-        'stories.story': 
-            {'fields':[
-                    {'name': 'body'},
-                ],
-            },
-        }
+	SUPERTAGGING_SETTINGS = {
+	    'ENABLED': True,
+	    'DEBUG': True,
+	    'OPEN_CALAIS': {
+	        'API_KEY': 'YOUR_API_KEY',
+	    },
+	    'WATCHED_FIELDS': {
+	        'stories.story': {
+	            'fields':[
+	                {'name': 'body'},
+	            ],
+	        },
+	    },
+	}
+
         
 The code above tells SuperTagging to tag the **body** field of model 
 **stories.story**. We can specify any number of fields and models as well.
 
 .. code-block:: python
 
-    SUPERTAGGING_MODULES = {
-        'stories.story': 
-            {'fields':[
-                    {'name': 'body'},
-                    {'name': 'tease'},
-                    {'name': 'kicker'},
-                ],
-            },
-        'media.image':
-            {'fields':[
-                    {'name': 'caption'},
-                    {'name': 'description'},
-                ],
-            }
-        }
-        
-View :ref:`setting_modules` for more information.        
-
+	SUPERTAGGING_SETTINGS = {
+	    'ENABLED': True,
+	    'DEBUG': True,
+	    'OPEN_CALAIS': {
+	        'API_KEY': 'YOUR_API_KEY',
+	    },
+	    'WATCHED_FIELDS': {
+	        'stories.story': {
+	            'fields':[
+	                    {'name': 'body'},
+	                    {'name': 'tease'},
+	                    {'name': 'kicker'},
+	            ],
+	        },
+	        'media.image': {
+	            'fields':[
+	                    {'name': 'caption'},
+	                    {'name': 'description'},
+	            ],
+	        }
+	    },
+	}
+
+
+View :ref:`setting_modules` for more information.
+
+Set up automatic processing
+***************************
+
+Finally, add:
 
 .. code-block:: python
 
-    SUPERTAGGING_AUTO_PROCESS = True
-    
+	SUPERTAGGING_SETTINGS = {
+	    'ENABLED': True,
+	    'DEBUG': True,
+	    'OPEN_CALAIS': {
+	        'API_KEY': 'YOUR_API_KEY',
+	    },
+	    'WATCHED_FIELDS': {
+	        'stories.story': {
+	            'fields':[
+	                {'name': 'body'},
+	            ],
+	        },
+	    },
+	    'AUTO_PROCESS': True,
+	}
+
 Post save and post delete signals will be connected to the models 
-specified in `SUPERTAGGING_MODULES`. Visit :ref:`reference_settings` to 
+specified in `WATCHED_FIELDS`. Visit :ref:`reference_settings` to 
 view more details about the SuperTagging settings
 
 View the complete list of :ref:`reference_settings`

doc_src/installation.rst

@@ -8,10 +8,12 @@ Download SuperTagging
 
 There are a couple ways for you to get Django-SuperTagging,
 
-    1. Clone the git repository `from here <http://opensource.washingtontimes.com/projects/supertagging/>`_
-    2. Download the latest build from our opensource site `here <http://opensource.washingtontimes.com/pypi/simple/supertagging/>`_
-    3. Use PIP to install from our opensource site pypi 
-        * pip install --extra-index-url=http://opensource.washingtontimes.com/pypi/simple/ supertagging
+    1. Clone the git repository `from GitHub <https://github.com/callowayproject/django-supertagging>`_
+    2. Use pip to install it from `PyPI <http://pypi.python.org/pypi/supertagging>`_
+
+::
+
+	pip install supertagging
 
 
 Dependencies

doc_src/markup.rst

@@ -14,33 +14,48 @@ In the settings you will need to have
 
 .. code-block:: python
 
-    SUPERTAGGING_MARKUP = True
+	SUPERTAGGING_SETTINGS = {
     
+	    # ... Other settings
+    
+	    'MARKUP': {
+	        'ENABLED': True,
+	    }
+	}
+
 How It Works
 ************
 
 When SuperTagging loads up and markup is enabled, it will add an additional 
-attribute for every field specified in :ref:`setting_modules`.
+attribute for every field specified in :ref:`setting_modules`\ .
 
 .. code-block:: python
 
+	SUPERTAGGING_SETTINGS = {
+	    'ENABLED': True,
+	    'WATCHED_FIELDS': {
+	        'stories.story': 
+	            {'fields':[
+	                {'name': 'body',
+	                 'markup_handler': 'MyCustomHandler'}]},
+	        'media.image':
+	            {'fields':[
+	                {'name': 'caption'}]},
+	        'blog.entry':
+	            {'fields':[
+	                {'name': 'content'},
+	                {'name': 'tease',
+	                 'markup': False}]}
+	    },
+	    
+	    # ... Other settings
+	    
+	    'MARKUP': {
+	        'ENABLED': True,
+	        'FIELD_SUFFIX': "tagged",
+	    },
+	}
 
-    SUPERTAGGING_MARKUP = True
-    MARKUP_FIELD_SUFFIX = "tagged"
-    SUPERTAGGING_MODULES = {
-       'stories.story': 
-            {'fields':[
-                {'name': 'body',
-                 'markup_handler': 'MyCustomHandler'}]},
-        'media.image':
-            {'fields':[
-                {'name': 'caption'}]},
-        'blog.entry':
-            {'fields':[
-                {'name': 'content'},
-                {'name': 'tease',
-                 'markup': False}]}
-    }
 
 Lets take the code sample above as an example. We notice that markup is 
 enabled and the prefix for the markup fields is `tagged`. The first module 
@@ -53,14 +68,11 @@ tagging, **content** and **tease**, but tease is not to be marked up.
 After `SuperTagging` is done loading you will end up with three additional
 attributes for the three different models.
 
-* **story model**
-    * tagged_body
-* **image model**
-    * tagged_caption
-* **entry**
-    * tagged_content
-
-Notice that the a 'tagged_tease' does not exist for the **entry** model.
+* **Story model:** ``body__tagged``
+* **Image model:** ``caption__tagged``
+* **Entry model:** ``content__tagged``
+
+Notice that the a ``tease__tagged`` does not exist for the **Entry** model because the markup flag for that field is ``False``\ .
 
 Markup handler
 **************
@@ -81,10 +93,9 @@ You can create your own custom handler as well.
             # DO YOUR CUSTOM MARKUP HERE
             return "MARKED UP CONTENT"
             
-The `handle` method needs to return a string of the marked up content.
+The ``handle`` method needs to return a string of the marked up content.
 
-If you want a create a custom handler but use the default markup method, your code
-might look something like this:
+If you want a create a custom handler but use the default markup method, your code might look something like this:
 
 .. code-block:: python