X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;ds=sidebyside;f=README.adoc;h=a236ac9df9b89081f8d162da791064594bc1e77e;hb=204231dffc0f85e3c14bb6c49e053f8cc324e38d;hp=6964087d6b37ed46bb323c7ae5ece5f7ecb0c7ec;hpb=6a6f83747ec67a47d5ad624d7559a57dd0c8dcf2;p=pve-docs.git

diff --git a/README.adoc b/README.adoc
index 6964087..a236ac9 100644
--- a/README.adoc
+++ b/README.adoc
@@ -239,6 +239,30 @@ text:
 For example, block headers can be used to add file names/paths to file
 content listings.
 
+
+Online Help
+-----------
+Each {pve} installation contains the full documentation in HTML format,
+which is then used as the target of various help buttons in the GUI.
+
+If after adding a specific entry in the documentation you want to
+create a help button pointing to that, you need to do the
+following:
+
+* add a string id in double square brackets before your 
+documentation entry,  like `[[qm_general_settings]]`
+* rebuild the `asciidoc-pve` script and the HTML chapter file containing 
+your entry
+* add a property `onlineHelp` in the ExtJS panel you want to document,
+using the above string, like `onlineHelp: qm_general_settings`
+This panel has to be a child class of PVE.panel.InputPanel
+
+On calling `make install` the asciidoc-pve script will populate
+a JS object associating the string id and a link to the 
+local HTML documentation, and the help button of your input panel 
+will point to this link.
+
+
 Screenshots
 -----------
 
@@ -275,13 +299,36 @@ 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
 ---------
 
-Copyright (C) 2016 Proxmox Server Solutions Gmbh
+Copyright (C) 2016-2017 Proxmox Server Solutions Gmbh
 
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or