2023-06-21 14:13:31 +02:00
== Embed parameters
2017-09-14 13:33:27 +02:00
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:
2020-12-26 22:05:08 +01:00
Cut and paste the following code into any webpage to embed a pad. The parameters below will hide the chat and the line numbers and will auto-focus on Line 4.
2012-08-07 20:19:37 +02:00
2023-06-21 14:13:31 +02:00
[source, html]
----
2020-12-26 22:05:08 +01:00
<iframe src='http://pad.test.de/p/PAD_NAME#L4?showChat=false&showLineNumbers=false' width=600 height=400></iframe>
2023-06-21 14:13:31 +02:00
----
2012-08-03 22:04:06 +02:00
2023-06-21 14:13:31 +02:00
=== showLineNumbers
2012-08-03 22:04:06 +02:00
* Boolean
Default: true
2023-06-21 14:13:31 +02:00
=== showControls
2012-08-03 22:04:06 +02:00
* Boolean
Default: true
2023-06-21 14:13:31 +02:00
=== showChat
2012-08-03 22:04:06 +02:00
* Boolean
Default: true
2023-06-21 14:13:31 +02:00
=== useMonospaceFont
2012-08-03 22:04:06 +02:00
* Boolean
Default: false
2023-06-21 14:13:31 +02:00
=== userName
2012-08-03 22:04:06 +02:00
* String
Default: "unnamed"
Example: `userName=Etherpad%20User`
2023-06-21 14:13:31 +02:00
=== userColor
2012-10-31 20:28:12 +01:00
* String (css hex color value)
Default: randomly chosen by pad server
Example: `userColor=%23ff9900`
2023-06-21 14:13:31 +02:00
=== noColors
2012-08-03 22:04:06 +02:00
* Boolean
Default: false
2023-06-21 14:13:31 +02:00
=== alwaysShowChat
2012-08-03 22:04:06 +02:00
* Boolean
2012-08-14 04:03:06 +02:00
Default: false
2012-11-14 17:21:45 +01:00
2023-06-21 14:13:31 +02:00
=== lang
2012-11-14 17:21:45 +01:00
* String
Default: en
Example: `lang=ar` (translates the interface into Arabic)
2023-06-21 14:13:31 +02:00
=== rtl
2013-03-05 23:12:00 +01:00
* Boolean
2019-10-20 02:09:22 +02:00
2013-03-05 23:12:00 +01:00
Default: true
Displays pad text from right to left.
2023-06-21 14:13:31 +02:00
=== #L
2020-12-26 22:05:08 +01:00
* Int
Default: 0
Focuses pad at specific line number and places caret at beginning of this line
Special note: Is not a URL parameter but instead of a Hash value