X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=README.adoc;h=5e1c36c5ca49bc1cd841285101c179c3a9e54671;hp=2970e60fa9f476ed2b346744b69492b77b9f1f15;hb=96124d0f9ebec3f84090d82f29edc62adb378498;hpb=0d1b9a161a2277dfc19e61617e8f83f201b4fe79 diff --git a/README.adoc b/README.adoc index 2970e60..5e1c36c 100644 --- a/README.adoc +++ b/README.adoc @@ -256,7 +256,49 @@ screenshot by setting the 'thumbnail' attribute on a paragraph: 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') + +.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