pad.pub0.org/doc/api/embed_parameters.adoc

77 lines
1.2 KiB
Plaintext
Raw Permalink 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 20:04:06 +00:00
2012-08-07 18:19:37 +00: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 and will auto-focus on Line 4.
2012-08-07 18:19:37 +00:00
[source, html]
----
<iframe src='http://pad.test.de/p/PAD_NAME#L4?showChat=false&showLineNumbers=false' width=600 height=400></iframe>
----
2012-08-03 20:04:06 +00:00
=== showLineNumbers
2012-08-03 20:04:06 +00:00
* Boolean
Default: true
=== showControls
2012-08-03 20:04:06 +00:00
* Boolean
Default: true
=== showChat
2012-08-03 20:04:06 +00:00
* Boolean
Default: true
=== useMonospaceFont
2012-08-03 20:04:06 +00:00
* Boolean
Default: false
=== userName
2012-08-03 20:04:06 +00:00
* String
Default: "unnamed"
Example: `userName=Etherpad%20User`
=== userColor
2012-10-31 19:28:12 +00:00
* String (css hex color value)
Default: randomly chosen by pad server
Example: `userColor=%23ff9900`
=== noColors
2012-08-03 20:04:06 +00:00
* Boolean
Default: false
=== alwaysShowChat
2012-08-03 20:04:06 +00:00
* Boolean
Default: false
2012-11-14 16:21:45 +00:00
=== lang
2012-11-14 16:21:45 +00:00
* String
Default: en
Example: `lang=ar` (translates the interface into Arabic)
=== rtl
* Boolean
Default: true
Displays pad text from right to left.
=== #L
* 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