Commit Graph

68 Commits

Author SHA1 Message Date
JC Brand 990aefc6cb docs: Discourage usage of overrides and add hook to example plugin 2022-07-19 10:35:45 +02:00
JC Brand 0b172be3d0 Update development docs and add theming info 2022-05-07 23:03:04 +02:00
JC Brand a0ff85d74e Update theming and development documentation
* The templates are no longer `.html` files and are dispersed throughout the source code.
* The Sass files are also no longer all in one place
* Add a section on webpack aliases for modifying templates without touching the original files

Updates #2603
2021-08-25 11:55:06 +02:00
JC Brand fa2d6cca10 Update developer documentation and buildout dependencies 2019-07-25 12:33:46 +02:00
JC Brand a45bd8d14b Convert older docstrings to JSDoc syntax 2019-03-30 12:54:56 +01:00
JC Brand cb8b5a7039 Update the developer documentation 2018-09-18 11:17:27 +02:00
JC Brand b79c946c52 Don't show old API in the table of contents 2018-09-03 09:50:50 +02:00
JC Brand dc4c832fce Add jsdoc docstrings to `chats` API.
Link to the jsdoc output from the Sphinx docs
2018-08-01 12:11:10 +02:00
JC Brand 7389e1e058 Add documentation on security considerations 2017-02-02 18:34:13 +00:00
JC Brand 575e9da705 Split development docs into separate files/sections 2016-10-21 14:36:05 +00:00
JC Brand bfd7d037d7 Document angular.js integration 2016-10-21 13:52:34 +00:00
JC Brand 3edaffd3ec Fix typo 2016-10-13 10:12:23 +02:00
JC Brand ab76f1da44 Let core populated the roster, and send the initial presence
This allows for cleaner separation between core and rosterview, making it
easier to remove that plugin for more stripped down deployments.
2016-09-21 15:06:48 +02:00
JC Brand ac2c5f3e4e Allow the context to be passed in when registering event listeners
Similar to how backbone.js does it.
2016-09-21 13:15:45 +02:00
JC Brand 89e5bd7c54 Update to pluggable.js 0.0.2 2016-08-31 10:39:11 +00:00
JC Brand b0de7948f3 Document the update to the rooms API. 2016-08-21 11:09:08 +00:00
JC Brand 01f576e505 Return all rooms or private chat when caling `get` without arguments 2016-06-24 10:54:39 +02:00
JC Brand 10ca2900d4 Add a "create" parameter to rooms.get
to indicate whether the room should be created if not found.
2016-06-17 09:30:31 +00:00
JC Brand e12c165454 Add new event `pluginsInitialized` and use it in converse-notifications
By listening for this event before registering event handlers, other plugins
can first get their overrides of those handlers applied.
2016-06-16 17:21:49 +02:00
JC Brand 6c99c51c74 New API method `converse.rooms.close()`. 2016-06-03 08:41:13 +00:00
JC Brand f60a0512d9 Emit an event when the roster is fetched from the cache
We already emit an event when the roster is fetched from the XMPP server,
similarly, it would be useful to know when the roster was instead fetched from
the cache.
2016-06-01 16:04:06 +00:00
JC Brand c243aba98f Add `jid` method to converse API, to retrieve the user's JID. 2016-05-10 08:08:42 +00:00
JC Brand a969d010cb Don't try to reconnect on auth fail. 2016-04-13 12:09:16 +00:00
JC Brand e09328df6a Add `login` API method. 2016-04-13 11:52:28 +00:00
JC Brand 3815d77cc1 Make 'connected' an attribute. 2016-03-29 13:57:33 +00:00
JC Brand a6b6ad5e9e Add 'connection' API grouping and 'connected' API method. 2016-03-29 13:41:10 +00:00
JC Brand 3aefba3200 Change ping plugin to not have to use overrides.
Had to add a `reconnect` event to core.
2016-03-21 10:00:15 +00:00
JC Brand f65b99e81c RST formatting fixes. 2016-03-18 08:39:47 +00:00
JC Brand 36a875a402 Add stanza-specific event listener.
Therefore removing the `presence` event again.
2016-03-16 18:12:11 +00:00
JC Brand 1c961ab4d1 Emit an event `presence` when a presence stanza is received. 2016-03-16 15:59:07 +00:00
JC Brand 08222182c5 Move VCard functionality into separate plugin 2016-03-16 11:21:27 +00:00
JC Brand 57aae4ad26 Mention `send` API command and fix formatting. 2016-03-15 08:28:41 +00:00
JC Brand 23a1dc4f2b Some fixes concerning event emitting.
Don't make the event "this" context the protected converse object.
Can't trigger multiple data parameters, need to pass an object if there are
multiple values to be sent.
2016-03-01 22:39:45 +00:00
JC Brand f7725943f8 Emit an event 'contactRequest' when a subscription request is received 2016-03-01 21:57:49 +00:00
JC Brand a4fd252a30 Elaborate on the right way to call super methods in plugins. 2016-02-29 13:50:44 +00:00
JC Brand f1b999d01a update the plugin docs
Add a UMD header so that the example plugin can be used without require.js
Remove needles cruft and dependencies.
2016-02-17 17:01:55 +00:00
JC Brand 576efc4815 Initial work on breaking converse.js up into components
First component to remove is MUC which was moved to src/converse-muc.js
The components are written as plugins and use converse.js's plugin machinery.

Update the plugin docs somewhat with new insites found while working on the muc
plugin.
2016-02-16 07:47:08 +00:00
Javier Mellado bef4e26a4b Better writing. 2015-10-20 11:04:15 +01:00
Javier Mellado b6d463b214 Update development.rst
remove capital letter.
2015-10-20 11:02:42 +01:00
Javier Mellado 5f27e25648 Better writing. 2015-10-20 11:01:05 +01:00
Javier Mellado 3142ebbb6b Force type comparison and documentation updates 2015-10-20 10:57:21 +01:00
JC Brand 96253f9673 Document using serviceDiscovery with archive.query. 2015-07-22 00:40:51 +02:00
JC Brand ccf908a658 Document that previous and next RSM methods take limit parameter.
updates #306
2015-07-19 23:36:26 +02:00
JC Brand 8a6bca191a Small doc fixes. 2015-07-17 20:57:00 +02:00
JC Brand 99c7b9cb95 Add a new emitted event: serviceDiscovered.
Gets thrown every time converse learns of a supported server service.
Useful when 3rd party code wants to use API methods that depend on the service
being discovered first.
2015-07-17 20:34:48 +02:00
JC Brand 080d86e7fe Show most recent archived messages first.
- Also ensure that the archive.query API always return messages chronologically.
- Fix docs which wrongly state that null can be passed in.

updates #306
2015-07-17 17:56:47 +02:00
JC Brand 69de033cea Write documentation for the archive API. Also add another test.
update #306
2015-07-12 21:27:22 +02:00
JC Brand 114a25a172 Add initial text on writing a converse.js plugin. 2015-06-27 21:49:40 +02:00
JC Brand b47069b4f6 Add, test and document an API method for setting the user's status.
fixes #367
2015-06-27 21:21:27 +02:00
JC Brand 785244f15e Add a styleguide to the documentation.
Also update the contributor guidelines to mention the styleguide.
2015-06-16 00:20:28 +02:00