improve README documentation: add INSTALLED_APPS, load tag, explain inline forms, and complete form examples for vertical and horizontal forms

This commit is contained in:
Joshua Tauberer 2014-05-14 16:06:48 -04:00
parent 5dce970179
commit 210f4cd114
1 changed files with 31 additions and 3 deletions

View File

@ -26,11 +26,39 @@ A simple Django template tag to work with `Bootstrap <http://twitter.github.com/
Usage
======
Use it like this, simple.
Add "bootstrapform" to your INSTALLED_APPS.
.. code-block::
At the top of your template load in our template tags::
{{ form|bootstrap }}
{% load bootstrap %}
Then to render your form::
<form role="form">
<legend>Form Title</legend>
{% csrf_token %}
{{ form|bootstrap }}
<div class="form-group">
<button type="submit" class="btn btn-primary">Submit</button>
</div>
</form>
You can also set class="form-vertical" on the form element.
To use class="form-inline" on the form element, also change the "|boostrap" template tag to "|bootstrap_inline".
It is also possible to create a horizontal form. The form class and template tag are both changed, and you will also need slightly different CSS around the submit button::
<form class="form-horizontal">
<legend>Form Title</legend>
{% csrf_token %}
{{ form|bootstrap_horizontal }}
<div class="form-group">
<div class="col-sm-10 col-sm-offset-2">
<button type="submit" class="btn btn-primary">Submit</button>
</div>
</div>
</form>
Demo