libretic/etherpad-lite
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
etherpad-lite/doc/api/embed_parameters.md
Mark Holmquist 17375b2eed Fix doc format, add in makefile for docs 
OK, first up, SOMEBODY *cough*analphabet*cough* screwed up the docs
by making them all use the wrong heading level. Not cool, guy. I
had to change them so they would compile right.

But anyway, now the docs will build into sexy-looking HTML and will
shortly be hosted on marktraceur.info.

Fixed the makefile to work properly.

Run:
 * `make clean` for removing old doc-build(s)
 * `make docs` for running new doc-build(s)
2012-08-13 21:11:39 -07:00

754 B
Raw Blame History

Embed parameters

You can easily embed your etherpad-lite into any webpage by using iframes. You can configure the embedded pad using embed paramters.

Example:

Cut and paste the following code into any webpage to embed a pad. The parameters below will hide the chat and the line numbers.

<iframe src='http://pad.test.de/p/PAD_NAME?showChat=false&showLineNumbers=false' width=600 height=400></iframe>

showLineNumbers

  • Boolean

Default: true

showControls

  • Boolean

Default: true

showChat

  • Boolean

Default: true

useMonospaceFont

  • Boolean

Default: false

userName

  • String

Default: "unnamed"

Example: userName=Etherpad%20User

noColors

  • Boolean

Default: false

alwaysShowChat

  • Boolean

Default: false