mirror of
https://github.com/Hopiu/django-fobi.git
synced 2026-03-16 22:10:28 +00:00
Consolidate docs (#276)
* Minor fixes in docs (old-style code) * Consolidate docs * Clean up
This commit is contained in:
Artur Barseghyan
GitHub
parent
48d87dec38
commit
b0b0d414c2
21 changed files with 603 additions and 9919 deletions
|
|
@ -1324,7 +1324,7 @@ Existing files
|
|||
2015-03-26
|
||||
|
||||
- `Checkbox select multiple
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/checkbox_select_multiple>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/checkbox_select_multiple>`_
|
||||
field added.
|
||||
- Minor improvements (styling) in the Foundation 5 theme.
|
||||
- Initial configuration for tox tests.
|
||||
|
|
@ -1360,22 +1360,22 @@ Existing files
|
|||
2015-03-20
|
||||
|
||||
- `Decimal
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/decimal>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/decimal>`_
|
||||
field added.
|
||||
- `Float
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/float>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/float>`_
|
||||
field added.
|
||||
- `Slug
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/slug>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/slug>`_
|
||||
field added.
|
||||
- `IP address
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/ip_address>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/ip_address>`_
|
||||
field added.
|
||||
- `Null boolean
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/null_boolean>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/null_boolean>`_
|
||||
field added.
|
||||
- `Time
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/time>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/time>`_
|
||||
field added.
|
||||
- From now on using `simplejson` package in favour of `json`, since it can
|
||||
handle decimal data.
|
||||
|
|
|
|||
14
CREDITS.rst
14
CREDITS.rst
|
|
@ -17,10 +17,10 @@ Thanks to the following people for their contributions:
|
|||
<https://github.com/barseghyanartur/django-fobi/commits?author=adrien-delhorme>`_
|
||||
for French translations and some minor fixes.
|
||||
- `Maximilian Kindshofer
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/master?author=MaximilianKindshofer>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/main?author=MaximilianKindshofer>`_
|
||||
for German translations.
|
||||
- `Thomas Wajs
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/master?author=thomasWajs>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/main?author=thomasWajs>`_
|
||||
for number of minor yet valuable fixes.
|
||||
- `garmoncheg
|
||||
<https://github.com/barseghyanartur/django-fobi/commits?author=garmoncheg>`_
|
||||
|
|
@ -29,20 +29,20 @@ Thanks to the following people for their contributions:
|
|||
<https://github.com/barseghyanartur/django-fobi/commits?author=jmsfwk>`_
|
||||
for number of Django 1.9 support fixes.
|
||||
- `Mario Taddei
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/master?author=mariuccio>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/main?author=mariuccio>`_
|
||||
for his initiative to make `Select multiple with max` plugin.
|
||||
- `Andy Babic
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/master?author=ababic>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/main?author=ababic>`_
|
||||
for improvements in the generic integration processor and contributions
|
||||
to the ``wagtail_integration`` contrib app.
|
||||
- `Heldroe
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/master?author=Heldroe>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/main?author=Heldroe>`_
|
||||
for minor fixes.
|
||||
- `Michal Dabski
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/master?author=mick88>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/main?author=mick88>`_
|
||||
for minor fixes.
|
||||
- `Marcos Amorim
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/master?author=marcosamorim>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/commits/main?author=marcosamorim>`_
|
||||
for number of validation improvements.
|
||||
- `Grzegorz Bialy
|
||||
<https://github.com/barseghyanartur/django-fobi/commits?author=grzegorzbialy>`_
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ several parts listed below::
|
|||
Part 1: standard Django installation
|
||||
====================================
|
||||
Example project code available `here
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/examples/quick_start>`_.
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/examples/quick_start>`_.
|
||||
|
||||
Installation and configuration
|
||||
------------------------------
|
||||
|
|
|
|||
94
README.rst
94
README.rst
|
|
@ -28,8 +28,8 @@ handling the submitted form data).
|
|||
:target: https://github.com/barseghyanartur/django-fobi/#License
|
||||
:alt: GPL-2.0-only OR LGPL-2.1-or-later
|
||||
|
||||
.. image:: https://coveralls.io/repos/github/barseghyanartur/django-fobi/badge.svg?branch=master
|
||||
:target: https://coveralls.io/github/barseghyanartur/django-fobi?branch=master
|
||||
.. image:: https://coveralls.io/repos/github/barseghyanartur/django-fobi/badge.svg?branch=main
|
||||
:target: https://coveralls.io/github/barseghyanartur/django-fobi?branch=main
|
||||
:alt: Coverage
|
||||
|
||||
Prerequisites
|
||||
|
|
@ -138,7 +138,7 @@ Some of the upcoming/in-development features/improvements are:
|
|||
- Foundation 6 support.
|
||||
|
||||
See the `TODOS
|
||||
<https://raw.githubusercontent.com/barseghyanartur/django-fobi/master/TODOS.rst>`_
|
||||
<https://raw.githubusercontent.com/barseghyanartur/django-fobi/main/TODOS.rst>`_
|
||||
for the full list of planned-, pending- in-development- or to-be-implemented
|
||||
features.
|
||||
|
||||
|
|
@ -1519,10 +1519,10 @@ Make changes to an existing theme
|
|||
As said above, making your own theme from scratch could be costly. Instead,
|
||||
you can override/reuse an existing one and change it to your needs with
|
||||
minimal efforts. See the `override simple theme
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/examples/simple/override_simple_theme/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/examples/simple/override_simple_theme/>`_
|
||||
example. In order to see it in action, run the project with
|
||||
`settings_override_simple_theme
|
||||
<https://github.com/barseghyanartur/django-fobi/blob/master/examples/simple/settings_override_simple_theme.py>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/blob/main/examples/simple/settings_override_simple_theme.py>`_
|
||||
option:
|
||||
|
||||
.. code-block:: sh
|
||||
|
|
@ -1913,59 +1913,67 @@ Fields marked with asterisk (*) fall under the definition of text elements.
|
|||
It's possible to provide `Dynamic initial values`_ for text elements.
|
||||
|
||||
- `Boolean (checkbox)
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/boolean/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/boolean/>`_
|
||||
- `Checkbox select multiple
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/checkbox_select_multiple/>`_
|
||||
- `Date
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/date/>`_
|
||||
- `DateTime
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/datetime/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/date/>`_
|
||||
- `Date drop down (year, month, day selection drop-downs)
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/date_drop_down/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/date_drop_down/>`_
|
||||
- `DateTime
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/datetime/>`_
|
||||
- `Decimal
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/decimal>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/decimal>`_
|
||||
- `Duration
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/duration>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/duration>`_
|
||||
- `Email*
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/email/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/email/>`_
|
||||
- `File
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/file/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/file/>`_
|
||||
- `Float
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/float>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/float>`_
|
||||
- `Hidden*
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/hidden/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/hidden/>`_
|
||||
- `Hidden model object
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/hidden_model_object/>`_
|
||||
- `Input
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/input/>`_
|
||||
- `IP address*
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/ip_address>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/input/>`_
|
||||
- `Integer
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/integer/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/integer/>`_
|
||||
- `IP address*
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/ip_address>`_
|
||||
- `Null boolean
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/null_boolean>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/null_boolean>`_
|
||||
- `Password*
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/password/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/password/>`_
|
||||
- `Radio select (radio button)
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/radio/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/radio/>`_
|
||||
- `Range select
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/range_select/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/range_select/>`_
|
||||
- `Regex
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/regex/>`_
|
||||
- `Select (drop-down)
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/select/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/select/>`_
|
||||
- `Select model object (drop-down)
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/select_model_object/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/select_model_object/>`_
|
||||
- `Select multiple (drop-down)
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/select_multiple/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/select_multiple/>`_
|
||||
- `Select multiple model objects (drop-down)
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/select_multiple_model_objects/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/select_multiple_model_objects/>`_
|
||||
- `Select multiple with max (drop-down)
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/select_multiple_with_max/>`_
|
||||
- `Slider
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/slider>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/slider>`_
|
||||
- `Slug*
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/slug>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/slug>`_
|
||||
- `Text*
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/text/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/text/>`_
|
||||
- `Textarea*
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/textarea/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/textarea/>`_
|
||||
- `Time
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/src/fobi/contrib/plugins/form_elements/fields/time>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/time>`_
|
||||
- `URL*
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/fields/url/>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/src/fobi/contrib/plugins/form_elements/fields/url/>`_
|
||||
|
||||
Content/presentation
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
@ -1978,16 +1986,16 @@ complete and content rich.
|
|||
- `Content image URL
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/content/content_image_url/>`_:
|
||||
Insert an image URL.
|
||||
- `Content text
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/content/content_text/>`_:
|
||||
Add text.
|
||||
- `Content markdown
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/content/content_markdown/>`_:
|
||||
Add markdown text.
|
||||
- `Content richtext
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/content/content_richtext/>`_:
|
||||
Add rich text (based on `django-ckeditor <https://github.com/django-ckeditor/django-ckeditor>`_
|
||||
package).
|
||||
- `Content markdown
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/content/content_markdown/>`_:
|
||||
Add markdown text.
|
||||
- `Content text
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/content/content_text/>`_:
|
||||
Add text.
|
||||
- `Content video
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/content/content_video/>`_:
|
||||
Add an embed YouTube or Vimeo video.
|
||||
|
|
@ -2290,7 +2298,7 @@ Using `django-floppyforms`
|
|||
{% form form %}
|
||||
|
||||
See how it's done in the `override simple theme
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/examples/simple/override_simple_theme/>`__
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/examples/simple/override_simple_theme/>`__
|
||||
example.
|
||||
|
||||
Import/export forms
|
||||
|
|
@ -2329,9 +2337,9 @@ easily achievable with introduction of custom locale paths in your project.
|
|||
See the following as a good example of overriding some English plugin labels.
|
||||
|
||||
- `custom settings
|
||||
<https://raw.githubusercontent.com/barseghyanartur/django-fobi/master/examples/simple/settings/alternative_labels.py>`__
|
||||
<https://raw.githubusercontent.com/barseghyanartur/django-fobi/main/examples/simple/settings/alternative_labels.py>`__
|
||||
- `custom locales directory
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/master/examples/simple/fobi_locale/>`__
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/main/examples/simple/fobi_locale/>`__
|
||||
|
||||
Run the example project as follows:
|
||||
|
||||
|
|
|
|||
1888
docs/changelog.rst
1888
docs/changelog.rst
File diff suppressed because it is too large
Load diff
7431
docs/index.rst
7431
docs/index.rst
File diff suppressed because it is too large
Load diff
|
|
@ -1,182 +1 @@
|
|||
========
|
||||
Licenses
|
||||
========
|
||||
Below information about third-party packages used in the project is presented.
|
||||
|
||||
Bootstrap3
|
||||
==========
|
||||
http://getbootstrap.com/
|
||||
|
||||
Licensing information:
|
||||
|
||||
- Apache license 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
|
||||
|
||||
Bootstrap 3 DateTime picker
|
||||
===========================
|
||||
http://eonasdan.github.io/bootstrap-datetimepicker/
|
||||
|
||||
- MIT (http://opensource.org/licenses/mit-license.html)
|
||||
|
||||
bootstrap-slider
|
||||
================
|
||||
https://github.com/seiyria/bootstrap-slider
|
||||
|
||||
- MIT (http://opensource.org/licenses/mit-license.html)
|
||||
|
||||
django-autoslug
|
||||
===============
|
||||
https://bitbucket.org/neithere/django-autoslug
|
||||
|
||||
Licensing information:
|
||||
|
||||
- LGPL 3 (https://www.gnu.org/licenses/lgpl.html)
|
||||
|
||||
django-formtools
|
||||
================
|
||||
https://github.com/django/django-formtools
|
||||
|
||||
Licensing information:
|
||||
|
||||
- BSD (http://opensource.org/licenses/BSD-3-Clause)
|
||||
|
||||
django-nine
|
||||
===========
|
||||
https://github.com/barseghyanartur/django-nine
|
||||
|
||||
Licensing information:
|
||||
|
||||
- GPL 2.0 (http://www.gnu.org/licenses/gpl-2.0.html)
|
||||
- LGPL 2.1 (https://www.gnu.org/licenses/lgpl-2.1.html)
|
||||
|
||||
django-nonefield
|
||||
================
|
||||
https://github.com/barseghyanartur/django-nonefield
|
||||
|
||||
Licensing information:
|
||||
|
||||
- GPL 2.0 (http://www.gnu.org/licenses/gpl-2.0.html)
|
||||
- LGPL 2.1 (https://www.gnu.org/licenses/lgpl-2.1.html)
|
||||
|
||||
easy-thumbnails
|
||||
===============
|
||||
https://github.com/SmileyChris/easy-thumbnails
|
||||
|
||||
Licensing information:
|
||||
|
||||
- BSD (http://opensource.org/licenses/BSD-3-Clause)
|
||||
|
||||
Font-awesome
|
||||
============
|
||||
http://fontawesome.io/
|
||||
|
||||
Licensing information:
|
||||
|
||||
- http://fontawesome.io/license/
|
||||
- SIL OFL 1.1 (http://scripts.sil.org/OFL)
|
||||
- MIT (http://opensource.org/licenses/mit-license.html)
|
||||
|
||||
Foundation 5
|
||||
============
|
||||
http://foundation.zurb.com/
|
||||
|
||||
Licensing information:
|
||||
|
||||
- MIT (http://opensource.org/licenses/mit-license.html)
|
||||
|
||||
Foundation 5 DateTime picker
|
||||
============================
|
||||
https://github.com/aliibrahim/foundation-datetimepicker-rails
|
||||
|
||||
Licensing information:
|
||||
|
||||
- MIT (http://opensource.org/licenses/mit-license.html)
|
||||
|
||||
jQuery Colorbox
|
||||
===============
|
||||
http://www.jacklmoore.com/colorbox/
|
||||
|
||||
Licensing information:
|
||||
|
||||
- MIT (http://www.opensource.org/licenses/mit-license.php)
|
||||
|
||||
jQuery
|
||||
======
|
||||
https://jquery.org
|
||||
|
||||
Licensing information:
|
||||
|
||||
- https://jquery.org/license/
|
||||
- MIT (http://github.com/jquery/jquery/blob/master/MIT-LICENSE.txt)
|
||||
|
||||
jQueryUI
|
||||
========
|
||||
http://jqueryui.com/
|
||||
|
||||
Licensing information:
|
||||
|
||||
- MIT (https://github.com/jquery/jquery-ui/blob/master/MIT-LICENSE.txt)
|
||||
|
||||
jQuery-Slugify-Plugin
|
||||
=====================
|
||||
https://github.com/pmcelhaney/jQuery-Slugify-Plugin
|
||||
|
||||
Licensing information:
|
||||
|
||||
- BSD (https://github.com/pmcelhaney/jQuery-Slugify-Plugin/blob/master/LICENSE).
|
||||
|
||||
moment.js
|
||||
=========
|
||||
http://momentjs.com/
|
||||
|
||||
Licensing information:
|
||||
|
||||
- MIT (http://opensource.org/licenses/mit-license.html)
|
||||
|
||||
ordereddict
|
||||
===========
|
||||
https://pypi.python.org/pypi/ordereddict
|
||||
|
||||
Licensing information:
|
||||
|
||||
- MIT (http://opensource.org/licenses/mit-license.html)
|
||||
|
||||
Pillow
|
||||
======
|
||||
http://python-pillow.github.io/
|
||||
|
||||
Licensing information:
|
||||
|
||||
- Python Imaging Library license (http://www.pythonware.com/products/pil/)
|
||||
|
||||
Requests
|
||||
========
|
||||
https://python-requests.org
|
||||
|
||||
Licensing information:
|
||||
|
||||
- MIT (http://opensource.org/licenses/mit-license.html)
|
||||
|
||||
Six
|
||||
===
|
||||
https://bitbucket.org/gutworth/six/
|
||||
|
||||
Licensing information:
|
||||
|
||||
- Apache 2.0 (http://opensource.org/licenses/Apache-2.0)
|
||||
|
||||
Unidecode
|
||||
=========
|
||||
https://pypi.python.org/pypi/Unidecode
|
||||
|
||||
Licensing information:
|
||||
|
||||
- GPL 2.0 (http://www.gnu.org/licenses/gpl-2.0.html)
|
||||
|
||||
vishap
|
||||
======
|
||||
https://pypi.python.org/pypi/vishap
|
||||
|
||||
Licensing information:
|
||||
|
||||
- GPL 2.0 (http://www.gnu.org/licenses/gpl-2.0.html)
|
||||
- LGPL 2.1 (https://www.gnu.org/licenses/lgpl-2.1.html)
|
||||
.. include:: ../LICENSES.rst
|
||||
|
|
@ -1,275 +1 @@
|
|||
===========
|
||||
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:: sh
|
||||
|
||||
pip install django-fobi
|
||||
|
||||
INSTALLED_APPS
|
||||
^^^^^^^^^^^^^^
|
||||
Add ``fobi`` core and the plugins to the ``INSTALLED_APPS`` of the your
|
||||
``settings`` module.
|
||||
|
||||
1. The core.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
'fobi',
|
||||
|
||||
2. The preferred theme. Bootstrap 3 theme is the default. If you have chosen a
|
||||
different theme, update the value of ``FOBI_DEFAULT_THEME`` accordingly.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
'fobi.contrib.themes.bootstrap3',
|
||||
|
||||
3. The form field plugins. Plugins are like blocks. You are recommended to have
|
||||
them all installed. Note, that the following plugins do not have
|
||||
additional dependencies, while some others (like
|
||||
`fobi.contrib.plugins.form_elements.security.captcha
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/security/captcha/>`_
|
||||
or `fobi.contrib.plugins.form_elements.security.recaptcha
|
||||
<https://github.com/barseghyanartur/django-fobi/tree/stable/src/fobi/contrib/plugins/form_elements/security/recaptcha/>`_
|
||||
would require additional packages to be installed. If so, make sure to have
|
||||
installed and configured those dependencies prior adding the dependant
|
||||
add-ons to the ``settings`` module.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
'fobi.contrib.plugins.form_elements.fields.boolean',
|
||||
'fobi.contrib.plugins.form_elements.fields.checkbox_select_multiple',
|
||||
'fobi.contrib.plugins.form_elements.fields.date',
|
||||
'fobi.contrib.plugins.form_elements.fields.date_drop_down',
|
||||
'fobi.contrib.plugins.form_elements.fields.datetime',
|
||||
'fobi.contrib.plugins.form_elements.fields.decimal',
|
||||
'fobi.contrib.plugins.form_elements.fields.email',
|
||||
'fobi.contrib.plugins.form_elements.fields.file',
|
||||
'fobi.contrib.plugins.form_elements.fields.float',
|
||||
'fobi.contrib.plugins.form_elements.fields.hidden',
|
||||
'fobi.contrib.plugins.form_elements.fields.input',
|
||||
'fobi.contrib.plugins.form_elements.fields.integer',
|
||||
'fobi.contrib.plugins.form_elements.fields.ip_address',
|
||||
'fobi.contrib.plugins.form_elements.fields.null_boolean',
|
||||
'fobi.contrib.plugins.form_elements.fields.password',
|
||||
'fobi.contrib.plugins.form_elements.fields.radio',
|
||||
'fobi.contrib.plugins.form_elements.fields.regex',
|
||||
'fobi.contrib.plugins.form_elements.fields.select',
|
||||
'fobi.contrib.plugins.form_elements.fields.select_model_object',
|
||||
'fobi.contrib.plugins.form_elements.fields.select_multiple',
|
||||
'fobi.contrib.plugins.form_elements.fields.select_multiple_model_objects',
|
||||
'fobi.contrib.plugins.form_elements.fields.slug',
|
||||
'fobi.contrib.plugins.form_elements.fields.text',
|
||||
'fobi.contrib.plugins.form_elements.fields.textarea',
|
||||
'fobi.contrib.plugins.form_elements.fields.time',
|
||||
'fobi.contrib.plugins.form_elements.fields.url',
|
||||
|
||||
4. The presentational form elements (images, texts, videos).
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
'easy_thumbnails', # Required by `content_image` plugin
|
||||
'fobi.contrib.plugins.form_elements.content.content_image',
|
||||
'fobi.contrib.plugins.form_elements.content.content_image_url',
|
||||
'fobi.contrib.plugins.form_elements.content.content_text',
|
||||
'fobi.contrib.plugins.form_elements.content.content_video',
|
||||
|
||||
5. Form handlers. Note, that some of them may require database sync/migration.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
'fobi.contrib.plugins.form_handlers.db_store',
|
||||
'fobi.contrib.plugins.form_handlers.http_repost',
|
||||
'fobi.contrib.plugins.form_handlers.mail',
|
||||
'fobi.contrib.plugins.form_handlers.mail_sender',
|
||||
|
||||
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',
|
||||
|
||||
# Theme
|
||||
'fobi.contrib.themes.bootstrap3',
|
||||
|
||||
# Form field plugins
|
||||
'fobi.contrib.plugins.form_elements.fields.boolean',
|
||||
'fobi.contrib.plugins.form_elements.fields.checkbox_select_multiple',
|
||||
'fobi.contrib.plugins.form_elements.fields.date',
|
||||
'fobi.contrib.plugins.form_elements.fields.date_drop_down',
|
||||
'fobi.contrib.plugins.form_elements.fields.datetime',
|
||||
'fobi.contrib.plugins.form_elements.fields.decimal',
|
||||
'fobi.contrib.plugins.form_elements.fields.email',
|
||||
'fobi.contrib.plugins.form_elements.fields.file',
|
||||
'fobi.contrib.plugins.form_elements.fields.float',
|
||||
'fobi.contrib.plugins.form_elements.fields.hidden',
|
||||
'fobi.contrib.plugins.form_elements.fields.input',
|
||||
'fobi.contrib.plugins.form_elements.fields.integer',
|
||||
'fobi.contrib.plugins.form_elements.fields.ip_address',
|
||||
'fobi.contrib.plugins.form_elements.fields.null_boolean',
|
||||
'fobi.contrib.plugins.form_elements.fields.password',
|
||||
'fobi.contrib.plugins.form_elements.fields.radio',
|
||||
'fobi.contrib.plugins.form_elements.fields.regex',
|
||||
'fobi.contrib.plugins.form_elements.fields.select',
|
||||
'fobi.contrib.plugins.form_elements.fields.select_model_object',
|
||||
'fobi.contrib.plugins.form_elements.fields.select_multiple',
|
||||
'fobi.contrib.plugins.form_elements.fields.select_multiple_model_objects',
|
||||
'fobi.contrib.plugins.form_elements.fields.slug',
|
||||
'fobi.contrib.plugins.form_elements.fields.text',
|
||||
'fobi.contrib.plugins.form_elements.fields.textarea',
|
||||
'fobi.contrib.plugins.form_elements.fields.time',
|
||||
'fobi.contrib.plugins.form_elements.fields.url',
|
||||
|
||||
# Form element plugins
|
||||
'easy_thumbnails', # Required by ``content_image`` plugin
|
||||
'fobi.contrib.plugins.form_elements.content.content_image',
|
||||
'fobi.contrib.plugins.form_elements.content.content_image_url',
|
||||
'fobi.contrib.plugins.form_elements.content.content_text',
|
||||
'fobi.contrib.plugins.form_elements.content.content_video',
|
||||
|
||||
# Form handlers
|
||||
'fobi.contrib.plugins.form_handlers.db_store',
|
||||
'fobi.contrib.plugins.form_handlers.http_repost',
|
||||
'fobi.contrib.plugins.form_handlers.mail',
|
||||
'fobi.contrib.plugins.form_handlers.mail_sender',
|
||||
|
||||
# ...
|
||||
)
|
||||
|
||||
TEMPLATE_CONTEXT_PROCESSORS
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Add ``django.core.context_processors.request`` and
|
||||
``fobi.context_processors.theme`` to ``TEMPLATES`` of
|
||||
your ``settings`` module.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
TEMPLATES = [
|
||||
{
|
||||
'BACKEND': 'django.template.backends.django.DjangoTemplates',
|
||||
'DIRS': [(os.path.join('path', 'to', 'your', 'templates'))],
|
||||
'OPTIONS': {
|
||||
'context_processors': [
|
||||
"django.template.context_processors.debug",
|
||||
'django.template.context_processors.request',
|
||||
"django.contrib.auth.context_processors.auth",
|
||||
"django.contrib.messages.context_processors.messages",
|
||||
"fobi.context_processors.theme", # Important!
|
||||
"fobi.context_processors.dynamic_values", # Optional
|
||||
],
|
||||
'loaders': [
|
||||
'django.template.loaders.filesystem.Loader',
|
||||
'django.template.loaders.app_directories.Loader',
|
||||
'admin_tools.template_loaders.Loader',
|
||||
],
|
||||
'debug': DEBUG_TEMPLATE,
|
||||
}
|
||||
},
|
||||
]
|
||||
|
||||
urlpatterns
|
||||
^^^^^^^^^^^
|
||||
Add the following line to ``urlpatterns`` of your ``urls`` module.
|
||||
|
||||
.. 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')),
|
||||
|
||||
# View URLs
|
||||
url(r'^fobi/', include('fobi.urls.view')),
|
||||
|
||||
# Edit URLs
|
||||
url(r'^fobi/', include('fobi.urls.edit')),
|
||||
|
||||
# ...
|
||||
]
|
||||
|
||||
Update the database
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
1. First you should migrate the database. Depending on your
|
||||
Django version and migration app, this step may vary. Typically as follows:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
./manage.py migrate --fake-initial
|
||||
|
||||
2. Sync installed ``fobi`` plugins. Go to terminal and type the following
|
||||
command.
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
./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
|
||||
to switch the permission checks off, set the value of
|
||||
``FOBI_RESTRICT_PLUGIN_ACCESS`` to False in your `settings` module.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
FOBI_RESTRICT_PLUGIN_ACCESS = False
|
||||
|
||||
Otherwise, after having completed all the steps above, do log into the
|
||||
Django administration and assign the permissions (to certain user or a group)
|
||||
for every single form element or form handler plugin. Bulk assignments work
|
||||
as well.
|
||||
|
||||
- http://yourdomain.com/admin/fobi/formelement/
|
||||
- http://yourdomain.com/admin/fobi/formhandler/
|
||||
|
||||
Also, make sure to have the Django model permissions set for following models:
|
||||
|
||||
- `fobi.models.FormEntry
|
||||
<https://github.com/barseghyanartur/django-fobi/blob/stable/src/fobi/models.py#L253>`_
|
||||
- `fobi.models.FormElementEntry
|
||||
<https://github.com/barseghyanartur/django-fobi/blob/stable/src/fobi/models.py#L427>`_
|
||||
- `fobi.models.FormHandlerEntry
|
||||
<https://github.com/barseghyanartur/django-fobi/blob/stable/src/fobi/models.py#L463>`_
|
||||
- `fobi.contrib.plugins.form_handlers.db_store.models.SavedFormDataEntry
|
||||
<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...
|
||||
.. include:: ../QUICK_START.rst
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
#./scripts/uninstall.sh
|
||||
#./scripts/install.sh
|
||||
./scripts/prepare_docs.sh
|
||||
#./scripts/prepare_docs.sh
|
||||
sphinx-build -n -a -b html docs builddocs
|
||||
#sphinx-build -n -a -b pdf docs builddocs
|
||||
cd builddocs && zip -r ../builddocs.zip . -x ".*" && cd ..
|
||||
|
|
|
|||
|
|
@ -1,286 +1,286 @@
|
|||
cat README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
docs/screenshots.rst.distrib \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
docs/documentation.rst.distrib \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
docs/submodules.rst.distrib \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/djangocms_integration/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/content/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/content/content_image/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/content/content_image_url/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/content/content_richtext/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/content/content_text/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/content/content_video/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/boolean/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/checkbox_select_multiple/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/date/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/date_drop_down/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/datetime/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/decimal/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/email/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/file/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/float/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/hidden/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/input/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/integer/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/ip_address/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/null_boolean/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/password/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/radio/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/range_select/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/regex/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/select/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/select_multiple/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/select_multiple_with_max/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/slider/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/slug/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/text/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/textarea/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/time/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_elements/fields/url/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_handlers/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_handlers/db_store/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_handlers/http_repost/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/drf_integration/form_handlers/mail/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/feincms_integration/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/apps/mezzanine_integration/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/content/content_image/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/content/content_image_url/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/content/content_text/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/content/content_richtext/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/content/content_video/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/boolean/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/checkbox_select_multiple/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/date/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/date_drop_down/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/datetime/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/decimal/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/email/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/file/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/float/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/hidden/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/input/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/integer/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/ip_address/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/null_boolean/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/password/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/radio/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/range_select/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/regex/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/select/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/select_model_object/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/select_mptt_model_object/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/select_multiple/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/select_multiple_model_objects/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/select_multiple_mptt_model_objects/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/select_multiple_with_max/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/slider/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/text/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/textarea/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/time/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/fields/url/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/security/captcha/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/security/honeypot/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/security/recaptcha/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_elements/test/dummy/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_handlers/db_store/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_handlers/http_repost/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_handlers/mail/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/plugins/form_importers/mailchimp_importer/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/themes/bootstrap3/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/themes/djangocms_admin_style_theme/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/themes/foundation5/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
src/fobi/contrib/themes/simple/README.rst \
|
||||
docs/empty.rst.distrib \
|
||||
\
|
||||
> docs/index.rst
|
||||
cat QUICK_START.rst > docs/quickstart.rst
|
||||
cat CHANGELOG.rst > docs/changelog.rst
|
||||
cat LICENSES.rst > docs/licenses.rst
|
||||
#cat README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# docs/screenshots.rst.distrib \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# docs/documentation.rst.distrib \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# docs/submodules.rst.distrib \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/djangocms_integration/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/content/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/content/content_image/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/content/content_image_url/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/content/content_richtext/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/content/content_text/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/content/content_video/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/boolean/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/checkbox_select_multiple/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/date/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/date_drop_down/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/datetime/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/decimal/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/email/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/file/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/float/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/hidden/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/input/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/integer/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/ip_address/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/null_boolean/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/password/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/radio/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/range_select/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/regex/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/select/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/select_multiple/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/select_multiple_with_max/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/slider/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/slug/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/text/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/textarea/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/time/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_elements/fields/url/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_handlers/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_handlers/db_store/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_handlers/http_repost/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/drf_integration/form_handlers/mail/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/feincms_integration/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/apps/mezzanine_integration/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/content/content_image/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/content/content_image_url/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/content/content_text/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/content/content_richtext/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/content/content_video/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/boolean/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/checkbox_select_multiple/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/date/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/date_drop_down/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/datetime/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/decimal/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/email/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/file/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/float/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/hidden/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/input/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/integer/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/ip_address/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/null_boolean/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/password/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/radio/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/range_select/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/regex/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/select/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/select_model_object/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/select_mptt_model_object/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/select_multiple/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/select_multiple_model_objects/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/select_multiple_mptt_model_objects/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/select_multiple_with_max/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/slider/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/text/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/textarea/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/time/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/fields/url/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/security/captcha/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/security/honeypot/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/security/recaptcha/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_elements/test/dummy/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_handlers/db_store/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_handlers/http_repost/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_handlers/mail/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/plugins/form_importers/mailchimp_importer/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/themes/bootstrap3/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/themes/djangocms_admin_style_theme/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/themes/foundation5/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# src/fobi/contrib/themes/simple/README.rst \
|
||||
# docs/empty.rst.distrib \
|
||||
# \
|
||||
# > docs/index.rst
|
||||
#cat QUICK_START.rst > docs/quickstart.rst
|
||||
#cat CHANGELOG.rst > docs/changelog.rst
|
||||
#cat LICENSES.rst > docs/licenses.rst
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
#./scripts/uninstall.sh
|
||||
#./scripts/install.sh
|
||||
rm docs/*.rst
|
||||
#rm docs/*.rst
|
||||
rm -rf builddocs/
|
||||
sphinx-apidoc src/fobi --full -o docs -H 'django-fobi' -A 'Artur Barseghyan <artur.barseghyan@gmail.com>' -V '0.1' -f -d 20
|
||||
cp docs/conf.distrib docs/conf.py
|
||||
|
|
|
|||
2
setup.py
2
setup.py
|
|
@ -94,7 +94,7 @@ try:
|
|||
screenshots = screenshots.replace(
|
||||
".. image:: _static",
|
||||
".. figure:: https://github.com/barseghyanartur/django-fobi/raw/"
|
||||
"master/docs/_static",
|
||||
"main/docs/_static",
|
||||
)
|
||||
except:
|
||||
readme = ""
|
||||
|
|
|
|||
|
|
@ -478,13 +478,13 @@ Meta-data is passed to the ``DRFIntegrationFormElementPluginProcessor`` as
|
|||
``field_metadata`` argument, which is supposed to be a dict.
|
||||
|
||||
- `Example 1: content_image plugin
|
||||
<https://github.com/barseghyanartur/django-fobi/blob/master/src/fobi/contrib/apps/drf_integration/form_elements/content/content_image/base.py#L54>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/blob/main/src/fobi/contrib/apps/drf_integration/form_elements/content/content_image/base.py#L54>`_
|
||||
|
||||
- `Example 2: decimal plugin
|
||||
<https://github.com/barseghyanartur/django-fobi/blob/master/src/fobi/contrib/apps/drf_integration/form_elements/fields/decimal/base.py#L86>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/blob/main/src/fobi/contrib/apps/drf_integration/form_elements/fields/decimal/base.py#L86>`_
|
||||
|
||||
- `Example 3: text plugin
|
||||
<https://github.com/barseghyanartur/django-fobi/blob/master/src/fobi/contrib/apps/drf_integration/form_elements/fields/text/base.py#L55>`_
|
||||
<https://github.com/barseghyanartur/django-fobi/blob/main/src/fobi/contrib/apps/drf_integration/form_elements/fields/text/base.py#L55>`_
|
||||
|
||||
Private forms would be only visible to authenticated users.
|
||||
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ Must haves
|
|||
+ Fixed Python3 issues with max_length for text fields.
|
||||
+ In decimal plugin, if any of the values are None, don't try to cast them
|
||||
into Decimal.
|
||||
+ Fix this https://github.com/barseghyanartur/django-fobi/blob/master/src/fobi/contrib/apps/drf_integration/views.py#L151
|
||||
+ Fix this https://github.com/barseghyanartur/django-fobi/blob/main/src/fobi/contrib/apps/drf_integration/views.py#L151
|
||||
It should not be form = ... but serializer = ...
|
||||
|
||||
Should haves
|
||||
|
|
|
|||
|
|
@ -10,9 +10,9 @@ Install `django-recaptcha`
|
|||
##########################
|
||||
(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``.
|
||||
|
||||
|
|
@ -21,31 +21,31 @@ Install `django-recaptcha`
|
|||
Install `fobi` ReCAPTCHA plugin
|
||||
###############################
|
||||
(1) Add ``fobi.contrib.plugins.form_elements.security.recaptcha`` to the
|
||||
``INSTALLED_APPS`` in your ``settings.py``.
|
||||
``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:
|
||||
|
||||
.. 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.
|
||||
the plugin if ``FOBI_RESTRICT_PLUGIN_ACCESS`` is set to True.
|
||||
|
||||
(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``
|
||||
|
||||
For testing purposes obtain the keys `here
|
||||
<https://developers.google.com/recaptcha/docs/faq#id-like-to-run-automated-tests-with-recaptcha.-what-should-i-do>`_:
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ Development status
|
|||
~~~~~~~~~~~~~~~~~~
|
||||
This part of code is alpha, which means it experimental and needs improvements.
|
||||
|
||||
See the `TODOS <https://raw.githubusercontent.com/barseghyanartur/django-fobi/master/TODOS.rst>`_
|
||||
See the `TODOS <https://raw.githubusercontent.com/barseghyanartur/django-fobi/main/TODOS.rst>`_
|
||||
for the full list of planned-, pending- in-development- or to-be-implemented
|
||||
features.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
fobi.wizard
|
||||
===========
|
||||
Persistent and working form-wizards for Django.
|
||||
Persistent and working form-wizards.
|
||||
|
|
|
|||
Loading…
Reference in a new issue