From: Mark Clarkstone Date: Mon, 9 May 2016 21:37:10 +0000 (+0100) Subject: mdhelp: update channel, schedulers, satip help + screenshots X-Git-Tag: v4.2.1~536 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=d0ce7c1d61f1d89d1c834a6d7c9ffd4f430ac988;p=thirdparty%2Ftvheadend.git mdhelp: update channel, schedulers, satip help + screenshots --- diff --git a/docs/class/channel.md b/docs/class/channel.md index 8ad3259a4..2b61f5e2c 100644 --- a/docs/class/channel.md +++ b/docs/class/channel.md @@ -4,52 +4,44 @@ This tab lists all defined channels. --- -###Menu Bar/Buttons +inc/common_button_table_start -The following functions are available: +inc/common_button_table_end + +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. +inc/add_grid_entry -!['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) +inc/edit_grid_entries -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. +inc/del_grid_entries --- diff --git a/docs/class/channeltag.md b/docs/class/channeltag.md new file mode 100644 index 000000000..2a79e6110 --- /dev/null +++ b/docs/class/channeltag.md @@ -0,0 +1,5 @@ +This tab is where you manage your channel tags. + +!['Channel tag'](docresources/channeltags.png) + +--- diff --git a/docs/class/linuxdvb_satconf.md b/docs/class/linuxdvb_satconf.md index f8d60bbc0..068ea84fd 100644 --- a/docs/class/linuxdvb_satconf.md +++ b/docs/class/linuxdvb_satconf.md @@ -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. --- diff --git a/docs/class/mpegts_mux_sched.md b/docs/class/mpegts_mux_sched.md index 4581fb4bf..1465d75fb 100644 --- a/docs/class/mpegts_mux_sched.md +++ b/docs/class/mpegts_mux_sched.md @@ -5,44 +5,28 @@ useful to get EPG, services or access rights updates. --- -###Menu Bar/Buttons +inc/common_button_table_start -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. +inc/common_button_table_end --- -###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: +inc/add_grid_entry +<<<<<<< 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 +inc/edit_grid_entries -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. +inc/del_grid_entries --- diff --git a/docs/class/mpegts_service.md b/docs/class/mpegts_service.md index d0d2e2118..6402ab3c0 100644 --- a/docs/class/mpegts_service.md +++ b/docs/class/mpegts_service.md @@ -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 index 000000000..b87b835a0 --- /dev/null +++ b/docs/class/satip_client.md @@ -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. +inc/common_button_table_end + +--- diff --git a/docs/class/satip_frontend.md b/docs/class/satip_frontend.md new file mode 100644 index 000000000..d813425d0 --- /dev/null +++ b/docs/class/satip_frontend.md @@ -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. +inc/common_button_table_end + +--- diff --git a/docs/class/satip_satconf.md b/docs/class/satip_satconf.md new file mode 100644 index 000000000..068ea84fd --- /dev/null +++ b/docs/class/satip_satconf.md @@ -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. +inc/common_button_table_end + +--- diff --git a/src/input/mpegts/mpegts_mux.c b/src/input/mpegts/mpegts_mux.c index ec3fe0aed..0ee868ad1 100644 --- a/src/input/mpegts/mpegts_mux.c +++ b/src/input/mpegts/mpegts_mux.c @@ -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, diff --git a/src/input/mpegts/mpegts_service.c b/src/input/mpegts/mpegts_service.c index 24d4e8d1c..3226d2852 100644 --- a/src/input/mpegts/mpegts_service.c +++ b/src/input/mpegts/mpegts_service.c @@ -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[]){ diff --git a/src/input/mpegts/satip/satip.c b/src/input/mpegts/satip/satip.c index a9d19ebfa..27de6e1cd 100644 --- a/src/input/mpegts/satip/satip.c +++ b/src/input/mpegts/satip/satip.c @@ -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, diff --git a/src/input/mpegts/satip/satip_frontend.c b/src/input/mpegts/satip/satip_frontend.c index 073e46915..64e23343f 100644 --- a/src/input/mpegts/satip/satip_frontend.c +++ b/src/input/mpegts/satip/satip_frontend.c @@ -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[]){ {} } diff --git a/src/input/mpegts/satip/satip_satconf.c b/src/input/mpegts/satip/satip_satconf.c index 3ca4d2764..58ffd77a5 100644 --- a/src/input/mpegts/satip/satip_satconf.c +++ b/src/input/mpegts/satip/satip_satconf.c @@ -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 index 000000000..6cbad10df 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 index 000000000..57ebafaac 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 index 000000000..4e83c88f0 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 index 000000000..b96618478 Binary files /dev/null and b/src/webui/static/img/doc/satipclient.png differ