]> git.ipfire.org Git - thirdparty/tvheadend.git/commitdiff
mdhelp: update channel, schedulers, satip help + screenshots
authorMark Clarkstone <hello@markclarkstone.co.uk>
Mon, 9 May 2016 21:37:10 +0000 (22:37 +0100)
committerJaroslav Kysela <perex@perex.cz>
Wed, 11 May 2016 19:09:22 +0000 (21:09 +0200)
17 files changed:
docs/class/channel.md
docs/class/channeltag.md [new file with mode: 0644]
docs/class/linuxdvb_satconf.md
docs/class/mpegts_mux_sched.md
docs/class/mpegts_service.md
docs/class/satip_client.md [new file with mode: 0644]
docs/class/satip_frontend.md [new file with mode: 0644]
docs/class/satip_satconf.md [new file with mode: 0644]
src/input/mpegts/mpegts_mux.c
src/input/mpegts/mpegts_service.c
src/input/mpegts/satip/satip.c
src/input/mpegts/satip/satip_frontend.c
src/input/mpegts/satip/satip_satconf.c
src/webui/static/img/doc/addchanneldialog.png [new file with mode: 0644]
src/webui/static/img/doc/addmuxsched.png [new file with mode: 0644]
src/webui/static/img/doc/channeltags.png [new file with mode: 0644]
src/webui/static/img/doc/satipclient.png [new file with mode: 0644]

index 8ad3259a44b6b8b23d137cce156d92eab3737f14..2b61f5e2cd482b8444820194a53c2161ac698cc3 100644 (file)
@@ -4,52 +4,44 @@ This tab lists all defined channels.
 
 ---
 
-###Menu Bar/Buttons
+<tvh_include>inc/common_button_table_start</tvh_include>
 
-The following functions are available:
+<tvh_include>inc/common_button_table_end</tvh_include>
+
+The following tab specific 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. 
+**Reset Icon**              | Reset the selected channel(s) *User Icon* / *Icon URL*, especially useful if you change your Picon settings. 
+**Map Services**            | Drop down menu (see mapping button table below). 
+**Number Operations**       | Drop down menu (see numbering button table below).
+
+Mapping Button              | Function
+----------------------------|--------------------
+**Map services**            | Map [services](class/mpegts_service).
+**Map all services**        | Map all available [services](class/mpegts_service) as channels
+
+Numbering Button            | Function
+----------------------------|--------------------
+**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 the **two** selected channels.
 
 ---
 
-###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.
+<tvh_include>inc/add_grid_entry</tvh_include>
 
-!['Channel Edit (single)'](static/img/doc/channeleditsingle.png)
+!['Add Channel Dialog'](static/img/doc/addchanneldialog.png)
 
-If you've selected multiple entries the *Edit Channel* dialog 
-will look slightly different.
+---
 
-!['Channel Edit (multiple)'](static/img/doc/channeleditmultiple.png)
+<tvh_include>inc/edit_grid_entries</tvh_include>
 
-Ticking the additional check box (before each setting) will apply that 
-setting to all selected channels.
+!['Edit Channel Dialog'](static/img/doc/channeleditsingle.png)
 
 ---
 
-###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. 
+<tvh_include>inc/del_grid_entries</tvh_include>
 
 ---
diff --git a/docs/class/channeltag.md b/docs/class/channeltag.md
new file mode 100644 (file)
index 0000000..2a79e61
--- /dev/null
@@ -0,0 +1,5 @@
+This tab is where you manage your channel tags.
+
+!['Channel tag'](docresources/channeltags.png)
+
+---
index f8d60bbc087594c84c73bc11649a19ede734ffc8..068ea84fd7274d0bfb3a77b86ee7b9ac12e58235 100644 (file)
@@ -1,4 +1,4 @@
-This panel tab lists all the available satellite (DVB-S/ISDB-S) configuration 
+This panel lists all the available satellite (DVB-S/ISDB-S) configuration 
 parameters.
 
 ---
