README.adoc: explain howto include screenshots

[pve-docs.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index 062b94eff9634b3266b220c2e851ff9ac90e13d2..2970e60fa9f476ed2b346744b69492b77b9f1f15 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -239,6 +239,25 @@ text:
 For example, block headers can be used to add file names/paths to file
 content listings.
 
+Screenshots
+-----------
+
+[thumbnail="gui-datacenter-search.png"]
+
+First, it should be noted that we can display screenshots on 'html'
+and 'wiki' pages, and we can include them in printed doumentation. But
+ith is not possible to render them inside manual pages. So screenshot
+inside manual pages should be optional, i.e. the text should not
+depend on the visibility of the screenshot. You can include a
+screenshot by setting the 'thumbnail' attribute on a paragraph:
+
+----
+[thumbnail="gui-datacenter-search.png"]
+First, it should be noted ...
+----
+
+
+
 
 Copyright
 ---------