From 033d2dc02f12e2504b8ca3b9eefc2c2ba87981d0 Mon Sep 17 00:00:00 2001 From: Peter Bittner Date: Mon, 21 Jul 2025 16:41:22 +0200 Subject: [PATCH] Align spelling of JavaScript across all files (docs, docstrings) --- CHANGELOG.rst | 5 +++++ README.rst | 4 ++-- analytical/templatetags/chartbeat.py | 4 ++-- analytical/templatetags/clickmap.py | 2 +- analytical/templatetags/clicky.py | 2 +- analytical/templatetags/crazy_egg.py | 2 +- analytical/templatetags/gauges.py | 2 +- analytical/templatetags/google_analytics.py | 2 +- analytical/templatetags/google_analytics_gtag.py | 2 +- analytical/templatetags/google_analytics_js.py | 2 +- analytical/templatetags/gosquared.py | 2 +- analytical/templatetags/heap.py | 2 +- analytical/templatetags/hubspot.py | 2 +- analytical/templatetags/intercom.py | 2 +- analytical/templatetags/kiss_insights.py | 2 +- analytical/templatetags/kiss_metrics.py | 2 +- analytical/templatetags/matomo.py | 2 +- analytical/templatetags/mixpanel.py | 2 +- analytical/templatetags/olark.py | 2 +- analytical/templatetags/optimizely.py | 2 +- analytical/templatetags/performable.py | 2 +- analytical/templatetags/rating_mailru.py | 2 +- analytical/templatetags/snapengage.py | 2 +- analytical/templatetags/spring_metrics.py | 2 +- analytical/templatetags/uservoice.py | 2 +- analytical/templatetags/woopra.py | 2 +- analytical/templatetags/yandex_metrica.py | 2 +- docs/install.rst | 2 +- docs/services/chartbeat.rst | 2 +- docs/services/clickmap.rst | 4 ++-- docs/services/clicky.rst | 4 ++-- docs/services/crazy_egg.rst | 2 +- docs/services/gauges.rst | 6 +++--- docs/services/google_analytics.rst | 2 +- docs/services/google_analytics_gtag.rst | 2 +- docs/services/google_analytics_js.rst | 4 ++-- docs/services/intercom.rst | 6 +++--- docs/services/kiss_insights.rst | 4 ++-- docs/services/kiss_metrics.rst | 6 +++--- docs/services/mixpanel.rst | 12 ++++++------ docs/services/olark.rst | 8 ++++---- docs/services/optimizely.rst | 6 +++--- docs/services/performable.rst | 8 ++++---- docs/services/rating_mailru.rst | 2 +- docs/services/snapengage.rst | 2 +- docs/services/spring_metrics.rst | 2 +- docs/services/uservoice.rst | 6 +++--- docs/services/woopra.rst | 2 +- docs/services/yandex_metrica.rst | 2 +- 49 files changed, 80 insertions(+), 75 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 2703614..1077d76 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,3 +1,8 @@ +(unreleased) +------------ +* Change spelling of "JavaScript" across all files in docstrings and docs + (Peter Bittner) + Version 3.2.0 ------------- * Remove deprecated Piwik integration. Use Matomo instead! (Peter Bittner) diff --git a/README.rst b/README.rst index b80259c..0ed5fe1 100644 --- a/README.rst +++ b/README.rst @@ -8,7 +8,7 @@ Django_ project. .. start docs include -Using an analytics service with a Django project means adding Javascript +Using an analytics service with a Django project means adding JavaScript tracking code to the project templates. Of course, every service has its own specific installation instructions. Furthermore, you need to include your unique identifiers, which then end up in the templates. @@ -19,7 +19,7 @@ behind a generic interface, and keeps personal information and configuration out of the templates. Its goal is to make the basic set-up very simple, while allowing advanced users to customize tracking. Each service is set up as recommended by the services themselves, using -an asynchronous version of the Javascript code if possible. +an asynchronous version of the JavaScript code if possible. .. end docs include diff --git a/analytical/templatetags/chartbeat.py b/analytical/templatetags/chartbeat.py index 83a977f..dfac04b 100644 --- a/analytical/templatetags/chartbeat.py +++ b/analytical/templatetags/chartbeat.py @@ -44,7 +44,7 @@ def chartbeat_top(parser, token): """ Top Chartbeat template tag. - Render the top Javascript code for Chartbeat. + Render the top JavaScript code for Chartbeat. """ bits = token.split_contents() if len(bits) > 1: @@ -64,7 +64,7 @@ def chartbeat_bottom(parser, token): """ Bottom Chartbeat template tag. - Render the bottom Javascript code for Chartbeat. You must supply + Render the bottom JavaScript code for Chartbeat. You must supply your Chartbeat User ID (as a string) in the ``CHARTBEAT_USER_ID`` setting. """ diff --git a/analytical/templatetags/clickmap.py b/analytical/templatetags/clickmap.py index 5b93010..08e7851 100644 --- a/analytical/templatetags/clickmap.py +++ b/analytical/templatetags/clickmap.py @@ -30,7 +30,7 @@ def clickmap(parser, token): """ Clickmap tracker template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your clickmap tracker ID (as a string) in the ``CLICKMAP_TRACKER_ID`` setting. """ diff --git a/analytical/templatetags/clicky.py b/analytical/templatetags/clicky.py index f260386..e00128a 100644 --- a/analytical/templatetags/clicky.py +++ b/analytical/templatetags/clicky.py @@ -40,7 +40,7 @@ def clicky(parser, token): """ Clicky tracking template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your Clicky Site ID (as a string) in the ``CLICKY_SITE_ID`` setting. """ diff --git a/analytical/templatetags/crazy_egg.py b/analytical/templatetags/crazy_egg.py index e9a949b..8e7155e 100644 --- a/analytical/templatetags/crazy_egg.py +++ b/analytical/templatetags/crazy_egg.py @@ -24,7 +24,7 @@ def crazy_egg(parser, token): """ Crazy Egg tracking template tag. - Renders Javascript code to track page clicks. You must supply + Renders JavaScript code to track page clicks. You must supply your Crazy Egg account number (as a string) in the ``CRAZY_EGG_ACCOUNT_NUMBER`` setting. """ diff --git a/analytical/templatetags/gauges.py b/analytical/templatetags/gauges.py index 16b6c89..3bfeaa6 100644 --- a/analytical/templatetags/gauges.py +++ b/analytical/templatetags/gauges.py @@ -33,7 +33,7 @@ def gauges(parser, token): """ Gaug.es template tag. - Renders Javascript code to gaug.es testing. You must supply + Renders JavaScript code to gaug.es testing. You must supply your Site ID account number in the ``GAUGES_SITE_ID`` setting. """ diff --git a/analytical/templatetags/google_analytics.py b/analytical/templatetags/google_analytics.py index 165585e..5e6a0eb 100644 --- a/analytical/templatetags/google_analytics.py +++ b/analytical/templatetags/google_analytics.py @@ -71,7 +71,7 @@ def google_analytics(parser, token): """ Google Analytics tracking template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your website property ID (as a string) in the ``GOOGLE_ANALYTICS_PROPERTY_ID`` setting. """ diff --git a/analytical/templatetags/google_analytics_gtag.py b/analytical/templatetags/google_analytics_gtag.py index 07c5a00..eb40a71 100644 --- a/analytical/templatetags/google_analytics_gtag.py +++ b/analytical/templatetags/google_analytics_gtag.py @@ -37,7 +37,7 @@ def google_analytics_gtag(parser, token): """ Google Analytics tracking template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your website property ID (as a string) in the ``GOOGLE_ANALYTICS_GTAG_PROPERTY_ID`` setting. """ diff --git a/analytical/templatetags/google_analytics_js.py b/analytical/templatetags/google_analytics_js.py index 9739888..495ad03 100644 --- a/analytical/templatetags/google_analytics_js.py +++ b/analytical/templatetags/google_analytics_js.py @@ -44,7 +44,7 @@ def google_analytics_js(parser, token): """ Google Analytics tracking template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your website property ID (as a string) in the ``GOOGLE_ANALYTICS_JS_PROPERTY_ID`` setting. """ diff --git a/analytical/templatetags/gosquared.py b/analytical/templatetags/gosquared.py index ee0ccae..9668351 100644 --- a/analytical/templatetags/gosquared.py +++ b/analytical/templatetags/gosquared.py @@ -40,7 +40,7 @@ def gosquared(parser, token): """ GoSquared tracking template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your GoSquared site token in the ``GOSQUARED_SITE_TOKEN`` setting. """ bits = token.split_contents() diff --git a/analytical/templatetags/heap.py b/analytical/templatetags/heap.py index d74bfdb..ec9b2e2 100644 --- a/analytical/templatetags/heap.py +++ b/analytical/templatetags/heap.py @@ -31,7 +31,7 @@ def heap(parser, token): """ Heap tracker template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your heap tracker ID (as a string) in the ``HEAP_TRACKER_ID`` setting. """ diff --git a/analytical/templatetags/hubspot.py b/analytical/templatetags/hubspot.py index fe897d8..37e7408 100644 --- a/analytical/templatetags/hubspot.py +++ b/analytical/templatetags/hubspot.py @@ -30,7 +30,7 @@ def hubspot(parser, token): """ HubSpot tracking template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your portal ID (as a string) in the ``HUBSPOT_PORTAL_ID`` setting. """ bits = token.split_contents() diff --git a/analytical/templatetags/intercom.py b/analytical/templatetags/intercom.py index 69ae77e..5b5835c 100644 --- a/analytical/templatetags/intercom.py +++ b/analytical/templatetags/intercom.py @@ -63,7 +63,7 @@ def intercom(parser, token): """ Intercom.io template tag. - Renders Javascript code to intercom.io testing. You must supply + Renders JavaScript code to intercom.io testing. You must supply your APP ID account number in the ``INTERCOM_APP_ID`` setting. """ diff --git a/analytical/templatetags/kiss_insights.py b/analytical/templatetags/kiss_insights.py index fabd3dd..4eb21c6 100644 --- a/analytical/templatetags/kiss_insights.py +++ b/analytical/templatetags/kiss_insights.py @@ -27,7 +27,7 @@ def kiss_insights(parser, token): """ KISSinsights set-up template tag. - Renders Javascript code to set-up surveys. You must supply + Renders JavaScript code to set-up surveys. You must supply your account number and site code in the ``KISS_INSIGHTS_ACCOUNT_NUMBER`` and ``KISS_INSIGHTS_SITE_CODE`` settings. diff --git a/analytical/templatetags/kiss_metrics.py b/analytical/templatetags/kiss_metrics.py index 53d6aa7..683e15a 100644 --- a/analytical/templatetags/kiss_metrics.py +++ b/analytical/templatetags/kiss_metrics.py @@ -50,7 +50,7 @@ def kiss_metrics(parser, token): """ KISSinsights tracking template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your KISSmetrics API key in the ``KISS_METRICS_API_KEY`` setting. """ diff --git a/analytical/templatetags/matomo.py b/analytical/templatetags/matomo.py index d6b16ec..2509150 100644 --- a/analytical/templatetags/matomo.py +++ b/analytical/templatetags/matomo.py @@ -59,7 +59,7 @@ def matomo(parser, token): """ Matomo tracking template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your Matomo domain (plus optional URI path), and tracked site ID in the ``MATOMO_DOMAIN_PATH`` and the ``MATOMO_SITE_ID`` setting. diff --git a/analytical/templatetags/mixpanel.py b/analytical/templatetags/mixpanel.py index 2dc3ade..3bc94b2 100644 --- a/analytical/templatetags/mixpanel.py +++ b/analytical/templatetags/mixpanel.py @@ -37,7 +37,7 @@ def mixpanel(parser, token): """ Mixpanel tracking template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your Mixpanel token in the ``MIXPANEL_API_TOKEN`` setting. """ bits = token.split_contents() diff --git a/analytical/templatetags/olark.py b/analytical/templatetags/olark.py index 34e5c4f..e1ceb07 100644 --- a/analytical/templatetags/olark.py +++ b/analytical/templatetags/olark.py @@ -57,7 +57,7 @@ def olark(parser, token): """ Olark set-up template tag. - Renders Javascript code to set-up Olark chat. You must supply + Renders JavaScript code to set-up Olark chat. You must supply your site ID in the ``OLARK_SITE_ID`` setting. """ bits = token.split_contents() diff --git a/analytical/templatetags/optimizely.py b/analytical/templatetags/optimizely.py index 91a8efc..34d945a 100644 --- a/analytical/templatetags/optimizely.py +++ b/analytical/templatetags/optimizely.py @@ -20,7 +20,7 @@ def optimizely(parser, token): """ Optimizely template tag. - Renders Javascript code to set-up A/B testing. You must supply + Renders JavaScript code to set-up A/B testing. You must supply your Optimizely account number in the ``OPTIMIZELY_ACCOUNT_NUMBER`` setting. """ diff --git a/analytical/templatetags/performable.py b/analytical/templatetags/performable.py index e02cf15..55bbe40 100644 --- a/analytical/templatetags/performable.py +++ b/analytical/templatetags/performable.py @@ -43,7 +43,7 @@ def performable(parser, token): """ Performable template tag. - Renders Javascript code to set-up Performable tracking. You must + Renders JavaScript code to set-up Performable tracking. You must supply your Performable API key in the ``PERFORMABLE_API_KEY`` setting. """ diff --git a/analytical/templatetags/rating_mailru.py b/analytical/templatetags/rating_mailru.py index cf506d1..aa61a31 100644 --- a/analytical/templatetags/rating_mailru.py +++ b/analytical/templatetags/rating_mailru.py @@ -35,7 +35,7 @@ def rating_mailru(parser, token): """ Rating@Mail.ru counter template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your website counter ID (as a string) in the ``RATING_MAILRU_COUNTER_ID`` setting. """ diff --git a/analytical/templatetags/snapengage.py b/analytical/templatetags/snapengage.py index ad33e35..df9ffaa 100644 --- a/analytical/templatetags/snapengage.py +++ b/analytical/templatetags/snapengage.py @@ -59,7 +59,7 @@ def snapengage(parser, token): """ SnapEngage set-up template tag. - Renders Javascript code to set-up SnapEngage chat. You must supply + Renders JavaScript code to set-up SnapEngage chat. You must supply your widget ID in the ``SNAPENGAGE_WIDGET_ID`` setting. """ bits = token.split_contents() diff --git a/analytical/templatetags/spring_metrics.py b/analytical/templatetags/spring_metrics.py index 9cb0ec1..69d93c3 100644 --- a/analytical/templatetags/spring_metrics.py +++ b/analytical/templatetags/spring_metrics.py @@ -40,7 +40,7 @@ def spring_metrics(parser, token): """ Spring Metrics tracking template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your Spring Metrics Tracking ID in the ``SPRING_METRICS_TRACKING_ID`` setting. """ diff --git a/analytical/templatetags/uservoice.py b/analytical/templatetags/uservoice.py index 5c0f1ed..5c260f0 100644 --- a/analytical/templatetags/uservoice.py +++ b/analytical/templatetags/uservoice.py @@ -35,7 +35,7 @@ def uservoice(parser, token): """ UserVoice tracking template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your UserVoice Widget Key in the ``USERVOICE_WIDGET_KEY`` setting or the ``uservoice_widget_key`` template context variable. """ diff --git a/analytical/templatetags/woopra.py b/analytical/templatetags/woopra.py index 80cf9f4..f8e20b6 100644 --- a/analytical/templatetags/woopra.py +++ b/analytical/templatetags/woopra.py @@ -39,7 +39,7 @@ def woopra(parser, token): """ Woopra tracking template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your Woopra domain in the ``WOOPRA_DOMAIN`` setting. """ bits = token.split_contents() diff --git a/analytical/templatetags/yandex_metrica.py b/analytical/templatetags/yandex_metrica.py index cead920..da1f2ee 100644 --- a/analytical/templatetags/yandex_metrica.py +++ b/analytical/templatetags/yandex_metrica.py @@ -44,7 +44,7 @@ def yandex_metrica(parser, token): """ Yandex.Metrica counter template tag. - Renders Javascript code to track page visits. You must supply + Renders JavaScript code to track page visits. You must supply your website counter ID (as a string) in the ``YANDEX_METRICA_COUNTER_ID`` setting. """ diff --git a/docs/install.rst b/docs/install.rst index daa105e..6949f3a 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -68,7 +68,7 @@ file of your project: Adding the template tags to the base template ============================================= -Because every analytics service uses own specific Javascript code that +Because every analytics service uses own specific JavaScript code that should be added to the top or bottom of either the head or body of the HTML page, django-analytical provides four general-purpose template tags that will render the code needed for the services you are using. Your diff --git a/docs/services/chartbeat.rst b/docs/services/chartbeat.rst index 62820dc..9f37395 100644 --- a/docs/services/chartbeat.rst +++ b/docs/services/chartbeat.rst @@ -96,7 +96,7 @@ important information about detecting the visitor IP address. Setting the domain ------------------ -The Javascript tracking code can send the website domain to Chartbeat. +The JavaScript tracking code can send the website domain to Chartbeat. If you use multiple subdomains this enables you to treat them as one website in Chartbeat. If your project uses the sites framework, the domain name of the current :class:`~django.contrib.sites.models.Site` diff --git a/docs/services/clickmap.rst b/docs/services/clickmap.rst index d3d9b9f..e7b3fdb 100644 --- a/docs/services/clickmap.rst +++ b/docs/services/clickmap.rst @@ -23,7 +23,7 @@ This step is only needed if you are not using the generic :ttag:`analytical.*` tags. If you are, skip to :ref:`clickmap-configuration`. -The Clickmap Javascript code is inserted into templates using a template +The Clickmap JavaScript code is inserted into templates using a template tag. Load the :mod:`clickmap` template tag library and insert the :ttag:`clickmap` tag. Because every page that you want to track must have the tag, it is useful to add it to your base template. Insert @@ -54,7 +54,7 @@ Setting the Tracker ID ---------------------- Clickmap gives you a unique Tracker ID, and the :ttag:`clickmap` -tag will include it in the rendered Javascript code. You can find your +tag will include it in the rendered JavaScript code. You can find your Tracker ID clicking the link named "Tracker" in the dashboard of your Clickmap account. Set :const:`CLICKMAP_TRACKER_ID` in the project :file:`settings.py` file:: diff --git a/docs/services/clicky.rst b/docs/services/clicky.rst index 40e8bd3..62f1d38 100644 --- a/docs/services/clicky.rst +++ b/docs/services/clicky.rst @@ -53,7 +53,7 @@ Setting the Site ID ------------------- Every website you track with Clicky gets its own Site ID, and the -:ttag:`clicky` tag will include it in the rendered Javascript code. +:ttag:`clicky` tag will include it in the rendered JavaScript code. You can find the Site ID in the *Info* tab of the website *Preferences* page, in your Clicky account. Set :const:`CLICKY_SITE_ID` in the project :file:`settings.py` file:: @@ -84,7 +84,7 @@ Custom data As described in the Clicky `customized tracking`_ documentation page, the data that is tracked by Clicky can be customized by setting the -:data:`clicky_custom` Javascript variable before loading the tracking +:data:`clicky_custom` JavaScript variable before loading the tracking code. Using template context variables, you can let the :ttag:`clicky` tag pass custom data to Clicky automatically. You can set the context variables in your view when you render a template containing the diff --git a/docs/services/crazy_egg.rst b/docs/services/crazy_egg.rst index a0a9cc7..20ea8f7 100644 --- a/docs/services/crazy_egg.rst +++ b/docs/services/crazy_egg.rst @@ -53,7 +53,7 @@ Setting the account number -------------------------- Crazy Egg gives you a unique account number, and the :ttag:`crazy egg` -tag will include it in the rendered Javascript code. You can find your +tag will include it in the rendered JavaScript code. You can find your account number by clicking the link named "What's my code?" in the dashboard of your Crazy Egg account. Set :const:`CRAZY_EGG_ACCOUNT_NUMBER` in the project :file:`settings.py` diff --git a/docs/services/gauges.rst b/docs/services/gauges.rst index a26ff4d..d47dabf 100644 --- a/docs/services/gauges.rst +++ b/docs/services/gauges.rst @@ -23,7 +23,7 @@ This step is only needed if you are not using the generic :ttag:`analytical.*` tags. If you are, skip to :ref:`gauges-configuration`. -The Gaug.es Javascript code is inserted into templates using a +The Gaug.es JavaScript code is inserted into templates using a template tag. Load the :mod:`gauges` template tag library and insert the :ttag:`gauges` tag. Because every page that you want to track must have the tag, it is useful to add it to your base template. @@ -51,7 +51,7 @@ Setting the site id -------------------------- Gaug.es gives you a unique site id, and the :ttag:`gauges` -tag will include it in the rendered Javascript code. You can find your +tag will include it in the rendered JavaScript code. You can find your site id by clicking the *Tracking Code* link when logged into the on the gaug.es website. A page will display containing HTML code looking like this:: @@ -76,7 +76,7 @@ file:: GAUGES_SITE_ID = 'XXXXXXXXXXXXXXXXXXXXXXX' -If you do not set an site id, the Javascript code will not be +If you do not set an site id, the JavaScript code will not be rendered. diff --git a/docs/services/google_analytics.rst b/docs/services/google_analytics.rst index 12d008c..6b8704d 100644 --- a/docs/services/google_analytics.rst +++ b/docs/services/google_analytics.rst @@ -58,7 +58,7 @@ Setting the property ID Every website you track with Google Analytics gets its own property ID, and the :ttag:`google_analytics` tag will include it in the rendered -Javascript code. You can find the web property ID on the overview page +JavaScript code. You can find the web property ID on the overview page of your account. Set :const:`GOOGLE_ANALYTICS_PROPERTY_ID` in the project :file:`settings.py` file:: diff --git a/docs/services/google_analytics_gtag.rst b/docs/services/google_analytics_gtag.rst index 9760930..a4f3978 100644 --- a/docs/services/google_analytics_gtag.rst +++ b/docs/services/google_analytics_gtag.rst @@ -61,7 +61,7 @@ Setting the property ID Every website you track with Google Analytics gets its own property ID, and the :ttag:`google_analytics_gtag` tag will include it in the rendered -Javascript code. You can find the web property ID on the overview page +JavaScript code. You can find the web property ID on the overview page of your account. Set :const:`GOOGLE_ANALYTICS_GTAG_PROPERTY_ID` in the project :file:`settings.py` file:: diff --git a/docs/services/google_analytics_js.rst b/docs/services/google_analytics_js.rst index c575bf8..a2e285e 100644 --- a/docs/services/google_analytics_js.rst +++ b/docs/services/google_analytics_js.rst @@ -61,7 +61,7 @@ Setting the property ID Every website you track with Google Analytics gets its own property ID, and the :ttag:`google_analytics_js` tag will include it in the rendered -Javascript code. You can find the web property ID on the overview page +JavaScript code. You can find the web property ID on the overview page of your account. Set :const:`GOOGLE_ANALYTICS_JS_PROPERTY_ID` in the project :file:`settings.py` file:: @@ -229,7 +229,7 @@ The value is the cookie expiration in seconds or 0 to delete the cookie when the .. _`Cookie Expiration`: https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiBasicConfiguration#_setsessioncookietimeout -Custom Javascript Source +Custom JavaScript Source ------------------------ You can configure a custom URL for the javascript file by setting the diff --git a/docs/services/intercom.rst b/docs/services/intercom.rst index f458d28..f404243 100644 --- a/docs/services/intercom.rst +++ b/docs/services/intercom.rst @@ -23,7 +23,7 @@ This step is only needed if you are not using the generic :ttag:`analytical.*` tags. If you are, skip to :ref:`intercom-configuration`. -The Intercom.io Javascript code is inserted into templates using a +The Intercom.io JavaScript code is inserted into templates using a template tag. Load the :mod:`intercom` template tag library and insert the :ttag:`intercom` tag. Because every page that you want to track must have the tag, it is useful to add it to your base template. @@ -55,7 +55,7 @@ Setting the app id -------------------------- Intercom.io gives you a unique app id, and the :ttag:`intercom` -tag will include it in the rendered Javascript code. You can find your +tag will include it in the rendered JavaScript code. You can find your app id by clicking the *Tracking Code* link when logged into the on the intercom.io website. A page will display containing HTML code looking like this:: @@ -71,7 +71,7 @@ file:: INTERCOM_APP_ID = 'XXXXXXXXXXXXXXXXXXXXXXX' -If you do not set an app id, the Javascript code will not be +If you do not set an app id, the JavaScript code will not be rendered. diff --git a/docs/services/kiss_insights.rst b/docs/services/kiss_insights.rst index 95ef77a..606f570 100644 --- a/docs/services/kiss_insights.rst +++ b/docs/services/kiss_insights.rst @@ -54,10 +54,10 @@ Setting the account number and site code In order to install the survey code, you need to set your KISSinsights account number and website code. The :ttag:`kiss_insights` tag will -include it in the rendered Javascript code. You can find the account +include it in the rendered JavaScript code. You can find the account number and website code by visiting the code installation page of the website you want to place the surveys on. You will see some HTML code -with a Javascript tag with a ``src`` attribute containing +with a JavaScript tag with a ``src`` attribute containing ``//s3.amazonaws.com/ki.js/XXXXX/YYY.js``. Here ``XXXXX`` is the account number and ``YYY`` the website code. Set :const:`KISS_INSIGHTS_ACCOUNT_NUMBER` and diff --git a/docs/services/kiss_metrics.rst b/docs/services/kiss_metrics.rst index 629709a..d1593c0 100644 --- a/docs/services/kiss_metrics.rst +++ b/docs/services/kiss_metrics.rst @@ -24,7 +24,7 @@ This step is only needed if you are not using the generic :ttag:`analytical.*` tags. If you are, skip to :ref:`kiss-metrics-configuration`. -The KISSmetrics Javascript code is inserted into templates using a +The KISSmetrics JavaScript code is inserted into templates using a template tag. Load the :mod:`kiss_metrics` template tag library and insert the :ttag:`kiss_metrics` tag. Because every page that you want to track must have the tag, it is useful to add it to your base @@ -53,7 +53,7 @@ Setting the API key Every website you track events for with KISSmetrics gets its own API key, and the :ttag:`kiss_metrics` tag will include it in the rendered -Javascript code. You can find the website API key by visiting the +JavaScript code. You can find the website API key by visiting the website *Product center* on your KISSmetrics dashboard. Set :const:`KISS_METRICS_API_KEY` in the project :file:`settings.py` file:: @@ -144,7 +144,7 @@ For example:: }) return some_template.render(context) -The output script tag will then include the corresponding Javascript event as +The output script tag will then include the corresponding JavaScript event as documented in the `KISSmetrics record API`_ docs. diff --git a/docs/services/mixpanel.rst b/docs/services/mixpanel.rst index afbde2c..cfe1c35 100644 --- a/docs/services/mixpanel.rst +++ b/docs/services/mixpanel.rst @@ -24,7 +24,7 @@ step is only needed if you are not using the generic :ttag:`analytical.*` tags. If you are, skip to :ref:`mixpanel-configuration`. -The Mixpanel Javascript code is inserted into templates using a +The Mixpanel JavaScript code is inserted into templates using a template tag. Load the :mod:`mixpanel` template tag library and insert the :ttag:`mixpanel` tag. Because every page that you want to track must have the tag, it is useful to add it to your base @@ -53,7 +53,7 @@ Setting the token ----------------- Every website you track events for with Mixpanel gets its own token, -and the :ttag:`mixpanel` tag will include it in the rendered Javascript +and the :ttag:`mixpanel` tag will include it in the rendered JavaScript code. You can find the project token on the Mixpanel *projects* page. Set :const:`MIXPANEL_API_TOKEN` in the project :file:`settings.py` file:: @@ -137,16 +137,16 @@ For example:: Tracking events =============== -The django-analytical app integrates the Mixpanel Javascript API in +The django-analytical app integrates the Mixpanel JavaScript API in templates. To tracking events in views or other parts of Django, you can use Wes Winham's `mixpanel-celery`_ package. -If you want to track an event in Javascript, use the asynchronous +If you want to track an event in JavaScript, use the asynchronous notation, as described in the section titled -`"Asynchronous Tracking with Javascript"`_ in the Mixpanel +`"Asynchronous Tracking with JavaScript"`_ in the Mixpanel documentation. For example:: mixpanel.track("play-game", {"level": "12", "weapon": "sword", "character": "knight"}); .. _mixpanel-celery: http://github.com/winhamwr/mixpanel-celery -.. _`"Asynchronous Tracking with Javascript"`: http://mixpanel.com/api/docs/guides/integration/js#async +.. _`"Asynchronous Tracking with JavaScript"`: http://mixpanel.com/api/docs/guides/integration/js#async diff --git a/docs/services/olark.rst b/docs/services/olark.rst index 9c5c313..4467ac1 100644 --- a/docs/services/olark.rst +++ b/docs/services/olark.rst @@ -24,7 +24,7 @@ step is only needed if you are not using the generic :ttag:`analytical.*` tags. If you are, skip to :ref:`olark-configuration`. -The Olark Javascript code is inserted into templates using a template +The Olark JavaScript code is inserted into templates using a template tag. Load the :mod:`olark` template tag library and insert the :ttag:`olark` tag. Because every page that you want to track must have the tag, it is useful to add it to your base template. Insert @@ -52,7 +52,7 @@ Setting the site ID ------------------- In order to install the chat code, you need to set your Olark site ID. -The :ttag:`olark` tag will include it in the rendered Javascript code. +The :ttag:`olark` tag will include it in the rendered JavaScript code. You can find the site ID on `installation page`_ of you Olark account. Set :const:`OLARK_SITE_ID` in the project :file:`settings.py` file:: @@ -93,7 +93,7 @@ Just remember that if you set the same context variable in the :class:`~django.template.context.RequestContext` constructor and in a context processor, the latter clobbers the former. -See also `api.chat.updateVisitorNickname`_ in the Olark Javascript API +See also `api.chat.updateVisitorNickname`_ in the Olark JavaScript API documentation. .. _`api.chat.updateVisitorNickname`: http://www.olark.com/documentation/javascript/api.chat.updateVisitorNickname @@ -113,7 +113,7 @@ and the :ttag:`olark` tag will pass them to Olark as status messages:: ]}) return some_template.render(context) -See also `api.chat.updateVisitorStatus`_ in the Olark Javascript API +See also `api.chat.updateVisitorStatus`_ in the Olark JavaScript API documentation. .. _`api.chat.updateVisitorStatus`: http://www.olark.com/documentation/javascript/api.chat.updateVisitorStatus diff --git a/docs/services/optimizely.rst b/docs/services/optimizely.rst index e726042..225784b 100644 --- a/docs/services/optimizely.rst +++ b/docs/services/optimizely.rst @@ -25,7 +25,7 @@ This step is only needed if you are not using the generic :ttag:`analytical.*` tags. If you are, skip to :ref:`optimizely-configuration`. -The Optimizely Javascript code is inserted into templates using a +The Optimizely JavaScript code is inserted into templates using a template tag. Load the :mod:`optimizely` template tag library and insert the :ttag:`optimizely` tag. Because every page that you want to track must have the tag, it is useful to add it to your base template. @@ -53,7 +53,7 @@ Setting the account number -------------------------- Optimizely gives you a unique account number, and the :ttag:`optimizely` -tag will include it in the rendered Javascript code. You can find your +tag will include it in the rendered JavaScript code. You can find your account number by clicking the *Implementation* link in the top right-hand corner of the Optimizely website. A pop-up window will appear containing HTML code looking like this:: @@ -66,7 +66,7 @@ file:: OPTIMIZELY_ACCOUNT_NUMBER = 'XXXXXXX' -If you do not set an account number, the Javascript code will not be +If you do not set an account number, the JavaScript code will not be rendered. diff --git a/docs/services/performable.rst b/docs/services/performable.rst index 43869c3..dafd299 100644 --- a/docs/services/performable.rst +++ b/docs/services/performable.rst @@ -25,7 +25,7 @@ This step is only needed if you are not using the generic :ttag:`analytical.*` tags. If you are, skip to :ref:`performable-configuration`. -The Performable Javascript code is inserted into templates using a +The Performable JavaScript code is inserted into templates using a template tag. Load the :mod:`performable` template tag library and insert the :ttag:`performable` tag. Because every page that you want to track must have the tag, it is useful to add it to your base template. @@ -53,14 +53,14 @@ Setting the API key ------------------- You Performable account has its own API key, which :ttag:`performable` -tag will include it in the rendered Javascript code. You can find your +tag will include it in the rendered JavaScript code. You can find your API key on the *Account Settings* page (click 'Account Settings' in the top right-hand corner of your Performable dashboard). Set :const:`PERFORMABLE_API_KEY` in the project :file:`settings.py` file:: PERFORMABLE_API_KEY = 'XXXXXX' -If you do not set an API key, the Javascript code will not be rendered. +If you do not set an API key, the JavaScript code will not be rendered. .. _performable-identity-user: @@ -116,7 +116,7 @@ Embedding a landing page ======================== You can embed a Performable landing page in your Django website. The -:ttag:`performable_embed` template tag adds the Javascript code to embed +:ttag:`performable_embed` template tag adds the JavaScript code to embed the page. It takes two arguments: the hostname and the page ID:: {% performable_embed HOSTNAME PAGE_ID %} diff --git a/docs/services/rating_mailru.rst b/docs/services/rating_mailru.rst index e905e4a..20a05b5 100644 --- a/docs/services/rating_mailru.rst +++ b/docs/services/rating_mailru.rst @@ -53,7 +53,7 @@ Setting the counter ID Every website you track with Rating\@Mail.ru gets its own counter ID, and the :ttag:`rating_mailru` tag will include it in the rendered -Javascript code. You can find the web counter ID on the overview page +JavaScript code. You can find the web counter ID on the overview page of your account. Set :const:`RATING_MAILRU_COUNTER_ID` in the project :file:`settings.py` file:: diff --git a/docs/services/snapengage.rst b/docs/services/snapengage.rst index db9233f..bb15c2b 100644 --- a/docs/services/snapengage.rst +++ b/docs/services/snapengage.rst @@ -24,7 +24,7 @@ This step is only needed if you are not using the generic :ttag:`analytical.*` tags. If you are, skip to :ref:`snapengage-configuration`. -The SnapEngage Javascript code is inserted into templates using a +The SnapEngage JavaScript code is inserted into templates using a template tag. Load the :mod:`SnapEngage` template tag library and insert the :ttag:`SnapEngage` tag. Because every page that you want to track must have the tag, it is useful to add it to your base template. diff --git a/docs/services/spring_metrics.rst b/docs/services/spring_metrics.rst index e80ebb9..062a180 100644 --- a/docs/services/spring_metrics.rst +++ b/docs/services/spring_metrics.rst @@ -53,7 +53,7 @@ Setting the Tracking ID Every website you track with Spring Metrics gets its own Tracking ID, and the :ttag:`spring_metrics` tag will include it in the rendered -Javascript code. You can find the Tracking ID in the `Site Settings`_ +JavaScript code. You can find the Tracking ID in the `Site Settings`_ of your Spring Metrics account. Set :const:`SPRING_METRICS_TRACKING_ID` in the project :file:`settings.py` file:: diff --git a/docs/services/uservoice.rst b/docs/services/uservoice.rst index dcbbca5..4d1dae7 100644 --- a/docs/services/uservoice.rst +++ b/docs/services/uservoice.rst @@ -29,7 +29,7 @@ This step is only needed if you are not using the generic :ttag:`analytical.*` tags. If you are, skip to :ref:`uservoice-configuration`. -The UserVoice Javascript code is inserted into templates using a +The UserVoice JavaScript code is inserted into templates using a template tag. Load the :mod:`uservoice` template tag library and insert the :ttag:`uservoice` tag. Because every page that you want to have the feedback tab to appear on must have the tag, it is useful to add @@ -57,8 +57,8 @@ Setting the widget key In order to use the feedback widget, you need to configure which widget you want to show. You can find the widget keys in the *Channels* tab on -your UserVoice *Settings* page. Under the *Javascript Widget* heading, -find the Javascript embed code of the widget. The widget key is the +your UserVoice *Settings* page. Under the *JavaScript Widget* heading, +find the JavaScript embed code of the widget. The widget key is the alphanumerical string contained in the URL of the script imported by the embed code:: diff --git a/docs/services/woopra.rst b/docs/services/woopra.rst index 1a8b122..e2f8f54 100644 --- a/docs/services/woopra.rst +++ b/docs/services/woopra.rst @@ -37,7 +37,7 @@ the tag at the bottom of the HTML head:: ... -Because Javascript code is asynchronous, putting the tag in the head +Because JavaScript code is asynchronous, putting the tag in the head section increases the chances that a page view is going to be tracked before the visitor leaves the page. See for details the `Asynchronous JavaScript Developer’s Guide`_ on the Woopra website. diff --git a/docs/services/yandex_metrica.rst b/docs/services/yandex_metrica.rst index d9861bb..bff16b9 100644 --- a/docs/services/yandex_metrica.rst +++ b/docs/services/yandex_metrica.rst @@ -53,7 +53,7 @@ Setting the counter ID Every website you track with Yandex.Metrica gets its own counter ID, and the :ttag:`yandex_metrica` tag will include it in the rendered -Javascript code. You can find the web counter ID on the overview page +JavaScript code. You can find the web counter ID on the overview page of your account. Set :const:`YANDEX_METRICA_COUNTER_ID` in the project :file:`settings.py` file::