mirror of
				https://github.com/ether/etherpad-lite.git
				synced 2025-11-04 10:11:33 +01:00 
			
		
		
		
	Beautify the docs
This commit is contained in:
		
							parent
							
								
									f7b46f6e69
								
							
						
					
					
						commit
						c4325a050f
					
				@ -9,6 +9,7 @@ https://github.com/Pita/etherpad-lite/blob/master/doc/easysync/easysync-notes.tx
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Functions
 | 
					## Functions
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### createAttributePool ()
 | 
					### createAttributePool ()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -5,6 +5,7 @@ The AuthorManager controlls all information about the Pad authors
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Functions
 | 
					## Functions
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### getAuthor4Token (token, callback)
 | 
					### getAuthor4Token (token, callback)
 | 
				
			||||||
Returns the Author Id for a token. If the token is unkown, 
 | 
					Returns the Author Id for a token. If the token is unkown, 
 | 
				
			||||||
it creates a author for the token
 | 
					it creates a author for the token
 | 
				
			||||||
@ -13,18 +14,21 @@ it creates a author for the token
 | 
				
			|||||||
* **callback** *(Function)* callback (err, author) 
 | 
					* **callback** *(Function)* callback (err, author) 
 | 
				
			||||||
The callback function that is called when the result is here
 | 
					The callback function that is called when the result is here
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### getAuthorColorId (author, callback)
 | 
					### getAuthorColorId (author, callback)
 | 
				
			||||||
Returns the color Id of the author
 | 
					Returns the color Id of the author
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **author** *(String)* The id of the author
 | 
					* **author** *(String)* The id of the author
 | 
				
			||||||
* **callback** *(Function)* callback(err, colorId)
 | 
					* **callback** *(Function)* callback(err, colorId)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### getAuthorName (author, callback)
 | 
					### getAuthorName (author, callback)
 | 
				
			||||||
Returns the name of the author
 | 
					Returns the name of the author
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **author** *(String)* The id of the author
 | 
					* **author** *(String)* The id of the author
 | 
				
			||||||
* **callback** *(Function)* callback(err, name)
 | 
					* **callback** *(Function)* callback(err, name)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### setAuthorColorId (author, colorId, callback)
 | 
					### setAuthorColorId (author, colorId, callback)
 | 
				
			||||||
Sets the color Id of the author
 | 
					Sets the color Id of the author
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -32,6 +36,7 @@ Sets the color Id of the author
 | 
				
			|||||||
* **colorId** *No description*
 | 
					* **colorId** *No description*
 | 
				
			||||||
* **callback** *(Function)* (optional)
 | 
					* **callback** *(Function)* (optional)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### setAuthorName (author, name, callback)
 | 
					### setAuthorName (author, name, callback)
 | 
				
			||||||
Sets the name of the author
 | 
					Sets the name of the author
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -3,6 +3,7 @@
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Functions
 | 
					## Functions
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### _slicerZipperFunc (attOp, csOp, opOut, pool)
 | 
					### _slicerZipperFunc (attOp, csOp, opOut, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **attOp** *No description*
 | 
					* **attOp** *No description*
 | 
				
			||||||
@ -10,28 +11,33 @@
 | 
				
			|||||||
* **opOut** *No description*
 | 
					* **opOut** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### appendATextToAssembler (atext, assem)
 | 
					### appendATextToAssembler (atext, assem)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **atext** *No description*
 | 
					* **atext** *No description*
 | 
				
			||||||
* **assem** *No description*
 | 
					* **assem** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### applyToAText (cs, atext, pool)
 | 
					### applyToAText (cs, atext, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
* **atext** *No description*
 | 
					* **atext** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### applyToAttribution (cs, astr, pool)
 | 
					### applyToAttribution (cs, astr, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
* **astr** *No description*
 | 
					* **astr** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### applyToText (cs, str)
 | 
					### applyToText (cs, str)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
* **str** *No description*
 | 
					* **str** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### applyZip (in1, idx1, in2, idx2, func)
 | 
					### applyZip (in1, idx1, in2, idx2, func)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **in1** *No description*
 | 
					* **in1** *No description*
 | 
				
			||||||
@ -40,21 +46,25 @@
 | 
				
			|||||||
* **idx2** *No description*
 | 
					* **idx2** *No description*
 | 
				
			||||||
* **func** *No description*
 | 
					* **func** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### attribsAttributeValue (attribs, key, pool)
 | 
					### attribsAttributeValue (attribs, key, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **attribs** *No description*
 | 
					* **attribs** *No description*
 | 
				
			||||||
