Accueil Explorer Aide
S'inscrire Connexion
im-changing.ru
/
converse.js
miroir de https://github.com/conversejs/converse.js.git
2
0
Fork 0
Fichiers Tickets 0 Wiki
Aborescence: 11ff072366
Branches Tags
converse.js
/
docs
/
source
/
quickstart.rst

quickstart.rst 3.9 KB
Historique Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107 
  1. .. raw:: html
    2. 

  2. 

  3.     <div id="banner"><a href="https://github.com/jcbrand/converse.js/blob/master/docs/source/quickstart.rst">Edit me on GitHub</a></div>
    4. 

  4. 

  5. ==========
    6. 

  6. Quickstart
    7. 

  7. ==========
    8. 

  8. 

  9. Getting a demo up and running
    10. 

  10. =============================
    11. 

  11. 

  12. Use the content delivery network
    13. 

  13. --------------------------------
    14. 

  14. 

  15. Converse.js has a `CDN <https://en.wikipedia.org/wiki/Content_delivery_network>`_, provided by `KeyCDN <http://keycdn.com/>`_,
    16. 

  16. which hosts its JavaScript and CSS files.
    17. 

  17. 

  18. The latest versions of these files are available at these URLs:
    19. 

  19. 

  20. * https://cdn.conversejs.org/dist/converse.min.js
    21. 

  21. * https://cdn.conversejs.org/css/converse.min.css
    22. 

  22. 

  23. To load a specific version of Converse.js you can put the version in the URL, like so:
    24. 

  24. 

  25. * https://cdn.conversejs.org/3.0.3/dist/converse.min.js
    26. 

  26. * https://cdn.conversejs.org/3.0.3/css/converse.min.css
    27. 

  27. 

  28. You can include these two URLs inside the *<head>* element of your website
    29. 

  29. via the *script* and *link* tags:
    30. 

  30. 

  31. .. code-block:: html
    32. 

  32. 

  33.     <link rel="stylesheet" type="text/css" media="screen" href="https://cdn.conversejs.org/css/converse.min.css">
    34. 

  34.     <script src="https://cdn.conversejs.org/dist/converse.min.js"></script>
    35. 

  35. 

  36. .. note:: Instead of always loading the latest version of Converse.js via the
    37. 

  37.     CDN, it's generally better to load a specific version (preferably the
    38. 

  38.     latest one), to avoid breakage when new backwards-incompatible versions are
    39. 

  39.     released.
    40. 

  40. 

  41. Initializing Converse.js
    42. 

  42. ------------------------
    43. 

  43. 

  44. You'll then need to initialize Converse.js with configuration settings relevant to your requirements.
    45. 

  45. Refer to the :ref:`configuration-settings` section for info on all the available configuration settings.
    46. 

  46. 

  47. To quickly get started, you can put the following JavaScript code at the
    48. 

  48. bottom of your page (after the closing *</body>* element)::
    49. 

  49. 

  50.     <script>
    51. 

  51.         converse.initialize({
    52. 

  52.             bosh_service_url: 'https://bind.conversejs.org', // Please use this connection manager only for testing purposes
    53. 

  53.             show_controlbox_by_default: true
    54. 

  54.         });
    55. 

  55.     </script>
    56. 

  56. 

  57. The `index.html <https://github.com/jcbrand/converse.js/blob/master/index.html>`_ file inside the
    58. 

  58. Converse.js repository may serve as a nice usable example.
    59. 

  59. 

  60. Alternative builds of Converse.js
    61. 

  61. =================================
    62. 

  62. 

  63. The minified ``.js`` and ``.css`` files provide the same functionality as is available
    64. 

  64. on the `conversejs.org <http://conversejs.org>`_ website. Useful for testing or demoing.
    65. 

  65. 

  66. Alternative builds are however also available via the CDN.
    67. 

  67. 

  68. Mobile build
    69. 

  69. ------------
    70. 

  70. 

  71. Besides the default build mentioned above, there is a build intended for mobile
    72. 

  72. websites, called ``converse-mobile.min.js``.
    73. 

  73. Take a look at the ``mobile.html`` file in the Converse.js repository
    74. 

  74. for an example of this build being used. There's an additional CSS file called 
    75. 

  75. ``mobile.min.css`` which should be used with the mobile build.
    76. 

  76. 

  77. When you load `conversejs.org <https://conversejs.org>`_ with a mobile device
    78. 

  78. then the mobile JavaScript build and its CSS will be used.
    79. 

  79. 

  80. Excluding 3rd party dependencies
    81. 

  81. --------------------------------
    82. 

  82. 

  83. Then there is also a build that contains no 3rd party dependencies, called 
    84. 

  84. ``converse-no-dependencies.min.js`` and which is used in the ``non_amd.html``
    85. 

  85. page in the repository.
    86. 

  86. 

  87. Excluding only jQuery
    88. 

  88. ---------------------
    89. 

  89. 

  90. Lastly there is a build called ``converse.nojquery.min.js`` which excludes only
    91. 

  91. jQuery but still includes all other 3rd party dependencies.
    92. 

  92. 

  93. Where to go from here?
    94. 

  94. ======================
    95. 

  95. 

  96. You might want to implement some kind of persistent single-session solution for
    97. 

  97. your website, where users authenticate once in your website and are then
    98. 

  98. automatically logged in to the XMPP server as well. For more info on how this
    99. 

  99. can be achieved, read: :ref:`session-support`.
    100. 

  100. 

  101. Perhaps you want to create your own custom build of Converse.js? Then head over
    102. 

  102. to the :doc:`builds` section, or more generally the :doc:`development`
    103. 

  103. documentation.
    104. 

  104. 

  105. Do you want to know how to theme Converse.js? Then read the :doc:`theming`
    106. 

  106. documentation.
    107. 

  107.