From 7b3700801c3e26d82b0e4fa6e7aba70367568f02 Mon Sep 17 00:00:00 2001
From: Kieran Eglin <kieran.eglin@gmail.com>
Date: Sat, 2 Mar 2024 11:57:03 -0800
Subject: [PATCH] Improved explainer UI

---
 .../controllers/media_profiles/media_profile_html.ex     | 8 +++++++-
 .../media_profile_html/output_template_help.html.heex    | 9 +++++----
 2 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/lib/pinchflat_web/controllers/media_profiles/media_profile_html.ex b/lib/pinchflat_web/controllers/media_profiles/media_profile_html.ex
index 1cffae9..a313002 100644
--- a/lib/pinchflat_web/controllers/media_profiles/media_profile_html.ex
+++ b/lib/pinchflat_web/controllers/media_profiles/media_profile_html.ex
@@ -30,7 +30,13 @@ defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
   end
 
   def custom_output_template_options do
-    ~w(upload_day upload_month upload_year source_custom_name source_collection_type)a
+    %{
+      upload_day: nil,
+      upload_month: nil,
+      upload_year: nil,
+      source_custom_name: "the name of the sources that use this profile",
+      source_collection_type: "the collection type of the sources that use this profile. Either 'channel' or 'playlist'"
+    }
   end
 
   def common_output_template_options do
diff --git a/lib/pinchflat_web/controllers/media_profiles/media_profile_html/output_template_help.html.heex b/lib/pinchflat_web/controllers/media_profiles/media_profile_html/output_template_help.html.heex
index 7b11b1d..7dd6df2 100644
--- a/lib/pinchflat_web/controllers/media_profiles/media_profile_html/output_template_help.html.heex
+++ b/lib/pinchflat_web/controllers/media_profiles/media_profile_html/output_template_help.html.heex
@@ -46,8 +46,8 @@
   </section>
 
   <h2 class="text-xl font-bold mb-2">Template Options</h2>
-  <section class="ml-2 md:ml-4 mb-4 max-w-prose">
-    <p>
+  <section class="ml-2 md:ml-4 mb-4">
+    <p class="max-w-prose">
       Any single-word <code class="text-sm">yt-dlp</code>
       option
       <.inline_link href="https://github.com/yt-dlp/yt-dlp?tab=readme-ov-file#output-template">
@@ -58,8 +58,9 @@
     </p>
     <h3 class="text-lg font-bold mb-2">Custom Aliases</h3>
     <ul class="list-disc list-inside ml-2 md:ml-5">
-      <li :for={opt <- custom_output_template_options()}>
-        <.inline_code>{{ <%= opt %> }}</.inline_code>
+      <li :for={{k, v} <- custom_output_template_options()}>
+        <.inline_code>{{ <%= k %> }}</.inline_code>
+        <span :if={v}>- <%= v %></span>
       </li>
     </ul>
     <h3 class="text-lg font-bold mb-2">Common Options</h3>