index 4581fb4bfa97914b0d4bbdca03cfae42393e3fbf..1465d75fbee49e9a16f047d4ac55dd4e7565fb26 100644 (file)
@@ -5,44 +5,28 @@ useful to get EPG, services or access rights updates.
 
 ---
 
-###Menu Bar/Buttons
+<tvh_include>inc/common_button_table_start</tvh_include>
 
-The following functions are available:
-
-Button         | Function
----------------|---------
-**Save**       | Save any changes made.
-**Undo**       | Undo any changes made since the last save.
-**Add**        | Add a new entry.
-**Delete**     | Delete an existing entry.
-**Edit**       | Edit an existing schedule entry.
-**View Level** | Change the interface view level to show/hide more advanced options.
-**Help**       | Displays this help page. 
+<tvh_include>inc/common_button_table_end</tvh_include>
 
 ---
 
-###Adding/Editing an Entry
-
-You can add an entry by pressing the *[Add]* button from the menu bar. 
-To edit an entry highlight (select) the entry from within the grid, and press the 
-*[Edit]* button from the menu bar.
-
-A common set of fields is used for the Add or Edit functions, most of 
-which can be seen in the grid view:
+<tvh_include>inc/add_grid_entry</tvh_include>
 
+<<<<<<< 10ce88504b561738e9b6c8845758490ce74a7f41
 !['Mux Add/Edit Example'](static/img/doc/configdvbmuxsched1.png)
 
 **Tip**: You can also edit entries directly within the grid.
+=======
+!['Add Mux Schedule'](docresources/addmuxsched.png)
+>>>>>>> mdhelp: update channel, schedulers, satip help + screenshots
 
 ---
 
-###Deleting an Entry
+<tvh_include>inc/edit_grid_entries</tvh_include>
 
-To delete an entry highlight (select) the entry from within the grid, 
-and press the *[Delete]* button from the menu bar.
+---
 
-**Tip**: You can select all entries within the grid by pressing ctrl+A. 
-You can also ctrl+click to make additional selections, or shift+click to 
-select a range. 
+<tvh_include>inc/del_grid_entries</tvh_include>
 
 ---
index d0d2e2118dd72fb2bee637517abb5b7ca0163e8a..6402ab3c0b7338f4977263274b1b6c7799235273 100644 (file)
@@ -12,10 +12,12 @@ The following tab specific buttons are available:
 
 Button                     | Function
 ---------------------------|---------
-**Map Services**           | Drop down menu: 
-↓                          | ↓ 
-**Map selected services**  | Map the highlighted services within the grid. 
-**Map all services**       | Map all available services as channels. 
+**Map Services**           | Drop down menu (see mapping button table below). 
+
+Mapping Button              | Function
+----------------------------|--------------------
+**Map selected services**   | Map the highlighted services within the grid. 
+**Map all services**        | Map all available services as channels. 
 
 ---
 
