From 7f7199abd4548936be07a6f4c816f6347123214a Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit@matrix.org>
Date: Wed, 8 Dec 2021 23:15:57 +0100
Subject: [PATCH] Add a help section in the settings.

---
 changelog.d/4638.feature                      |  1 +
 .../features/settings/VectorPreferences.kt    |  1 +
 .../VectorSettingsHelpAboutFragment.kt        | 13 +++++
 .../features/settings/VectorSettingsUrls.kt   |  1 +
 vector/src/main/res/values/strings.xml        |  5 ++
 .../res/xml/vector_settings_help_about.xml    | 49 +++++++++++++------
 6 files changed, 54 insertions(+), 16 deletions(-)
 create mode 100644 changelog.d/4638.feature

diff --git a/changelog.d/4638.feature b/changelog.d/4638.feature
new file mode 100644
index 0000000000..0f8bd36465
--- /dev/null
+++ b/changelog.d/4638.feature
@@ -0,0 +1 @@
+Add a help section in the settings.
\ No newline at end of file
diff --git a/vector/src/main/java/im/vector/app/features/settings/VectorPreferences.kt b/vector/src/main/java/im/vector/app/features/settings/VectorPreferences.kt
index 8db2d777e1..c9464550ac 100755
--- a/vector/src/main/java/im/vector/app/features/settings/VectorPreferences.kt
+++ b/vector/src/main/java/im/vector/app/features/settings/VectorPreferences.kt
@@ -35,6 +35,7 @@ import javax.inject.Inject
 class VectorPreferences @Inject constructor(private val context: Context) {
 
     companion object {
+        const val SETTINGS_HELP_PREFERENCE_KEY = "SETTINGS_HELP_PREFERENCE_KEY"
         const val SETTINGS_CHANGE_PASSWORD_PREFERENCE_KEY = "SETTINGS_CHANGE_PASSWORD_PREFERENCE_KEY"
         const val SETTINGS_VERSION_PREFERENCE_KEY = "SETTINGS_VERSION_PREFERENCE_KEY"
         const val SETTINGS_SDK_VERSION_PREFERENCE_KEY = "SETTINGS_SDK_VERSION_PREFERENCE_KEY"
diff --git a/vector/src/main/java/im/vector/app/features/settings/VectorSettingsHelpAboutFragment.kt b/vector/src/main/java/im/vector/app/features/settings/VectorSettingsHelpAboutFragment.kt
index 86b454a243..31d9cf0426 100644
--- a/vector/src/main/java/im/vector/app/features/settings/VectorSettingsHelpAboutFragment.kt
+++ b/vector/src/main/java/im/vector/app/features/settings/VectorSettingsHelpAboutFragment.kt
@@ -20,8 +20,10 @@ import androidx.preference.Preference
 import im.vector.app.BuildConfig
 import im.vector.app.R
 import im.vector.app.core.preference.VectorPreference
+import im.vector.app.core.utils.FirstThrottler
 import im.vector.app.core.utils.copyToClipboard
 import im.vector.app.core.utils.openAppSettingsPage
+import im.vector.app.core.utils.openUrlInChromeCustomTab
 import im.vector.app.features.version.VersionProvider
 import org.matrix.android.sdk.api.Matrix
 import javax.inject.Inject
@@ -33,7 +35,18 @@ class VectorSettingsHelpAboutFragment @Inject constructor(
     override var titleRes = R.string.preference_root_help_about
     override val preferenceXmlRes = R.xml.vector_settings_help_about
 
+    private val firstThrottler = FirstThrottler(1000)
+
     override fun bindPref() {
+        // Help
+        findPreference<VectorPreference>(VectorPreferences.SETTINGS_HELP_PREFERENCE_KEY)!!
+                .onPreferenceClickListener = Preference.OnPreferenceClickListener {
+            if (firstThrottler.canHandle() is FirstThrottler.CanHandlerResult.Yes) {
+                openUrlInChromeCustomTab(requireContext(), null, VectorSettingsUrls.HELP)
+            }
+            false
+        }
+
         // preference to start the App info screen, to facilitate App permissions access
         findPreference<VectorPreference>(APP_INFO_LINK_PREFERENCE_KEY)!!
                 .onPreferenceClickListener = Preference.OnPreferenceClickListener {
diff --git a/vector/src/main/java/im/vector/app/features/settings/VectorSettingsUrls.kt b/vector/src/main/java/im/vector/app/features/settings/VectorSettingsUrls.kt
index b3925c32dc..09249c4957 100644
--- a/vector/src/main/java/im/vector/app/features/settings/VectorSettingsUrls.kt
+++ b/vector/src/main/java/im/vector/app/features/settings/VectorSettingsUrls.kt
@@ -17,6 +17,7 @@
 package im.vector.app.features.settings
 
 object VectorSettingsUrls {
+    const val HELP = "https://element.io/help"
     const val COPYRIGHT = "https://element.io/copyright"
     const val TAC = "https://element.io/terms-of-service"
     const val PRIVACY_POLICY = "https://element.io/privacy"
diff --git a/vector/src/main/res/values/strings.xml b/vector/src/main/res/values/strings.xml
index 2759f0ebc5..97bf7a7d6a 100644
--- a/vector/src/main/res/values/strings.xml
+++ b/vector/src/main/res/values/strings.xml
@@ -2278,6 +2278,11 @@
     <string name="preference_root_help_about">Help &amp; About</string>
     <string name="preference_root_legals">Legals</string>
 
+    <string name="preference_help">Help</string>
+    <string name="preference_help_title">Help and support</string>
+    <string name="preference_help_summary">Get help with using Element</string>
+    <string name="preference_versions">Versions</string>
+    <string name="preference_system_settings">System settings</string>
 
     <string name="settings_troubleshoot_test_token_registration_quick_fix">Register token</string>
 
diff --git a/vector/src/main/res/xml/vector_settings_help_about.xml b/vector/src/main/res/xml/vector_settings_help_about.xml
index c532536785..0388b545b7 100644
--- a/vector/src/main/res/xml/vector_settings_help_about.xml
+++ b/vector/src/main/res/xml/vector_settings_help_about.xml
@@ -2,24 +2,41 @@
 <androidx.preference.PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:tools="http://schemas.android.com/tools">
 
-    <im.vector.app.core.preference.VectorPreference
-        android:key="APP_INFO_LINK_PREFERENCE_KEY"
-        android:summary="@string/settings_app_info_link_summary"
-        android:title="@string/settings_app_info_link_title" />
+    <im.vector.app.core.preference.VectorPreferenceCategory android:title="@string/preference_help">
 
-    <im.vector.app.core.preference.VectorPreference
-        android:key="SETTINGS_VERSION_PREFERENCE_KEY"
-        android:title="@string/settings_version"
-        tools:summary="1.2.3" />
+        <im.vector.app.core.preference.VectorPreference
+            android:key="SETTINGS_HELP_PREFERENCE_KEY"
+            android:summary="@string/preference_help_summary"
+            android:title="@string/preference_help_title" />
 
-    <im.vector.app.core.preference.VectorPreference
-        android:key="SETTINGS_SDK_VERSION_PREFERENCE_KEY"
-        android:title="@string/settings_sdk_version"
-        tools:summary="4.5.6" />
+    </im.vector.app.core.preference.VectorPreferenceCategory>
 
-    <im.vector.app.core.preference.VectorPreference
-        android:key="SETTINGS_OLM_VERSION_PREFERENCE_KEY"
-        android:title="@string/settings_olm_version"
-        tools:summary="7.8.9" />
+    <im.vector.app.core.preference.VectorPreferenceCategory android:title="@string/preference_versions">
+
+        <im.vector.app.core.preference.VectorPreference
+            android:key="SETTINGS_VERSION_PREFERENCE_KEY"
+            android:title="@string/settings_version"
+            tools:summary="1.2.3" />
+
+        <im.vector.app.core.preference.VectorPreference
+            android:key="SETTINGS_SDK_VERSION_PREFERENCE_KEY"
+            android:title="@string/settings_sdk_version"
+            tools:summary="4.5.6" />
+
+        <im.vector.app.core.preference.VectorPreference
+            android:key="SETTINGS_OLM_VERSION_PREFERENCE_KEY"
+            android:title="@string/settings_olm_version"
+            tools:summary="7.8.9" />
+
+    </im.vector.app.core.preference.VectorPreferenceCategory>
+
+    <im.vector.app.core.preference.VectorPreferenceCategory android:title="@string/preference_system_settings">
+
+        <im.vector.app.core.preference.VectorPreference
+            android:key="APP_INFO_LINK_PREFERENCE_KEY"
+            android:summary="@string/settings_app_info_link_summary"
+            android:title="@string/settings_app_info_link_title" />
+
+    </im.vector.app.core.preference.VectorPreferenceCategory>
 
 </androidx.preference.PreferenceScreen>
\ No newline at end of file