matty/peertube-plugin-livechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Text simplification to prepare translation.

Browse Source
This commit is contained in:
John Livingston 2021-06-11 14:45:18 +02:00
parent 80ef06c65f
commit d4f9fa9428
1 changed files with 59 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
server/lib/settings.ts
View File

@ -33,7 +33,7 @@ function initSettings (options: RegisterServerOptions): void {
}) })
registerSetting({ registerSetting({
name: 'chat-type', name: 'chat-type',
label: 'Webchat mode', label: 'Chat mode',
type: 'select', type: 'select',
default: 'disabled' as ChatType, default: 'disabled' as ChatType,
private: false, private: false,
@ -41,7 +41,7 @@ function initSettings (options: RegisterServerOptions): void {
{ value: 'disabled', label: 'Disabled' }, { value: 'disabled', label: 'Disabled' },
{ value: 'builtin-prosody', label: 'Prosody server controlled by Peertube (recommended)' }, { value: 'builtin-prosody', label: 'Prosody server controlled by Peertube (recommended)' },
{ value: 'builtin-converse', label: 'Connect to an existing XMPP server with ConverseJS' }, { value: 'builtin-converse', label: 'Connect to an existing XMPP server with ConverseJS' },
{ value: 'external-uri', label: 'Use an external webchat' } { value: 'external-uri', label: 'Use an external web chat tool' }
] as Array<{value: ChatType, label: string}>, ] as Array<{value: ChatType, label: string}>,
descriptionHTML: 'Please choose the webchat mode you want to use.' descriptionHTML: 'Please choose the webchat mode you want to use.'
}) })
@ -56,39 +56,38 @@ function initSettings (options: RegisterServerOptions): void {
name: 'chat-type-help-builtin-prosody', name: 'chat-type-help-builtin-prosody',
type: 'html', type: 'html',
label: 'Prosody server controlled by Peertube (recommended)', label: 'Prosody server controlled by Peertube (recommended)',
descriptionHTML: ` descriptionHTML: `With this mode, the Peertube server will control a local Prosody XMPP server.<br>
With this mode, the Peertube server will control a local Prosody XMPP server.<br> Note: you have to install the Prosody XMPP server.
Note: you have to install the Prosody XMPP server. Please read the <a
Please read the <a href="https://github.com/JohnXLivingston/peertube-plugin-livechat/blob/main/documentation/prosody.md"
href="https://github.com/JohnXLivingston/peertube-plugin-livechat/blob/main/documentation/prosody.md" target="_blank"
target="_blank" >documentation</a>.`,
>documentation.</a>`,
private: true private: true
}) })
registerSetting({ registerSetting({
name: 'chat-type-help-builtin-converse', name: 'chat-type-help-builtin-converse',
type: 'html', type: 'html',
label: 'Connect to an existing XMPP server with ConverseJS', label: 'Connect to an existing XMPP server with ConverseJS',
descriptionHTML: ` descriptionHTML:
With this mode, you can connect to an existing XMPP server, with anonymous authentication and rooms enabled. `With this mode, you can connect to an existing XMPP server, that allow anonymous authentication and room creation.
Please read the Please read the
<a <a
href="https://github.com/JohnXLivingston/peertube-plugin-livechat/blob/main/documentation/conversejs.md" href="https://github.com/JohnXLivingston/peertube-plugin-livechat/blob/main/documentation/conversejs.md"
target="_blank" target="_blank"
>documentation</a>.`, >documentation</a>.`,
private: true private: true
}) })
registerSetting({ registerSetting({
name: 'chat-type-help-external-uri', name: 'chat-type-help-external-uri',
type: 'html', type: 'html',
label: 'Use an external webchat', label: 'Use an external webchat',
descriptionHTML: ` descriptionHTML:
With this mode, you can use any external webchat that can be included in an iframe. `With this mode, you can use any external web chat that can be included in an iframe.
Please read the Please read the
<a <a
href="https://github.com/JohnXLivingston/peertube-plugin-livechat/blob/main/documentation/external.md" href="https://github.com/JohnXLivingston/peertube-plugin-livechat/blob/main/documentation/external.md"
target="_blank" target="_blank"
>documentation</a>.`, >documentation</a>.`,
private: true private: true
}) })
@ -98,9 +97,10 @@ function initSettings (options: RegisterServerOptions): void {
type: 'input', type: 'input',
default: '52800', default: '52800',
private: true, private: true,
descriptionHTML: 'The port that will be used by the builtin Prosody server.<br>' + descriptionHTML:
'Change it if this port is already in use on your server.<br>' + `The port that will be used by the builtin Prosody server.<br>
'You can close this port on your firewall, it will not be accessed from the outer world.' Change it if this port is already in use on your server.<br>
You can close this port on your firewall, it will not be accessed from the outer world.`
}) })
registerSetting({ registerSetting({
@ -116,10 +116,11 @@ function initSettings (options: RegisterServerOptions): void {
label: 'XMPP room template', label: 'XMPP room template',
type: 'input', type: 'input',
default: '', default: '',
descriptionHTML: 'Your XMPP room. You can use the placeholder {{VIDEO_UUID}} to add the video UUID.' + descriptionHTML:
'Without this placeholder, all videos will point to the same chat room.<br>' + `Your XMPP room. You can use the placeholder {{VIDEO_UUID}} to add the video UUID.
'Example: public@room.peertube.im.your_domain<br>' + Without this placeholder, all videos will point to the same chat room.<br>
'Example: public_{{VIDEO_UUID}}@room.peertube.im.your_domain', Example: public@room.peertube.im.your_domain<br>
Example: public_{{VIDEO_UUID}}@room.peertube.im.your_domain`,
private: true private: true
}) })
registerSetting({ registerSetting({
@ -127,9 +128,10 @@ function initSettings (options: RegisterServerOptions): void {
label: 'BOSH uri', label: 'BOSH uri',
type: 'input', type: 'input',
default: '', default: '',
descriptionHTML: 'URI of the external BOSH server. ' + descriptionHTML:
'Please make sure it accept cross origin request from your domain.<br>' + `URI of the external BOSH server.
'You must at least have a BOSH or a Websocket uri.', Please make sure it accept cross origin request from your domain.<br>
You must at least have a BOSH or a Websocket uri.`,
private: true private: true
}) })
registerSetting({ registerSetting({
@ -137,9 +139,10 @@ function initSettings (options: RegisterServerOptions): void {
label: 'Websocket uri', label: 'Websocket uri',
type: 'input', type: 'input',
default: '', default: '',
descriptionHTML: 'URI of the external WS server. ' + descriptionHTML: `
'Please make sure it accept cross origin request from your domain.<br>' + URI of the external WS server.
'You must at least have a BOSH or a Websocket uri.', Please make sure it accept cross origin request from your domain.<br>
You must at least have a BOSH or a Websocket uri.`,
private: true private: true
}) })
@ -148,10 +151,11 @@ function initSettings (options: RegisterServerOptions): void {
label: 'Webchat url', label: 'Webchat url',
type: 'input', type: 'input',
default: '', default: '',
descriptionHTML: 'Put here your webchat url. An iframe will be created pointing to this url. ' + descriptionHTML:
'The placeholder {{VIDEO_UUID}} will be replace by the video UUID if present. ' + `Put here your webchat url. An iframe will be created pointing to this url.
'Example : https://my_domain/conversejs.html?room=video_{{VIDEO_UUID}}.<br>' + The placeholder {{VIDEO_UUID}} will be replace by the video UUID if present.
'If this field is empty, it will use the builtin ConverseJS webchat.', Example : https://my_domain/conversejs.html?room=video_{{VIDEO_UUID}}.<br>
If this field is empty, it will use the builtin ConverseJS webchat.`,
private: false private: false
}) })
@ -172,7 +176,7 @@ function initSettings (options: RegisterServerOptions): void {
registerSetting({ registerSetting({
name: 'chat-open-blank', name: 'chat-open-blank',
label: 'Show the «open in new window» button', label: 'Show the «open in new window» button',
descriptionHTML: 'There will be a button for opening the webchat in a new window.', descriptionHTML: 'There will be a button for opening the web chat in a new window.',
private: false, private: false,
type: 'input-checkbox', type: 'input-checkbox',
default: true default: true
@ -189,8 +193,8 @@ function initSettings (options: RegisterServerOptions): void {
name: 'chat-only-locals-warning', name: 'chat-only-locals-warning',
type: 'html', type: 'html',
private: true, private: true,
descriptionHTML: ` descriptionHTML:
<span class="peertube-plugin-livechat-warning"> `<span class="peertube-plugin-livechat-warning">
The plugin is not compatible with video federation yet. The plugin is not compatible with video federation yet.
The webchat will only be accessible for people watching videos on your server. The webchat will only be accessible for people watching videos on your server.
</span>` </span>`
@ -200,15 +204,15 @@ function initSettings (options: RegisterServerOptions): void {
label: 'Users can activate the chat for their lives', label: 'Users can activate the chat for their lives',
type: 'input-checkbox', type: 'input-checkbox',
default: true, default: true,
descriptionHTML: 'If checked, all live videos will have a checkbox in there properties for enabling the webchat.', descriptionHTML: 'If checked, all live videos will have a checkbox in their properties for enabling the web chat.',
private: false private: false
}) })
registerSetting({ registerSetting({
name: 'chat-per-live-video-warning', name: 'chat-per-live-video-warning',
type: 'html', type: 'html',
private: true, private: true,
descriptionHTML: ` descriptionHTML:
<span class="peertube-plugin-livechat-warning"> `<span class="peertube-plugin-livechat-warning">
You have enabled the setting «Users can activate the chat for their lives». You have enabled the setting «Users can activate the chat for their lives».
It is redundant with the «Activate chat for all lives» setting. It is redundant with the «Activate chat for all lives» setting.
</span>` </span>`
@ -231,13 +235,14 @@ function initSettings (options: RegisterServerOptions): void {
}) })
registerSetting({ registerSetting({
name: 'chat-videos-list', name: 'chat-videos-list',
label: 'Activate chat for specific videos', label: 'Activate chat for these videos',
type: 'input-textarea', type: 'input-textarea',
default: '', default: '',
descriptionHTML: 'Videos UUIDs for which we want a chat. ' + descriptionHTML:
'Can be non-live videos. One per line. <br />' + `Videos UUIDs for which we want a web chat.
'You can add comments: everything after the # character will be stripped off, and empty lines ignored.<br />' + Can be non-live videos. One per line. <br />
'Don\'t add private videos, the UUIDs will be send to frontend.', You can add comments: everything after the # character will be stripped off, and empty lines ignored.<br />
Don't add private videos, the UUIDs will be send to frontend.`,
private: false private: false
}) })
@ -246,8 +251,9 @@ function initSettings (options: RegisterServerOptions): void {
label: 'Webchat iframe style attribute', label: 'Webchat iframe style attribute',
type: 'input-textarea', type: 'input-textarea',
default: '', default: '',
descriptionHTML: 'Additional styles to be added on the iframe style attribute. <br>' + descriptionHTML:
'Example: height:400px;', `Additional styles to be added on the iframe style attribute. <br>
Example: height:400px;`,
private: false private: false
}) })