more on docs

This commit is contained in:
Artur Barseghyan 2017-05-15 23:27:30 +02:00
parent 481f61844a
commit d8217f88df
8 changed files with 124 additions and 124 deletions

View file

@ -1,26 +1,26 @@
fobi.contrib.plugins.form_elements.fields.date
==============================================
----------------------------------------------
A ``Fobi`` Date form field plugin. Makes use of the
``django.forms.fields.DateField`` and ``django.forms.widgets.DateInput``.
Installation
------------
1. Add ``fobi.contrib.plugins.form_elements.fields.date`` to the
``INSTALLED_APPS`` in your ``settings.py``.
~~~~~~~~~~~~
(1) Add ``fobi.contrib.plugins.form_elements.fields.date`` to the
``INSTALLED_APPS`` in your ``settings.py``.
.. code-block:: python
.. code-block:: python
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.date',
# ...
)
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.date',
# ...
)
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.

View file

@ -1,27 +1,27 @@
fobi.contrib.plugins.form_elements.fields.date_drop_down
========================================================
--------------------------------------------------------
A ``Fobi`` Birthday form field plugin. Makes use of the
``django.forms.fields.DateField`` and
``django.forms.extras.widgets.SelectDateWidget``.
Installation
------------
1. Add ``fobi.contrib.plugins.form_elements.fields.date_drop_down`` to the
``INSTALLED_APPS`` in your ``settings.py``.
~~~~~~~~~~~~
(1) Add ``fobi.contrib.plugins.form_elements.fields.date_drop_down`` to the
``INSTALLED_APPS`` in your ``settings.py``.
.. code-block:: python
.. code-block:: python
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.date_drop_down',
# ...
)
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.date_drop_down',
# ...
)
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.

View file

@ -1,27 +1,27 @@
fobi.contrib.plugins.form_elements.fields.datetime
==================================================
--------------------------------------------------
A ``Fobi`` DateTime form field plugin. Makes use of the
``django.forms.fields.DateTimeField`` and
``django.forms.widgets.DateTimeInput``.
Installation
------------
1. Add ``fobi.contrib.plugins.form_elements.fields.datetime`` to the
``INSTALLED_APPS`` in your ``settings.py``.
~~~~~~~~~~~~
(1) Add ``fobi.contrib.plugins.form_elements.fields.datetime`` to the
``INSTALLED_APPS`` in your ``settings.py``.
.. code-block:: python
.. code-block:: python
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.datetime',
# ...
)
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.datetime',
# ...
)
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.

View file

@ -1,28 +1,28 @@
fobi.contrib.plugins.form_elements.fields.decimal
=================================================
-------------------------------------------------
A ``Fobi`` Decimal form field plugin. Makes use of the
``django.forms.fields.DecimalField`` 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.decimal`` to the
``INSTALLED_APPS`` in your ``settings.py``.
~~~~~~~~~~~~
(1) Add ``fobi.contrib.plugins.form_elements.fields.decimal`` to the
``INSTALLED_APPS`` in your ``settings.py``.
.. code-block:: python
.. code-block:: python
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.decimal',
# ...
)
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.decimal',
# ...
)
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.

View file

@ -1,26 +1,26 @@
fobi.contrib.plugins.form_elements.fields.email
===============================================
-----------------------------------------------
A ``Fobi`` Email form field plugin. Makes use of the
``django.forms.fields.EmailField`` and ``django.forms.widgets.TextInput``.
Installation
------------
1. Add ``fobi.contrib.plugins.form_elements.fields.email`` to the
``INSTALLED_APPS`` in your ``settings.py``.
~~~~~~~~~~~~
(1) Add ``fobi.contrib.plugins.form_elements.fields.email`` to the
``INSTALLED_APPS`` in your ``settings.py``.
.. code-block:: python
.. code-block:: python
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.email',
# ...
)
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.email',
# ...
)
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.

View file

@ -1,32 +1,32 @@
fobi.contrib.plugins.form_elements.fields.file
==============================================
----------------------------------------------
A ``Fobi`` File form field plugin. Makes use of the
``django.forms.fields.FileField`` and
``django.forms.widgets.ClearableFileInput``.
Installation
------------
1. Add ``fobi.contrib.plugins.form_elements.fields.file`` to the
``INSTALLED_APPS`` in your ``settings.py``.
~~~~~~~~~~~~
(1) Add ``fobi.contrib.plugins.form_elements.fields.file`` to the
``INSTALLED_APPS`` in your ``settings.py``.
.. code-block:: python
.. code-block:: python
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.file',
# ...
)
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.file',
# ...
)
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 uploaded files are stored in the "fobi_plugins/file" directory
of the media root. If you want to change the directory location,
set the ``FOBI_PLUGIN_FIELDS_FILE_FILES_UPLOAD_DIR`` value to the desired
(relative) path.
(4) By default uploaded files are stored in the "fobi_plugins/file" directory
of the media root. If you want to change the directory location,
set the ``FOBI_PLUGIN_FIELDS_FILE_FILES_UPLOAD_DIR`` value to the desired
(relative) path.

View file

@ -1,28 +1,28 @@
fobi.contrib.plugins.form_elements.fields.float
===============================================
-----------------------------------------------
A ``Fobi`` Integer form field plugin. Makes use of the
``django.forms.fields.FloatField`` 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.float`` to the
``INSTALLED_APPS`` in your ``settings.py``.
~~~~~~~~~~~~
(1) Add ``fobi.contrib.plugins.form_elements.fields.float`` to the
``INSTALLED_APPS`` in your ``settings.py``.
.. code-block:: python
.. code-block:: python
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.float',
# ...
)
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.float',
# ...
)
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.

View file

@ -1,26 +1,26 @@
fobi.contrib.plugins.form_elements.fields.hidden
================================================
------------------------------------------------
A ``Fobi`` Hidden form field plugin. Makes use of the
``django.forms.fields.CharField`` and ``django.forms.widgets.HiddenInput``.
Installation
------------
1. Add ``fobi.contrib.plugins.form_elements.fields.hidden`` to the
``INSTALLED_APPS`` in your ``settings.py``.
~~~~~~~~~~~~
(1) Add ``fobi.contrib.plugins.form_elements.fields.hidden`` to the
``INSTALLED_APPS`` in your ``settings.py``.
.. code-block:: python
.. code-block:: python
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.hidden',
# ...
)
INSTALLED_APPS = (
# ...
'fobi.contrib.plugins.form_elements.fields.hidden',
# ...
)
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.