mdhelp: profile / stream filters conversion

tvheadend · Apr 14, 2016 · f0707ad · f0707ad
1 parent 0310d28
commit f0707ad
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 8 deletions.
diff --git a/docs/class/profile.md b/docs/class/profile.md
@@ -0,0 +1,45 @@
+##Configuration - Stream - Stream Profiles
+
+Stream Profiles are the settings for output formats. These are used for Live TV
+streaming and recordings. The profiles are assigned through the Access Entries,
+DVR Profiles or as parameter for HTTP Streaming.
+
+* Types
+  - [HTSP Profile](class/profile-htsp)
+  - [MPEG-TS Pass-thru Profile](class/profile-mpegts)
+  - [Matroska Profile](class/profile-matroska)
+  - [MPEG-TS/libav Profile](class/profile-libav-mpegts)
+  - [Matroska/libav Profile](class/profile-libav-matroska)
+  - [MP4/libav Profile](class/profile-libav-mp4)
+  - [Transcode Profile](class/profile-transcode)
+
+!['Stream Profiles'](docresources/configstreamprofiles.png)
+
+---
+
+###Menu Bar/Buttons
+
+The following functions are available:
+
+Button     | Function
+-----------|---------
+**Save**   | Save any changes made to the stream profile configuration.
+**Undo**   | Undo any changes made to the stream profile configuration since the last save.
+**Add**    | Add a new stream profile.
+**Delete** | Delete an existing stream profile.
+**Help**   | Display this help page.
+
+---
+
+####Add/Edit Dialog Example
+
+A common set of fields is used for the _Add_ or _Edit_ functions, most
+of which can also be seen in the grid view:
+
+!['Add/Edit Stream Profiles' Dialog - mkv](docresources/configstreamprofiles1.png)
+
+!['Add/Edit Stream Profiles' Dialog - ts](docresources/configstreamprofiles2.png)
+
+!['Add/Edit Stream Profiles' Dialog - transcode](docresources/configstreamprofiles3.png)
+
+---
diff --git a/docs/markdown/toc.md b/docs/markdown/toc.md
@@ -69,7 +69,7 @@ Web Interface Configuration Guide
 
   - Stream Profiles
     - [HTSP Profile](class/profile-htsp)
-    - [MPEG-TS Pass-thru Profile][class/profile-mpegts)
+    - [MPEG-TS Pass-thru Profile](class/profile-mpegts)
     - [Matroska Profile](class/profile-matroska)
     - [MPEG-TS/libav Profile](class/profile-libav-mpegts)
     - [Matroska/libav Profile](class/profile-libav-matroska)

diff --git a/src/profile.c b/src/profile.c
@@ -270,11 +270,14 @@ profile_class_svfilter_list ( void *o, const char *lang )
   return strtab2htsmsg(tab, 1, lang);
 }
 
+CLASS_DOC(profile)
+
 const idclass_t profile_class =
 {
   .ic_class      = "profile",
   .ic_caption    = N_("Stream profile"),
   .ic_event      = "profile",
+  .ic_doc        = tvh_doc_profile_class,
   .ic_perm_def   = ACCESS_ADMIN,
   .ic_save       = profile_class_save,
   .ic_get_title  = profile_class_get_title,

diff --git a/src/webui/static/app/esfilter.js b/src/webui/static/app/esfilter.js
@@ -40,7 +40,7 @@ tvheadend.esfilter_tab = function(panel)
         },
         del: true,
         help: function() {
-            new tvheadend.help(_('Stream Profile'), 'config_streamprofile.html');
+            new tvheadend.mdhelp('class/profile')
         }
     });
 
@@ -62,7 +62,7 @@ tvheadend.esfilter_tab = function(panel)
         del: true,
         move: true,
         help: function() {
-            new tvheadend.help(_('Elementary Stream Filter'), 'config_esfilter.html');
+            new tvheadend.mdhelp('class/esfilter_video')
         }
     });
 
@@ -82,7 +82,7 @@ tvheadend.esfilter_tab = function(panel)
         del: true,
         move: true,
         help: function() {
-            new tvheadend.help(_('Elementary Stream Filter'), 'config_esfilter.html');
+            new tvheadend.mdhelp('class/esfilter_audio')
         }
     });
 
@@ -102,7 +102,7 @@ tvheadend.esfilter_tab = function(panel)
         del: true,
         move: true,
         help: function() {
-            new tvheadend.help('Elementary Stream Filter', 'config_esfilter.html');
+            new tvheadend.mdhelp('class/esfilter_teletext')
         }
     });
 
@@ -122,7 +122,7 @@ tvheadend.esfilter_tab = function(panel)
         del: true,
         move: true,
         help: function() {
-            new tvheadend.help(_('Elementary Stream Filter'), 'config_esfilter.html');
+            new tvheadend.mdhelp('class/esfilter_subtit')
         }
     });
 
@@ -141,7 +141,7 @@ tvheadend.esfilter_tab = function(panel)
         del: true,
         move: true,
         help: function() {
-            new tvheadend.help(_('Elementary Stream Filter'), 'config_esfilter.html');
+            new tvheadend.mdhelp('class/esfilter_ca')
         }
     });
 
@@ -161,7 +161,7 @@ tvheadend.esfilter_tab = function(panel)
         del: true,
         move: true,
         help: function() {
-            new tvheadend.help(_('Elementary Stream Filter'), 'config_esfilter.html');
+            new tvheadend.mdhelp('class/esfilter_other')
         }
     });
 };