[pirate-politics] r578 committed - Created wiki page through web user interface.

[pirate-...@googlecode.com]

Revision: 578
Author: fragro
Date: Wed Feb 9 03:25:09 2011
Log: Created wiki page through web user interface.
http://code.google.com/p/pirate-politics/source/detail?r=578

Added:
/wiki/pp_get_argument_list.wiki

=======================================
--- /dev/null
+++ /wiki/pp_get_argument_list.wiki Wed Feb 9 03:25:09 2011
@@ -0,0 +1,38 @@
+#summary To load this tag include {% load argumenttags %} at the top of
the html file.
+#sidebar TableOfContents
+
+= Custom Tag: `pp_get_argument_list` =
+====_Module: pirate_reputation_====
+
+This template tag populates the namespace `pp_argumentation` with a list
of arguments, generally specified by their parent object. Arguments are
generic, so they can be attached to any object through the ContentType
fields. See
[http://docs.djangoproject.com/en/dev/ref/contrib/contenttypes/](http://docs.djangoproject.com/en/dev/ref/contrib/contenttypes/)
+
+==_Arguments and Parameters_==
+
+ * object: the object which the arguments are being gathered for
+ * arg_type: The str value of the arg_type
+ * start: start of slicing for pagination
+ * end: end of slicing for pagination
+
+==_Return value_==
+
+Returns a list containing arguments pertaining to the object specified in
the argument list.
+
+ * `pp_argumentation.argument_list`: A list of Argument objects, with the
following accessible fields.
+ * name = models.CharField(max_length=64)
+ * pub_date = models.DateTimeField()
+ * user = models.ForeignKey(User, related_name='arg_author')
+ * text = models.TextField(max_length=1200)
+
+==_Usage Notes_==
+ * *Assumptions*: None
+
+ * *Errors*: None
+
+==_Examples_==
+====Basic form====
+The following code will display the reputation integer.
+{{{
+ {% pp_get_argument_list object=solution start=0 end=20
arg_type="Nay" %}
+ {{ pp_argumentation.argument_list }}
+ {% endpp_get_argument_list %}
+}}}