Metadata-Version: 1.1
Name: qhonuskan-votes
Version: 0.1.4
Summary: Easy to use reddit like voting system for django models.
Home-page: https://github.com/miratcan/qhonuskan-votes
Author: Mirat Can Bayrak
Author-email: miratcanbayrak@gmail.com
License: GPL
Description: ===============
        Qhonuskan-Votes
        ===============
        
        Easy to use reddit like voting system for django models.
        
        Features
        --------
        
        *  Does not use GenericForeignKeys (which irritates me when making queries)
           Has vote_buttons_for templatetag, that generates html code for your object
           for vote buttons.
        
        *  Has, default_buttons.css which gives a shape your buttons as default, but
           you can override.
        
        *  Has, voting_script template tag, it generates javascript code to make
           ajax requests for voting. Automatically finds qhonuskan_votes views.
        
        *  voting_script tag also renders overridable show_not_authenticated_error
           function, so you can use your own error windows (jquery-ui etc.) via
           overriding it.
        
        *  Default buttons are pure css, there is no images. So it's lite.
        
        Quick Implementation Guide
        --------------------------
        
        1. Add qhonuskan_votes to your INSTALLED_APPS.
        
           ::
        
             INSTALLED_APPS = ('...',
                               '...',
                               'qhonuskan_votes')
        
        
        2. Add **VotesField**, and add **ObjectsWithScoresManager** to your model.
        
           ::
        
             from django.db import models
             from qhonuskan_votes.models import VotesField
              
             class MyModel(models.Model):
                 votes = VotesField()
                 objects_with_scores = ObjectsWithScoresManager()
                 ...
                 ...
        
        3. Syncdb.
        4. Extend your urls [#]_. 
           ::
        
             import qhonuskan_votes.urls
             from django.conf.urls.defaults import *
        
             urlpatterns = patterns('',
               ...
               ...
               url(r'^votes/', include(qhonuskan_votes.urls)),
             )
        
        5. Load qhonuskan_votes templatetags from your template. You will need STATIC_PREFIX too.
        
           ::
        
             {% load qhonuskan_votes static %}
             {% get_static_prefix as STATIC_PREFIX %}
        
        
        6. Load default_buttons.css to give little shape to buttons
        
           ::
        
             <link href="{{STATIC_PREFIX}}default_buttons.css" rel="stylesheet" type="text/css" />
        
        7. After that line, if you wish you can override some properties
        
           ::
        
             <style type="text/css">
               div.vote_buttons {
                 width: 40px;
                 margin-right: 5px;
                 float: left;
                 border: 1px solid #666;
               }
             </style>
        
        8. Load jquery to your template
        
           ::
        
             <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js"></script>
        
        9. After all, you can add voting_script template tag to your head section.
           It generates necessary javascript code for ajax requests.
        
           ::
        
             {% voting_script %}
        
        10. use vote_buttons_for_object template tag to create buttons.
        
            ::
        
              {% for object in objects %}
                <div class="object">
                  {% vote_buttons_for object %}
                    <div class="text">
                      {{ object.text }}
                    </div>
                </div>
              {% endfor %}
        
        For further information you can inspect example project at root of the repository.
        
        FootNotes
        ~~~~~~~~~~
        .. [#] To use the views for up voting and down voting you include the urls.py in your
               website's url patterns. You can serve qhonuskan_votes views wherever you
               want. Javascript files updates automatically to find qhonuskan_votes views.
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Operating System :: OS Independent
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Requires: django(>=1.2)