diff --git a/docs/class/satip_client.md b/docs/class/satip_client.md
new file mode 100644 (file)
index 0000000..b87b835
--- /dev/null
@@ -0,0 +1,16 @@
+This panel displays all available SAT>IP client parameters.
+
+!['SAT>IP Panel'](docresources/satipclient.png)
+
+---
+
+###Buttons
+
+The following buttons are available:
+
+Button         | Function
+---------------|---------
+**Save**       | Save the current configuration.
+<tvh_include>inc/common_button_table_end</tvh_include>
+
+---
diff --git a/docs/class/satip_frontend.md b/docs/class/satip_frontend.md
new file mode 100644 (file)
index 0000000..d813425
--- /dev/null
@@ -0,0 +1,15 @@
+This panel displays all available SAT>IP 
+DVB-T/DVB-S/DVB-C/ATSC-T/ATSC-C frontend parameters.
+
+---
+
+###Buttons
+
+The following buttons are available:
+
+Button         | Function
+---------------|---------
+**Save**       | Save the current configuration.
+<tvh_include>inc/common_button_table_end</tvh_include>
+
+---
diff --git a/docs/class/satip_satconf.md b/docs/class/satip_satconf.md
new file mode 100644 (file)
index 0000000..068ea84
--- /dev/null
@@ -0,0 +1,15 @@
+This panel lists all the available satellite (DVB-S/ISDB-S) configuration 
+parameters.
+
+---
+
+###Buttons
+
+The following buttons are available:
+
+Button         | Function
+---------------|---------
+**Save**       | Save the current configuration.
+<tvh_include>inc/common_button_table_end</tvh_include>
+
+---
index ec3fe0aedbeaf6daaf7efb5f02f245b8ee0d5e78..0ee868ad14612eed7739f53eb416f7fdf1fb4ad3 100644 (file)
@@ -492,7 +492,7 @@ CLASS_DOC(mpegts_mux)
 const idclass_t mpegts_mux_class =
 {
   .ic_class      = "mpegts_mux",
-  .ic_caption    = N_("MPEG-TS multiplex"),
+  .ic_caption    = N_("MPEG-TS Multiplex"),
   .ic_event      = "mpegts_mux",
   .ic_doc        = tvh_doc_mpegts_mux_class,
   .ic_perm_def   = ACCESS_ADMIN,
index 24d4e8d1cce76acbf8aee68b8a96892c3c283afe..3226d28521ef77c6510a5cd90ea4b0f321a94c5f 100644 (file)
@@ -86,7 +86,7 @@ const idclass_t mpegts_service_class =
 {
   .ic_super      = &service_class,
   .ic_class      = "mpegts_service",
-  .ic_caption    = N_("MPEG-TS service"),
+  .ic_caption    = N_("MPEG-TS Service"),
   .ic_doc        = tvh_doc_mpegts_service_class,
   .ic_order      = "enabled,channel,svcname",
   .ic_properties = (const property_t[]){
index a9d19ebfabfe8025f7f9f7a0aa92bc4d06498d6e..27de6e1cd050e02bb04dac0fbfe3615b27ecd548 100644 (file)
@@ -206,11 +206,14 @@ satip_device_class_tunercfg_notify ( void *o, const char *lang )
     satip_device_destroy_later(sd, 100);
 }
 
+CLASS_DOC(satip_client)
+
 const idclass_t satip_device_class =
 {
   .ic_class      = "satip_client",
   .ic_event      = "satip_client",
-  .ic_caption    = N_("SAT>IP client"),
+  .ic_caption    = N_("SAT>IP Client"),
+  .ic_doc        = tvh_doc_satip_client_class,
   .ic_save       = satip_device_class_save,
   .ic_get_childs = satip_device_class_get_childs,
   .ic_get_title  = satip_device_class_get_title,
index 073e46915755deda185f5cf406b95c7098a1f2b3..64e23343fa7e3238e6185afadf9accbdad49023c 100644 (file)
@@ -141,11 +141,14 @@ satip_frontend_class_override_enum( void * p, const char *lang )
   return m;
 }
 
+CLASS_DOC(satip_frontend)
+
 const idclass_t satip_frontend_class =
 {
   .ic_super      = &mpegts_input_class,
   .ic_class      = "satip_frontend",
-  .ic_caption    = N_("SAT>IP DVB frontend"),
+  .ic_doc        = tvh_doc_satip_frontend_class,
+  .ic_caption    = N_("SAT>IP DVB Frontend"),
   .ic_changed    = satip_frontend_class_changed,
   .ic_properties = (const property_t[]) {
     {
@@ -227,7 +230,7 @@ const idclass_t satip_frontend_dvbt_class =
 {
   .ic_super      = &satip_frontend_class,
   .ic_class      = "satip_frontend_dvbt",
-  .ic_caption    = N_("SAT>IP DVB-T frontend"),
+  .ic_caption    = N_("SAT>IP DVB-T Frontend"),
   .ic_properties = (const property_t[]){
     {
       .type     = PT_STR,
@@ -315,7 +318,7 @@ const idclass_t satip_frontend_dvbs_class =
 {
   .ic_super      = &satip_frontend_class,
   .ic_class      = "satip_frontend_dvbs",
-  .ic_caption    = N_("SAT>IP DVB-S frontend"),
+  .ic_caption    = N_("SAT>IP DVB-S Frontend"),
   .ic_get_childs = satip_frontend_dvbs_class_get_childs,
   .ic_properties = (const property_t[]){
     {
@@ -360,7 +363,7 @@ const idclass_t satip_frontend_dvbs_slave_class =
 {
   .ic_super      = &satip_frontend_class,
   .ic_class      = "satip_frontend_dvbs_slave",
-  .ic_caption    = N_("SAT>IP DVB-S slave frontend"),
+  .ic_caption    = N_("SAT>IP DVB-S Slave Frontend"),
   .ic_properties = (const property_t[]){
     {
       .type     = PT_INT,
@@ -392,7 +395,7 @@ const idclass_t satip_frontend_dvbc_class =
 {
   .ic_super      = &satip_frontend_class,
   .ic_class      = "satip_frontend_dvbc",
-  .ic_caption    = N_("SAT>IP DVB-C frontend"),
+  .ic_caption    = N_("SAT>IP DVB-C Frontend"),
   .ic_properties = (const property_t[]){
     {
       .type     = PT_STR,
@@ -411,7 +414,7 @@ const idclass_t satip_frontend_atsc_t_class =
 {
   .ic_super      = &satip_frontend_class,
   .ic_class      = "satip_frontend_atsc_t",
-  .ic_caption    = N_("SAT>IP ATSC-T frontend"),
+  .ic_caption    = N_("SAT>IP ATSC-T Frontend"),
   .ic_properties = (const property_t[]){
     {}
   }
@@ -421,7 +424,7 @@ const idclass_t satip_frontend_atsc_c_class =
 {
   .ic_super      = &satip_frontend_class,
   .ic_class      = "satip_frontend_atsc_c",
-  .ic_caption    = N_("SAT>IP ATSC-C frontend"),
+  .ic_caption    = N_("SAT>IP ATSC-C Frontend"),
   .ic_properties = (const property_t[]){
     {}
   }
index 3ca4d2764a7603eaa0132fd7f45d6f4fb290d124..58ffd77a52a87187494db2f2ddd927ee99fd9f54 100644 (file)
@@ -319,11 +319,14 @@ satip_satconf_class_changed ( idnode_t *in )
   satip_satconf_sanity_check(sfc->sfc_lfe);
 }
 
+CLASS_DOC(satip_satconf)
+
 const idclass_t satip_satconf_class =
 {
   .ic_class      = "satip_satconf",
-  .ic_caption    = N_("Satconf"),
+  .ic_caption    = N_("SAT>IP Satellite Configuration"),
   .ic_event      = "satip_satconf",
+  .ic_doc        = tvh_doc_satip_satconf_class,
   .ic_get_title  = satip_satconf_class_get_title,
   .ic_changed    = satip_satconf_class_changed,
   .ic_properties = (const property_t[]) {
diff --git a/src/webui/static/img/doc/addchanneldialog.png b/src/webui/static/img/doc/addchanneldialog.png
new file mode 100644 (file)
index 0000000..6cbad10
Binary files /dev/null and b/src/webui/static/img/doc/addchanneldialog.png differ
diff --git a/src/webui/static/img/doc/addmuxsched.png b/src/webui/static/img/doc/addmuxsched.png
new file mode 100644 (file)
index 0000000..57ebafa
Binary files /dev/null and b/src/webui/static/img/doc/addmuxsched.png differ
diff --git a/src/webui/static/img/doc/channeltags.png b/src/webui/static/img/doc/channeltags.png
new file mode 100644 (file)
index 0000000..4e83c88
Binary files /dev/null and b/src/webui/static/img/doc/channeltags.png differ
diff --git a/src/webui/static/img/doc/satipclient.png b/src/webui/static/img/doc/satipclient.png
new file mode 100644 (file)
index 0000000..b966184
Binary files /dev/null and b/src/webui/static/img/doc/satipclient.png differ