README.adoc: add info about macro usage
authorDietmar Maurer <dietmar@proxmox.com>
Wed, 6 Jan 2016 16:58:58 +0000 (17:58 +0100)
committerDietmar Maurer <dietmar@proxmox.com>
Wed, 6 Jan 2016 16:58:58 +0000 (17:58 +0100)
README.adoc

index 7907228..6d2e570 100644 (file)
@@ -1,5 +1,6 @@
 Proxmox VE Documentation
 ========================
+include::attributes.txt[]
 
 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').
 
+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
 ----------------------------------