this repository. It is possible to generate the docs without installing
any additional Proxmox packages with:
+ make pve-doc-generator.mk
make index
To update the auto-generate API definitions use:
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
* First level again
+If you need to have other elements on the same level as a list element you
+can do this with the '+' symbol:
+
+----
+. First level
+.. Second level
++
+Another Sentence (or Block) on the continued second level.
+. First level again
+----
+
+. First level
+.. Second level
++
+Another Sentence (or Block) on the continued second level.
+
+. First level again
+
Labeled Lists
^^^^^^^^^^^^^
Use this for formatting file contents or command output.
----
-Specially highlighted 'notes', 'warnings' and 'important' information
-can be created by starting a paragraph with `NOTE:`, `WARNING:` or
+Specially highlighted 'tips', 'notes', 'warnings' and 'important' information
+can be created by starting a paragraph with `TIP`, `NOTE:`, `WARNING:` or
`IMPORTANT:`:
+TIP: this is a tip
+
NOTE: this is a note
WARNING: this is warning
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 documentation. But
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 ...
----
.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 paragraph. On printed documentation, we render the full sized
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 ...
----
Copyright
---------
-Copyright (C) 2016-2017 Proxmox Server Solutions Gmbh
+Copyright (C) 2016-2021 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