From 03dfa3de6f3d07ff923fd659ff3b083e5441e2d2 Mon Sep 17 00:00:00 2001
From: John Livingston <git@john-livingston.fr>
Date: Tue, 26 Sep 2023 14:21:32 +0200
Subject: [PATCH] Help button.

---
 CHANGELOG.md                                  |  1 +
 .../configuration/templates/home.mustache     |  5 +++-
 client/common/configuration/templates/home.ts | 26 +++++++++++++++++++
 3 files changed, 31 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index cfa6b974..984b879c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,7 @@
 * Channel configuration:
   * Fix dark mode for buttons.
   * Fix buttons margin.
+* Help button on top of the "channels" page.
 
 ## 8.0.0
 
diff --git a/client/common/configuration/templates/home.mustache b/client/common/configuration/templates/home.mustache
index da0099e8..314948ae 100644
--- a/client/common/configuration/templates/home.mustache
+++ b/client/common/configuration/templates/home.mustache
@@ -1,5 +1,8 @@
 <div class="margin-content peertube-plugin-livechat-configuration peertube-plugin-livechat-configuration-home">
-  <h1>{{title}}</h1>
+  <h1>
+    {{title}}
+    {{{helpButton}}}
+  </h1>
   <p>{{description}}</p>
   <p>{{please_select}}</p>
   <ul class="peertube-plugin-livechat-configuration-home-channels">
diff --git a/client/common/configuration/templates/home.ts b/client/common/configuration/templates/home.ts
index fff4e190..7570476e 100644
--- a/client/common/configuration/templates/home.ts
+++ b/client/common/configuration/templates/home.ts
@@ -1,4 +1,6 @@
 import type { RegisterClientOptions } from '@peertube/peertube-types/client'
+import { localizedHelpUrl } from '../../../utils/help'
+import { helpButtonSVG } from '../../../videowatch/buttons'
 // Must use require for mustache, import seems buggy.
 const Mustache = require('mustache')
 
@@ -40,6 +42,8 @@ async function renderConfigurationHome (registerClientOptions: RegisterClientOpt
       channels: channels.data
     }
 
+    await _fillViewHelpButtons(registerClientOptions, view)
+
     return Mustache.render(MUSTACHE_CONFIGURATION_HOME, view) as string
   } catch (err: any) {
     peertubeHelpers.notifier.error(err.toString())
@@ -47,6 +51,28 @@ async function renderConfigurationHome (registerClientOptions: RegisterClientOpt
   }
 }
 
+async function _fillViewHelpButtons ( // TODO: refactor with the similar function in channel.ts
+  registerClientOptions: RegisterClientOptions,
+  view: any
+): Promise<void> {
+  const title = await registerClientOptions.peertubeHelpers.translate(LOC_ONLINE_HELP)
+
+  const button = async (page: string): Promise<string> => {
+    const helpUrl = await localizedHelpUrl(registerClientOptions, {
+      page
+    })
+    const helpIcon = helpButtonSVG()
+    return `<a
+        href="${helpUrl}"
+        target=_blank
+        title="${title}"
+        class="orange-button peertube-button-link"
+      >${helpIcon}</a>`
+  }
+
+  view.helpButton = await button('documentation/user/streamers/channel')
+}
+
 export {
   renderConfigurationHome
 }