README.adoc: improve docs about screenshots

[pve-docs.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index 062b94eff9634b3266b220c2e851ff9ac90e13d2..6964087d6b37ed46bb323c7ae5ece5f7ecb0c7ec 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -239,6 +239,44 @@ 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 ...
+----
+
+The corresponding file need to reside inside folder
+`images/screenshot`, and should be in `.png` image format. We include
+the screenshots in printed documentation, and 'pdftex' uses the
+density (DPI) specified inside the file. So all screenshots should use
+the same density. We currently require the density set to 146 DPI, so
+that we can display a 1024 pixels wide image. You should not include
+larger screenshots (although it is possible).
+
+You can use the `./png-cleanup.pl` script to set the correct
+density. Simply use the following command to import a screenshot
+image:
+
+----
+# ./png-cleanup.pl screenshot.png images/screenshot/screenshot.png
+----
+
+TIP: You can use `identify -verbose screenshot.png` command to show
+all image attributes (from debian package 'imagemagick')
+
+
+
 
 Copyright
 ---------