mirror of
				https://github.com/ether/etherpad-lite.git
				synced 2025-11-04 10:11:33 +01:00 
			
		
		
		
	removed docs created with doc.md, these docs were completly useless
This commit is contained in:
		
							parent
							
								
									bfbdac10d3
								
							
						
					
					
						commit
						3c8ee3df20
					
				@ -114,8 +114,8 @@ You also help the project, if you only host a Etherpad Lite instance and share y
 | 
				
			|||||||
# Modules created for this project
 | 
					# Modules created for this project
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* [ueberDB](https://github.com/Pita/ueberDB) "transforms every database into a object key value store" - manages all database access
 | 
					* [ueberDB](https://github.com/Pita/ueberDB) "transforms every database into a object key value store" - manages all database access
 | 
				
			||||||
* [doc.md](https://github.com/Pita/doc.md) "A simple JSDoc documentation tool that creates markdown for node.js modules exports" - is used to generate the docs
 | 
					 | 
				
			||||||
* [channels](https://github.com/Pita/channels) "Event channels in node.js" - ensures that ueberDB operations are atomic and in series for each key
 | 
					* [channels](https://github.com/Pita/channels) "Event channels in node.js" - ensures that ueberDB operations are atomic and in series for each key
 | 
				
			||||||
 | 
					* [async-stacktrace](https://github.com/Pita/async-stacktrace) "Improves node.js stacktraces and makes it easier to handle errors"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# License
 | 
					# License
 | 
				
			||||||
[Apache License v2](http://www.apache.org/licenses/LICENSE-2.0.html)
 | 
					[Apache License v2](http://www.apache.org/licenses/LICENSE-2.0.html)
 | 
				
			||||||
 | 
				
			|||||||
@ -1,24 +0,0 @@
 | 
				
			|||||||
#!/bin/sh
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
#Move to the folder where ep-lite is installed
 | 
					 | 
				
			||||||
cd `dirname $0`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
#Was this script started in the bin folder? if yes move out
 | 
					 | 
				
			||||||
if [ -d "../bin" ]; then
 | 
					 | 
				
			||||||
  cd "../"
 | 
					 | 
				
			||||||
fi
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
hash node > /dev/null 2>&1 || { 
 | 
					 | 
				
			||||||
  echo "You need to install node!" >&2
 | 
					 | 
				
			||||||
  exit 1 
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
hash doc.md > /dev/null 2>&1 || { 
 | 
					 | 
				
			||||||
  echo "You need to install doc.md! npm install -g doc.md" >&2
 | 
					 | 
				
			||||||
  exit 1 
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
echo "empty doc folder..."
 | 
					 | 
				
			||||||
rm -rf doc/jsdoc/*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
doc.md node doc/jsdoc
 | 
					 | 
				
			||||||
@ -1,2 +0,0 @@
 | 
				
			|||||||
# About this folder
 | 
					 | 
				
			||||||
This is the documentation generated with doc.md. This documentation might be not up to date, you can generate the latest jsdocs with bin/generateJsDoc.sh
 | 
					 | 
				
			||||||
@ -1,53 +0,0 @@
 | 
				
			|||||||
# db/AuthorMana
 | 
					 | 
				
			||||||
`require("./db/AuthorManager");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
The AuthorManager controlls all information about the Pad authors
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### getAuthor (author, callback)
 | 
					 | 
				
			||||||
Internal function that creates the database entry for an author
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **author** *(String)* The id of the author
 | 
					 | 
				
			||||||
* **callback** *(Function)* callback(err, authorObj)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### getAuthor4Token (token, callback)
 | 
					 | 
				
			||||||
Returns the Author Id for a token. If the token is unkown, 
 | 
					 | 
				
			||||||
it creates a author for the token
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **token** *(String)* The token
 | 
					 | 
				
			||||||
* **callback** *(Function)* callback (err, author) 
 | 
					 | 
				
			||||||
The callback function that is called when the result is here
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### getAuthorColorId (author, callback)
 | 
					 | 
				
			||||||
Returns the color Id of the author
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **author** *(String)* The id of the author
 | 
					 | 
				
			||||||
* **callback** *(Function)* callback(err, colorId)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### getAuthorName (author, callback)
 | 
					 | 
				
			||||||
Returns the name of the author
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **author** *(String)* The id of the author
 | 
					 | 
				
			||||||
* **callback** *(Function)* callback(err, name)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### setAuthorColorId (author, colorId, callback)
 | 
					 | 
				
			||||||
Sets the color Id of the author
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **author** *(String)* The id of the author
 | 
					 | 
				
			||||||
* **colorId** *No description*
 | 
					 | 
				
			||||||
* **callback** *(Function)* (optional)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### setAuthorName (author, name, callback)
 | 
					 | 
				
			||||||
Sets the name of the author
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **author** *(String)* The id of the author
 | 
					 | 
				
			||||||
* **name** *No description*
 | 
					 | 
				
			||||||
* **callback** *(Function)* (optional)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,20 +0,0 @@
 | 
				
			|||||||
# db
 | 
					 | 
				
			||||||
`require("./db/DB");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
The DB Module provides a database initalized with the settings 
 | 
					 | 
				
			||||||
provided by the settings module
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### init (callback)
 | 
					 | 
				
			||||||
Initalizes the database with the settings provided by the settings module
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **callback** *(Function)* *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
##Variables
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### db 
 | 
					 | 
				
			||||||
The UeberDB Object that provides the database functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,13 +0,0 @@
 | 
				
			|||||||
# db/
 | 
					 | 
				
			||||||
`require("./db/Pad");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
The pad object, defined with joose
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### cleanText (txt)
 | 
					 | 
				
			||||||
Copied from the Etherpad source code. It converts Windows line breaks to Unix line breaks and convert Tabs to spaces
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **txt** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,14 +0,0 @@
 | 
				
			|||||||
# db/PadMana
 | 
					 | 
				
			||||||
`require("./db/PadManager");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
The Pad Manager is a Factory for pad Objects
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### getPad (id, callback)
 | 
					 | 
				
			||||||
A Array with all known Pads
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **id** A String with the id of the pad
 | 
					 | 
				
			||||||
* **callback** *(Function)* *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,21 +0,0 @@
 | 
				
			|||||||
# db/ReadOnlyMana
 | 
					 | 
				
			||||||
`require("./db/ReadOnlyManager");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
The ReadOnlyManager manages the database and rendering releated to read only pads
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### getPadId (readOnlyId, callback)
 | 
					 | 
				
			||||||
returns a the padId for a read only id
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **readOnlyId** *(String)* read only id
 | 
					 | 
				
			||||||
* **callback** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### getReadOnlyId (padId, callback)
 | 
					 | 
				
			||||||
returns a read only id for a pad
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **padId** *(String)* the id of the pad
 | 
					 | 
				
			||||||
* **callback** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,7 +0,0 @@
 | 
				
			|||||||
# easysync_tests
 | 
					 | 
				
			||||||
`require("./easysync_tests");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
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,16 +0,0 @@
 | 
				
			|||||||
# handler/Expor
 | 
					 | 
				
			||||||
`require("./handler/ExportHandler");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Handles the export requests
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### doExport (req, res, padId, type)
 | 
					 | 
				
			||||||
do a requested export
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **req** *No description*
 | 
					 | 
				
			||||||
* **res** *No description*
 | 
					 | 
				
			||||||
* **padId** *No description*
 | 
					 | 
				
			||||||
* **type** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,15 +0,0 @@
 | 
				
			|||||||
# handler/Impor
 | 
					 | 
				
			||||||
`require("./handler/ImportHandler");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Handles the import requests
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### doImport (req, res, padId)
 | 
					 | 
				
			||||||
do a requested import
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **req** *No description*
 | 
					 | 
				
			||||||
* **res** *No description*
 | 
					 | 
				
			||||||
* **padId** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,38 +0,0 @@
 | 
				
			|||||||
# handler/PadMessag
 | 
					 | 
				
			||||||
`require("./handler/PadMessageHandler");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
The MessageHandler handles all Messages that comes from Socket.IO and controls the sessions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### handleConnect (client)
 | 
					 | 
				
			||||||
Handles the connection of a new user
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **client** the new client
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### handleDisconnect (client)
 | 
					 | 
				
			||||||
Handles the disconnection of a user
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **client** the client that leaves
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### 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)
 | 
					 | 
				
			||||||
A associative array that translates a session to a pad
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **socket_io** The Socket
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### updatePadClients (pad, callback)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **pad** *No description*
 | 
					 | 
				
			||||||
* **callback** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,23 +0,0 @@
 | 
				
			|||||||
# handler/Socket
 | 
					 | 
				
			||||||
`require("./handler/SocketIORouter");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
This is the Socket.IO Router. It routes the Messages between the 
 | 
					 | 
				
			||||||
components of the Server. The components are at the moment: pad and timeslider
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### addComponent (moduleName, module)
 | 
					 | 
				
			||||||
Saves all components
 | 
					 | 
				
			||||||
key is the component name
 | 
					 | 
				
			||||||
value is the component module
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **moduleName** *No description*
 | 
					 | 
				
			||||||
* **module** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### setSocketIO (_socket)
 | 
					 | 
				
			||||||
sets the socket.io and adds event functions for routing
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **_socket** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,32 +0,0 @@
 | 
				
			|||||||
# handler/TimesliderMessag
 | 
					 | 
				
			||||||
`require("./handler/TimesliderMessageHandler");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
The MessageHandler handles all Messages that comes from Socket.IO and controls the sessions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### handleConnect (client)
 | 
					 | 
				
			||||||
Handles the connection of a new user
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **client** the new client
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### handleDisconnect (client)
 | 
					 | 
				
			||||||
Handles the disconnection of a user
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **client** the client that leaves
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### 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)
 | 
					 | 
				
			||||||
Saves the Socket class we need to send and recieve data from the client
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **socket_io** The Socket
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,13 +0,0 @@
 | 
				
			|||||||
# server
 | 
					 | 
				
			||||||
`require("./server");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
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 
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,15 +0,0 @@
 | 
				
			|||||||
# utils/A
 | 
					 | 
				
			||||||
`require("./utils/Abiword");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Controls the communication with the Abiword application
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### convertFile (srcFile, destFile, type, callback)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **srcFile** *No description*
 | 
					 | 
				
			||||||
* **destFile** *No description*
 | 
					 | 
				
			||||||
* **type** *No description*
 | 
					 | 
				
			||||||
* **callback** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,15 +0,0 @@
 | 
				
			|||||||
# utils/AttributePoolF
 | 
					 | 
				
			||||||
`require("./utils/AttributePoolFactory");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
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
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### createAttributePool ()
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,363 +0,0 @@
 | 
				
			|||||||
# utils/Cha
 | 
					 | 
				
			||||||
`require("./utils/Changeset");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### _slicerZipperFunc (attOp, csOp, opOut, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **attOp** *No description*
 | 
					 | 
				
			||||||
* **csOp** *No description*
 | 
					 | 
				
			||||||
* **opOut** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### appendATextToAssembler (atext, assem)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **atext** *No description*
 | 
					 | 
				
			||||||
* **assem** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### applyToAText (cs, atext, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
* **atext** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### applyToAttribution (cs, astr, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
* **astr** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### applyToText (cs, str)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
* **str** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### applyZip (in1, idx1, in2, idx2, func)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **in1** *No description*
 | 
					 | 
				
			||||||
* **idx1** *No description*
 | 
					 | 
				
			||||||
* **in2** *No description*
 | 
					 | 
				
			||||||
* **idx2** *No description*
 | 
					 | 
				
			||||||
* **func** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### attribsAttributeValue (attribs, key, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **attribs** *No description*
 | 
					 | 
				
			||||||
* **key** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### attributeTester (attribPair, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **attribPair** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### builder (oldLen)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **oldLen** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### characterRangeFollow (cs, startChar, endChar, insertionsAfter)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
* **startChar** *No description*
 | 
					 | 
				
			||||||
* **endChar** *No description*
 | 
					 | 
				
			||||||
* **insertionsAfter** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### checkRep (cs)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### clearOp (op)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **op** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### cloneAText (atext)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **atext** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### cloneOp (op)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **op** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### compose (cs1, cs2, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs1** *No description*
 | 
					 | 
				
			||||||
* **cs2** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### composeAttributes (att1, att2, resultIsMutation, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **att1** *No description*
 | 
					 | 
				
			||||||
* **att2** *No description*
 | 
					 | 
				
			||||||
* **resultIsMutation** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### copyAText (atext1, atext2)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **atext1** *No description*
 | 
					 | 
				
			||||||
* **atext2** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### copyOp (op1, op2)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **op1** *No description*
 | 
					 | 
				
			||||||
* **op2** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### eachAttribNumber (cs, func)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
* **func** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### filterAttribNumbers (cs, filter)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
* **filter** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### follow (cs1, cs2, reverseInsertOrder, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs1** *No description*
 | 
					 | 
				
			||||||
* **cs2** *No description*
 | 
					 | 
				
			||||||
* **reverseInsertOrder** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### followAttributes (att1, att2, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **att1** *No description*
 | 
					 | 
				
			||||||
* **att2** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### identity (N)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **N** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### inverse (cs, lines, alines, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
* **lines** *No description*
 | 
					 | 
				
			||||||
* **alines** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### isIdentity (cs)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### joinAttributionLines (theAlines)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **theAlines** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### makeAText (text, attribs)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **text** *No description*
 | 
					 | 
				
			||||||
* **attribs** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### makeAttribsString (opcode, attribs, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **opcode** *No description*
 | 
					 | 
				
			||||||
* **attribs** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### makeAttribution (text)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **text** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### 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*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### mapAttribNumbers (cs, func)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
* **func** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### mergingOpAssembler ()
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### moveOpsToNewPool (cs, oldPool, newPool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
* **oldPool** *No description*
 | 
					 | 
				
			||||||
* **newPool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### mutateAttributionLines (cs, lines, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
* **lines** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### mutateTextLines (cs, lines)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
* **lines** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### newLen (cs)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### newOp (optOpcode)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **optOpcode** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### numToString (num)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **num** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### oldLen (cs)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### oneInsertedLineAtATimeOpIterator (opsStr, optStartIndex, charBank)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **opsStr** *No description*
 | 
					 | 
				
			||||||
* **optStartIndex** *No description*
 | 
					 | 
				
			||||||
* **charBank** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### opAssembler ()
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### opAttributeValue (op, key, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **op** *No description*
 | 
					 | 
				
			||||||
* **key** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### opIterator (opsStr, optStartIndex)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **opsStr** *No description*
 | 
					 | 
				
			||||||
* **optStartIndex** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### opString (op)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **op** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### pack (oldLen, newLen, opsStr, bank)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **oldLen** *No description*
 | 
					 | 
				
			||||||
* **newLen** *No description*
 | 
					 | 
				
			||||||
* **opsStr** *No description*
 | 
					 | 
				
			||||||
* **bank** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### parseNum (str)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **str** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### prepareForWire (cs, pool)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
* **pool** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### smartOpAssembler ()
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### splitAttributionLines (attrOps, text)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **attrOps** *No description*
 | 
					 | 
				
			||||||
* **text** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### splitTextLines (text)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **text** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### stringAssembler ()
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### stringIterator (str)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **str** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### stringOp (str)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **str** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### subattribution (astr, start, optEnd)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **astr** *No description*
 | 
					 | 
				
			||||||
* **start** *No description*
 | 
					 | 
				
			||||||
* **optEnd** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### textLinesMutator (lines)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **lines** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### toBaseTen (cs)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### toSplices (cs)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### unpack (cs)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **cs** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
##Variables
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### assert 
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### error 
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,24 +0,0 @@
 | 
				
			|||||||
# utils/Expo
 | 
					 | 
				
			||||||
`require("./utils/ExportHtml");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Copyright 2009 Google Inc.
 | 
					 | 
				
			||||||
* 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
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### getPadHTMLDocument (padId, revNum, noDocType, callback)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **padId** *No description*
 | 
					 | 
				
			||||||
* **revNum** *No description*
 | 
					 | 
				
			||||||
* **noDocType** *No description*
 | 
					 | 
				
			||||||
* **callback** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,16 +0,0 @@
 | 
				
			|||||||
# utils/
 | 
					 | 
				
			||||||
`require("./utils/Minify");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
This Module manages all /minified/* requests. It controls the 
 | 
					 | 
				
			||||||
minification && compression of Javascript and CSS.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Functions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### minifyJS (req, res, jsFilename)
 | 
					 | 
				
			||||||
creates the minifed javascript for the given minified name
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **req** the Express request
 | 
					 | 
				
			||||||
* **res** the Express response
 | 
					 | 
				
			||||||
* **jsFilename** *No description*
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@ -1,40 +0,0 @@
 | 
				
			|||||||
# utils/Se
 | 
					 | 
				
			||||||
`require("./utils/Settings");`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
The Settings Modul reads the settings out of settings.json and provides 
 | 
					 | 
				
			||||||
this information to the other modules
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
##Variables
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### abiword 
 | 
					 | 
				
			||||||
The path of the abiword executable
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### dbSettings 
 | 
					 | 
				
			||||||
This setting is passed with dbType to ueberDB to set up the database
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### dbType 
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### defaultPadText 
 | 
					 | 
				
			||||||
The default Text of a new pad
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### ip 
 | 
					 | 
				
			||||||
The IP ep-lite should listen to
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### logHTTP 
 | 
					 | 
				
			||||||
A flag that shows if http requests should be loged to stdout
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### minify 
 | 
					 | 
				
			||||||
A flag that shows if minification is enabled or not
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- - -
 | 
					 | 
				
			||||||
### port 
 | 
					 | 
				
			||||||
The Port ep-lite should listen to
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user