forked from jwalck/etherpad-lite-client
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
14 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,34 @@ | ||
This PHP Etherpad Lite class allows you to easily interact with Etherpad Lite API with PHP. Etherpad Lite is a collaborative editor provided by the Etherpad Foundation. http://etherpad.org | ||
# PHP Etherpad Lite Client | ||
This PHP Etherpad Lite class allows you to easily interact with Etherpad Lite API with PHP. | ||
Etherpad Lite is a collaborative editor provided by the Etherpad Foundation (http://etherpad.org) | ||
|
||
#1 Basic usage | ||
## Basic usage | ||
|
||
<pre> | ||
include 'etherpad-lite-client.php'; | ||
$instance = new EtherpadLiteClient('EtherpadFTW,http://beta.etherpad.org/api'); | ||
$instance = new EtherpadLiteClient('EtherpadFTW', 'http://beta.etherpad.org/api'); | ||
$revisionCount = $instance->getRevisionsCount('testPad'); | ||
$revisionCount = $revisionCount->revisions; | ||
echo "Pad has $revisionCount revisions\n\n"; | ||
</pre> | ||
|
||
#2 Examples | ||
## Examples | ||
|
||
See it live here http://beta.etherpad.org/example_big.php | ||
See it live here: http://beta.etherpad.org/example\_big.php | ||
|
||
Examples are located in examples.php and example_big.php. examples.php contains an example for each API call. example_big.php contains a UI for managing pads. | ||
Examples are located in examples.php and example\_big.php. | ||
examples.php contains an example for each API call. | ||
example\_big.php contains a UI for managing pads. | ||
|
||
This example is the most commonly used, the example displays a pads text on the screen: | ||
|
||
<pre> | ||
$padContents = $instance->getText('testPad'); | ||
echo "Pad text is: <br/><ul>$padContents->text\n\n</ul>"; | ||
echo "End of Pad Text\n\n<hr>"; | ||
</pre> | ||
|
||
#3 License | ||
# License | ||
|
||
Apache License | ||
|
||
#4 Other stuff | ||
# Other stuff | ||
|
||
The Etherpad Foundation also provides a jQuery plugin for Etherpad Lite. This can be found at http://etherpad.org/2011/08/14/etherpad-lite-jquery-plugin/ | ||
The Etherpad Foundation also provides a jQuery plugin for Etherpad Lite. | ||
This can be found at http://etherpad.org/2011/08/14/etherpad-lite-jquery-plugin/ |