From 7aabb2deefc9f55e3b479dd4a346f0b528c30c11 Mon Sep 17 00:00:00 2001 From: Daniel Greenfeld Date: Sat, 12 Sep 2009 16:48:32 -0700 Subject: [PATCH] Various documentation fixes --- README | 18 ++++++++++++------ README.rst | 18 ++++++++++++------ docs/index.txt | 25 +++++++++++++++---------- docs/install.txt | 22 ++++++++++++++++------ docs/usage.txt | 28 +++------------------------- 5 files changed, 58 insertions(+), 53 deletions(-) diff --git a/README b/README index 133d39b..8004558 100644 --- a/README +++ b/README @@ -12,12 +12,18 @@ format. Installing django-uni-form ============================ -1. Install as uni_form in your Django apps directory. -2. Copy the site_media files in uni_form to your project site_media directory. - uni-form-generic.css - uni-form.css - uni-form.jquery.js -3. Add 'uni_form' to INSTALLED_APPS in settings.py. + +#. Install as uni_form in your Django apps directory. + +#. Copy the site_media files in uni_form to your project site_media directory. + + * uni-form-generic.css + + * uni-form.css + + * uni-form.jquery.js + +#. Add 'uni_form' to INSTALLED_APPS in settings.py. Using the django-uni-form filter (Easy and fun!) diff --git a/README.rst b/README.rst index 133d39b..8004558 100644 --- a/README.rst +++ b/README.rst @@ -12,12 +12,18 @@ format. Installing django-uni-form ============================ -1. Install as uni_form in your Django apps directory. -2. Copy the site_media files in uni_form to your project site_media directory. - uni-form-generic.css - uni-form.css - uni-form.jquery.js -3. Add 'uni_form' to INSTALLED_APPS in settings.py. + +#. Install as uni_form in your Django apps directory. + +#. Copy the site_media files in uni_form to your project site_media directory. + + * uni-form-generic.css + + * uni-form.css + + * uni-form.jquery.js + +#. Add 'uni_form' to INSTALLED_APPS in settings.py. Using the django-uni-form filter (Easy and fun!) diff --git a/docs/index.txt b/docs/index.txt index 7894052..c10731f 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -1,12 +1,17 @@ -############### -django-uni-form -############### +===================================== +django-uni-form (Django Uni-Form) +===================================== + +Django_ forms are easily rendered as tables, +paragraphs, and unordered lists. However, elegantly rendered div based forms +is something you have to do by hand. The purpose of this application is to +provide a simple tag and/or filter that lets you quickly render forms in a div +format. + +`Uni-form`_ has been selected as the base model for the design of the forms. Django-uni-form lets you easily display Django forms as divs. - -Contents: - -.. toctree:: - - install.txt - usage.txt \ No newline at end of file + + +.. _Django: http://djangoproject.com +.. _`Uni-form`: http://sprawsm.com/uni-form \ No newline at end of file diff --git a/docs/install.txt b/docs/install.txt index 6ceab11..e65b0b8 100644 --- a/docs/install.txt +++ b/docs/install.txt @@ -1,8 +1,18 @@ Installing django-uni-form ============================ -1. Install as uni_form in your Django apps directory. -2. Copy the site_media files in uni_form to your project site_media directory. - uni-form-generic.css - uni-form.css - uni-form.jquery.js -3. Add 'uni_form' to INSTALLED_APPS in settings.py. + +#. Install as uni_form in your Django apps directory. + +#. Copy the site_media files in uni_form to your project site_media directory. + + * uni-form-generic.css + + * uni-form.css + + * uni-form.jquery.js + +#. Add 'uni_form' to INSTALLED_APPS in settings.py. + + +.. _Django: http://djangoproject.com +.. _`Uni-form`: http://sprawsm.com/uni-form \ No newline at end of file diff --git a/docs/usage.txt b/docs/usage.txt index 133d39b..4e5a183 100644 --- a/docs/usage.txt +++ b/docs/usage.txt @@ -1,24 +1,6 @@ -===================================== -django-uni-form (Django Uni-Form) -===================================== - -Django_ forms are easily rendered as tables, -paragraphs, and unordered lists. However, elegantly rendered div based forms -is something you have to do by hand. The purpose of this application is to -provide a simple tag and/or filter that lets you quickly render forms in a div -format. - -`Uni-form`_ has been selected as the base model for the design of the forms. - -Installing django-uni-form -============================ -1. Install as uni_form in your Django apps directory. -2. Copy the site_media files in uni_form to your project site_media directory. - uni-form-generic.css - uni-form.css - uni-form.jquery.js -3. Add 'uni_form' to INSTALLED_APPS in settings.py. - +=========================== +Ways to use Django-uni-form +=========================== Using the django-uni-form filter (Easy and fun!) ================================================= @@ -192,7 +174,3 @@ Then, just like in the previous example, add the following to your template:: This allows you to group fields in fieldsets, or rows or columns or add HTML between fields etc. - - -.. _Django: http://djangoproject.com -.. _`Uni-form`: http://sprawsm.com/uni-form \ No newline at end of file