Properly captitalize JavaScript
This commit is contained in:
parent
f668f2981a
commit
11ff072366
@ -47,7 +47,7 @@ This command does the following:
|
||||
|
||||
* Also, the CSS files in the ``./css`` directory will be minified.
|
||||
|
||||
The Javascript build files are contained in the ``./dist`` directory:
|
||||
The JavaScript build files are contained in the ``./dist`` directory:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
|
@ -261,7 +261,7 @@ If ``authentication`` is set to ``anonymous``, then you will also need to provid
|
||||
server's domain via the `jid`_ setting.
|
||||
|
||||
This is a useful setting if you'd like to create a custom login form in your
|
||||
website. You'll need to write some Javascript to accept that custom form's
|
||||
website. You'll need to write some JavaScript to accept that custom form's
|
||||
login credentials, then you can pass those credentials (``jid`` and
|
||||
``password``) to ``converse.initialize`` to start converse.js and log the user
|
||||
into their XMPP account.
|
||||
@ -1341,7 +1341,7 @@ xhr_custom_status
|
||||
* Default: ``false``
|
||||
|
||||
.. note::
|
||||
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
|
||||
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous JavaScript and XML).
|
||||
|
||||
This option will let converse.js make an AJAX POST with your changed custom chat status to a
|
||||
remote server.
|
||||
@ -1350,7 +1350,7 @@ xhr_custom_status_url
|
||||
---------------------
|
||||
|
||||
.. note::
|
||||
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
|
||||
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous JavaScript and XML).
|
||||
|
||||
* Default: Empty string
|
||||
|
||||
@ -1367,7 +1367,7 @@ xhr_user_search
|
||||
* Default: ``false``
|
||||
|
||||
.. note::
|
||||
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
|
||||
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous JavaScript and XML).
|
||||
|
||||
There are two ways to add users.
|
||||
|
||||
@ -1392,7 +1392,7 @@ xhr_user_search_url
|
||||
-------------------
|
||||
|
||||
.. note::
|
||||
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
|
||||
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous JavaScript and XML).
|
||||
|
||||
* Default: Empty string
|
||||
|
||||
|
@ -50,7 +50,7 @@ Public API methods
|
||||
==================
|
||||
|
||||
Publich API methods are those methods that are accessible on the global
|
||||
``window.converse`` object. They are public, because any Javascript in the page
|
||||
``window.converse`` object. They are public, because any JavaScript in the page
|
||||
can call them. Public methods therefore don't expose any sensitive or closured
|
||||
data. To do that, you'll need to create a plugin, which has access to the
|
||||
private API method.
|
||||
@ -325,7 +325,7 @@ room under the ``with`` key.
|
||||
|
||||
The ``start`` and ``end`` parameters are used to query for messages
|
||||
within a certain timeframe. The passed in date values may either be ISO8601
|
||||
formatted date strings, or Javascript Date objects.
|
||||
formatted date strings, or JavaScript Date objects.
|
||||
|
||||
.. code-block:: javascript
|
||||
|
||||
@ -1070,7 +1070,7 @@ Example:
|
||||
The **listen** grouping
|
||||
-----------------------
|
||||
|
||||
Converse.js emits events to which you can subscribe from your own Javascript.
|
||||
Converse.js emits events to which you can subscribe from your own JavaScript.
|
||||
|
||||
Concerning events, the following methods are available under the "listen"
|
||||
grouping:
|
||||
|
@ -9,7 +9,7 @@ Developer guidelines
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
If you want to work with the non-minified Javascript and CSS files you'll soon
|
||||
If you want to work with the non-minified JavaScript and CSS files you'll soon
|
||||
notice that there are references to a missing *node_modules* directory.
|
||||
Please follow the instructions below to create these directories and fetch Converse's
|
||||
3rd-party dependencies.
|
||||
@ -97,7 +97,7 @@ Without AMD and require.js
|
||||
Converse.js can also be used without require.js. If you for some reason prefer
|
||||
to use it this way, please refer to
|
||||
`non_amd.html <https://github.com/jcbrand/converse.js/blob/master/non_amd.html>`_
|
||||
for an example of how and in what order all the Javascript files that converse.js
|
||||
for an example of how and in what order all the JavaScript files that converse.js
|
||||
depends on need to be loaded.
|
||||
|
||||
Brief description of converse.js's dependencies
|
||||
|
@ -21,7 +21,7 @@ The OTR protocol not only **encrypts your messages**, it provides ways to
|
||||
**plausible deniability** and **perfect forward secrecy** by generating
|
||||
new encryption keys for each conversation.
|
||||
|
||||
In its current state, Javascript cryptography is fraught with dangers and
|
||||
In its current state, JavaScript cryptography is fraught with dangers and
|
||||
challenges that make it impossible to reach the same standard of security that
|
||||
is available with native "desktop" software.
|
||||
|
||||
@ -29,8 +29,8 @@ This is due to its runtime malleability, the way it is "installed" (e.g.
|
||||
served) and the browser's lack of cryptographic primitives needed to implement
|
||||
secure crypto.
|
||||
|
||||
For harsh but fairly valid criticism of Javascript cryptography, read:
|
||||
`Javascript Cryptography Considered Harmful <http://www.matasano.com/articles/javascript-cryptography/>`_.
|
||||
For harsh but fairly valid criticism of JavaScript cryptography, read:
|
||||
`JavaScript Cryptography Considered Harmful <http://www.matasano.com/articles/javascript-cryptography/>`_.
|
||||
|
||||
To get an idea on how this applies to OTR support in Converse.js, please read
|
||||
`my thoughts on it <https://opkode.com/media/blog/2013/11/11/conversejs-otr-support>`_.
|
||||
|
@ -23,7 +23,7 @@ Introduction
|
||||
============
|
||||
|
||||
Converse.js is a free and open-source `XMPP <http://xmpp.org/about-xmpp/>`_
|
||||
chat client written in Javascript which can be tightly integrated into any website.
|
||||
chat client written in JavaScript which can be tightly integrated into any website.
|
||||
|
||||
The benefit of using converse.js as opposed to relying on a SaaS
|
||||
(software-as-a-service) solution, is that your users can have a much more
|
||||
|
@ -13,7 +13,7 @@ Use the content delivery network
|
||||
--------------------------------
|
||||
|
||||
Converse.js has a `CDN <https://en.wikipedia.org/wiki/Content_delivery_network>`_, provided by `KeyCDN <http://keycdn.com/>`_,
|
||||
which hosts its Javascript and CSS files.
|
||||
which hosts its JavaScript and CSS files.
|
||||
|
||||
The latest versions of these files are available at these URLs:
|
||||
|
||||
@ -44,7 +44,7 @@ Initializing Converse.js
|
||||
You'll then need to initialize Converse.js with configuration settings relevant to your requirements.
|
||||
Refer to the :ref:`configuration-settings` section for info on all the available configuration settings.
|
||||
|
||||
To quickly get started, you can put the following Javascript code at the
|
||||
To quickly get started, you can put the following JavaScript code at the
|
||||
bottom of your page (after the closing *</body>* element)::
|
||||
|
||||
<script>
|
||||
@ -75,7 +75,7 @@ for an example of this build being used. There's an additional CSS file called
|
||||
``mobile.min.css`` which should be used with the mobile build.
|
||||
|
||||
When you load `conversejs.org <https://conversejs.org>`_ with a mobile device
|
||||
then the mobile Javascript build and its CSS will be used.
|
||||
then the mobile JavaScript build and its CSS will be used.
|
||||
|
||||
Excluding 3rd party dependencies
|
||||
--------------------------------
|
||||
|
@ -57,7 +57,7 @@ Addititional measures
|
||||
Besides the measures mentioned above, integrators and hosts can also take
|
||||
further security precautions.
|
||||
|
||||
The most effective is to avoid serving untrusted 3rd party Javascript (e.g.
|
||||
The most effective is to avoid serving untrusted 3rd party JavaScript (e.g.
|
||||
advertisements and analytics).
|
||||
|
||||
Another option is to forego the use of a global ``converse`` object (which
|
||||
|
@ -14,10 +14,10 @@ Software Style Guide
|
||||
rely on a transpiler and still support older browsers.
|
||||
|
||||
Most of the style guide recommendations here come from Douglas Crockford's book
|
||||
`Javascript, the good parts <http://shop.oreilly.com/product/9780596517748.do>`_
|
||||
`JavaScript, the good parts <http://shop.oreilly.com/product/9780596517748.do>`_
|
||||
|
||||
This style guide is fairly opinionated. Some of these opinions perhaps don't
|
||||
conform to your expectations on how Javascript code should look like.
|
||||
conform to your expectations on how JavaScript code should look like.
|
||||
I apologize for that. However, for the sake of sanity, consistency and having
|
||||
code that is pleasing to the eye, please stick to these guidelines.
|
||||
|
||||
@ -103,7 +103,7 @@ and method invocations.
|
||||
Checking for equality
|
||||
---------------------
|
||||
|
||||
Javascript has a strict ``===`` and less strict ``==`` equality operator. The
|
||||
JavaScript has a strict ``===`` and less strict ``==`` equality operator. The
|
||||
stricter equality operator also does type checking. To avoid subtle bugs when
|
||||
doing comparisons, always use the strict equality check.
|
||||
|
||||
|
@ -71,7 +71,7 @@ Creating dist files
|
||||
===================
|
||||
|
||||
Once you've themed converse.js, you'll want to create new minified distribution
|
||||
files of all the Javascript and CSS.
|
||||
files of all the JavaScript and CSS.
|
||||
|
||||
Please refer to the :doc:`builds` section for information on how this is done.
|
||||
|
||||
|
@ -59,7 +59,7 @@ translated into, do the following
|
||||
|
||||
Please make sure to add the following attributes at the top of the file (under
|
||||
*Content-Transfer-Encoding*). They are required as configuration settings for Jed,
|
||||
the Javascript translations library that we're using.
|
||||
the JavaScript translations library that we're using.
|
||||
|
||||
.. code-block:: po
|
||||
|
||||
@ -90,7 +90,7 @@ The resulting `.po` file is then what gets translated.
|
||||
|
||||
|
||||
-----------------------------------------------------
|
||||
Generating a Javascript file from a translations file
|
||||
Generating a JavaScript file from a translations file
|
||||
-----------------------------------------------------
|
||||
|
||||
Unfortunately `Jed <http://slexaxton.github.io/Jed>`_, which we use for
|
||||
|
@ -42,13 +42,13 @@ more likely on the XMPP server's end (perhaps a misconfiguration?). If they
|
||||
**are** logged, then there might be a bug or misconfiguration in Converse.js.
|
||||
|
||||
|
||||
Conflicts with other Javascript libraries
|
||||
Conflicts with other JavaScript libraries
|
||||
=========================================
|
||||
|
||||
Problem:
|
||||
---------
|
||||
|
||||
You are using other Javascript libraries (like JQuery plugins), and
|
||||
You are using other JavaScript libraries (like JQuery plugins), and
|
||||
get errors like these in your browser console::
|
||||
|
||||
Uncaught TypeError: Object [object Object] has no method 'xxx' from example.js
|
||||
|
Loading…
Reference in New Issue
Block a user