mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-04-23 00:46:16 -04:00
Documentation
This commit is contained in:
Peter 'Pita' Martischka
parent
88297a99ef
commit
f7b46f6e69
22 changed files with 368 additions and 447 deletions
|
|
@ -1,32 +1,14 @@
|
|||
#AttributePoolFactory
|
||||
# AttributePoolFactory
|
||||
`require("./AttributePoolFactory");`
|
||||
|
||||
Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
This code represents the Attribute Pool Object of the original Etherpad.
|
||||
90% of the code is still like in the original Etherpad
|
||||
Look at https://github.com/ether/pad/blob/master/infrastructure/ace/www/easysync2.js
|
||||
You can find a explanation what a attribute pool is here:
|
||||
https://github.com/Pita/etherpad-lite/blob/master/doc/easysync/easysync-notes.txt
|
||||
|
||||
##Functions
|
||||
## Functions
|
||||
|
||||
###createAttributePool ()
|
||||
Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
### createAttributePool ()
|
||||
|
||||
* ****
|
||||
|
||||
##Variables
|
||||
|
||||
|
|
|
|||
|
|
@ -1,59 +1,41 @@
|
|||
#AuthorManager
|
||||
# AuthorManager
|
||||
`require("./AuthorManager");`
|
||||
|
||||
2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
The AuthorManager controlls all information about the Pad authors
|
||||
|
||||
##Functions
|
||||
## Functions
|
||||
|
||||
###getAuthor4Token (token, callback)
|
||||
2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
### getAuthor4Token (token, callback)
|
||||
Returns the Author Id for a token. If the token is unkown,
|
||||
it creates a author for the token
|
||||
|
||||
* **token** The token
|
||||
* **callback**
|
||||
* **token** *(String)* The token
|
||||
* **callback** *(Function)* callback (err, author)
|
||||
The callback function that is called when the result is here
|
||||
|
||||
###getAuthorColorId (author, callback)
|
||||
### getAuthorColorId (author, callback)
|
||||
Returns the color Id of the author
|
||||
|
||||
* **author**
|
||||
* **callback**
|
||||
* **author** *(String)* The id of the author
|
||||
* **callback** *(Function)* callback(err, colorId)
|
||||
|
||||
###getAuthorName (author, callback)
|
||||
### getAuthorName (author, callback)
|
||||
Returns the name of the author
|
||||
|
||||
* **author**
|
||||
* **callback**
|
||||
* **author** *(String)* The id of the author
|
||||
* **callback** *(Function)* callback(err, name)
|
||||
|
||||
###setAuthorColorId (author, colorId, callback)
|
||||
### setAuthorColorId (author, colorId, callback)
|
||||
Sets the color Id of the author
|
||||
|
||||
* **author**
|
||||
* **colorId**
|
||||
* **callback**
|
||||
* **author** *(String)* The id of the author
|
||||
* **colorId** *No description*
|
||||
* **callback** *(Function)* (optional)
|
||||
|
||||
###setAuthorName (author, name, callback)
|
||||
### setAuthorName (author, name, callback)
|
||||
Sets the name of the author
|
||||
|
||||
* **author**
|
||||
* **name**
|
||||
* **callback**
|
||||
|
||||
##Variables
|
||||
* **author** *(String)* The id of the author
|
||||
* **name** *No description*
|
||||
* **callback** *(Function)* (optional)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,328 +1,303 @@
|
|||
#Changeset
|
||||
# Changeset
|
||||
`require("./Changeset");`
|
||||
|
||||
Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
## Functions
|
||||
|
||||
##Functions
|
||||
### _slicerZipperFunc (attOp, csOp, opOut, pool)
|
||||
|
||||
###_slicerZipperFunc (attOp, csOp, opOut, pool)
|
||||
* **attOp** *No description*
|
||||
* **csOp** *No description*
|
||||
* **opOut** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **attOp**
|
||||
* **csOp**
|
||||
* **opOut**
|
||||
* **pool**
|
||||
### appendATextToAssembler (atext, assem)
|
||||
|
||||
###appendATextToAssembler (atext, assem)
|
||||
* **atext** *No description*
|
||||
* **assem** *No description*
|
||||
|
||||
* **atext**
|
||||
* **assem**
|
||||
### applyToAText (cs, atext, pool)
|
||||
|
||||
###applyToAText (cs, atext, pool)
|
||||
* **cs** *No description*
|
||||
* **atext** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs**
|
||||
* **atext**
|
||||
* **pool**
|
||||
### applyToAttribution (cs, astr, pool)
|
||||
|
||||
###applyToAttribution (cs, astr, pool)
|
||||
* **cs** *No description*
|
||||
* **astr** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs**
|
||||
* **astr**
|
||||
* **pool**
|
||||
### applyToText (cs, str)
|
||||
|
||||
###applyToText (cs, str)
|
||||
* **cs** *No description*
|
||||
* **str** *No description*
|
||||
|
||||
* **cs**
|
||||
* **str**
|
||||
### applyZip (in1, idx1, in2, idx2, func)
|
||||
|
||||
###applyZip (in1, idx1, in2, idx2, func)
|
||||
* **in1** *No description*
|
||||
* **idx1** *No description*
|
||||
* **in2** *No description*
|
||||
* **idx2** *No description*
|
||||
* **func** *No description*
|
||||
|
||||
* **in1**
|
||||
* **idx1**
|
||||
* **in2**
|
||||
* **idx2**
|
||||
* **func**
|
||||
### attribsAttributeValue (attribs, key, pool)
|
||||
|
||||
###attribsAttributeValue (attribs, key, pool)
|
||||
* **attribs** *No description*
|
||||
* **key** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **attribs**
|
||||
* **key**
|
||||
* **pool**
|
||||
### attributeTester (attribPair, pool)
|
||||
|
||||
###attributeTester (attribPair, pool)
|
||||
* **attribPair** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **attribPair**
|
||||
* **pool**
|
||||
### builder (oldLen)
|
||||
|
||||
###builder (oldLen)
|
||||
* **oldLen** *No description*
|
||||
|
||||
* **oldLen**
|
||||
### characterRangeFollow (cs, startChar, endChar, insertionsAfter)
|
||||
|
||||
###characterRangeFollow (cs, startChar, endChar, insertionsAfter)
|
||||
* **cs** *No description*
|
||||
* **startChar** *No description*
|
||||
* **endChar** *No description*
|
||||
* **insertionsAfter** *No description*
|
||||
|
||||
* **cs**
|
||||
* **startChar**
|
||||
* **endChar**
|
||||
* **insertionsAfter**
|
||||
### checkRep (cs)
|
||||
|
||||
###checkRep (cs)
|
||||
* **cs** *No description*
|
||||
|
||||
* **cs**
|
||||
### clearOp (op)
|
||||
|
||||
###clearOp (op)
|
||||
* **op** *No description*
|
||||
|
||||
* **op**
|
||||
### cloneAText (atext)
|
||||
|
||||
###cloneAText (atext)
|
||||
* **atext** *No description*
|
||||
|
||||
* **atext**
|
||||
### cloneOp (op)
|
||||
|
||||
###cloneOp (op)
|
||||
* **op** *No description*
|
||||
|
||||
* **op**
|
||||
### compose (cs1, cs2, pool)
|
||||
|
||||
###compose (cs1, cs2, pool)
|
||||
* **cs1** *No description*
|
||||
* **cs2** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs1**
|
||||
* **cs2**
|
||||
* **pool**
|
||||
### composeAttributes (att1, att2, resultIsMutation, pool)
|
||||
|
||||
###composeAttributes (att1, att2, resultIsMutation, pool)
|
||||
* **att1** *No description*
|
||||
* **att2** *No description*
|
||||
* **resultIsMutation** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **att1**
|
||||
* **att2**
|
||||
* **resultIsMutation**
|
||||
* **pool**
|
||||
### copyAText (atext1, atext2)
|
||||
|
||||
###copyAText (atext1, atext2)
|
||||
* **atext1** *No description*
|
||||
* **atext2** *No description*
|
||||
|
||||
* **atext1**
|
||||
* **atext2**
|
||||
### copyOp (op1, op2)
|
||||
|
||||
###copyOp (op1, op2)
|
||||
* **op1** *No description*
|
||||
* **op2** *No description*
|
||||
|
||||
* **op1**
|
||||
* **op2**
|
||||
### eachAttribNumber (cs, func)
|
||||
|
||||
###eachAttribNumber (cs, func)
|
||||
* **cs** *No description*
|
||||
* **func** *No description*
|
||||
|
||||
* **cs**
|
||||
* **func**
|
||||
### filterAttribNumbers (cs, filter)
|
||||
|
||||
###filterAttribNumbers (cs, filter)
|
||||
* **cs** *No description*
|
||||
* **filter** *No description*
|
||||
|
||||
* **cs**
|
||||
* **filter**
|
||||
### follow (cs1, cs2, reverseInsertOrder, pool)
|
||||
|
||||
###follow (cs1, cs2, reverseInsertOrder, pool)
|
||||
* **cs1** *No description*
|
||||
* **cs2** *No description*
|
||||
* **reverseInsertOrder** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs1**
|
||||
* **cs2**
|
||||
* **reverseInsertOrder**
|
||||
* **pool**
|
||||
### followAttributes (att1, att2, pool)
|
||||
|
||||
###followAttributes (att1, att2, pool)
|
||||
* **att1** *No description*
|
||||
* **att2** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **att1**
|
||||
* **att2**
|
||||
* **pool**
|
||||
### identity (N)
|
||||
|
||||
###identity (N)
|
||||
* **N** *No description*
|
||||
|
||||
* **N**
|
||||
### inverse (cs, lines, alines, pool)
|
||||
|
||||
###inverse (cs, lines, alines, pool)
|
||||
* **cs** *No description*
|
||||
* **lines** *No description*
|
||||
* **alines** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs**
|
||||
* **lines**
|
||||
* **alines**
|
||||
* **pool**
|
||||
### isIdentity (cs)
|
||||
|
||||
###isIdentity (cs)
|
||||
* **cs** *No description*
|
||||
|
||||
* **cs**
|
||||
### joinAttributionLines (theAlines)
|
||||
|
||||
###joinAttributionLines (theAlines)
|
||||
* **theAlines** *No description*
|
||||
|
||||
* **theAlines**
|
||||
### makeAText (text, attribs)
|
||||
|
||||
###makeAText (text, attribs)
|
||||
* **text** *No description*
|
||||
* **attribs** *No description*
|
||||
|
||||
* **text**
|
||||
* **attribs**
|
||||
### makeAttribsString (opcode, attribs, pool)
|
||||
|
||||
###makeAttribsString (opcode, attribs, pool)
|
||||
* **opcode** *No description*
|
||||
* **attribs** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **opcode**
|
||||
* **attribs**
|
||||
* **pool**
|
||||
### makeAttribution (text)
|
||||
|
||||
###makeAttribution (text)
|
||||
* **text** *No description*
|
||||
|
||||
* **text**
|
||||
### makeSplice (oldFullText, spliceStart, numRemoved, newText, optNewTextAPairs, pool)
|
||||
|
||||
###makeSplice (oldFullText, spliceStart, numRemoved, newText, optNewTextAPairs, pool)
|
||||
* **oldFullText** *No description*
|
||||
* **spliceStart** *No description*
|
||||
* **numRemoved** *No description*
|
||||
* **newText** *No description*
|
||||
* **optNewTextAPairs** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **oldFullText**
|
||||
* **spliceStart**
|
||||
* **numRemoved**
|
||||
* **newText**
|
||||
* **optNewTextAPairs**
|
||||
* **pool**
|
||||
### mapAttribNumbers (cs, func)
|
||||
|
||||
###mapAttribNumbers (cs, func)
|
||||
* **cs** *No description*
|
||||
* **func** *No description*
|
||||
|
||||
* **cs**
|
||||
* **func**
|
||||
### mergingOpAssembler ()
|
||||
|
||||
###mergingOpAssembler ()
|
||||
|
||||
* ****
|
||||
### moveOpsToNewPool (cs, oldPool, newPool)
|
||||
|
||||
###moveOpsToNewPool (cs, oldPool, newPool)
|
||||
* **cs** *No description*
|
||||
* **oldPool** *No description*
|
||||
* **newPool** *No description*
|
||||
|
||||
* **cs**
|
||||
* **oldPool**
|
||||
* **newPool**
|
||||
### mutateAttributionLines (cs, lines, pool)
|
||||
|
||||
###mutateAttributionLines (cs, lines, pool)
|
||||
Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
* **cs** *No description*
|
||||
* **lines** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs**
|
||||
* **lines**
|
||||
* **pool**
|
||||
### mutateTextLines (cs, lines)
|
||||
|
||||
###mutateTextLines (cs, lines)
|
||||
* **cs** *No description*
|
||||
* **lines** *No description*
|
||||
|
||||
* **cs**
|
||||
* **lines**
|
||||
### newLen (cs)
|
||||
|
||||
###newLen (cs)
|
||||
* **cs** *No description*
|
||||
|
||||
* **cs**
|
||||
### newOp (optOpcode)
|
||||
|
||||
###newOp (optOpcode)
|
||||
* **optOpcode** *No description*
|
||||
|
||||
* **optOpcode**
|
||||
### numToString (num)
|
||||
|
||||
###numToString (num)
|
||||
* **num** *No description*
|
||||
|
||||
* **num**
|
||||
### oldLen (cs)
|
||||
|
||||
###oldLen (cs)
|
||||
* **cs** *No description*
|
||||
|
||||
* **cs**
|
||||
### oneInsertedLineAtATimeOpIterator (opsStr, optStartIndex, charBank)
|
||||
|
||||
###oneInsertedLineAtATimeOpIterator (opsStr, optStartIndex, charBank)
|
||||
* **opsStr** *No description*
|
||||
* **optStartIndex** *No description*
|
||||
* **charBank** *No description*
|
||||
|
||||
* **opsStr**
|
||||
* **optStartIndex**
|
||||
* **charBank**
|
||||
### opAssembler ()
|
||||
|
||||
###opAssembler ()
|
||||
|
||||
* ****
|
||||
### opAttributeValue (op, key, pool)
|
||||
|
||||
###opAttributeValue (op, key, pool)
|
||||
* **op** *No description*
|
||||
* **key** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **op**
|
||||
* **key**
|
||||
* **pool**
|
||||
### opIterator (opsStr, optStartIndex)
|
||||
|
||||
###opIterator (opsStr, optStartIndex)
|
||||
* **opsStr** *No description*
|
||||
* **optStartIndex** *No description*
|
||||
|
||||
* **opsStr**
|
||||
* **optStartIndex**
|
||||
### opString (op)
|
||||
|
||||
###opString (op)
|
||||
* **op** *No description*
|
||||
|
||||
* **op**
|
||||
### pack (oldLen, newLen, opsStr, bank)
|
||||
|
||||
###pack (oldLen, newLen, opsStr, bank)
|
||||
* **oldLen** *No description*
|
||||
* **newLen** *No description*
|
||||
* **opsStr** *No description*
|
||||
* **bank** *No description*
|
||||
|
||||
* **oldLen**
|
||||
* **newLen**
|
||||
* **opsStr**
|
||||
* **bank**
|
||||
### parseNum (str)
|
||||
|
||||
###parseNum (str)
|
||||
* **str** *No description*
|
||||
|
||||
* **str**
|
||||
### prepareForWire (cs, pool)
|
||||
|
||||
###prepareForWire (cs, pool)
|
||||
* **cs** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs**
|
||||
* **pool**
|
||||
### smartOpAssembler ()
|
||||
|
||||
###smartOpAssembler ()
|
||||
|
||||
* ****
|
||||
### splitAttributionLines (attrOps, text)
|
||||
|
||||
###splitAttributionLines (attrOps, text)
|
||||
* **attrOps** *No description*
|
||||
* **text** *No description*
|
||||
|
||||
* **attrOps**
|
||||
* **text**
|
||||
### splitTextLines (text)
|
||||
|
||||
###splitTextLines (text)
|
||||
* **text** *No description*
|
||||
|
||||
* **text**
|
||||
### stringAssembler ()
|
||||
|
||||
###stringAssembler ()
|
||||
|
||||
* ****
|
||||
### stringIterator (str)
|
||||
|
||||
###stringIterator (str)
|
||||
* **str** *No description*
|
||||
|
||||
* **str**
|
||||
### stringOp (str)
|
||||
|
||||
###stringOp (str)
|
||||
* **str** *No description*
|
||||
|
||||
* **str**
|
||||
### subattribution (astr, start, optEnd)
|
||||
|
||||
###subattribution (astr, start, optEnd)
|
||||
* **astr** *No description*
|
||||
* **start** *No description*
|
||||
* **optEnd** *No description*
|
||||
|
||||
* **astr**
|
||||
* **start**
|
||||
* **optEnd**
|
||||
### textLinesMutator (lines)
|
||||
|
||||
###textLinesMutator (lines)
|
||||
* **lines** *No description*
|
||||
|
||||
* **lines**
|
||||
### toBaseTen (cs)
|
||||
|
||||
###toBaseTen (cs)
|
||||
* **cs** *No description*
|
||||
|
||||
* **cs**
|
||||
### toSplices (cs)
|
||||
|
||||
###toSplices (cs)
|
||||
* **cs** *No description*
|
||||
|
||||
* **cs**
|
||||
### unpack (cs)
|
||||
|
||||
###unpack (cs)
|
||||
|
||||
* **cs**
|
||||
* **cs** *No description*
|
||||
|
||||
##Variables
|
||||
|
||||
###assert
|
||||
### assert
|
||||
|
||||
|
||||
###error
|
||||
### error
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,48 +1,28 @@
|
|||
#MessageHandler
|
||||
# MessageHandler
|
||||
`require("./MessageHandler");`
|
||||
|
||||
Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
The MessageHandler handles all Messages that comes from Socket.IO and controls the sessions
|
||||
|
||||
##Functions
|
||||
## Functions
|
||||
|
||||
###handleConnect (client)
|
||||
### handleConnect (client)
|
||||
Handles the connection of a new user
|
||||
|
||||
* **client** the new client
|
||||
|
||||
###handleDisconnect (client)
|
||||
### handleDisconnect (client)
|
||||
Handles the disconnection of a user
|
||||
|
||||
* **client** the client that leaves
|
||||
|
||||
###handleMessage (client, message)
|
||||
### handleMessage (client, message)
|
||||
Handles a message from a user
|
||||
|
||||
* **client** the client that send this message
|
||||
* **message** the message from the client
|
||||
|
||||
###setSocketIO (socket_io)
|
||||
Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
### setSocketIO (socket_io)
|
||||
A associative array that translates a session to a pad
|
||||
|
||||
* **socket_io** The Socket
|
||||
|
||||
##Variables
|
||||
|
||||
|
|
|
|||
|
|
@ -1,15 +1,12 @@
|
|||
#Mod
|
||||
# Mod
|
||||
`require("./Models/Pad");`
|
||||
|
||||
Copied from the Etherpad source code, don't know what its good for
|
||||
@param txt
|
||||
The pad object, defined with joose
|
||||
|
||||
##Functions
|
||||
## Functions
|
||||
|
||||
###cleanText (txt)
|
||||
Copied from the Etherpad source code, don't know what its good for
|
||||
### cleanText (txt)
|
||||
Copied from the Etherpad source code. It converts Windows line breaks to Unix line breaks and convert Tabs to spaces
|
||||
|
||||
* **txt**
|
||||
|
||||
##Variables
|
||||
* **txt** *No description*
|
||||
|
||||
|
|
|
|||
|
|
@ -1,33 +1,13 @@
|
|||
#PadManager
|
||||
# PadManager
|
||||
`require("./PadManager");`
|
||||
|
||||
2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
The Pad Manager is a Factory for pad Objects
|
||||
|
||||
##Functions
|
||||
## Functions
|
||||
|
||||
###getPad (id, callback)
|
||||
2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
### getPad (id, callback)
|
||||
A Array with all known Pads
|
||||
|
||||
* **id** A String with the id of the pad
|
||||
* **callback**
|
||||
|
||||
##Variables
|
||||
* **callback** *(Function)* *No description*
|
||||
|
||||
|
|
|
|||
|
|
@ -1,25 +1,18 @@
|
|||
#db
|
||||
# db
|
||||
`require("./db");`
|
||||
|
||||
2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
The DB Module provides a database initalized with the settings
|
||||
provided by the settings module
|
||||
|
||||
##Functions
|
||||
## Functions
|
||||
|
||||
###init (callback)
|
||||
### init (callback)
|
||||
Initalizes the database with the settings provided by the settings module
|
||||
|
||||
* **callback**
|
||||
* **callback** *(Function)* *No description*
|
||||
|
||||
##Variables
|
||||
|
||||
###db
|
||||
|
||||
### db
|
||||
The UeberDB Object that provides the database functions
|
||||
|
||||
|
|
|
|||
|
|
@ -1,18 +1,7 @@
|
|||
#easysync_tests
|
||||
# easysync_tests
|
||||
`require("./easysync_tests");`
|
||||
|
||||
Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
##Functions
|
||||
|
||||
##Variables
|
||||
I found this tests in the old Etherpad and used it to test if the Changeset library can be run on node.js.
|
||||
It has no use for ep-lite, but I thought I keep it cause it may help someone to understand the Changeset library
|
||||
https://github.com/ether/pad/blob/master/infrastructure/ace/www/easysync2_tests.js
|
||||
|
||||
|
|
|
|||
|
|
@ -1,33 +1,14 @@
|
|||
#minify
|
||||
# minify
|
||||
`require("./minify");`
|
||||
|
||||
2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
This Module manages all /minified/* requests. It controls the
|
||||
minification && compression of Javascript and CSS.
|
||||
|
||||
##Functions
|
||||
## Functions
|
||||
|
||||
###padJS (req, res)
|
||||
2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
### padJS (req, res)
|
||||
Answers a http request for the pad javascript
|
||||
|
||||
* **req**
|
||||
* **res**
|
||||
|
||||
##Variables
|
||||
* **req** the Express request
|
||||
* **res** the Express response
|
||||
|
||||
|
|
|
|||
|
|
@ -1,21 +1,12 @@
|
|||
#server
|
||||
# server
|
||||
`require("./server");`
|
||||
|
||||
2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
##Functions
|
||||
This module is started with bin/run.sh. It sets up a Express HTTP and a Socket.IO Server.
|
||||
Static file Requests are answered directly from this module, Socket.IO messages are passed
|
||||
to MessageHandler and minfied requests are passed to minified.
|
||||
|
||||
##Variables
|
||||
|
||||
###maxAge
|
||||
### maxAge
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,36 +1,26 @@
|
|||
#settings
|
||||
# settings
|
||||
`require("./settings");`
|
||||
|
||||
2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
##Functions
|
||||
The Settings Modul reads the settings out of settings.json and provides
|
||||
this information to the other modules
|
||||
|
||||
##Variables
|
||||
|
||||
###dbSettings
|
||||
### dbSettings
|
||||
This setting is passed with dbType to ueberDB to set up the database
|
||||
|
||||
### dbType
|
||||
|
||||
|
||||
###dbType
|
||||
### defaultPadText
|
||||
The default Text of a new pad
|
||||
|
||||
### logHTTP
|
||||
A flag that shows if http requests should be loged to stdout
|
||||
|
||||
###defaultPadText
|
||||
|
||||
|
||||
###logHTTP
|
||||
|
||||
|
||||
###minify
|
||||
|
||||
|
||||
###port
|
||||
### minify
|
||||
A flag that shows if minification is enabled or not
|
||||
|
||||
### port
|
||||
The Port ep-lite should listen to
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue