Skip to content

Commit

Permalink
prepare 0.5.5; make sure action field exists; captcha, recaptcha and …
Browse files Browse the repository at this point in the history
…honeypot plugins are now by default required in the form; minor fixes
  • Loading branch information
barseghyanartur committed Jun 30, 2015
1 parent a49ec3a commit 20cd6cf
Show file tree
Hide file tree
Showing 24 changed files with 355 additions and 165 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,9 @@ fobi/fobi.migrations.rst
/examples/quickstart/
/dev.db

/examples/requirements_wagtail.txt
/examples/wagtail_example/
/scripts/install_django_1_7_wagtail.sh
/scripts/reinstall_django_1_7_wagtail.sh
/src/fobi/contrib/apps/wagtail_integration/
/src/fobi/contrib/plugins/form_elements/fields/select_mptt_model_object/
11 changes: 11 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,17 @@ are used for versioning (schema follows below):
0.3.4 to 0.4).
- All backwards incompatible changes are mentioned in this document.

0.5.5
-----
2015-06-30

- Change the `action` field of the FormEntry into a URL field; check if
action exists.
- `captcha`, `recaptcha` and `honeypot` plugins have been made required
in the form.
- Fix: take default values provided in the `plugin_data_fields` of the plugin
form into consideration.

0.5.4
-----
2015-05-21
Expand Down
33 changes: 21 additions & 12 deletions QUICK_START.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
===============================================
===========
Quick start
===============================================
===========
Tutorial for very quick start with ``django-fobi``. Consists of
several parts listed below::

- Part 1: Standard Django installation
- Part 2: Integration with DjangoCMS (coming soon)

Part 1: standard Django installation
===============================================
====================================
Example project code available `here
<https://github.com/barseghyanartur/django-fobi/tree/master/examples/quick_start>`_.

Installation and configuration
-----------------------------------------------
------------------------------
Install the package in your environment.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
pip install django-fobi
INSTALLED_APPS
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^
Add ``fobi`` core and the plugins to the ``INSTALLED_APPS`` of the your
`settings` module.

Expand Down Expand Up @@ -100,6 +100,15 @@ Putting all together, you would have something like this.
.. code-block:: python
INSTALLED_APPS = (
# Used by fobi
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
'django.contrib.messages',
'django.contrib.staticfiles',
'django.contrib.admin',
# ...
# Core
'fobi',
Expand Down Expand Up @@ -150,7 +159,7 @@ Putting all together, you would have something like this.
)
TEMPLATE_CONTEXT_PROCESSORS
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Add ``django.core.context_processors.request`` and
``fobi.context_processors.theme`` to ``TEMPLATE_CONTEXT_PROCESSORS`` of
your `settings` module.
Expand All @@ -165,7 +174,7 @@ your `settings` module.
)
urlpatterns
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^
Add the following line to ``urlpatterns`` of your `urls` module.

.. code-block:: python
Expand All @@ -188,7 +197,7 @@ Add the following line to ``urlpatterns`` of your `urls` module.
)
Update the database
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^
1. First you should be syncing/migrating the database. Depending on your
Django version and migration app, this step may vary. Typically as follows:

Expand All @@ -205,15 +214,15 @@ Update the database
$ ./manage.py fobi_sync_plugins
Specify the active theme
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^
Specify the default theme in your `settings` module.

.. code-block:: python
FOBI_DEFAULT_THEME = 'bootstrap3'
Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^
``fobi`` has been built with permissions in mind. Every single form element
plugin or handler is permission based. If user hasn't been given permission
to work with a form element or a form handler plugin, he won't be. If you want
Expand Down Expand Up @@ -244,5 +253,5 @@ Also, make sure to have the Django model permissions set for following models:
<https://github.com/barseghyanartur/django-fobi/blob/stable/src/fobi/contrib/plugins/form_handlers/db_store/models.py#L52>`_

Part 2: Integration with DjangoCMS
===============================================
==================================
Coming soon...

0 comments on commit 20cd6cf

Please sign in to comment.