diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a6c6210c..5d57d25c 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -15,6 +15,12 @@ are used for versioning (schema follows below): 0.3.4 to 0.4). - All backwards incompatible changes are mentioned in this document. +0.12 +---- +2017-06-dd (not release yet) + +- Wagtail integration. + 0.11.13 ------- 2017-06-10 diff --git a/MANIFEST.in b/MANIFEST.in index 7b03cd7a..f3a13d2e 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -41,6 +41,7 @@ recursive-include src/fobi/contrib/themes/djangocms_admin_style_theme/templates recursive-include src/fobi/contrib/apps/djangocms_integration/templates * #recursive-include src/fobi/contrib/apps/feincms_integration/templates * recursive-include src/fobi/contrib/apps/mezzanine_integration/templates * +recursive-include src/fobi/contrib/apps/wagtail_integration/templates * recursive-include src/fobi/contrib/plugins/form_elements/content/content_image/templates * recursive-include src/fobi/contrib/plugins/form_elements/content/content_image_url/templates * diff --git a/setup.py b/setup.py index c8a2b980..b3a4898f 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ import sys from distutils.version import LooseVersion from setuptools import setup, find_packages -version = '0.11.13' +version = '0.12' # *************************************************************************** # ************************** Python version ********************************* @@ -122,6 +122,10 @@ template_dirs = [ "src/fobi/contrib/apps/mezzanine_integration/templates/" "mezzanine_integration", + # Wagtail integration + "src/fobi/contrib/apps/wagtail_integration/templates/" + "wagtail_integration", + # Content image "src/fobi/contrib/plugins/form_elements/content/content_image/" "templates/content_image", diff --git a/src/fobi/__init__.py b/src/fobi/__init__.py index 459be2e5..7bde7a8a 100644 --- a/src/fobi/__init__.py +++ b/src/fobi/__init__.py @@ -1,6 +1,6 @@ __title__ = 'django-fobi' -__version__ = '0.11.13' -__build__ = 0x000088 +__version__ = '0.12' +__build__ = 0x000089 __author__ = 'Artur Barseghyan ' __copyright__ = '2014-2017 Artur Barseghyan' __license__ = 'GPL 2.0/LGPL 2.1' diff --git a/src/fobi/contrib/apps/wagtail_integration/README.rst b/src/fobi/contrib/apps/wagtail_integration/README.rst index 07219312..cab145ab 100644 --- a/src/fobi/contrib/apps/wagtail_integration/README.rst +++ b/src/fobi/contrib/apps/wagtail_integration/README.rst @@ -32,8 +32,15 @@ See the `example settings file 'fobi.contrib.apps.wagtail_integration', # Wagtail integration app ] -your_project/page/models.py -########################### +your_project/your_app/models.py +############################### +If existing ``fobi.contrib.apps.wagtail_integration.models.FobiFormPage`` +model does not fit your needs and you want to extend, there's a +``fobi.contrib.apps.wagtail_integration.abstract.AbstractFobiFormPage`` +abstract model which you can extend. If so, remove the +``fobi.contrib.apps.wagtail_integration`` from ``INSTALLED_APPS`` and add +path to the app with your customised ``FobiFormPage`` model. + .. code-block:: python from fobi.contrib.apps.wagtail_integration.models import AbstractFobiFormPage @@ -43,6 +50,17 @@ your_project/page/models.py # ... customise your form page further +And then: + +.. code-block:: python + + INSTALLED_APPS = [ + # ... standard wagtail apps + + # ... standard django-fobi apps + + 'your_app', # Customised `FobiFormPage` model app + ] Information for developers ########################## diff --git a/src/fobi/contrib/apps/wagtail_integration/abstract.py b/src/fobi/contrib/apps/wagtail_integration/abstract.py index 1aba7587..fdb23c49 100644 --- a/src/fobi/contrib/apps/wagtail_integration/abstract.py +++ b/src/fobi/contrib/apps/wagtail_integration/abstract.py @@ -216,6 +216,7 @@ class AbstractFobiFormPage(Page): """Serve the page in Wagtail's 'preview' mode.""" if mode == 'success': fobi_form_processor = FobiFormProcessor() + # TODO: Returning HttpResponse seems dirty. See if it can be # replaced with TemplateResponse. return HttpResponse( diff --git a/src/fobi/contrib/apps/wagtail_integration/models.py b/src/fobi/contrib/apps/wagtail_integration/models.py index 7756a688..bffc6b48 100644 --- a/src/fobi/contrib/apps/wagtail_integration/models.py +++ b/src/fobi/contrib/apps/wagtail_integration/models.py @@ -11,3 +11,6 @@ __all__ = ('FobiFormPage',) class FobiFormPage(AbstractFobiFormPage): """Fobi form page.""" + + form_template = 'wagtail_integration/fobi_form_page.html' + success_template = 'wagtail_integration/fobi_form_page_success.html' diff --git a/src/fobi/contrib/apps/wagtail_integration/templates/fobi_form_page.html.example b/src/fobi/contrib/apps/wagtail_integration/templates/fobi_form_page.html.example deleted file mode 100644 index 2d2b5b02..00000000 --- a/src/fobi/contrib/apps/wagtail_integration/templates/fobi_form_page.html.example +++ /dev/null @@ -1,23 +0,0 @@ -{% extends "pages/page.html" %} - -{% load static %} - -{% block extra_css %} - {{ block.super }} - {% for css_file in fobi_theme.get_media_css %} - - {% endfor %} -{% endblock extra_css %} - -{% block main %} - {{ block.super }} - {% if not fobi_hide_form_title and fobi_form_title %}

