etherpad-lite/doc/api/embed_parameters.md

47 lines
761 B
Markdown
Raw Normal View History

2012-08-07 20:19:37 +02:00
## Embed parameters
2012-08-03 22:04:06 +02:00
You can easily embed your etherpad-lite into any webpage by using iframes. You can configure the embedded pad using embed paramters.
2012-08-07 20:19:37 +02:00
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>
```
2012-08-03 22:04:06 +02:00
### 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
2012-08-07 20:19:37 +02:00
Default: false