Changes between Version 1 and Version 2 of AJAXForeignKey

Timestamp:

May 20, 2007, 3:56:52 PM (18 years ago)

Author:

Michael Axiak <axiak@…>

Comment:

Michael Axiak

AJAXForeignKey

@@ -14 +14 @@
 1. Create a new folder in your project called {{{ajaxfkey }}}
 
-2. Create three files in that directory:
+2. Put four files in that directory:
 
   * {{{__init__.py}}} -- duh
   * {{{fields.py}}} -- contains the actual model field. (download)
   * {{{forms.py}}}  -- contains the form field. (download)
+  * {{{views.py}}}  -- contains the AJAX view. (download)
+
 3. Create a {{{base_site.html}}} file in your {{{base_templates/admin}}} directory.
 
-4. Modify your models to use it correctly.
+4. Modify your {{{urls conf}}} to contain the ajax view.
 
-=== {{{ base_templates/admin/base_site.html }}} ===
+5. Modify your models to use it correctly.
+
+=== Creating {{{ base_templates/admin/base_site.html }}} ===
+
+Put the contents below in the file, but be wary of where yui is on your setup.
 
 {{{
@@ -48 +54 @@
 }}}
 
-Notice how YUI is in {{{"/media/scripts/yui"}}} and I downloaded [http://www.json.org/json.js json.js]
+Notice how YUI is in {{{"/media/scripts/yui"}}} and I downloaded [http://www.json.org/json.js json.js].
+
+=== Modify {{{urls.py}}} ===
+
+Put the following in your urls configuration:
+{{{
+#!python
+(r'^admin/ajax_autocomplete/?', 'project.ajaxfkey.views.ajax_autocomplete'),
+}}}
+
+Change {{{project.ajaxfkey}}} to the path to the views file you created.
+
+=== Using it in your models ===
+
+Below is an example usage in some models:
+
+{{{
+#!python
+from django.db import models
+from ajaxfkey.fields import AjaxForeignKey
+
+# notice the manager, we can create a staticmethod in Poll if we wanted.
+class PollManager(models.Manager):
+    def ajax_autocomplete(self, data):
+        return self.filter(question__istartswith = data).order_by('question')
+
+class Poll(models.Model):
+    question = models.CharField(maxlength=200)
+    pub_date = models.DateTimeField('date published')
+
+class Choice(models.Model):
+    # notice it's the same syntax as models.ForeignKey
+    poll = AjaxForeignKey(Poll)
+    choice = models.CharField(maxlength=200)
+    votes = models.IntegerField()
+}}}