README: note level 4 heading issues

[pve-docs.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index a236ac9df9b89081f8d162da791064594bc1e77e..43ce69f9d032571800d097c59aadce0db274c336 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -96,6 +96,10 @@ below the title text:
  Level 3:                 ^^^^^^^^^^^^^^^^^^^^^^
  Level 4 (bottom level):  ++++++++++++++++++++++
 
+NOTE: Level 4 headings are currently not working for `manpage` outputs, you may
+want to use `.SECTION' instead, which results in the same rendering, and this
+level of Heading isn't displayed in any Index/TOC anyway.
+
 Section titles should always be preceded by two empty lines. Each word
 in a title should be capitalized except for ``articles, coordinating
 conjunctions, prepositions, and the word to in infinitives unless they
@@ -266,17 +270,17 @@ will point to this link.
 Screenshots
 -----------
 
-[thumbnail="gui-datacenter-search.png"]
+[thumbnail="screenshot/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:
 
 ----
-[thumbnail="gui-datacenter-search.png"]
+[thumbnail="screenshot/gui-datacenter-search.png"]
 First, it should be noted ...
 ----
 
@@ -301,22 +305,22 @@ all image attributes (from debian package 'imagemagick')
 
 .Default Screenshot Layout
 
-[thumbnail="gui-datacenter-search.png"]
+[thumbnail="screenshot/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.
 
-[thumbnail="gui-datacenter-search.png", float="left"]
+[thumbnail="screenshot/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"]
+[thumbnail="screenshot/gui-datacenter-search.png", float="left"]
 If you need to render many screenshots ...
 ----