Commit graph

306 commits

Author SHA1 Message Date
Adam Niederer
6d279f0ee1 Spelling fix
Also removes an extra space
2017-03-11 21:34:34 -05:00
Adam Niederer
a5e576c564 Grammar fix 2017-03-11 21:30:32 -05:00
Adam Niederer
eeb8e82771 Remove an extra space 2017-03-11 21:27:34 -05:00
Sjoerd Langkemper
d48395089c Update called from for two hooks
`expressCreateServer` and `expressConfigure` are called from `express.js`, not
from `server.js`.
2017-01-17 14:59:24 +01:00
Alexander Lorz
cd7f01f40a minor changes in docs
- correct link to doc generation tool.
 - fixed incomplete sentence regarding API client libraries
2016-12-26 20:18:34 +01:00
Luiza Pagliari
01d23b1f6a Merge pull request #2929 from xavidotron/develop
Pass through the "item" parameter to registerAceCommand callbacks.
2016-12-13 06:12:26 -02:00
Luc Didry
2341d09807 Add undocumented API function restoreRevision to doc
This commit is dedicated to Schoumi. Thx for supporting me on Tipeee :-)
2016-11-16 10:36:18 +01:00
John McLear
f09e10b122 Merge pull request #2944 from storytouch/aceRegisterNonScrollableEditEvents
Create hook to register events that won't scroll editor after aceEditEvt
2016-06-20 10:36:53 +01:00
Luiza Pagliari
69ac8e1722 Include usage example for aceRegisterNonScrollableEditEvents 2016-06-20 06:31:11 -03:00
Xavid
56b851a46f Pass through the "item" parameter to registerAceCommand callbacks. 2016-05-06 21:58:24 -04:00
Luiza Pagliari
3fb695a7a0 Create hook to register events that won't scroll editor after aceEditEvt 2016-03-30 11:51:18 -03:00
John McLear
4846798528 extend attributesonselection method 2016-03-26 22:00:34 +08:00
Ted Mielczarek
c70d655b96 Add appendText API (from #2810) to docs. 2016-01-13 07:26:20 -05:00
Mikk Andresen
4ad759dd25 Add postToolbarInit documentation and usage examples 2015-12-18 13:33:49 +02:00
Mikk Andresen
03a4828d31 Update aceEditorCSS hook documentation 2015-12-02 13:15:27 +02:00
Luiza Pagliari
92a8253449 Create hook exportHtmlAdditionalTagsWithData
The new hook does the same as exportHtmlAdditionalTags, but is declared
in another hook to avoid confusion about how to export tags when they
are stored as ['tag', 'value'] on attribute pool.

This complements #2762, as per @Gared suggestions.
2015-11-03 07:16:55 -02:00
John McLear
c337a0585c Merge pull request #2724 from xavidotron/develop
Add a aceSelectionChanged hook to allow plugins to react when the cursor moves
2015-10-22 16:19:07 +01:00
Stefan
504cc102a0 Merge pull request #2762 from storytouch/exportTagsAsArrays
Accepting Arrays on 'exportHtmlAdditionalTags'
2015-10-17 18:24:18 +02:00
Stefan
9d29b15def Merge pull request #2730 from emilyxxie/clientready_hook
added clientReady hook
2015-10-10 13:30:36 +02:00
Luiza Pagliari
1d134f0b13 Fixing ed52626. It was closing the span with </span data-TAG=VALUE>, not </span> 2015-09-17 15:30:09 -03:00
Luiza Pagliari
ed5262650a Generating pad HTML with tags like <span data-TAG="VALUE"> instead of <TAG:VALUE> 2015-09-07 03:55:56 -07:00
Luiza Pagliari
1a5985dc75 Accepting Arrays on 'exportHtmlAdditionalTags' to handle attributes stored as ['key', 'value'] (and not only ['key', 'true']) 2015-08-24 07:58:45 -07:00
Stefan
c8d7e6e0b8 Add appendChatMessage API to docs 2015-08-15 22:41:09 +02:00
Emily Xie
21f0d12d31 clientReady hook- pass entire message, updated doc 2015-07-20 11:45:41 -04:00
Xavid
008d4e653c Add a aceSelectionChanged hook to allow plugins to react when the cursor
location changes.
2015-07-11 11:33:20 -04:00
Xavid
bc78e0c68d Update documentation for the updatePad and createPad hooks to include 'author'
in the context.
2015-06-21 11:34:59 -04:00
John McLear
48da5c1ab1 docs for handle message security 2015-05-20 01:09:35 +01:00
Luiza Pagliari
6bd2013c71 Fixing documentation of collectContentPre 2015-05-15 11:18:58 -03:00
John McLear
b4163fc862 fix docs 2015-04-23 17:27:54 +01:00
John McLear
d31523aa08 Update hooks_server-side.md 2015-04-17 15:58:23 +01:00
John McLear
1d44490dc4 Merge pull request #2599 from Gared/doc_api_fix
Fix documentation for deleteSession api method
2015-04-11 15:07:18 +01:00
Stefan
a842eb4f5c Fix documentation for deleteSession api method 2015-04-11 16:05:41 +02:00
John McLear
84b3f1728f Merge pull request #2597 from Gared/increase_api_version
increase http api version to latest version
2015-04-11 14:56:47 +01:00
Stefan
d26c3d5f7e increase http api version 2015-04-11 13:45:59 +02:00
Stefan
601be46993 Add docs for new error message for createPad api method 2015-04-11 13:16:03 +02:00
Thomas Muehlichen
1e8e64d675 feature #2567 added documentation 2015-03-31 10:50:20 +02:00
Luc Didry
845788c39d Add a saveRevision API function
Calling saveRevision create an author which name is "API"
2015-02-25 01:04:27 +01:00
Luc Didry
a08c50a77d Fixes #1870
Add two functions to API :
 * getSavedRevisionsCount
 * listSavedRevisions
2015-02-24 23:42:35 +01:00
Luc Didry
4166f19078 Set correct API version in doc
The doc says current version is 1.2.9, but there is getPadID which uses 1.2.10 API.
2015-02-22 22:32:18 +01:00
John McLear
4de42da2e3 Merge pull request #2497 from ether/image-support-hook
clean support for image hook
2015-01-26 16:07:56 +00:00
John McLear
b8ac349b53 Update hooks_client-side.md 2015-01-26 16:07:46 +00:00
John McLear
2c3ce30fed docs 2015-01-26 02:42:48 +00:00
Stefan
4c64b7a670 Revert 'asyncLineHTMLForExport' hook 2015-01-25 22:08:40 +01:00
John McLear
378ed02269 docs 2015-01-24 13:30:03 +00:00
John McLear
4ecf0dfad2 docs for export HTML 2015-01-24 02:24:10 +00:00
John McLear
c878a957b7 fix issue in docs 2015-01-24 02:18:59 +00:00
John McLear
fccfc3bd41 docs 2014-12-09 16:16:19 +00:00
John McLear
b94a525e07 docs 2014-12-09 01:35:59 +00:00
John McLear
ce004f9c59 docs 2014-12-08 19:48:02 +00:00
John McLear
2218cbd252 docs 2014-12-08 19:08:12 +00:00
Simon Gaeremynck
2f8b860e69 Added a userLeave hook that gets called when a user leaves a pad 2014-08-08 15:49:15 +01:00
John McLear
44cb676ba2 Merge pull request #2150 from ether/export-file-name-hook
Server side hook to modify the export file name
2014-06-16 16:47:15 +01:00
Marcel Klehr
40a97f08bb Merge pull request #2169 from stephan48/develop
Added documentation for the newly added API method getPadID
2014-06-02 20:31:37 +02:00
Stephan Jauernick
bbd50dfc62 Added documentation for the newly added API method getPadID 2014-06-02 20:25:16 +02:00
David Cook
49114d2b7a Fix typos in easysync-full-description.tex 2014-06-01 23:57:20 -05:00
John McLear
d09e66e271 use call first and update docs 2014-05-12 15:08:32 +01:00
John McLear
a8d9a3868d docs for new hook 2014-05-06 21:22:03 +01:00
Marcel Klehr
a7671a690b docs: update api version 2014-03-30 15:10:29 +02:00
Marcel Klehr
33ecc1d8df Update docs 2014-03-30 13:08:26 +02:00
Marcel Klehr
3a82cba4c5 Polish the styles of our docs a little 2014-03-27 18:08:55 +01:00
Marcel Klehr
a69793a203 Add docs for toolbar controller and pad_editbar 2014-03-16 15:43:38 +01:00
John McLear
df205a4ef4 docs 2014-03-05 21:44:22 +00:00
Lennart Brinkmann
7dd29454e9 Remove duplicate doc entry for setHTML() 2013-12-14 21:11:37 +01:00
John McLear
58bbfd8a65 resolve merge conflict 2013-12-09 21:55:04 +00:00
John McLear
505dc70df5 Merge pull request #2013 from ether/getAttributeOnSelection
getAttributeOnSelection function
2013-12-09 09:46:57 -08:00
John McLear
d9ef40f9d7 docs but not sure how to specify the verison this was introduced 2013-12-07 17:48:06 +00:00
Luc Didry
3d8452b143 Replace tabs indentation with spaces indentation
Some files are obviously external libraries, I didn't touch them
2013-12-05 08:41:29 +01:00
s1341
5409cdaa3f add some documentation for move/copy 2013-11-18 14:38:44 +02:00
Luc Didry
b769acaee0 Forgot to bump the API version 2013-11-07 23:28:07 +01:00
Luc Didry
5bccfdf060 Forgot a small chunck of documentation for getRevisionChangeset 2013-11-07 22:46:35 +01:00
Luc Didry
a4194efaf1 Fixed #1981 - uncomplete HTTP API documentation 2013-11-07 22:22:37 +01:00
Marcel Klehr
5bce9bc336 Add docs for stats 2013-10-27 21:59:40 +01:00
Eric Schrijver
b34224559d ‘Etherpad Lite’ -> ‘Etherpad’ 2013-09-29 13:57:37 +02:00
Eric Schrijver
4377f7a2e4 Fix encoding issue in localization.md 2013-09-01 10:57:31 +02:00
j@mailb.org
bc5dc74f90 pass pad in postAceInit hook
no way for plugins to access current pad otherwise.
2013-06-17 15:52:51 +02:00
Chia-liang Kao
8f262d0ede document aceSetAuthorStyle 2013-06-15 11:07:13 +08:00
neurolit
e96baf6ef1 API documentation: listAllPads() returns {padIDs: [...]} instead of [...] 2013-03-26 16:37:57 +01:00
Marcel Klehr
bcb92f25a6 Refactor chat notifications and the chatNewMessage hook 2013-03-19 20:21:27 +01:00
John McLear
8406cc95ab docs for hook 2013-03-19 03:43:38 +00:00
Marcel Klehr
760e1b82c3 Add a setting for RTL text direction (integrating the url paramter)
Fixes #1191
2013-03-05 23:12:00 +01:00
John McLear
716cac9c95 timeslider init hook docs 2013-02-27 15:17:22 +00:00
John McLear
9e1dfc9487 docs for setHTML 2013-02-12 23:44:09 +00:00
Manuel Knitza
fde10052ca Update doc/api/http_api.md
Updated
2013-02-12 21:57:01 +01:00
John McLear
280b3a404c doh, doc fix 2013-02-09 17:02:54 +00:00
John McLear
bb1d462612 plugin test docs 2013-02-09 15:45:00 +00:00
John McLear
a19ad983f1 docs for api change 2013-01-29 16:48:56 +00:00
mluto
cb2b93b133 Added getChatHistory and getChatHead (api+code+doc) 2013-01-26 14:35:26 +01:00
mluto
41cb5d8265 Added hook for clientVars and hook-doc 2013-01-14 22:51:26 +01:00
John McLear
654654b4e1 Merge pull request #1342 from spcsser/feature/padlisting
API & backend to list pads on epl instance
2013-01-14 08:13:57 -08:00
spcsser
062dbff738 Added listAllPads api docu 2013-01-11 12:59:02 +01:00
Stephan Jauernick
9f9f7a627e corrected a documentation glitch for checkToken - clarified which token is validated 2013-01-02 15:14:46 +01:00
Marcel Klehr
b31563ea07 Fix docs: Correct API version for listAllGroups endpoint 2012-12-28 15:37:10 +01:00
Marcel Klehr
ffc9bcf028 Bump API version for checkToken endpoint 2012-12-27 22:09:22 +01:00
Marcel Klehr
e60f8de676 Expand plugin system docs with l10n info 2012-12-23 22:48:28 +01:00
Marcel Klehr
220e084484 Simplify local locale file format 2012-12-23 22:43:32 +01:00
Marcel Klehr
1a4923ef60 Update docs 2012-12-23 18:17:30 +01:00
Marcel Klehr
6cd7b999b5 [docs] Update localization.md and tell users to translate on twn 2012-12-12 12:00:33 +01:00
Stephan Jauernick
c2cc292324 Update doc/api/http_api.md
Added docs for the checkToken function
2012-12-07 11:28:03 +01:00
Hyacinthe Cartiaux
d6027726e6
Fix urls, use github.com/ether
Signed-off-by: Hyacinthe Cartiaux <hyacinthe.cartiaux@uni.lu>
2012-11-22 01:12:30 +01:00
Marcel Klehr
bb33cfb23d Add in docs for L10n 2012-11-14 18:01:01 +01:00
0ip
7ee42edcf1 Document 'lang' Parameter 2012-11-14 17:21:45 +01:00
Marcel Klehr
6a027a1c2c [docs] Document custom static files. 2012-11-01 14:48:19 +01:00
yourcelf
13cef386f8 Add api docs for userColor query arg 2012-10-31 16:28:12 -03:00
Marcel Klehr
f676e90199 [docs] Fix assets: Rename doc/_assets to doc/assets
github's jekyll would do some dark magic with '_assets'.
We don't want that.
2012-10-31 18:12:12 +01:00
Marcel Klehr
dd1e383d6e Bump api version in #usage section 2012-10-30 14:35:26 +01:00
Marcel Klehr
ef923209b0 Refactor structure of api/http_api.md and add api version numbers for all endpoints. 2012-10-30 14:18:50 +01:00
John McLear
4afc9ccbdf Merge pull request #1094 from marcelklehr/fix/doc-generator
Change filename hooks.md -> hooks_overview.md
2012-10-29 06:36:56 -07:00
Marcel Klehr
7a8401c363 Add recipe for doc assets and some basic styling for the generated docs. 2012-10-27 18:47:09 +02:00
Marcel Klehr
3d1fd05085 Insert epl version into template. 2012-10-27 17:28:15 +02:00
Marcel Klehr
94e399e8a9 Change filename hooks.md -> hooks_overview.md
so it doesn't confuse tools/doc/generator
2012-10-27 16:30:31 +02:00
Marcel Klehr
63e4aafae8 Add docs for plugins and plugin framework
@redhog please elaborate on / improve 'doc/api/pluginfw.md'!
2012-10-25 15:45:06 +02:00
John McLear
db1a1a0e3e Merge pull request #1034 from d-a-n/develop
Added hooks for pad events create/edit/load/remove
2012-10-05 17:28:40 -07:00
d-a-n
0fd8490ca6 Changed pad_id to padID to follow projct standards. 2012-10-03 15:49:28 +03:00
d-a-n
754c559d63 Changed pad hook names to follow naming conventions. 2012-10-03 13:35:31 +03:00
Marcel Klehr
2684a1d295 Merge branch 'develop' into express-v3
Conflicts:
	src/node/hooks/express/errorhandling.js
2012-10-03 10:09:00 +02:00
d-a-n
4652751285 Updated docs for new pad hooks (add, edit, remove) 2012-10-02 22:32:30 +03:00
d-a-n
c0f2e557d3 Updated docs for new pad hooks (add, edit, remove) 2012-10-02 22:11:54 +03:00
d-a-n
07c33c77c4 Updated docs for new pad hooks (add, edit, remove) 2012-10-02 22:10:18 +03:00
Gedion
6009903095 added comments to ace exposed methods 2012-10-01 19:18:19 -05:00
Gedion
61022be6e4 added comments to ace exposed methods 2012-10-01 19:14:27 -05:00
Gedion
3fe3df91ae update docs for new hooks and ace exposures 2012-09-30 17:13:14 -05:00
Marcel Klehr
1c38f5bab9 Update docs 2012-09-22 16:04:30 +02:00
Marcel Klehr
4416210471 Differentiate between http server and express app 2012-09-21 17:12:22 +02:00
Marcel Klehr
f8f002adc0 Add listAllGroups API endpoint
Adds a database key that lists all groups
2012-09-17 23:03:56 +02:00
Marcel Klehr
40572b13b9 Document, how return values of hooks are handled. 2012-09-12 17:15:38 +02:00
Marcel Klehr
eeb605334f Add in docs for getAuthorName API method 2012-09-06 12:13:41 +02:00
Marcel Klehr
8a696ab77d Expect a comma seperated list of sessionIDs in session cookie
This allows people to be active on more than one group.
2012-09-02 19:51:12 +02:00
Mark Holmquist
f9469ef256 Add in padUsers HTTP API call
I needed the list of users this time, so I got it. There are docs
and everything.
2012-08-17 13:39:16 -07:00
Marcel Klehr
1bb8844f42 Document loadSettings hook. 2012-08-15 10:10:55 +02:00
Mark Holmquist
17375b2eed Fix doc format, add in makefile for docs
OK, first up, SOMEBODY *cough*analphabet*cough* screwed up the docs
by making them all use the wrong heading level. Not cool, guy. I
had to change them so they would compile right.

But anyway, now the docs will build into sexy-looking HTML and will
shortly be hosted on marktraceur.info.

Fixed the makefile to work properly.

Run:
 * `make clean` for removing old doc-build(s)
 * `make docs` for running new doc-build(s)
2012-08-13 21:11:39 -07:00
Marcel Klehr
98cdb96ac3 Document 'documentReady' client hook. 2012-08-12 21:29:21 +02:00
John McLear
838834f438 Merge pull request #930 from MarkTraceur/new-doc/http/send-clients-message
Added in docs for the HTTP call I just added
2012-08-12 09:09:20 -07:00
John McLear
aabdf665a7 Merge pull request #934 from MarkTraceur/new-doc/plugin/handle-client-message
Add in docs for the new hook I just added
2012-08-12 08:55:44 -07:00
Mark Holmquist
14da09dddd Add in docs for the new hook I just added 2012-08-10 09:49:43 -07:00
Marcel Klehr
453c68da19 Add doc generator. 2012-08-08 20:56:56 +02:00
Mark Holmquist
e491476a0f Added in docs for the HTTP call I just added 2012-08-08 10:26:18 -07:00
Marcel Klehr
db4ae500a1 Fix markup. 2012-08-07 20:29:44 +02:00
Marcel Klehr
7e2820a674 Remove file endings from includes. 2012-08-07 20:21:11 +02:00
Marcel Klehr
70fb765118 Restructure headings. 2012-08-07 20:19:37 +02:00
Marcel Klehr
5fac05a395 Add docs. 2012-08-03 22:04:06 +02:00
Peter 'Pita' Martischka
3c8ee3df20 removed docs created with doc.md, these docs were completly useless 2011-12-04 17:12:27 +01:00
Peter 'Pita' Martischka
e79f29f67d removed 'planed' from the database documentation 2011-08-21 20:49:07 +01:00
Peter 'Pita' Martischka
dbf9dc6dfb added listSessionsOfGroup and listSessionsOfAuthor 2011-08-09 20:14:32 +01:00
Peter 'Pita' Martischka
212cf83a25 updated the database doc 2011-08-08 17:33:25 +01:00
Peter 'Pita' Martischka
31067f163f added a documentation for the database structure 2011-08-03 12:09:19 +01:00
Peter 'Pita' Martischka
8ca57ffde4 Added READMEs to explain the doc folders 2011-08-01 19:29:22 +01:00
Peter 'Pita' Martischka
0772f6bb4e updated documentation 2011-07-30 17:25:54 +01:00
Peter 'Pita' Martischka
c4325a050f Beautify the docs 2011-05-30 16:05:42 +01:00
Peter 'Pita' Martischka
f7b46f6e69 Documentation 2011-05-30 15:53:11 +01:00
Peter 'Pita' Martischka
7024f3e78a Replace JSDoc-Toolkit with doc.md 2011-05-29 21:30:56 +01:00
Peter 'Pita' Martischka
e2ce9dcc02 reorganize Joes PDF's 2011-04-07 14:45:19 +01:00
Peter 'Pita' Martischka
31952532c2 Uploaded improved documentation about easysync, thx @Joe Corneli 2011-03-28 13:30:42 +01:00
Peter 'Pita' Martischka
9360814242 Created a JSDoc, first try 2011-03-27 12:49:56 +01:00
Peter 'Pita' Martischka
bf15ebe073 Adding some documentation about easysync - Thx to Joe Corneli 2011-03-26 15:32:25 +00:00
Peter 'Pita' Martischka
437cd90b90 Removing unused files 2011-03-26 13:49:01 +00:00
Peter 'Pita' Martischka
325c322a27 first-commit 2011-03-26 13:10:41 +00:00