]> git.ipfire.org Git - thirdparty/tvheadend.git/commitdiff
mdhelp: add screenshot and button table to access_entry doc mdhelp: update config...
authorMark Clarkstone <hello@markclarkstone.co.uk>
Sat, 16 Apr 2016 01:15:51 +0000 (02:15 +0100)
committerJaroslav Kysela <perex@perex.cz>
Sun, 17 Apr 2016 17:17:24 +0000 (19:17 +0200)
docs/class/access_entry.md
docs/class/config.md
docs/class/imagecache.md
docs/docresources/accessentriesgrid.png [new file with mode: 0644]
docs/docresources/configimagecache.png [new file with mode: 0644]
src/imagecache.c

index a4093d1ee8f167db8c984a83dbab06105edf1e3e..876913ab46dd9693977006eff72dc06924defafc 100644 (file)
@@ -9,6 +9,24 @@ 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.
 
+!['Access Entries Grid'](docresources/accessentriesgrid.png)
+
+---
+
+###Buttons
+
+The tab has the following buttons:
+
+Button                 | Function
+-----------------------|-------------------
+**Save**               | Save any changes made to the grid/entries.
+**Undo**               | Revert any changes made since the last save.
+**Add**                | Display the *Add Access* dialog.
+**Delete**             | Delete the selected entry/entries.
+**Move Up**            | Move the selected entry up the grid.
+**Move Down**          | Move the selected entry down the grid.
+**Edit**               | Edit the selected entry.
+
 ---
 
 ### Adding an Entry/Creating an Account
index 3eab26684105313062a3aefd4b038c0a4af7ee0f..a0f65a62147bf0cc1dd31df39369881daf50fa4a 100644 (file)
@@ -11,7 +11,7 @@ The tab has the following buttons:
 
 Button                 | Function
 -----------------------|-------------------
-**Save**               | Save all changes.
+**Save**               | Save all changes (this will reload the web interface).
 **Undo**               | Revert all changes since last save.
 **Start wizard**       | Display the first-run set-up wizard.
 
index 140d2f540500b32a0f9b63b046ae6cfa4a1464ea..bcc6e7984e13d71c901929261503fe55481e5958 100644 (file)
@@ -2,3 +2,20 @@ This will cache any channel icons or other images (such as EPG metadata)
 to be served from the local webserver. This can be useful for
 multi-client systems and, generally, to reduce hits on upstream
 providers.
+
+!['Configuration - Image Cache tab'](docresources/configimagecache.png)
+
+---
+
+###Buttons
+
+The tab has the following buttons:
+
+Button                      | Function
+----------------------------|-------------------
+**Save**                    | Save any changes made to the tab.
+**Undo**                    | Revert any changes made since the last save.
+**Clean image (icon) cache**| Clean-up the stored image files (empty cache and re-fetch icons).
+**Re-fetch images**         | Re-refresh image cache (reload images from upstream providers).
+
+---
diff --git a/docs/docresources/accessentriesgrid.png b/docs/docresources/accessentriesgrid.png
new file mode 100644 (file)
index 0000000..3de25c6
Binary files /dev/null and b/docs/docresources/accessentriesgrid.png differ
diff --git a/docs/docresources/configimagecache.png b/docs/docresources/configimagecache.png
new file mode 100644 (file)
index 0000000..b201e3b
Binary files /dev/null and b/docs/docresources/configimagecache.png differ
index 761e3c5b97031855511cbea7da9020bcd12d49a4..f0785611cd051574539220b67ba788cf353b8ce5 100644 (file)
@@ -76,7 +76,7 @@ CLASS_DOC(imagecache)
 const idclass_t imagecache_class = {
   .ic_snode      = (idnode_t *)&imagecache_conf,
   .ic_class      = "imagecache",
-  .ic_caption    = N_("Image cache"),
+  .ic_caption    = N_("Configuration - Image cache"),
   .ic_event      = "imagecache",
   .ic_perm_def   = ACCESS_ADMIN,
   .ic_doc        = tvh_doc_imagecache_class,