Merge branch 'release-2.1.4'

closes #143

README.md

@@ -29,6 +29,7 @@ Login with user `demo` and password `demo`
     - [Menu](#configuration-menu)
     - [Search Field](#configuration-search-field)
     - [Analytics](#configuration-analytics)
+- [Page Detection](#page-detection)
 - [Signals](#signals)
 - [Js Utilities](#js-utilities)
 - [Js Translations](#js-translations)
@@ -336,6 +337,33 @@ Once the service account is created, you can click the Generate New JSON Key but
 
 Add the service account as a user in Google Analytics. The service account you created in the previous step has an email address that you can add to any of the Google Analytics views you'd like to request the data from. It's generally best to only grant the service account read-only access.
 
+## <a name="page-detection"></a>Page Detection
+
+Baton triggers some of its functionalities basing upon the current page. For example, it will trigger the tab functionality only when the current page is an add form or change form page.
+
+Baton understands which page is currently displayed performing some basic regular expressions against the location pathname.
+There may be cases in which you'd like to serve such contents at different and custom urls, in such cases you need a way to tell Baton which kind of page is tied to that url.
+
+For this reason you can inject your custom hook, a javascript function which should return the page type and that receives as first argument the Baton's default function to use as fallback, i.e.
+
+``` html
+<!-- admin/base_site.html -->
+<script>
+    (function ($, undefined) {
+        $(document).ready(function () {
+            Baton.detectPageHook = fn => /newschange/.test(location.pathname) ? 'change_form' : fn()
+            Baton.init(JSON.parse(document.getElementById('baton-config').textContent));
+        })
+    })(jQuery, undefined)
+</script>
+```
+
+In this case we tell Baton that when the location pathname includes the string `newschange`, then the page should be considered a `change_form`, otherwise we let Baton guess the page type.
+
+So, in order to hook into the Baton page detection system, just define a `Baton.detectPageHook` function which receives the default function as first argument and should return the page type.
+
+The available page types are the following: `dashboard`, `admindocs`, `login`, `logout`, `passowrd_change`, `password_change_success`, `add_form`, `change_form`, `changelist`, `filer`, `default`.
+
 ## <a name="signals"></a>Signals
 
 Baton provides a dispatcher that can be used to register function that will be called when some events occurr.

baton/static/baton/app/package.json

@@ -1,6 +1,6 @@
 {
   "name": "baton",
-  "version": "2.1.3",
+  "version": "2.1.4",
   "description": "Django Baton App",
   "main": "index.js",
   "scripts": {

baton/static/baton/app/src/index.js

@@ -24,7 +24,7 @@ window.Baton = {
   init: function (config) {
     console.info('Baton:', 'init')
     this.initialized = true
-    let page = this.page()
+    let page = this.detectPageHook ? this.detectPageHook(this.page) : this.page()
     $('body').addClass('page-' + page)
 
     // toasts

docs/conf.py

@@ -54,9 +54,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'2.1.3'
+version = u'2.1.4'
 # The full version, including alpha/beta/rc tags.
-release = u'2.1.3'
+release = u'2.1.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/index.rst

@@ -35,6 +35,7 @@ Getting started
 
    installation
    configuration
+   page_detection
    signals
    js_utilities
    js_translations

docs/page_detection.rst

@@ -0,0 +1,25 @@
+Page Detection
+==============
+
+Baton triggers some of its functionalities basing upon the current page. For example, it will trigger the tab functionality only when the current page is an add form or change form page.
+
+Baton understands which page is currently displayed performing some basic regular expressions against the location pathname.
+There may be cases in which you'd like to serve such contents at different and custom urls, in such cases you need a way to tell Baton which kind of page is tied to that url.
+
+For this reason you can inject your custom hook, a javascript function which should return the page type and that receives as first argument the Baton's default function to use as fallback, i.e. ::
+
+    <!-- admin/base_site.html -->
+    <script>
+        (function ($, undefined) {
+            $(document).ready(function () {
+                Baton.detectPageHook = fn => /newschange/.test(location.pathname) ? 'change_form' : fn()
+                Baton.init(JSON.parse(document.getElementById('baton-config').textContent));
+            })
+        })(jQuery, undefined)
+    </script>
+
+In this case we tell Baton that when the location pathname includes the string ``newschange``, then the page should be considered a ``change_form``, otherwise we let Baton guess the page type.
+
+So, in order to hook into the Baton page detection system, just define a ``Baton.detectPageHook`` function which receives the default function as first argument and should return the page type.
+
+The available page types are the following: ``dashboard``, ``admindocs``, ``login``, ``logout``, ``passowrd_change``, ``password_change_success``, ``add_form``, ``change_form``, ``changelist``, ``filer``, ``default``.

setup.py

@@ -11,7 +11,7 @@
 
 setup(
     name='django-baton',
-    version='2.1.3',
+    version='2.1.4',
     packages=['baton', 'baton.autodiscover', 'baton.templatetags'],
     include_package_data=True,
     license='MIT License',

testapp/app/app/settings.py

@@ -199,6 +199,11 @@
                     'label': 'Google search',
                     'url': 'http://www.google.it'
                 },
+                # {
+                #     'type': 'free',
+                #     'label': 'Dalla change form',
+                #     'url': '/admin/newschange/3'
+                # },
             ]
         },
     ),

testapp/app/app/urls.py

@@ -19,10 +19,12 @@
 from django.views import static
 from django.contrib.staticfiles.views import serve
 from app.views import admin_search
+from news.views import news_change_view
 
 urlpatterns = [
     path('admin/doc/', include('django.contrib.admindocs.urls')),
     path('admin/search/', admin_search),
+    # path('admin/newschange/<int:id>', news_change_view),
     path('admin/', admin.site.urls),
     path('baton/', include('baton.urls')),
     path('tinymce/', include('tinymce.urls')),

testapp/app/news/views.py

@@ -1,3 +1,9 @@
 from django.shortcuts import render
+from .admin import NewsAdmin
+from .models import News
+from baton.autodiscover import admin
 
 # Create your views here.
+
+def news_change_view(request, id):
+    return NewsAdmin(News, admin.site).change_view(request, str(id))