mdhelp: add screenshot and button table to access_entry doc mdhelp: u…

…pdate config doc button table mdhelp: add screenshot, button table and update caption (imagecache)
tvheadend · Apr 17, 2016 · 7e586fa · 7e586fa
1 parent 3af7a46
commit 7e586fa
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 2 deletions.
diff --git a/docs/class/access_entry.md b/docs/class/access_entry.md
@@ -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

diff --git a/docs/class/config.md b/docs/class/config.md
@@ -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.
 

diff --git a/docs/class/imagecache.md b/docs/class/imagecache.md
@@ -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
diff --git a/docs/docresources/configimagecache.png b/docs/docresources/configimagecache.png
diff --git a/src/imagecache.c b/src/imagecache.c
@@ -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,