etherpad-lite/doc/api/embed_parameters.md

69 lines
1 KiB
Markdown
Raw Normal View History

# Embed parameters
You can easily embed your etherpad-lite into any webpage by using iframes. You can configure the embedded pad using embed parameters.
2012-08-03 22:04:06 +02:00
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
2012-08-03 22:04:06 +02:00
* Boolean
Default: true
## showControls
2012-08-03 22:04:06 +02:00
* Boolean
Default: true
## showChat
2012-08-03 22:04:06 +02:00
* Boolean
Default: true
## useMonospaceFont
2012-08-03 22:04:06 +02:00
* Boolean
Default: false
## userName
2012-08-03 22:04:06 +02:00
* String
Default: "unnamed"
Example: `userName=Etherpad%20User`
2012-10-31 20:28:12 +01:00
## userColor
* String (css hex color value)
Default: randomly chosen by pad server
Example: `userColor=%23ff9900`
## noColors
2012-08-03 22:04:06 +02:00
* Boolean
Default: false
## alwaysShowChat
2012-08-03 22:04:06 +02:00
* Boolean
Default: false
2012-11-14 17:21:45 +01:00
## lang
* String
Default: en
Example: `lang=ar` (translates the interface into Arabic)
## rtl
* Boolean
Default: true
Displays pad text from right to left.