From 642af5a398568b8d6fed26bf695090ea6ea8b890 Mon Sep 17 00:00:00 2001 From: Mark Clarkstone Date: Thu, 26 May 2016 15:47:21 +0100 Subject: [PATCH] mdhelp: shuffle some tips, update title property description for dvrtimerec, plus other minor changes. --- docs/class/dvrautorec.md | 2 ++ docs/class/dvrtimerec.md | 4 ++++ docs/markdown/inc/add_grid_entry.md | 7 ++++--- docs/markdown/inc/edit_grid_entries.md | 13 +++++++------ src/dvr/dvr_timerec.c | 2 +- 5 files changed, 18 insertions(+), 10 deletions(-) diff --git a/docs/class/dvrautorec.md b/docs/class/dvrautorec.md index 7b14cecef..20c9eec16 100644 --- a/docs/class/dvrautorec.md +++ b/docs/class/dvrautorec.md @@ -12,6 +12,8 @@ This tab controls EPG-driven recording rules. inc/add_grid_entry +####Example + If you wanted to record any programs matching "BBC News" on BBC One you would enter something like this into the add entry dialog: diff --git a/docs/class/dvrtimerec.md b/docs/class/dvrtimerec.md index ad5db0cae..75b774d9d 100644 --- a/docs/class/dvrtimerec.md +++ b/docs/class/dvrtimerec.md @@ -12,6 +12,10 @@ This tab controls timer-driven recording rules. inc/add_grid_entry +####Example + +This is an example of a one-time timer-based recording entry: + ![Timer add example](static/img/doc/dvrtimeradd.png) Note that when you create a rule/entry it will also generate a [DVR Entry](class/dvrentry). diff --git a/docs/markdown/inc/add_grid_entry.md b/docs/markdown/inc/add_grid_entry.md index 05a78a1d3..806053818 100644 --- a/docs/markdown/inc/add_grid_entry.md +++ b/docs/markdown/inc/add_grid_entry.md @@ -3,8 +3,9 @@ To add an entry click the *[Add]* button from the menu bar, the add dialog should now be displayed. A common set of fields is used for the add dialog, most of which can be seen in the grid view. + Pressing the *[Save]* button (at the bottom of the dialog) -will commit your changes and close the dialog, pressing the *[Apply]* -button will commit your changes but won't close the dialog, pressing -the *[Cancel]* button closes the dialog - any unsaved changes will be +will commit your changes and close the dialog, the *[Apply]* +button will commit your changes but won't close the dialog, +the *[Cancel]* button closes the dialog, any unsaved changes will be lost. diff --git a/docs/markdown/inc/edit_grid_entries.md b/docs/markdown/inc/edit_grid_entries.md index e94600ce8..cafef24b4 100644 --- a/docs/markdown/inc/edit_grid_entries.md +++ b/docs/markdown/inc/edit_grid_entries.md @@ -1,10 +1,6 @@ ###Editing an Entry -There are two methods to editing an entry. - -inc/selecting_entries_tip - -inc/paging_tip +There are two methods for editing an entry. ####Editing in the Grid @@ -17,12 +13,17 @@ After a cell is changed, a small red flag or triangle will appear in the top-left corner to indicate that it has been changed. These changes can now be kept (*[Save]* button), or abandoned (*[Undo]* button). +inc/selecting_entries_tip + +inc/paging_tip + ####Using the *[Edit]* Button Highlight (select) the entries in the grid that you'd like to edit, then click the *[Edit]* button from the menu bar, the edit dialog should now be displayed. A common set of fields is used for the edit dialog, most -of which can be seen in the grid view. Note that when editing +of which can be seen in the grid view. +Note that when editing multiple entries there is an additional check box before each setting, ticking it will apply that setting to all selected entries. diff --git a/src/dvr/dvr_timerec.c b/src/dvr/dvr_timerec.c index e6ed27700..7be194d37 100644 --- a/src/dvr/dvr_timerec.c +++ b/src/dvr/dvr_timerec.c @@ -549,7 +549,7 @@ const idclass_t dvr_timerec_entry_class = { .type = PT_STR, .id = "title", .name = N_("Title"), - .desc = N_("Title of the recording."), + .desc = N_("Title of the recording - this is used to generate the filename."), .doc = prop_doc_dvr_timerec_title_format, .off = offsetof(dvr_timerec_entry_t, dte_title), .def.s = "Time-%F_%R", -- 2.47.3