* **key** *No description*
 | 
					* **key** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### attributeTester (attribPair, pool)
 | 
					### attributeTester (attribPair, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **attribPair** *No description*
 | 
					* **attribPair** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### builder (oldLen)
 | 
					### builder (oldLen)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **oldLen** *No description*
 | 
					* **oldLen** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### characterRangeFollow (cs, startChar, endChar, insertionsAfter)
 | 
					### characterRangeFollow (cs, startChar, endChar, insertionsAfter)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
@ -62,28 +72,34 @@
 | 
				
			|||||||
* **endChar** *No description*
 | 
					* **endChar** *No description*
 | 
				
			||||||
* **insertionsAfter** *No description*
 | 
					* **insertionsAfter** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### checkRep (cs)
 | 
					### checkRep (cs)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### clearOp (op)
 | 
					### clearOp (op)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **op** *No description*
 | 
					* **op** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### cloneAText (atext)
 | 
					### cloneAText (atext)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **atext** *No description*
 | 
					* **atext** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### cloneOp (op)
 | 
					### cloneOp (op)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **op** *No description*
 | 
					* **op** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### compose (cs1, cs2, pool)
 | 
					### compose (cs1, cs2, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs1** *No description*
 | 
					* **cs1** *No description*
 | 
				
			||||||
* **cs2** *No description*
 | 
					* **cs2** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### composeAttributes (att1, att2, resultIsMutation, pool)
 | 
					### composeAttributes (att1, att2, resultIsMutation, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **att1** *No description*
 | 
					* **att1** *No description*
 | 
				
			||||||
@ -91,26 +107,31 @@
 | 
				
			|||||||
* **resultIsMutation** *No description*
 | 
					* **resultIsMutation** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### copyAText (atext1, atext2)
 | 
					### copyAText (atext1, atext2)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **atext1** *No description*
 | 
					* **atext1** *No description*
 | 
				
			||||||
* **atext2** *No description*
 | 
					* **atext2** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### copyOp (op1, op2)
 | 
					### copyOp (op1, op2)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **op1** *No description*
 | 
					* **op1** *No description*
 | 
				
			||||||
* **op2** *No description*
 | 
					* **op2** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### eachAttribNumber (cs, func)
 | 
					### eachAttribNumber (cs, func)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
* **func** *No description*
 | 
					* **func** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### filterAttribNumbers (cs, filter)
 | 
					### filterAttribNumbers (cs, filter)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
* **filter** *No description*
 | 
					* **filter** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### follow (cs1, cs2, reverseInsertOrder, pool)
 | 
					### follow (cs1, cs2, reverseInsertOrder, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs1** *No description*
 | 
					* **cs1** *No description*
 | 
				
			||||||
@ -118,16 +139,19 @@
 | 
				
			|||||||
* **reverseInsertOrder** *No description*
 | 
					* **reverseInsertOrder** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### followAttributes (att1, att2, pool)
 | 
					### followAttributes (att1, att2, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **att1** *No description*
 | 
					* **att1** *No description*
 | 
				
			||||||
* **att2** *No description*
 | 
					* **att2** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### identity (N)
 | 
					### identity (N)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **N** *No description*
 | 
					* **N** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### inverse (cs, lines, alines, pool)
 | 
					### inverse (cs, lines, alines, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
@ -135,29 +159,35 @@
 | 
				
			|||||||
* **alines** *No description*
 | 
					* **alines** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### isIdentity (cs)
 | 
					### isIdentity (cs)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### joinAttributionLines (theAlines)
 | 
					### joinAttributionLines (theAlines)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **theAlines** *No description*
 | 
					* **theAlines** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### makeAText (text, attribs)
 | 
					### makeAText (text, attribs)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **text** *No description*
 | 
					* **text** *No description*
 | 
				
			||||||
* **attribs** *No description*
 | 
					* **attribs** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### makeAttribsString (opcode, attribs, pool)
 | 
					### makeAttribsString (opcode, attribs, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **opcode** *No description*
 | 
					* **opcode** *No description*
 | 
				
			||||||
* **attribs** *No description*
 | 
					* **attribs** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### makeAttribution (text)
 | 
					### makeAttribution (text)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **text** *No description*
 | 
					* **text** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### makeSplice (oldFullText, spliceStart, numRemoved, newText, optNewTextAPairs, pool)
 | 
					### makeSplice (oldFullText, spliceStart, numRemoved, newText, optNewTextAPairs, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **oldFullText** *No description*
 | 
					* **oldFullText** *No description*
 | 
				
			||||||
