Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
mdhelp: update channel, schedulers, satip help + screenshots
  • Loading branch information
Mark Clarkstone authored and perexg committed May 11, 2016
1 parent 6058e16 commit d0ce7c1
Show file tree
Hide file tree
Showing 17 changed files with 113 additions and 75 deletions.
58 changes: 25 additions & 33 deletions docs/class/channel.md
Expand Up @@ -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>

---
5 changes: 5 additions & 0 deletions docs/class/channeltag.md
@@ -0,0 +1,5 @@
This tab is where you manage your channel tags.

!['Channel tag'](docresources/channeltags.png)

---
2 changes: 1 addition & 1 deletion 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.

---
Expand Down
36 changes: 10 additions & 26 deletions docs/class/mpegts_mux_sched.md
Expand Up @@ -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>

---
10 changes: 6 additions & 4 deletions docs/class/mpegts_service.md
Expand Up @@ -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.

---

Expand Down
16 changes: 16 additions & 0 deletions 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.
<tvh_include>inc/common_button_table_end</tvh_include>

---
15 changes: 15 additions & 0 deletions 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.
<tvh_include>inc/common_button_table_end</tvh_include>

---
15 changes: 15 additions & 0 deletions 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.
<tvh_include>inc/common_button_table_end</tvh_include>

---
2 changes: 1 addition & 1 deletion src/input/mpegts/mpegts_mux.c
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion src/input/mpegts/mpegts_service.c
Expand Up @@ -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[]){
Expand Down
5 changes: 4 additions & 1 deletion src/input/mpegts/satip/satip.c
Expand Up @@ -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,
Expand Down
17 changes: 10 additions & 7 deletions src/input/mpegts/satip/satip_frontend.c
Expand Up @@ -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[]) {
{
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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[]){
{
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand All @@ -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[]){
{}
}
Expand All @@ -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[]){
{}
}
Expand Down
5 changes: 4 additions & 1 deletion src/input/mpegts/satip/satip_satconf.c
Expand Up @@ -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[]) {
Expand Down
Binary file added src/webui/static/img/doc/addchanneldialog.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/webui/static/img/doc/addmuxsched.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/webui/static/img/doc/channeltags.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/webui/static/img/doc/satipclient.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d0ce7c1

Please sign in to comment.