public-offering
/
pad.pub0.org
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
pad.pub0.org/doc/api/embed_parameters.md

76 lines
1.2 KiB
Markdown
Raw Normal View History

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-14 02:03:06 +00:00
# Embed parameters
Typos and minor fixes in bin, doc, and root
2017-09-14 11:33:27 +00:00
You can easily embed your etherpad-lite into any webpage by using iframes. You can configure the embedded pad using embed parameters.
Add docs.
2012-08-03 20:04:06 +00:00
Restructure headings.
2012-08-07 18:19:37 +00:00
Example:
Feature: Scroll to Line number based on Hash IE http://foo.com/p/bar#L10 will scroll to line 10. (#4554) Includes test coverage Co-authored-by: webzwo0i <webzwo0i@c3d2.de>
2020-12-26 21:05:08 +00: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.
Restructure headings.
2012-08-07 18:19:37 +00:00
```
Feature: Scroll to Line number based on Hash IE http://foo.com/p/bar#L10 will scroll to line 10. (#4554) Includes test coverage Co-authored-by: webzwo0i <webzwo0i@c3d2.de>
2020-12-26 21:05:08 +00:00
<iframe src='http://pad.test.de/p/PAD_NAME#L4?showChat=false&showLineNumbers=false' width=600 height=400></iframe>
Restructure headings.
2012-08-07 18:19:37 +00:00
```
Add docs.
2012-08-03 20:04:06 +00:00
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-14 02:03:06 +00:00
## showLineNumbers
Add docs.
2012-08-03 20:04:06 +00:00
* Boolean
Default: true
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-14 02:03:06 +00:00
## showControls
Add docs.
2012-08-03 20:04:06 +00:00
* Boolean
Default: true
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-14 02:03:06 +00:00
## showChat
Add docs.
2012-08-03 20:04:06 +00:00
* Boolean
Default: true
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-14 02:03:06 +00:00
## useMonospaceFont
Add docs.
2012-08-03 20:04:06 +00:00
* Boolean
Default: false
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-14 02:03:06 +00:00
## userName
Add docs.
2012-08-03 20:04:06 +00:00
* String
Default: "unnamed"
Example: `userName=Etherpad%20User`
Add api docs for `userColor` query arg
2012-10-31 19:28:12 +00:00
## userColor
* String (css hex color value)
Default: randomly chosen by pad server
Example: `userColor=%23ff9900`
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-14 02:03:06 +00:00
## noColors
Add docs.
2012-08-03 20:04:06 +00:00
* Boolean
Default: false
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-14 02:03:06 +00:00
## alwaysShowChat
Add docs.
2012-08-03 20:04:06 +00:00
* Boolean
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-14 02:03:06 +00:00
Default: false
Document 'lang' Parameter
2012-11-14 16:21:45 +00:00
## lang
* String
Default: en
Example: `lang=ar` (translates the interface into Arabic)
Add a setting for RTL text direction (integrating the url paramter) Fixes #1191
2013-03-05 22:12:00 +00:00
## rtl
* Boolean
formatting: bulk remove trailing whitespaces Do not touch vendorized files (e.g. libraries that were imported from external projects). No functional changes. Command: find . -name '*.<EXTENSION>' -type f -print0 | xargs -0 sed -i 's/[[:space:]]*$//'
2019-10-20 00:09:22 +00:00
Add a setting for RTL text direction (integrating the url paramter) Fixes #1191
2013-03-05 22:12:00 +00:00
Default: true
Displays pad text from right to left.
Feature: Scroll to Line number based on Hash IE http://foo.com/p/bar#L10 will scroll to line 10. (#4554) Includes test coverage Co-authored-by: webzwo0i <webzwo0i@c3d2.de>
2020-12-26 21:05:08 +00:00
## #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