@ -167,71 +197,86 @@
 | 
				
			|||||||
* **optNewTextAPairs** *No description*
 | 
					* **optNewTextAPairs** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### mapAttribNumbers (cs, func)
 | 
					### mapAttribNumbers (cs, func)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
* **func** *No description*
 | 
					* **func** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### mergingOpAssembler ()
 | 
					### mergingOpAssembler ()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### moveOpsToNewPool (cs, oldPool, newPool)
 | 
					### moveOpsToNewPool (cs, oldPool, newPool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
* **oldPool** *No description*
 | 
					* **oldPool** *No description*
 | 
				
			||||||
* **newPool** *No description*
 | 
					* **newPool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### mutateAttributionLines (cs, lines, pool)
 | 
					### mutateAttributionLines (cs, lines, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
* **lines** *No description*
 | 
					* **lines** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### mutateTextLines (cs, lines)
 | 
					### mutateTextLines (cs, lines)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
* **lines** *No description*
 | 
					* **lines** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### newLen (cs)
 | 
					### newLen (cs)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### newOp (optOpcode)
 | 
					### newOp (optOpcode)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **optOpcode** *No description*
 | 
					* **optOpcode** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### numToString (num)
 | 
					### numToString (num)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **num** *No description*
 | 
					* **num** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### oldLen (cs)
 | 
					### oldLen (cs)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### oneInsertedLineAtATimeOpIterator (opsStr, optStartIndex, charBank)
 | 
					### oneInsertedLineAtATimeOpIterator (opsStr, optStartIndex, charBank)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **opsStr** *No description*
 | 
					* **opsStr** *No description*
 | 
				
			||||||
* **optStartIndex** *No description*
 | 
					* **optStartIndex** *No description*
 | 
				
			||||||
* **charBank** *No description*
 | 
					* **charBank** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### opAssembler ()
 | 
					### opAssembler ()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### opAttributeValue (op, key, pool)
 | 
					### opAttributeValue (op, key, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **op** *No description*
 | 
					* **op** *No description*
 | 
				
			||||||
* **key** *No description*
 | 
					* **key** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### opIterator (opsStr, optStartIndex)
 | 
					### opIterator (opsStr, optStartIndex)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **opsStr** *No description*
 | 
					* **opsStr** *No description*
 | 
				
			||||||
* **optStartIndex** *No description*
 | 
					* **optStartIndex** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### opString (op)
 | 
					### opString (op)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **op** *No description*
 | 
					* **op** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### pack (oldLen, newLen, opsStr, bank)
 | 
					### pack (oldLen, newLen, opsStr, bank)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **oldLen** *No description*
 | 
					* **oldLen** *No description*
 | 
				
			||||||
@ -239,65 +284,80 @@
 | 
				
			|||||||
* **opsStr** *No description*
 | 
					* **opsStr** *No description*
 | 
				
			||||||
* **bank** *No description*
 | 
					* **bank** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### parseNum (str)
 | 
					### parseNum (str)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **str** *No description*
 | 
					* **str** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### prepareForWire (cs, pool)
 | 
					### prepareForWire (cs, pool)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
* **pool** *No description*
 | 
					* **pool** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### smartOpAssembler ()
 | 
					### smartOpAssembler ()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### splitAttributionLines (attrOps, text)
 | 
					### splitAttributionLines (attrOps, text)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **attrOps** *No description*
 | 
					* **attrOps** *No description*
 | 
				
			||||||
* **text** *No description*
 | 
					* **text** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### splitTextLines (text)
 | 
					### splitTextLines (text)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **text** *No description*
 | 
					* **text** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### stringAssembler ()
 | 
					### stringAssembler ()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### stringIterator (str)
 | 
					### stringIterator (str)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **str** *No description*
 | 
					* **str** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### stringOp (str)
 | 
					### stringOp (str)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **str** *No description*
 | 
					* **str** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### subattribution (astr, start, optEnd)
 | 
					### subattribution (astr, start, optEnd)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **astr** *No description*
 | 
					* **astr** *No description*
 | 
				
			||||||
* **start** *No description*
 | 
					* **start** *No description*
 | 
				
			||||||
