mdhelp: add some missing details. mdhelp: add channels help doc.

tvheadend · May 7, 2016 · 93076fc · 93076fc
1 parent ed69650
commit 93076fc
Show file tree

Hide file tree

Showing 8 changed files with 75 additions and 4 deletions.
diff --git a/docs/class/channel.md b/docs/class/channel.md
@@ -0,0 +1,55 @@
+This tab lists all defined channels.
+
+!['Channel lists'](docresources/configchannellist.png)
+
+---
+
+###Menu Bar/Buttons
+
+The following functions are available:
+
+Button                      | Function
+----------------------------|-------------------
+**Save**                    | Save any changes made to the grid entries.
+**Undo**                    | Undo any changes made since the last save.
+**Add**                     | Create a new channel using the *Add Channel* dialog.
+**Delete**                  | Delete the selected entries.
+**Edit**                    | Edit the selected entries.
+**Map Services**            | Drop down menu: Map selected services, map [services](class/mpegts_service). Map all services, map all available [services](class/mpegts_service) as channels. Both options use the *Map services to channels* dialog. 
+**Number Operations**       | Drop down menu: Assign Number, assign the lowest available channel number(s) to the selected channel(s). Number Up, increment the selected channel number(s) by 1. Number Down, decrement the selected channel numbers by 1. Swap Numbers, swap the numbers of **two** selected channels.
+**View Level**              | Change the interface view level to show/hide more advanced options.
+**Reset Icon**              | Reset the selected channel(s) *User Icon* / *Icon URL*, especially useful if you change your Picon settings.
+**Help**                    | Displays this help page. 
+
+---
+
+###Adding/Editing a Channel.
+
+To add a channel press the *[Add]* button from the menu bar. To Edit a 
+channel you can highlight the channel(s) you want to edit then 
+press the *[Edit]* button, or edit the an entry directly in the grid.
+
+The _Add_ and _Edit_ buttons use a dialog similar to the following.
+
+!['Channel Edit (single)'](docresources/channeleditsingle.png)
+
+If you've selected multiple entries the *Edit Channel* dialog 
+will look slightly different.
+
+!['Channel Edit (multiple)'](docresources/channeleditmultiple.png)
+
+Ticking the additional check box (before each setting) will apply that 
+setting to all selected channels.
+
+---
+
+###Deleting Channels
+
+To delete channels highlight the desired channels from within the grid, and 
+press the *[Delete]* button from the menu bar. 
+
+**Tip**: You can select all channels within the grid by pressing ctrl+A. 
+You can also ctrl+click to make additional selections, or shift+click to 
+select a range. 
+
+---
diff --git a/docs/class/imagecache.md b/docs/class/imagecache.md
@@ -17,7 +17,7 @@ Button                      | Function
 **Undo**                    | Revert any changes made since the last save.
 **Clean image (icon) cache**| Clean-up the stored image files (empty cache and re-fetch icons).
 **Re-fetch images**         | Re-refresh image cache (reload images from upstream providers).
-**View Level**| Change the interface view level to show/hide more advanced options.
+**View Level**              | Change the interface view level to show/hide more advanced options.
 **Help**                    | Display this help page.
 
 ---
diff --git a/docs/class/mpegts_mux_sched.md b/docs/class/mpegts_mux_sched.md
@@ -32,6 +32,8 @@ which can also be seen in the grid view:
 
 !['Mux Add/Edit Example'](docresources/configdvbmuxsched1.png)
 
+**Tip**: You can also edit entries directly within the grid.
+
 ---
 
 ###Deleting an Entry

diff --git a/docs/class/mpegts_service.md b/docs/class/mpegts_service.md
@@ -14,7 +14,7 @@ Button           | Function
 **Undo**         | Undo any changes made since the last save.
 **Edit**         | Edit an existing service.
 **Delete**       | Delete a service.
-**Map Selected** | Drop down menu: Map selected services, map the highlighted services within the grid. Map all services, map all available services as channels. Both options use the *Map services to channels* dialog. 
+**Map Services** | Drop down menu: Map selected services, map the highlighted services within the grid. Map all services, map all available services as channels. Both options use the *Map services to channels* dialog. 
 **View Level**   | Change the interface view level to show/hide more advanced options.
 **Help**         | Displays this help page. 
 
@@ -86,7 +86,7 @@ you'd like to associate/disassociate the service with.
 
 ---
 
-###Editing Services.
+###Editing Services
 
 You can edit services by highlighting (selecting) the services from 
 within the grid and then clicking the *[Edit]* button from the menu bar.
@@ -102,3 +102,14 @@ Ticking the additional check box (before each setting) will apply that
 setting to all selected services.
 
 ---
+
+###Deleting Services
+
+You can delete services by selecting them from within the grid, and then 
+pressing the *[Delete]* button from the menu bar.
+
+**Tip**: You can select all services within the grid by pressing ctrl+A. 
+You can also ctrl+click to make additional selections, or shift+click to 
+select a range. 
+
+---
diff --git a/docs/docresources/channeleditmultiple.png b/docs/docresources/channeleditmultiple.png
diff --git a/docs/docresources/channeleditsingle.png b/docs/docresources/channeleditsingle.png
diff --git a/docs/docresources/configchannellist.png b/docs/docresources/configchannellist.png
diff --git a/src/channels.c b/src/channels.c
@@ -358,9 +358,12 @@ channel_class_epg_running_list ( void *o, const char *lang )
   return strtab2htsmsg(tab, 1, lang);
 }
 
+CLASS_DOC(channel)
+
 const idclass_t channel_class = {
   .ic_class      = "channel",
-  .ic_caption    = N_("Channel"),
+  .ic_caption    = N_("Channels"),
+  .ic_doc        = tvh_doc_channel_class,
   .ic_event      = "channel",
   .ic_changed    = channel_class_changed,
   .ic_save       = channel_class_save,