README.adoc: add info about macro usage

diff --git a/README.adoc b/README.adoc
index 7907228a13625450cecb50bc1de30a62a23eb819..6d2e570e67e6e327e51cbfbf3a43a5d30e6ae7c2 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -1,5 +1,6 @@
 Proxmox VE Documentation
 ========================
 Proxmox VE Documentation
 ========================

+include::attributes.txt[]

 
 What is this?
 -------------
 
 What is this?
 -------------


@@ -14,6 +15,17 @@ Administration Guide].  So we have one source, and generate several
 documents from that. It is also possible to generate printable PDF
 files, or ebook formats ('.ebup').
 
 documents from that. It is also possible to generate printable PDF
 files, or ebook formats ('.ebup').
 

+Common Macro definition in link:attributes.txt[]
+------------------------------------------------
+
+'asciidoc' allows us to define common macros, which can then be
+referred to using `{macro}`. We try to use this mechanism to improve
+consistency. For example, we defined a macro called `pve`, which
+expands to "Proxmox VE". The plan is to add more such definitions for
+terms which are used more than once.
+
+NOTE: The github 'asciidoc' viewer does not expand those macros.
+

 Autogenerated CLI Command Synopsis
 ----------------------------------
 
 Autogenerated CLI Command Synopsis
 ----------------------------------