Merge branch 'develop' into express-v3

Conflicts:
	src/node/hooks/express/errorhandling.js

doc/api/api.md

@@ -1,6 +1,6 @@
-# API
 @include embed_parameters
 @include http_api
+@include hooks
 @include hooks_client-side
 @include hooks_server-side
 @include editorInfo

doc/api/editorInfo.md

@@ -45,3 +45,26 @@ Returns the `rep` object.
 ## editorInfo.ace_doInsertUnorderedList(?)
 ## editorInfo.ace_doInsertOrderedList(?)
 ## editorInfo.ace_performDocumentApplyAttributesToRange()
+
+## editorInfo.ace_getAuthorInfos()
+Returns an info object about the author. Object key = author_id and info includes author's bg color value.
+Use to define your own authorship.
+## editorInfo.ace_performDocumentReplaceRange(start, end, newText)
+This function replaces a range (from [x1,y1] to [x2,y2]) with `newText`.
+## editorInfo.ace_performDocumentReplaceCharRange(startChar, endChar, newText)
+This function replaces a range (from y1 to y2) with `newText`.
+## editorInfo.ace_renumberList(lineNum)
+If you delete a line, calling this method will fix the line numbering.
+## editorInfo.ace_doReturnKey()
+Forces a return key at the current carret position.
+## editorInfo.ace_isBlockElement(element)
+Returns true if your passed elment is registered as a block element
+## editorInfo.ace_getLineListType(lineNum)
+Returns the line's html list type.
+## editorInfo.ace_caretLine()
+Returns X position of the caret.
+## editorInfo.ace_caretColumn()
+Returns Y position of the caret.
+## editorInfo.ace_caretDocChar()
+Returns the Y offset starting from [x=0,y=0]
+## editorInfo.ace_isWordChar(?)

doc/api/hooks.md

@@ -0,0 +1,11 @@
+# Hooks
+All hooks are called with two arguments:
+
+1. name - the name of the hook being called
+2. context - an object with some relevant information about the context of the call
+
+## Return values
+A hook should always return a list or undefined. Returning undefined is equivalent to returning an empty list.
+All the returned lists are appended to each other, so if the return values where `[1, 2]`, `undefined`, `[3, 4,]`, `undefined` and `[5]`, the value returned by callHook would be `[1, 2, 3, 4, 5]`.
+
+This is, because it should never matter if you have one plugin or several plugins doing some work - a single plugin should be able to make callHook return the same value a set of plugins are able to return collectively. So, any plugin can return a list of values, of any length, not just one value.

doc/api/hooks_client-side.md

@@ -1,11 +1,6 @@
 # Client-side hooks
 Most of these hooks are called during or in order to set up the formatting process.
 
-All hooks registered to these events are called with two arguments:
-
-1. name - the name of the hook being called
-2. context - an object with some relevant information about the context of the call
-
 ## documentReady
 Called from: src/templates/pad.html
 
@@ -179,3 +174,71 @@ Things in context:
 This hook gets called every time the client receives a message of type `name`. This can most notably be used with the new HTTP API call, "sendClientsMessage", which sends a custom message type to all clients connected to a pad. You can also use this to handle existing types.
 
 `collab_client.js` has a pretty extensive list of message types, if you want to take a look.
+
+##aceStartLineAndCharForPoint-aceEndLineAndCharForPoint 
+Called from: src/static/js/ace2_inner.js
+
+Things in context:
+
+1. callstack - a bunch of information about the current action
+2. editorInfo - information about the user who is making the change
+3. rep - information about where the change is being made
+4. root - the span element of the current line
+5. point - the starting/ending element where the cursor highlights
+6. documentAttributeManager - information about attributes in the document
+
+This hook is provided to allow a plugin to turn DOM node selection into [line,char] selection.
+The return value should be an array of [line,char]
+
+##aceKeyEvent 
+Called from: src/static/js/ace2_inner.js
+
+Things in context:
+
+1. callstack - a bunch of information about the current action
+2. editorInfo - information about the user who is making the change
+3. rep - information about where the change is being made
+4. documentAttributeManager - information about attributes in the document
+5. evt - the fired event
+
+This hook is provided to allow a plugin to handle key events.
+The return value should be true if you have handled the event.
+
+##collectContentLineText 
+Called from: src/static/js/contentcollector.js
+
+Things in context:
+
+1. cc - the contentcollector object
+2. state - the current state of the change being made
+3. tname - the tag name of this node currently being processed
+4. text - the text for that line
+
+This hook allows you to validate/manipulate the text before it's sent to the server side.
+The return value should be the validated/manipulated text.
+
+##collectContentLineBreak 
+Called from: src/static/js/contentcollector.js
+
+Things in context:
+
+1. cc - the contentcollector object
+2. state - the current state of the change being made
+3. tname - the tag name of this node currently being processed
+
+This hook is provided to allow whether the br tag should induce a new magic domline or not.
+The return value should be either true(break the line) or false.
+
+##disableAuthorColorsForThisLine 
+Called from: src/static/js/linestylefilter.js
+
+Things in context:
+
+1. linestylefilter - the JavaScript object that's currently processing the ace attributes
+2. text - the line text
+3. class - line class
+
+This hook is provided to allow whether a given line should be deliniated with multiple authors.
+Multiple authors in one line cause the creation of magic span lines. This might not suit you and
+now you can disable it and handle your own deliniation.
+The return value should be either true(disable) or false.

doc/api/hooks_server-side.md

@@ -1,11 +1,6 @@
 # Server-side hooks
 These hooks are called on server-side.
 
-All hooks registered to these events are called with two arguments:
-
-1. name - the name of the hook being called
-2. context - an object with some relevant information about the context of the call
-
 ## loadSettings
 Called from: src/node/server.js
 
@@ -143,3 +138,16 @@ function handleMessage ( hook, context, callback ) {
   }
 };
 ```
+
+
+## getLineHTMLForExport
+Called from: src/node/utils/ExportHtml.js
+
+Things in context:
+
+1. apool - pool object
+2. attribLine - line attributes
+3. text - line text
+
+This hook will allow a plug-in developer to re-write each line when exporting to HTML.
+

doc/api/http_api.md

@@ -135,6 +135,10 @@ Pads can belong to a group. The padID of grouppads is starting with a groupID li
   * `{code: 1, message:"pad does already exist", data: null}`
   * `{code: 1, message:"groupID does not exist", data: null}`
 
+* **listAllGroups()** lists all existing groups<br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {groupIDs: ["g.mKjkmnAbSMtCt8eL", "g.3ADWx6sbGuAiUmCy"]}}`
+  * `{code: 0, message:"ok", data: {groupIDs: []}}`
+
 ### Author
 These authors are bound to the attributes the users choose (color and name). 
 

doc/database.md

@@ -2,6 +2,9 @@
 
 ## Keys and their values
 
+### groups
+A list of all existing groups (a JSON object with groupIDs as keys and `1` as values).
+
 ### pad:$PADID
 Saves all informations about pads