From: Dietmar Maurer <dietmar@proxmox.com>
Date: Wed, 6 Jan 2016 16:58:58 +0000 (+0100)
Subject: README.adoc: add info about macro usage
X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=commitdiff_plain;h=8e6e64116e8b6f207764a853c7959705aacf5be1

README.adoc: add info about macro usage
---

diff --git a/README.adoc b/README.adoc
index 7907228..6d2e570 100644
--- a/README.adoc
+++ b/README.adoc
@@ -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
 ----------------------------------