* **optEnd** *No description*
 | 
					* **optEnd** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### textLinesMutator (lines)
 | 
					### textLinesMutator (lines)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **lines** *No description*
 | 
					* **lines** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### toBaseTen (cs)
 | 
					### toBaseTen (cs)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### toSplices (cs)
 | 
					### toSplices (cs)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### unpack (cs)
 | 
					### unpack (cs)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **cs** *No description*
 | 
					* **cs** *No description*
 | 
				
			||||||
 | 
					
 | 
				
			||||||
##Variables
 | 
					##Variables
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### assert 
 | 
					### assert 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### error 
 | 
					### error 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -5,22 +5,26 @@ The MessageHandler handles all Messages that comes from Socket.IO and controls t
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Functions
 | 
					## Functions
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### handleConnect (client)
 | 
					### handleConnect (client)
 | 
				
			||||||
Handles the connection of a new user
 | 
					Handles the connection of a new user
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **client** the new client
 | 
					* **client** the new client
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### handleDisconnect (client)
 | 
					### handleDisconnect (client)
 | 
				
			||||||
Handles the disconnection of a user
 | 
					Handles the disconnection of a user
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **client** the client that leaves
 | 
					* **client** the client that leaves
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### handleMessage (client, message)
 | 
					### handleMessage (client, message)
 | 
				
			||||||
Handles a message from a user
 | 
					Handles a message from a user
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* **client** the client that send this message
 | 
					* **client** the client that send this message
 | 
				
			||||||
* **message** the message from the client
 | 
					* **message** the message from the client
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### setSocketIO (socket_io)
 | 
					### setSocketIO (socket_io)
 | 
				
			||||||
A associative array that translates a session to a pad
 | 
					A associative array that translates a session to a pad
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -5,6 +5,7 @@ The pad object, defined with joose
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Functions
 | 
					## Functions
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### cleanText (txt)
 | 
					### cleanText (txt)
 | 
				
			||||||
Copied from the Etherpad source code. It converts Windows line breaks to Unix line breaks and convert Tabs to spaces
 | 
					Copied from the Etherpad source code. It converts Windows line breaks to Unix line breaks and convert Tabs to spaces
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -5,6 +5,7 @@ The Pad Manager is a Factory for pad Objects
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Functions
 | 
					## Functions
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### getPad (id, callback)
 | 
					### getPad (id, callback)
 | 
				
			||||||
A Array with all known Pads
 | 
					A Array with all known Pads
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -6,6 +6,7 @@ provided by the settings module
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Functions
 | 
					## Functions
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### init (callback)
 | 
					### init (callback)
 | 
				
			||||||
Initalizes the database with the settings provided by the settings module
 | 
					Initalizes the database with the settings provided by the settings module
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -13,6 +14,7 @@ Initalizes the database with the settings provided by the settings module
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
##Variables
 | 
					##Variables
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### db 
 | 
					### db 
 | 
				
			||||||
The UeberDB Object that provides the database functions
 | 
					The UeberDB Object that provides the database functions
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -6,6 +6,7 @@ minification && compression of Javascript and CSS.
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Functions
 | 
					## Functions
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### padJS (req, res)
 | 
					### padJS (req, res)
 | 
				
			||||||
Answers a http request for the pad javascript
 | 
					Answers a http request for the pad javascript
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -7,6 +7,7 @@ to MessageHandler and minfied requests are passed to minified.
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
##Variables
 | 
					##Variables
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### maxAge 
 | 
					### maxAge 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -6,21 +6,27 @@ this information to the other modules
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
##Variables
 | 
					##Variables
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### dbSettings 
 | 
					### dbSettings 
 | 
				
			||||||
This setting is passed with dbType to ueberDB to set up the database
 | 
					This setting is passed with dbType to ueberDB to set up the database
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### dbType 
 | 
					### dbType 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### defaultPadText 
 | 
					### defaultPadText 
 | 
				
			||||||
The default Text of a new pad
 | 
					The default Text of a new pad
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### logHTTP 
 | 
					### logHTTP 
 | 
				
			||||||
A flag that shows if http requests should be loged to stdout
 | 
					A flag that shows if http requests should be loged to stdout
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### minify 
 | 
					### minify 
 | 
				
			||||||
A flag that shows if minification is enabled or not
 | 
					A flag that shows if minification is enabled or not
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- - -
 | 
				
			||||||
### port 
 | 
					### port 
 | 
				
			||||||
The Port ep-lite should listen to
 | 
					The Port ep-lite should listen to
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user