README.adoc: improve docs about screenshots
authorDietmar Maurer <dietmar@proxmox.com>
Tue, 8 Nov 2016 08:26:52 +0000 (09:26 +0100)
committerDietmar Maurer <dietmar@proxmox.com>
Tue, 8 Nov 2016 08:26:52 +0000 (09:26 +0100)
README.adoc

index 6964087..5e1c36c 100644 (file)
@@ -275,7 +275,30 @@ image:
 TIP: You can use `identify -verbose screenshot.png` command to show
 all image attributes (from debian package 'imagemagick')
 
+.Default Screenshot Layout
 
+[thumbnail="gui-datacenter-search.png"]
+
+We normally display screenshots as small thumbnail on the right side
+of a paraprah. On printed docomentation, we render the full sized
+graphic just before the paragraph, or between the title and the text
+if the paragraph has a title. It is usually a good idea to add a title
+to paragraph with screenshots.
+
+[thumbnail="gui-datacenter-search.png", float="left"]
+
+If you need to render many screenshots, it is possible to place them
+on the left side, so you can alternate the thumbnail position using the
+`float` attribute:
+
+----
+[thumbnail="gui-datacenter-search.png", float="left"]
+If you need to render many screenshots ...
+----
+
+Please avoid to many consecutive screenshots to avoid rendering
+problems. Also verify the printed documentation to see if large
+screenshots create layout problems.
 
 
 Copyright