diff --git a/src/fobi/contrib/plugins/form_elements/README.rst b/src/fobi/contrib/plugins/form_elements/README.rst new file mode 100644 index 00000000..20718236 --- /dev/null +++ b/src/fobi/contrib/plugins/form_elements/README.rst @@ -0,0 +1,2 @@ +Form elements +============= diff --git a/src/fobi/contrib/plugins/form_elements/fields/input/README.rst b/src/fobi/contrib/plugins/form_elements/fields/input/README.rst index 5c0dc0bc..be178543 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/input/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/input/README.rst @@ -1,5 +1,5 @@ fobi.contrib.plugins.form_elements.fields.input -=============================================== +----------------------------------------------- A generic input form field plugin. Makes use of the ``django.forms.fields.Field`` and ``django.forms.widgets.Input``. Comes with a lot of options you likely won't use every day. @@ -23,23 +23,23 @@ See `w3schools.com `_ for further explanations. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.input`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.input`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.input', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.input', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_elements/fields/integer/README.rst b/src/fobi/contrib/plugins/form_elements/fields/integer/README.rst index f04bd88c..06c68f8a 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/integer/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/integer/README.rst @@ -1,28 +1,28 @@ fobi.contrib.plugins.form_elements.fields.integer -================================================= +------------------------------------------------- A ``Fobi`` Integer form field plugin. Makes use of the ``django.forms.fields.IntegerField`` and ``django.forms.widgets.NumberInput`` (falling back to ``django.forms.widgets.TextInput`` for older Django versions). Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.integer`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.integer`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.integer', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.integer', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_elements/fields/ip_address/README.rst b/src/fobi/contrib/plugins/form_elements/fields/ip_address/README.rst index bb14c485..225ded7f 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/ip_address/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/ip_address/README.rst @@ -1,27 +1,27 @@ fobi.contrib.plugins.form_elements.fields.ip_address -==================================================== +---------------------------------------------------- A ``Fobi`` Text form field plugin. Makes use of the ``django.forms.fields.GenericIPAddressField`` and ``django.forms.widgets.TextInput``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.ip_address`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.ip_address`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.ip_address', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.ip_address', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_elements/fields/null_boolean/README.rst b/src/fobi/contrib/plugins/form_elements/fields/null_boolean/README.rst index 7d3621fd..c82cba49 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/null_boolean/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/null_boolean/README.rst @@ -1,27 +1,27 @@ fobi.contrib.plugins.form_elements.fields.null_boolean -====================================================== +------------------------------------------------------ A ``Fobi`` NullBoolean form field plugin. Makes use of the ``django.forms.fields.NullBooleanField`` and ``django.forms.widgets.NullBooleanSelect``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.null_boolean`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.null_boolean`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.null_boolean', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.null_boolean', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_elements/fields/password/README.rst b/src/fobi/contrib/plugins/form_elements/fields/password/README.rst index 1087164f..59f20436 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/password/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/password/README.rst @@ -1,26 +1,26 @@ fobi.contrib.plugins.form_elements.fields.password -================================================== +-------------------------------------------------- A ``Fobi`` Password form field plugin. Makes use of the ``django.forms.fields.CharField`` and ``django.forms.widgets.PasswordInput``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.password`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.password`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.password', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.password', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_elements/fields/radio/README.rst b/src/fobi/contrib/plugins/form_elements/fields/radio/README.rst index 1a2c9d51..ea66aa6d 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/radio/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/radio/README.rst @@ -1,55 +1,55 @@ fobi.contrib.plugins.form_elements.fields.radio -=============================================== +----------------------------------------------- A ``Fobi`` Radio form field plugin. Makes use of the ``django.forms.fields.ChoiceField`` and ``django.forms.widgets.RadioSelect``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.radio`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.radio`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.radio', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.radio', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. -4. By default, the submitted form value of `radio` - elements is label (human readable representation of the value chosen). - However, that part of the behaviour has been made configurable. You can - choose between the following options: +(4) By default, the submitted form value of `radio` + elements is label (human readable representation of the value chosen). + However, that part of the behaviour has been made configurable. You can + choose between the following options: - Consider the following list of (value, label) choices (the first element in - the tuple is value, the second element is label): + Consider the following list of (value, label) choices (the first element in + the tuple is value, the second element is label): - .. code-block:: python + .. code-block:: python - [ - ('alpha', 'Alpha'), - ('beta', 'Beta'), - ('gamma', 'Gamma'), - ] + [ + ('alpha', 'Alpha'), + ('beta', 'Beta'), + ('gamma', 'Gamma'), + ] - .. code-block:: text + .. code-block:: text - - "val": `value` (example: "alpha"). - - "repr" (default): `label` (example: "Alpha"). - - "mix": `value (label)` (example: "Alpha (alpha)"). + - "val": `value` (example: "alpha"). + - "repr" (default): `label` (example: "Alpha"). + - "mix": `value (label)` (example: "Alpha (alpha)"). - Simply set the - ``FOBI_FORM_ELEMENT_RADIO_SUBMIT_VALUE_AS`` assign one of the following - values: "val", "repr" or "mix" to get the desired behaviour. + Simply set the + ``FOBI_FORM_ELEMENT_RADIO_SUBMIT_VALUE_AS`` assign one of the following + values: "val", "repr" or "mix" to get the desired behaviour. Usage ----- diff --git a/src/fobi/contrib/plugins/form_elements/fields/range_select/README.rst b/src/fobi/contrib/plugins/form_elements/fields/range_select/README.rst index 93f02334..55ee041a 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/range_select/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/range_select/README.rst @@ -1,50 +1,50 @@ fobi.contrib.plugins.form_elements.fields.range_select -====================================================== +------------------------------------------------------ A ``Fobi`` RangeSelect form field plugin. Makes use of the ``django.forms.fields.ChoiceField`` and ``django.forms.widgets.Select``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.range_select`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.range_select`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.range_select', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.range_select', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. -4. Ranges are specified within the given min/max values. The default values - are: +(4) Ranges are specified within the given min/max values. The default values + are: -.. code-block:: text + .. code-block:: text - - INITIAL: 50 - - INITIAL_MAX_VALUE: 100 - - INITIAL_MIN_VALUE: 0 - - MIN_VALUE: 0 - - MAX_VALUE: 100 - - STEP: 1 + - INITIAL: 50 + - INITIAL_MAX_VALUE: 100 + - INITIAL_MIN_VALUE: 0 + - MIN_VALUE: 0 + - MAX_VALUE: 100 + - STEP: 1 - However, you can override each of them in the settings of your project by - prefixing correspondent names with `FOBI_FORM_ELEMENT_RANGE_SELECT_`: + However, you can override each of them in the settings of your project by + prefixing correspondent names with `FOBI_FORM_ELEMENT_RANGE_SELECT_`: -.. code-block:: text + .. code-block:: text - - FOBI_FORM_ELEMENT_RANGE_SELECT_INITIAL - - FOBI_FORM_ELEMENT_RANGE_SELECT_INITIAL_MAX_VALUE - - FOBI_FORM_ELEMENT_RANGE_SELECT_INITIAL_MIN_VALUE - - FOBI_FORM_ELEMENT_RANGE_SELECT_MIN_VALUE - - FOBI_FORM_ELEMENT_RANGE_SELECT_MAX_VALUE - - FOBI_FORM_ELEMENT_RANGE_SELECT_STEP + - FOBI_FORM_ELEMENT_RANGE_SELECT_INITIAL + - FOBI_FORM_ELEMENT_RANGE_SELECT_INITIAL_MAX_VALUE + - FOBI_FORM_ELEMENT_RANGE_SELECT_INITIAL_MIN_VALUE + - FOBI_FORM_ELEMENT_RANGE_SELECT_MIN_VALUE + - FOBI_FORM_ELEMENT_RANGE_SELECT_MAX_VALUE + - FOBI_FORM_ELEMENT_RANGE_SELECT_STEP diff --git a/src/fobi/contrib/plugins/form_elements/fields/regex/README.rst b/src/fobi/contrib/plugins/form_elements/fields/regex/README.rst index 710f0d80..baa2bbfc 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/regex/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/regex/README.rst @@ -1,26 +1,26 @@ fobi.contrib.plugins.form_elements.fields.regex -=============================================== +----------------------------------------------- A ``Fobi`` Text form field plugin. Makes use of the ``django.forms.fields.RegexField`` and ``django.forms.widgets.TextInput``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.regex`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.regex`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.regex', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.regex', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_elements/fields/select/README.rst b/src/fobi/contrib/plugins/form_elements/fields/select/README.rst index 41ae6810..4f3fdbcd 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/select/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/select/README.rst @@ -1,58 +1,58 @@ fobi.contrib.plugins.form_elements.fields.select -================================================ +------------------------------------------------ A ``Fobi`` Select form field plugin. Makes use of the ``django.forms.fields.ChoiceField`` and ``django.forms.widgets.Select``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.select`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.select`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.select', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.select', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. -4. By default, the submitted form value of `select` - elements is label (human readable representation of the value chosen). - However, that part of the behaviour has been made configurable. You can - choose between the following options: +(4) By default, the submitted form value of `select` + elements is label (human readable representation of the value chosen). + However, that part of the behaviour has been made configurable. You can + choose between the following options: - Consider the following list of (value, label) choices (the first element in - the tuple is value, the second element is label): + Consider the following list of (value, label) choices (the first element in + the tuple is value, the second element is label): - .. code-block:: python + .. code-block:: python - [ - ('alpha', 'Alpha'), - ('beta', 'Beta'), - ('gamma', 'Gamma'), - ] + [ + ('alpha', 'Alpha'), + ('beta', 'Beta'), + ('gamma', 'Gamma'), + ] - .. code-block:: text + .. code-block:: text - - "val": `value` (example: "alpha"). - - "repr" (default): `label` (example: "Alpha"). - - "mix": `value (label)` (example: "Alpha (alpha)"). + - "val": `value` (example: "alpha"). + - "repr" (default): `label` (example: "Alpha"). + - "mix": `value (label)` (example: "Alpha (alpha)"). - Simply set the - ``FOBI_FORM_ELEMENT_SELECT_SUBMIT_VALUE_AS`` assign one of the following - values: "val", "repr" or "mix" to get the desired behaviour. + Simply set the + ``FOBI_FORM_ELEMENT_SELECT_SUBMIT_VALUE_AS`` assign one of the following + values: "val", "repr" or "mix" to get the desired behaviour. Usage ------ +~~~~~ You should be entering a single choice per line. Choice might consist of just a single value or value/label pair. diff --git a/src/fobi/contrib/plugins/form_elements/fields/select_model_object/README.rst b/src/fobi/contrib/plugins/form_elements/fields/select_model_object/README.rst index 4ad20141..18db75d0 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/select_model_object/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/select_model_object/README.rst @@ -1,52 +1,52 @@ fobi.contrib.plugins.form_elements.fields.select_model_object -============================================================= +------------------------------------------------------------- A ``Fobi`` Select Model Object form field plugin. Makes use of the ``django.forms.models.ModelChoiceField`` and ``django.forms.widgets.Select``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.select_model_object`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.select_model_object`` to + the ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.select_model_object', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.select_model_object', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. -4. Make sure to take a look at - ``fobi.contrib.plugins.form_elements.fields.select_model_object.defaults.IGNORED_MODELS``. - If necessary, override it in your `settings` as shown in the example below: +(4) Make sure to take a look at + ``fobi.contrib.plugins.form_elements.fields.select_model_object.defaults.IGNORED_MODELS``. + If necessary, override it in your `settings` as shown in the example below: -.. code-block:: python + .. code-block:: python - FOBI_FORM_ELEMENT_SELECT_MODEL_OBJECT_IGNORED_MODELS = [ - 'auth.User', - 'auth.Group', - ] + FOBI_FORM_ELEMENT_SELECT_MODEL_OBJECT_IGNORED_MODELS = [ + 'auth.User', + 'auth.Group', + ] -5. By default, the submitted form value of `select_model_object` elements is - `app_label.model_name.object_pk.object_repr`. However, that part of the - behaviour has been made configurable. You can choose between the following - options: +(5) By default, the submitted form value of `select_model_object` elements is + `app_label.model_name.object_pk.object_repr`. However, that part of the + behaviour has been made configurable. You can choose between the following + options: - .. code-block:: text + .. code-block:: text - - "val": `app_label.model_name.object_pk.object_repr`. - - "repr": `object_repr` (uses the ``__unicode__`` method of the model). - - "mix" (default): `app_label.model_name.object_pk.object_repr`. + - "val": `app_label.model_name.object_pk.object_repr`. + - "repr": `object_repr` (uses the ``__unicode__`` method of the model). + - "mix" (default): `app_label.model_name.object_pk.object_repr`. - Simply set the ``FOBI_FORM_ELEMENT_SELECT_MODEL_OBJECT_SUBMIT_VALUE_AS`` - assign one of the following values: "val", "repr" or "mix" to get the - desired behaviour. + Simply set the ``FOBI_FORM_ELEMENT_SELECT_MODEL_OBJECT_SUBMIT_VALUE_AS`` + assign one of the following values: "val", "repr" or "mix" to get the + desired behaviour. diff --git a/src/fobi/contrib/plugins/form_elements/fields/select_mptt_model_object/README.rst b/src/fobi/contrib/plugins/form_elements/fields/select_mptt_model_object/README.rst index 705673d4..8807f621 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/select_mptt_model_object/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/select_mptt_model_object/README.rst @@ -1,12 +1,12 @@ fobi.contrib.plugins.form_elements.fields.select_mptt_model_object -================================================================== +------------------------------------------------------------------ A ``Fobi`` Select MPTT Model Object form field plugin. Makes use of the ``mptt.fields.TreeNodeChoiceField`` and ``django.forms.widgets.Select``. Installation ------------- +~~~~~~~~~~~~ Install `django-mptt` -~~~~~~~~~~~~~~~~~~~~~ +##################### Taken from django-mptt `Getting started `_. @@ -19,51 +19,51 @@ Taken from django-mptt `Getting started 2. Add ``mptt`` to the ``INSTALLED_APPS`` in your ``settings.py``. Install `select_mptt_model_object` plugin -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1. Add ``mptt`` and - ``fobi.contrib.plugins.form_elements.fields.select_mptt_model_object`` - to the ``INSTALLED_APPS`` in your ``settings.py``. +######################################### +(1) Add ``mptt`` and + ``fobi.contrib.plugins.form_elements.fields.select_mptt_model_object`` + to the ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'mptt', - 'fobi.contrib.plugins.form_elements.fields.select_mptt_model_object', - # ... - ) + INSTALLED_APPS = ( + # ... + 'mptt', + 'fobi.contrib.plugins.form_elements.fields.select_mptt_model_object', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. -4. Make sure to take a look at - ``fobi.contrib.plugins.form_elements.fields.select_mptt_model_object.defaults.IGNORED_MODELS``. - If necessary, override it in your `settings` as shown in the example below: +(4) Make sure to take a look at + ``fobi.contrib.plugins.form_elements.fields.select_mptt_model_object.defaults.IGNORED_MODELS``. + If necessary, override it in your `settings` as shown in the example below: - .. code-block:: python + .. code-block:: python - FOBI_FORM_ELEMENT_SELECT_MPTT_MODEL_OBJECT_IGNORED_MODELS = [ - 'auth.User', - 'auth.Group', - ] + FOBI_FORM_ELEMENT_SELECT_MPTT_MODEL_OBJECT_IGNORED_MODELS = [ + 'auth.User', + 'auth.Group', + ] -5. By default, the submitted form value of `select_mptt_model_object` elements - is `app_label.model_name.object_pk.object_repr`. However, that part of the - behaviour has been made configurable. You can choose between the following - options: +(5) By default, the submitted form value of `select_mptt_model_object` elements + is `app_label.model_name.object_pk.object_repr`. However, that part of the + behaviour has been made configurable. You can choose between the following + options: - .. code-block:: text + .. code-block:: text - - "val": `app_label.model_name.object_pk.object_repr`. - - "repr": `object_repr` (uses the ``__unicode__`` method of the model). - - "mix" (default): `app_label.model_name.object_pk.object_repr`. + - "val": `app_label.model_name.object_pk.object_repr`. + - "repr": `object_repr` (uses the ``__unicode__`` method of the model). + - "mix" (default): `app_label.model_name.object_pk.object_repr`. - Simply set the ``FOBI_FORM_ELEMENT_SELECT_MPTT_MODEL_OBJECT_SUBMIT_VALUE_AS`` - assign one of the following values: "val", "repr" or "mix" to get the - desired behaviour. + Simply set the ``FOBI_FORM_ELEMENT_SELECT_MPTT_MODEL_OBJECT_SUBMIT_VALUE_AS`` + assign one of the following values: "val", "repr" or "mix" to get the + desired behaviour. diff --git a/src/fobi/contrib/plugins/form_elements/fields/select_multiple/README.rst b/src/fobi/contrib/plugins/form_elements/fields/select_multiple/README.rst index 149aaea8..22c2c54e 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/select_multiple/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/select_multiple/README.rst @@ -1,59 +1,59 @@ fobi.contrib.plugins.form_elements.fields.select_multiple -========================================================= +--------------------------------------------------------- A ``Fobi`` Select Multiple form field plugin. Makes use of the ``django.forms.fields.MultipleChoiceField`` and ``django.forms.widgets.SelectMultiple``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.select_multiple`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.select_multiple`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.select_multiple', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.select_multiple', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. -4. By default, the submitted form value of `select_multiple` - elements is label (human readable representation of the value chosen). - However, that part of the behaviour has been made configurable. You can - choose between the following options: +(4) By default, the submitted form value of `select_multiple` + elements is label (human readable representation of the value chosen). + However, that part of the behaviour has been made configurable. You can + choose between the following options: - Consider the following list of (value, label) choices (the first element in - the tuple is value, the second element is label): + Consider the following list of (value, label) choices (the first element in + the tuple is value, the second element is label): - .. code-block:: python + .. code-block:: python - [ - ('alpha', 'Alpha'), - ('beta', 'Beta'), - ('gamma', 'Gamma'), - ] + [ + ('alpha', 'Alpha'), + ('beta', 'Beta'), + ('gamma', 'Gamma'), + ] - .. code-block:: text + .. code-block:: text - - "val": `value` (example: "alpha"). - - "repr" (default): `label` (example: "Alpha"). - - "mix": `value (label)` (example: "Alpha (alpha)"). + - "val": `value` (example: "alpha"). + - "repr" (default): `label` (example: "Alpha"). + - "mix": `value (label)` (example: "Alpha (alpha)"). - Simply set the - ``FOBI_FORM_ELEMENT_SELECT_MULTIPLE_SUBMIT_VALUE_AS`` assign one of the - following values: "val", "repr" or "mix" to get the desired behaviour. + Simply set the + ``FOBI_FORM_ELEMENT_SELECT_MULTIPLE_SUBMIT_VALUE_AS`` assign one of the + following values: "val", "repr" or "mix" to get the desired behaviour. Usage ------ +~~~~~ You should be entering a single choice per line. Choice might consist of just a single value or value/label pair. diff --git a/src/fobi/contrib/plugins/form_elements/fields/select_multiple_model_objects/README.rst b/src/fobi/contrib/plugins/form_elements/fields/select_multiple_model_objects/README.rst index 0ce0b654..b3f090f8 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/select_multiple_model_objects/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/select_multiple_model_objects/README.rst @@ -1,55 +1,55 @@ fobi.contrib.plugins.form_elements.fields.select_multiple_model_objects -======================================================================= +----------------------------------------------------------------------- A ``Fobi`` Select Multiple Model Objects form field plugin. Makes use of the ``django.forms.models.ModelMultipleChoiceField`` and ``django.forms.widgets.SelectMultiple``. Installation ------------- -1. Add - ``fobi.contrib.plugins.form_elements.fields.select_multiple_model_objects`` - to the ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add + ``fobi.contrib.plugins.form_elements.fields.select_multiple_model_objects`` + to the ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.select_multiple_model_objects', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.select_multiple_model_objects', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. -4. Make sure to take a look at - ``fobi.contrib.plugins.form_elements.fields.select_multiple_model_objects.defaults.IGNORED_MODELS``. - If necessary, override it in your `settings` as shown in the example below: +(4) Make sure to take a look at + ``fobi.contrib.plugins.form_elements.fields.select_multiple_model_objects.defaults.IGNORED_MODELS``. + If necessary, override it in your `settings` as shown in the example below: - .. code-block:: python + .. code-block:: python - FOBI_FORM_ELEMENT_SELECT_MULTIPLE_MODEL_OBJECTS_IGNORED_MODELS = [ - 'auth.User', - 'auth.Group', - ] + FOBI_FORM_ELEMENT_SELECT_MULTIPLE_MODEL_OBJECTS_IGNORED_MODELS = [ + 'auth.User', + 'auth.Group', + ] -5. By default, the submitted form value of `select_multiple_model_objects` - elements is `app_label.model_name.object_pk.object_repr`. However, that part - of the behaviour has been made configurable. You can choose between the - following options: +(5) By default, the submitted form value of `select_multiple_model_objects` + elements is `app_label.model_name.object_pk.object_repr`. However, that + part of the behaviour has been made configurable. You can choose between + the following options: - .. code-block:: text + .. code-block:: text - - "val": `app_label.model_name.object_pk.object_repr`. - - "repr": `object_repr` (uses the ``__unicode__`` method of the model). - - "mix" (default): `app_label.model_name.object_pk.object_repr`. + - "val": `app_label.model_name.object_pk.object_repr`. + - "repr": `object_repr` (uses the ``__unicode__`` method of the model). + - "mix" (default): `app_label.model_name.object_pk.object_repr`. - Simply set the - ``FOBI_FORM_ELEMENT_SELECT_MULTIPLE_MODEL_OBJECTS_SUBMIT_VALUE_AS`` assign - one of the following values: "val", "repr" or "mix" to get the desired - behaviour. + Simply set the + ``FOBI_FORM_ELEMENT_SELECT_MULTIPLE_MODEL_OBJECTS_SUBMIT_VALUE_AS`` assign + one of the following values: "val", "repr" or "mix" to get the desired + behaviour. diff --git a/src/fobi/contrib/plugins/form_elements/fields/select_multiple_mptt_model_objects/README.rst b/src/fobi/contrib/plugins/form_elements/fields/select_multiple_mptt_model_objects/README.rst index 9128a198..4602f65a 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/select_multiple_mptt_model_objects/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/select_multiple_mptt_model_objects/README.rst @@ -1,13 +1,13 @@ fobi.contrib.plugins.form_elements.fields.select_multiple_mptt_model_objects -============================================================================ +---------------------------------------------------------------------------- A ``Fobi`` Select Multiple MPTT Model Objects form field plugin. Makes use of the ``mptt.forms.TreeNodeMultipleChoiceField`` and ``django.forms.widgets.SelectMultiple``. Installation ------------- +~~~~~~~~~~~~ Install `django-mptt` -~~~~~~~~~~~~~~~~~~~~~ +##################### Taken from django-mptt `Getting started `_. @@ -20,52 +20,52 @@ Taken from django-mptt `Getting started 2. Add ``mptt`` to the ``INSTALLED_APPS`` in your ``settings.py``. Install `select_multiple_mptt_model_objects` plugin -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1. Add - ``fobi.contrib.plugins.form_elements.fields.select_multiple_mptt_model_objects`` - to the ``INSTALLED_APPS`` in your ``settings.py``. +################################################### +(1) Add + ``fobi.contrib.plugins.form_elements.fields.select_multiple_mptt_model_objects`` + to the ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'mptt', - 'fobi.contrib.plugins.form_elements.fields.select_multiple_mptt_model_objects', - # ... - ) + INSTALLED_APPS = ( + # ... + 'mptt', + 'fobi.contrib.plugins.form_elements.fields.select_multiple_mptt_model_objects', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. -4. Make sure to take a look at - ``fobi.contrib.plugins.form_elements.fields.select_multiple_mptt_model_objects.defaults.IGNORED_MODELS``. - If necessary, override it in your `settings` as shown in the example below: +(4) Make sure to take a look at + ``fobi.contrib.plugins.form_elements.fields.select_multiple_mptt_model_objects.defaults.IGNORED_MODELS``. + If necessary, override it in your `settings` as shown in the example below: - .. code-block:: python + .. code-block:: python - FOBI_FORM_ELEMENT_SELECT_MULTIPLE_MPTT_MODEL_OBJECTS_IGNORED_MODELS = [ - 'auth.User', - 'auth.Group', - ] + FOBI_FORM_ELEMENT_SELECT_MULTIPLE_MPTT_MODEL_OBJECTS_IGNORED_MODELS = [ + 'auth.User', + 'auth.Group', + ] -5. By default, the submitted form value of `select_multiple_mptt_model_objects` - elements is `app_label.model_name.object_pk.object_repr`. However, that part - of the behaviour has been made configurable. You can choose between the - following options: +(5) By default, the submitted form value of `select_multiple_mptt_model_objects` + elements is `app_label.model_name.object_pk.object_repr`. However, that part + of the behaviour has been made configurable. You can choose between the + following options: - .. code-block:: text + .. code-block:: text - - "val": `app_label.model_name.object_pk.object_repr`. - - "repr": `object_repr` (uses the ``__unicode__`` method of the model). - - "mix" (default): `app_label.model_name.object_pk.object_repr`. + - "val": `app_label.model_name.object_pk.object_repr`. + - "repr": `object_repr` (uses the ``__unicode__`` method of the model). + - "mix" (default): `app_label.model_name.object_pk.object_repr`. - Simply set the - ``FOBI_FORM_ELEMENT_SELECT_MULTIPLE_MPTT_MODEL_OBJECTS_SUBMIT_VALUE_AS`` - assign one of the following values: "val", "repr" or "mix" to get the - desired behaviour. + Simply set the + ``FOBI_FORM_ELEMENT_SELECT_MULTIPLE_MPTT_MODEL_OBJECTS_SUBMIT_VALUE_AS`` + assign one of the following values: "val", "repr" or "mix" to get the + desired behaviour. diff --git a/src/fobi/contrib/plugins/form_elements/fields/select_multiple_with_max/README.rst b/src/fobi/contrib/plugins/form_elements/fields/select_multiple_with_max/README.rst index 06baf972..efbb8a8d 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/select_multiple_with_max/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/select_multiple_with_max/README.rst @@ -1,55 +1,55 @@ fobi.contrib.plugins.form_elements.fields.select_multiple_with_max -================================================================== +------------------------------------------------------------------ A ``Fobi`` Select Multiple form field plugin with max choices. Makes use of the ``django.forms.widgets.SelectMultiple``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.select_multiple_with_max`` - to the ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.select_multiple_with_max`` + to the ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.select_multiple_with_max', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.select_multiple_with_max', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. -4. By default, the submitted form value of `select_multiple_with_max` - elements is label (human readable representation of the value chosen). - However, that part of the behaviour has been made configurable. You can - choose between the following options: +(4) By default, the submitted form value of `select_multiple_with_max` + elements is label (human readable representation of the value chosen). + However, that part of the behaviour has been made configurable. You can + choose between the following options: - Consider the following list of (value, label) choices (the first element in - the tuple is value, the second element is label): + Consider the following list of (value, label) choices (the first element in + the tuple is value, the second element is label): - .. code-block:: python + .. code-block:: python - [ - ('alpha', 'Alpha'), - ('beta', 'Beta'), - ('gamma', 'Gamma'), - ] + [ + ('alpha', 'Alpha'), + ('beta', 'Beta'), + ('gamma', 'Gamma'), + ] - .. code-block:: text + .. code-block:: text - - "val": `value` (example: "alpha"). - - "repr" (default): `label` (example: "Alpha"). - - "mix": `value (label)` (example: "Alpha (alpha)"). + - "val": `value` (example: "alpha"). + - "repr" (default): `label` (example: "Alpha"). + - "mix": `value (label)` (example: "Alpha (alpha)"). - Simply set the - ``FOBI_FORM_ELEMENT_SELECT_MULTIPLE_WITH_MAX_SUBMIT_VALUE_AS`` assign one of the - following values: "val", "repr" or "mix" to get the desired behaviour. + Simply set the + ``FOBI_FORM_ELEMENT_SELECT_MULTIPLE_WITH_MAX_SUBMIT_VALUE_AS`` assign one of the + following values: "val", "repr" or "mix" to get the desired behaviour. Usage ----- diff --git a/src/fobi/contrib/plugins/form_elements/fields/slider/README.rst b/src/fobi/contrib/plugins/form_elements/fields/slider/README.rst index 2c0aa3d1..ee6c650d 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/slider/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/slider/README.rst @@ -1,50 +1,50 @@ fobi.contrib.plugins.form_elements.fields.slider -================================================ +------------------------------------------------ A ``Fobi`` Percentage form field plugin. Makes use of the ``django.forms.fields.ChoiceField`` and ``django.forms.widgets.Select``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.slider`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.slider`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.slider', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.slider', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. -4. Ranges are specified within the given min/max values. The default values - are: +(4) Ranges are specified within the given min/max values. The default values + are: -.. code-block:: text + .. code-block:: text - - INITIAL: 50 - - INITIAL_MAX_VALUE: 100 - - INITIAL_MIN_VALUE: 0 - - MIN_VALUE: 0 - - MAX_VALUE: 100 - - STEP: 1 + - INITIAL: 50 + - INITIAL_MAX_VALUE: 100 + - INITIAL_MIN_VALUE: 0 + - MIN_VALUE: 0 + - MAX_VALUE: 100 + - STEP: 1 - However, you can override each of them in the settings of your project by - prefixing correspondent names with `FOBI_FORM_ELEMENT_SLIDER_`: + However, you can override each of them in the settings of your project by + prefixing correspondent names with `FOBI_FORM_ELEMENT_SLIDER_`: -.. code-block:: text + .. code-block:: text - - FOBI_FORM_ELEMENT_SLIDER_INITIAL - - FOBI_FORM_ELEMENT_SLIDER_INITIAL_MAX_VALUE - - FOBI_FORM_ELEMENT_SLIDER_INITIAL_MIN_VALUE - - FOBI_FORM_ELEMENT_SLIDER_MIN_VALUE - - FOBI_FORM_ELEMENT_SLIDER_MAX_VALUE - - FOBI_FORM_ELEMENT_SLIDER_STEP + - FOBI_FORM_ELEMENT_SLIDER_INITIAL + - FOBI_FORM_ELEMENT_SLIDER_INITIAL_MAX_VALUE + - FOBI_FORM_ELEMENT_SLIDER_INITIAL_MIN_VALUE + - FOBI_FORM_ELEMENT_SLIDER_MIN_VALUE + - FOBI_FORM_ELEMENT_SLIDER_MAX_VALUE + - FOBI_FORM_ELEMENT_SLIDER_STEP diff --git a/src/fobi/contrib/plugins/form_elements/fields/slug/README.rst b/src/fobi/contrib/plugins/form_elements/fields/slug/README.rst index 69ddca69..c9545113 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/slug/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/slug/README.rst @@ -1,26 +1,26 @@ fobi.contrib.plugins.form_elements.fields.slug -============================================== +---------------------------------------------- A ``Fobi`` Text form field plugin. Makes use of the ``django.forms.fields.SlugField`` and ``django.forms.widgets.TextInput``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.slug`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.slug`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.slug', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.slug', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_elements/fields/text/README.rst b/src/fobi/contrib/plugins/form_elements/fields/text/README.rst index 5b9f2c80..5358d6fc 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/text/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/text/README.rst @@ -1,26 +1,26 @@ fobi.contrib.plugins.form_elements.fields.text -============================================== +---------------------------------------------- A ``Fobi`` Text form field plugin. Makes use of the ``django.forms.fields.CharField`` and ``django.forms.widgets.TextInput``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.text`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.text`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.text', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.text', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_elements/fields/textarea/README.rst b/src/fobi/contrib/plugins/form_elements/fields/textarea/README.rst index 6cbf8f72..af11a94b 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/textarea/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/textarea/README.rst @@ -1,26 +1,26 @@ fobi.contrib.plugins.form_elements.fields.textarea -================================================== +-------------------------------------------------- A ``Fobi`` Textarea form field plugin. Makes use of the ``django.forms.fields.CharField`` and ``django.forms.widgets.Textarea``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.textarea`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.textarea`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.textarea', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.textarea', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_elements/fields/time/README.rst b/src/fobi/contrib/plugins/form_elements/fields/time/README.rst index d14dfe47..6acb19a3 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/time/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/time/README.rst @@ -1,27 +1,27 @@ fobi.contrib.plugins.form_elements.fields.time -============================================== +---------------------------------------------- A ``Fobi`` DateTime form field plugin. Makes use of the ``django.forms.fields.TimeField`` and ``django.forms.widgets.TextInput``. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.time`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.time`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.time', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.time', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_elements/fields/url/README.rst b/src/fobi/contrib/plugins/form_elements/fields/url/README.rst index 9843f924..3802bf5b 100644 --- a/src/fobi/contrib/plugins/form_elements/fields/url/README.rst +++ b/src/fobi/contrib/plugins/form_elements/fields/url/README.rst @@ -1,27 +1,27 @@ fobi.contrib.plugins.form_elements.fields.url -============================================= +--------------------------------------------- A ``Fobi`` URL form field plugin. Makes use of the ``django.forms.fields.URLField`` and ``django.forms.widgets.URLInput`` falling back to ``django.forms.widgets.TextInput`` for older Django versions. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.fields.url`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.fields.url`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.fields.url', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.fields.url', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_elements/security/captcha/README.rst b/src/fobi/contrib/plugins/form_elements/security/captcha/README.rst index b9f69262..09d9e0ff 100644 --- a/src/fobi/contrib/plugins/form_elements/security/captcha/README.rst +++ b/src/fobi/contrib/plugins/form_elements/security/captcha/README.rst @@ -1,70 +1,70 @@ fobi.contrib.plugins.form_elements.security.captcha -=================================================== +--------------------------------------------------- A `CAPTCHA `_ form field plugin. Makes use of the `django-simple-captcha `_. Prerequisites -------------- -You will need `libfreetype6`, otherwise `django-captcha` won't work. +~~~~~~~~~~~~~ +You will need ``libfreetype6``, otherwise ``django-captcha`` won't work. .. code-block:: sh sudo apt-get install libfreetype6-dev Installation ------------- +~~~~~~~~~~~~ Install `django-simple-captcha` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +############################### Taken from django-simple-captcha `installation instructions `_. -1. Download ``django-simple-captcha`` using pip by running: +(1) Download ``django-simple-captcha`` using pip by running: -.. code-block:: sh + .. code-block:: sh - pip install django-simple-captcha + pip install django-simple-captcha -2. Add ``captcha`` to the ``INSTALLED_APPS`` in your ``settings.py``. +(2) Add ``captcha`` to the ``INSTALLED_APPS`` in your ``settings.py``. -3. Run ``python manage.py syncdb`` (or ``python manage.py migrate`` if you are - managing database migrations via South) to create the required database - tables. +(3) Run ``python manage.py syncdb`` (or ``python manage.py migrate`` if you are + managing database migrations via South) to create the required database + tables. -4. Add an entry to your ``urls.py``: +(4) Add an entry to your ``urls.py``: -.. code-block:: python + .. code-block:: python - urlpatterns += [ - url(r'^captcha/', include('captcha.urls')), - ] + urlpatterns += [ + url(r'^captcha/', include('captcha.urls')), + ] Install `fobi` Captcha plugin -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1. Add ``fobi.contrib.plugins.form_elements.security.captcha`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +############################# +(1) Add ``fobi.contrib.plugins.form_elements.security.captcha`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.security.captcha', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.security.captcha', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. Troubleshooting and usage limitations -------------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In combination with other captcha solutions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +########################################### At the moment, you can't use both ``CAPTCHA`` (fobi.contrib.plugins.form_elements.security.captcha) and ``ReCAPTCHA`` (fobi.contrib.plugins.form_elements.security.recaptcha) plugins alongside due @@ -74,7 +74,7 @@ packages. That limitation is likely to be solved in future in the another, but not both on the same time. Usage ------ +~~~~~ Note, that unlike most of the other form element plugins, default value for the ``required`` attribute is True, which makes the Captcha obligatory. Although you could still set it to False, it does not make diff --git a/src/fobi/contrib/plugins/form_elements/security/honeypot/README.rst b/src/fobi/contrib/plugins/form_elements/security/honeypot/README.rst index ee30e5a6..b56030aa 100644 --- a/src/fobi/contrib/plugins/form_elements/security/honeypot/README.rst +++ b/src/fobi/contrib/plugins/form_elements/security/honeypot/README.rst @@ -1,26 +1,26 @@ fobi.contrib.plugins.form_elements.security.honeypot -==================================================== +---------------------------------------------------- A `Honeypot `_ form field plugin. Just another anti-spam technique. Installation ------------- -1. Add ``fobi.contrib.plugins.form_elements.security.honeypot`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.security.honeypot`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.security.honeypot', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.security.honeypot', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_elements/security/recaptcha/README.rst b/src/fobi/contrib/plugins/form_elements/security/recaptcha/README.rst index 810dfa91..41d6f78e 100644 --- a/src/fobi/contrib/plugins/form_elements/security/recaptcha/README.rst +++ b/src/fobi/contrib/plugins/form_elements/security/recaptcha/README.rst @@ -1,59 +1,58 @@ -===================================================== fobi.contrib.plugins.form_elements.security.recaptcha -===================================================== +----------------------------------------------------- A `ReCAPTCHA `_ form field plugin. Makes use of the `django-recaptcha `_. Installation -============ +~~~~~~~~~~~~ Install `django-recaptcha` --------------------------- -1. Download ``django-recaptcha`` using pip by running: +########################## +(1) Download ``django-recaptcha`` using pip by running: -.. code-block:: sh + .. code-block:: sh - pip install django-recaptcha + pip install django-recaptcha -2. Add ``captcha`` to the ``INSTALLED_APPS`` in your ``settings.py``. +(2) Add ``captcha`` to the ``INSTALLED_APPS`` in your ``settings.py``. -3. Run ``python manage.py syncdb`` (or ``python manage.py migrate`` if you are +(3) Run ``python manage.py syncdb`` (or ``python manage.py migrate`` if you are managing database migrations via South) to create the required database tables. Install `fobi` ReCAPTCHA plugin -------------------------------- -1. Add ``fobi.contrib.plugins.form_elements.security.recaptcha`` to the +############################### +(1) Add ``fobi.contrib.plugins.form_elements.security.recaptcha`` to the ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.security.recaptcha', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.security.recaptcha', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using +(3) Assign appropriate permissions to the target users/groups to be using the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. -4. Specify the following ReCAPTCHA credentials in your settings. +(4) Specify the following ReCAPTCHA credentials in your settings. -.. code-block:: text + .. code-block:: text - - ``RECAPTCHA_PUBLIC_KEY`` - - ``RECAPTCHA_PRIVATE_KEY`` + - ``RECAPTCHA_PUBLIC_KEY`` + - ``RECAPTCHA_PRIVATE_KEY`` Troubleshooting and usage limitations -===================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In combination with other captcha solutions -------------------------------------------- +########################################### At the moment, you can't use both ``CAPTCHA`` (fobi.contrib.plugins.form_elements.security.captcha) and ``ReCAPTCHA`` (fobi.contrib.plugins.form_elements.security.recaptcha) plugins alongside due @@ -69,7 +68,7 @@ See the `following `_ thread for more information. Usage -===== +~~~~~ Note, that unlike most of the other form element plugins, default value for the ``required`` attribute is True, which makes the ReCaptcha obligatory. Although you could still set it to False, it does not make diff --git a/src/fobi/contrib/plugins/form_elements/test/dummy/README.rst b/src/fobi/contrib/plugins/form_elements/test/dummy/README.rst index fc8bcf22..466770d7 100644 --- a/src/fobi/contrib/plugins/form_elements/test/dummy/README.rst +++ b/src/fobi/contrib/plugins/form_elements/test/dummy/README.rst @@ -1,26 +1,25 @@ -============================================= fobi.contrib.plugins.form_elements.test.dummy -============================================= +--------------------------------------------- A ``Fobi`` Dummy form element plugin. Created for testing purposes. Installation -============ -1. Add ``fobi.contrib.plugins.form_elements.test.dummy`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_elements.test.dummy`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_elements.test.dummy', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_elements.test.dummy', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_handlers/README.rst b/src/fobi/contrib/plugins/form_handlers/README.rst new file mode 100644 index 00000000..72c57b91 --- /dev/null +++ b/src/fobi/contrib/plugins/form_handlers/README.rst @@ -0,0 +1,2 @@ +Form handlers +============= diff --git a/src/fobi/contrib/plugins/form_handlers/db_store/README.rst b/src/fobi/contrib/plugins/form_handlers/db_store/README.rst index 281817bb..bf260ec3 100644 --- a/src/fobi/contrib/plugins/form_handlers/db_store/README.rst +++ b/src/fobi/contrib/plugins/form_handlers/db_store/README.rst @@ -1,56 +1,55 @@ -=========================================== fobi.contrib.plugins.form_handlers.db_store -=========================================== +------------------------------------------- A ``Fobi`` Database Store form-/wizard- handler plugin. Saves submitted form data into the ``SavedFormDataEntry``/``SavedFormWizardDataEntry`` models. Dependencies -============ +~~~~~~~~~~~~ The `xlwt `_ package is required (optional) for XLS export. If not present, export format falls back to CSV. Installation -============ -1. Add ``fobi.contrib.plugins.form_handlers.db_store`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_handlers.db_store`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_handlers.db_store', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_handlers.db_store', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py migrate + ./manage.py migrate - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. -4. Add db_store form handler plugin URLs to the urls.py of your project. +(4) Add db_store form handler plugin URLs to the urls.py of your project. -.. code-block:: python + .. code-block:: python - urlpatterns = [ - # DB Store plugin URLs - url(r'^fobi/plugins/form-handlers/db-store/', - include('fobi.contrib.plugins.form_handlers.db_store.urls')), - ] + urlpatterns = [ + # DB Store plugin URLs + url(r'^fobi/plugins/form-handlers/db-store/', + include('fobi.contrib.plugins.form_handlers.db_store.urls')), + ] -For form wizards do: + For form wizards do: -.. code-block:: python + .. code-block:: python - urlpatterns = [ - # DB Store plugin URLs - url(r'^fobi/plugins/form-wizard-handlers/db-store/', - include('fobi.contrib.plugins.form_handlers.db_store.urls.' - 'form_wizard_handlers')), - ] + urlpatterns = [ + # DB Store plugin URLs + url(r'^fobi/plugins/form-wizard-handlers/db-store/', + include('fobi.contrib.plugins.form_handlers.db_store.urls.' + 'form_wizard_handlers')), + ] diff --git a/src/fobi/contrib/plugins/form_handlers/http_repost/README.rst b/src/fobi/contrib/plugins/form_handlers/http_repost/README.rst index 1296c478..664c3844 100644 --- a/src/fobi/contrib/plugins/form_handlers/http_repost/README.rst +++ b/src/fobi/contrib/plugins/form_handlers/http_repost/README.rst @@ -1,27 +1,26 @@ -============================================== fobi.contrib.plugins.form_handlers.http_repost -============================================== +---------------------------------------------- A ``Fobi`` HTTP Repost form handler plugin. Submits the form data as is to the given endpoint. Installation -============ -1. Add ``fobi.contrib.plugins.form_handlers.http_repost`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_handlers.http_repost`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_handlers.http_repost', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_handlers.http_repost', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_handlers/mail/README.rst b/src/fobi/contrib/plugins/form_handlers/mail/README.rst index e189b224..cda3e258 100644 --- a/src/fobi/contrib/plugins/form_handlers/mail/README.rst +++ b/src/fobi/contrib/plugins/form_handlers/mail/README.rst @@ -1,27 +1,26 @@ -======================================= fobi.contrib.plugins.form_handlers.mail -======================================= +--------------------------------------- A ``Fobi`` Mail form handler plugin. Submits the form data by email to the specified email address. Installation -============ -1. Add ``fobi.contrib.plugins.form_handlers.mail`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.plugins.form_handlers.mail`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.plugins.form_handlers.mail', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.plugins.form_handlers.mail', + # ... + ) -2. In the terminal type: +(2) In the terminal type: -.. code-block:: sh + .. code-block:: sh - ./manage.py fobi_sync_plugins + ./manage.py fobi_sync_plugins -3. Assign appropriate permissions to the target users/groups to be using - the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. +(3) Assign appropriate permissions to the target users/groups to be using + the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True. diff --git a/src/fobi/contrib/plugins/form_importers/README.rst b/src/fobi/contrib/plugins/form_importers/README.rst new file mode 100644 index 00000000..18c0a8b8 --- /dev/null +++ b/src/fobi/contrib/plugins/form_importers/README.rst @@ -0,0 +1,2 @@ +Form importers +============== diff --git a/src/fobi/contrib/plugins/form_importers/mailchimp_importer/README.rst b/src/fobi/contrib/plugins/form_importers/mailchimp_importer/README.rst index 65906415..24dbf32b 100644 --- a/src/fobi/contrib/plugins/form_importers/mailchimp_importer/README.rst +++ b/src/fobi/contrib/plugins/form_importers/mailchimp_importer/README.rst @@ -1,6 +1,5 @@ -================== mailchimp_importer -================== +------------------ A ``django-fobi`` integration with MailChimp. This plugin makes it possible to import a form from a MailChimp list. A typical @@ -16,7 +15,7 @@ For additional information on MailChimp import see the following `article `_. Prerequisites -============= +~~~~~~~~~~~~~ Python wrapper for the Mailchimp: .. code-block:: sh @@ -31,9 +30,9 @@ package as well: pip install django-formtools Installation -============ +~~~~~~~~~~~~ your_project/settings.py ------------------------- +######################## .. code-block:: python INSTALLED_APPS = list(INSTALLED_APPS) @@ -42,7 +41,7 @@ your_project/settings.py ] How it works -============ +~~~~~~~~~~~~ Assuming that you have configured the `mailchimp_importer` plugin properly and have the Django running locally on port 8000, accessing the following URL would bring you to the MailChimp form import wizard. @@ -55,7 +54,7 @@ information. The key isn't stored/saved/remembered. Next time you want to import a form from the same account, you would have to provide it again. Development status -================== +~~~~~~~~~~~~~~~~~~ This part of code is alpha, which means it experimental and needs improvements. See the `TODOS `_ diff --git a/src/fobi/contrib/themes/README.rst b/src/fobi/contrib/themes/README.rst new file mode 100644 index 00000000..318fef7a --- /dev/null +++ b/src/fobi/contrib/themes/README.rst @@ -0,0 +1,2 @@ +Themes +====== diff --git a/src/fobi/contrib/themes/bootstrap3/README.rst b/src/fobi/contrib/themes/bootstrap3/README.rst index b62ae806..7d94fe0b 100644 --- a/src/fobi/contrib/themes/bootstrap3/README.rst +++ b/src/fobi/contrib/themes/bootstrap3/README.rst @@ -1,23 +1,22 @@ -============================== fobi.contrib.themes.bootstrap3 -============================== +------------------------------ A ``django-fobi`` Bootstrap 3 theme. Based on the ??? template. Installation -============ -1. Add ``fobi.contrib.themes.bootstrap3`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.themes.bootstrap3`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.themes.bootstrap3', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.themes.bootstrap3', + # ... + ) -2. Specify ``bootstrap3`` as a default theme in your ``settings.py``: +(2) Specify ``bootstrap3`` as a default theme in your ``settings.py``: -.. code-block:: python + .. code-block:: python - FOBI_DEFAULT_THEME = 'bootstrap3' + FOBI_DEFAULT_THEME = 'bootstrap3' diff --git a/src/fobi/contrib/themes/djangocms_admin_style_theme/README.rst b/src/fobi/contrib/themes/djangocms_admin_style_theme/README.rst index 3fbab0a8..6b488ec8 100644 --- a/src/fobi/contrib/themes/djangocms_admin_style_theme/README.rst +++ b/src/fobi/contrib/themes/djangocms_admin_style_theme/README.rst @@ -1,43 +1,42 @@ -=============================================== fobi.contrib.themes.djangocms_admin_style_theme -=============================================== +----------------------------------------------- A ``django-fobi`` theme in a style of ``djangocms-admin-style`` admin. Relies on ``djangocms-admin-style`` package and some jQuery UI only. jQuery UI "Smoothness" theme comes from `here `_. Installation -============ +~~~~~~~~~~~~ Install `djangocms-admin-style` -------------------------------- +############################### See the original `installation instructions `_. -1. Install the ``djangocms-admin-style`` package. +(1) Install the ``djangocms-admin-style`` package. -.. code-block:: sh + .. code-block:: sh - pip install djangocms-admin-style + pip install djangocms-admin-style -2. Add 'djangocms_admin_style' to your INSTALLED_APPS just before - 'django.contrib.admin'. +(2) Add ``djangocms_admin_style`` to your ``INSTALLED_APPS`` just before + ``django.contrib.admin``. Install `fobi.contrib.themes.djangocms_admin_style_theme` theme ---------------------------------------------------------------- -1. Add ``fobi.contrib.themes.djangocms_admin_style_theme`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +############################################################### +(1) Add ``fobi.contrib.themes.djangocms_admin_style_theme`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.themes.djangocms_admin_style_theme', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.themes.djangocms_admin_style_theme', + # ... + ) -2. Specify ``djangocms_admin_style_theme`` as a default theme in your - ``settings.py``: +(2) Specify ``djangocms_admin_style_theme`` as a default theme in your + ``settings.py``: -.. code-block:: python + .. code-block:: python - FOBI_DEFAULT_THEME = 'djangocms_admin_style_theme' + FOBI_DEFAULT_THEME = 'djangocms_admin_style_theme' diff --git a/src/fobi/contrib/themes/foundation5/README.rst b/src/fobi/contrib/themes/foundation5/README.rst index 5b2a4588..876b9c1c 100644 --- a/src/fobi/contrib/themes/foundation5/README.rst +++ b/src/fobi/contrib/themes/foundation5/README.rst @@ -1,26 +1,25 @@ -=============================== fobi.contrib.themes.foundation5 -=============================== +------------------------------- A ``django-fobi`` Foundation 5 theme. Based on the ??? template, but entire JS and CSS are taken from Foundation 5 version 5.4.0. The `following `_ icon set was used. Installation -============ -1. Add ``fobi.contrib.themes.foundation5`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.themes.foundation5`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.themes.foundation5', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.themes.foundation5', + # ... + ) -2. Specify ``foundation5`` as a default theme in your ``settings.py``: +(2) Specify ``foundation5`` as a default theme in your ``settings.py``: -.. code-block:: python + .. code-block:: python - FOBI_DEFAULT_THEME = 'foundation5' + FOBI_DEFAULT_THEME = 'foundation5' diff --git a/src/fobi/contrib/themes/simple/README.rst b/src/fobi/contrib/themes/simple/README.rst index 7c9e12a6..29066c9d 100644 --- a/src/fobi/contrib/themes/simple/README.rst +++ b/src/fobi/contrib/themes/simple/README.rst @@ -1,6 +1,5 @@ -========================== fobi.contrib.themes.simple -========================== +-------------------------- A ``django-fobi`` theme in a style of Django admin. Relies on Django-admin and some jQuery UI only. @@ -8,20 +7,20 @@ jQuery UI "Django" theme comes from `here `_. Installation -============ -1. Add ``fobi.contrib.themes.simple`` to the - ``INSTALLED_APPS`` in your ``settings.py``. +~~~~~~~~~~~~ +(1) Add ``fobi.contrib.themes.simple`` to the + ``INSTALLED_APPS`` in your ``settings.py``. -.. code-block:: python + .. code-block:: python - INSTALLED_APPS = ( - # ... - 'fobi.contrib.themes.simple', - # ... - ) + INSTALLED_APPS = ( + # ... + 'fobi.contrib.themes.simple', + # ... + ) -2. Specify ``simple`` as a default theme in your ``settings.py``: +(2) Specify ``simple`` as a default theme in your ``settings.py``: -.. code-block:: python + .. code-block:: python - FOBI_DEFAULT_THEME = 'simple' + FOBI_DEFAULT_THEME = 'simple'