{{ fobi_form_title }}

{% endif %} - {% include fobi_theme.form_snippet_template_name %} -{% endblock main %} - -{% block extra_js %} - {{ block.super }} - {% for js_file in fobi_theme.get_media_js %} - - {% endfor %} -{% endblock extra_js %} diff --git a/src/fobi/contrib/apps/wagtail_integration/templates/fobi_form_page_success.html.example b/src/fobi/contrib/apps/wagtail_integration/templates/fobi_form_page_success.html.example deleted file mode 100644 index 035ee13d..00000000 --- a/src/fobi/contrib/apps/wagtail_integration/templates/fobi_form_page_success.html.example +++ /dev/null @@ -1,6 +0,0 @@ -{% extends "pages/page.html" %} - -{% block main %} -

{{ fobi_success_page_title }}

-

{{ fobi_success_page_text }}

-{% endblock main %} diff --git a/src/fobi/contrib/apps/wagtail_integration/templates/wagtail_integration/README.rst b/src/fobi/contrib/apps/wagtail_integration/templates/wagtail_integration/README.rst new file mode 100644 index 00000000..953e50d7 --- /dev/null +++ b/src/fobi/contrib/apps/wagtail_integration/templates/wagtail_integration/README.rst @@ -0,0 +1,12 @@ +Example templates for ``wagtail_integration`` app. + +Both pages extend from "page/base.html", which does not exist, unless +you make it. + +**fobi_form_page.html** + +Rendering the form page. + +**fobi_form_page_success.html** + +Rendering the success page. diff --git a/src/fobi/contrib/apps/wagtail_integration/templates/wagtail_integration/fobi_form_page.html b/src/fobi/contrib/apps/wagtail_integration/templates/wagtail_integration/fobi_form_page.html new file mode 100644 index 00000000..9d49e6f0 --- /dev/null +++ b/src/fobi/contrib/apps/wagtail_integration/templates/wagtail_integration/fobi_form_page.html @@ -0,0 +1,56 @@ +{% extends "page/base.html" %} +{% load i18n static %} + +{% block extra_css %} + {{ block.super }} + {% for css_file in fobi_theme.get_media_css %} + + {% endfor %} +{% endblock extra_css %} + +{% block form_page_header_wrapper %} + + {{ block.super }} +{% endblock %} + +{% block content %} + {% include fobi_theme.view_embed_form_entry_ajax_template %} +{% endblock %} + +{% block extra_js %} + {{ block.super }} + {% for js_file in fobi_theme.get_media_js %} + + {% endfor %} +{% endblock extra_js %} + + + +{% comment %} +{% extends "demo/base.html" %} + +{% load static %} + +{% block extra_css %} + {{ block.super }} + {% for css_file in fobi_theme.get_media_css %} + + {% endfor %} +{% endblock extra_css %} + +{% block content %} + {{ block.super }} + {% if not fobi_hide_form_title and fobi_form_title %}

{{ fobi_form_title }}

{% endif %} + {% include fobi_theme.form_snippet_template_name %} +{% endblock content %} + +{% block extra_js %} + {{ block.super }} + {% for js_file in fobi_theme.get_media_js %} + + {% endfor %} +{% endblock extra_js %} +{% endcomment %} \ No newline at end of file diff --git a/src/fobi/contrib/apps/wagtail_integration/templates/wagtail_integration/fobi_form_page_success.html b/src/fobi/contrib/apps/wagtail_integration/templates/wagtail_integration/fobi_form_page_success.html new file mode 100644 index 00000000..ba997199 --- /dev/null +++ b/src/fobi/contrib/apps/wagtail_integration/templates/wagtail_integration/fobi_form_page_success.html @@ -0,0 +1,39 @@ +{% extends "page/base.html" %} +{% load i18n static %} + +{% block extra_css %} + {{ block.super }} + {% for css_file in fobi_theme.get_media_css %} + + {% endfor %} +{% endblock extra_css %} + +{% block form_page_header_wrapper %} + + {{ block.super }} +{% endblock %} + +{% block content %} + {% include fobi_theme.embed_form_entry_submitted_ajax_template %} +{% endblock %} + +{% block extra_js %} + {{ block.super }} + {% for js_file in fobi_theme.get_media_js %} + + {% endfor %} +{% endblock extra_js %} + + + +{% comment %} +{% extends "pages/page.html" %} + +{% block main %} +

{{ fobi_success_page_title }}

+

{{ fobi_success_page_text }}

+{% endblock main %} +{% endcomment %} \ No newline at end of file