From: Mark Clarkstone <hello@markclarkstone.co.uk>
Date: Thu, 14 Apr 2016 06:42:48 +0000 (+0100)
Subject: mdhelp: access entry update (plus screenshot) mdhelp: add title formatting info to... 
X-Git-Tag: v4.2.1~660
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=2a4dea22ad7e2493fec4935dd12a6134e3c9d4c6;p=thirdparty%2Ftvheadend.git

mdhelp: access entry update (plus screenshot) mdhelp: add title formatting info to dvr_timerec
---

diff --git a/docs/class/access_entry.md b/docs/class/access_entry.md
index 2717136f8..a4093d1ee 100644
--- a/docs/class/access_entry.md
+++ b/docs/class/access_entry.md
@@ -8,3 +8,47 @@ combined for all matching access entries. An access entry is said to match
 if the username matches and the IP source address of the requesting peer
 is within the prefix. There is also anonymous access, if the user is set
 to asterisk. Only network prefix is matched then.
+
+---
+
+### Adding an Entry/Creating an Account
+
+To create a new user, navigate to the *Configuration -> Users -> Access Entries*
+tab and click on the *[Add]* button from the menu bar, then using the 
+*Add Access Entry* dialog enter the *required* username and select the 
+desired rights options. 
+
+If you would like to allow anonymous access to your Tvheadend 
+server you may set-up an anonymous account by entering an asterisk `*` 
+in the username field. **WARNING: All access rights given to an anonymous account also
+apply to subsequent accounts.**
+
+!['Access Entry Example'](docresources/accessentriesnewuser.png)
+
+**Don't forget** to also create a password entry for the user in the 
+*Passwords* tab!
+
+**Tips**:
+* Be as limiting as possible especially when making Tvheadend available over the internet.
+* For extra security, always enter (a comma-separated list of) network prefix(es) (*Allowed networks* in the *Add Access Entry* dialog).
+* If you lock yourself out, you can use the backdoor account to regain access, or restart Tvheadend with the `--noacl` argument.
+* You can have multiple entries using the same username with varying rights, allowing you to enable / disable each as needed. Keep in mind that matching account entry permissions are combined.
+
+---
+
+### Editing an Entry/Account
+
+To edit an entry highlight (select) the entry from the grid then press 
+the *[Edit]* button from the menu bar.
+
+**Tip**: You can quickly make changes to an entry by double-clicking on 
+the desired field within the grid. See *Editing Fields* on the [Web interface Guide - General](webui_general) 
+page for details.
+
+---
+
+### Deleting a User.
+
+To delete a user highlight (select) the entry from the grid then press
+the *[Delete]* button from the menu bar.
+
diff --git a/docs/docresources/accessentriesnewuser.png b/docs/docresources/accessentriesnewuser.png
new file mode 100644
index 000000000..6415876bf
Binary files /dev/null and b/docs/docresources/accessentriesnewuser.png differ
diff --git a/docs/property/dvr_timerec_title_format.md b/docs/property/dvr_timerec_title_format.md
new file mode 100644
index 000000000..42e7f3740
--- /dev/null
+++ b/docs/property/dvr_timerec_title_format.md
@@ -0,0 +1,10 @@
+:
+
+String | Format Result
+------ | -------------
+%F     | The date in ISO-format (e.g. 2015-02-28).
+%R     | The time in 24h HH:MM format (e.g. 19:45).
+%x     | The date, formatted according to your locale settings.
+
+The escape-codes use
+[strftime](http://man7.org/linux/man-pages/man3/strftime.3.html) format.
diff --git a/src/dvr/dvr_timerec.c b/src/dvr/dvr_timerec.c
index fd747294c..8af4b722e 100644
--- a/src/dvr/dvr_timerec.c
+++ b/src/dvr/dvr_timerec.c
@@ -517,6 +517,14 @@ dvr_timerec_entry_class_owner_opts(void *o)
   return PO_RDONLY | PO_ADVANCED;
 }
 
+static char *
+dvr_timerec_prop_titleformat_doc(const struct property *p, const char *lang)
+{
+  extern const char *tvh_doc_dvr_timerec_title_format_property[];
+  return prop_md_doc(tvh_doc_dvr_timerec_title_format_property, lang);
+}
+
+
 extern const char *tvh_doc_dvrtimerec_class[];
 
 const idclass_t dvr_timerec_entry_class = {
@@ -549,6 +557,7 @@ const idclass_t dvr_timerec_entry_class = {
       .id       = "title",
       .name     = N_("Title"),
       .desc     = N_("Title of the recording."),
+      .doc      = dvr_timerec_prop_titleformat_doc,
       .off      = offsetof(dvr_timerec_entry_t, dte_title),
       .def.s    = "Time-%F_%R",
     },