output-format.adoc: documentation for output format options

[pve-docs.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index 5e1c36c5ca49bc1cd841285101c179c3a9e54671..cda72b0a9bc3a90698ee1c0806e6790935be4c96 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -239,14 +239,38 @@ 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
 -----------
 
 [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
+and 'wiki' pages, and we can include them in printed documentation. But
+it 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:
@@ -280,7 +304,7 @@ all image attributes (from debian package 'imagemagick')
 [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
+of a paragraph. On printed documentation, 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.
@@ -304,7 +328,7 @@ 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