X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=README.adoc;h=6d2e570e67e6e327e51cbfbf3a43a5d30e6ae7c2;hp=514a764e7f95f7a387735277a5702c49b85b8e6e;hb=e0e8bd4748167628cd745596caf55560aa08f7b1;hpb=f1e6bbae48355d7b6eea89c9af46dd9897327ba7 diff --git a/README.adoc b/README.adoc index 514a764..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 ---------------------------------- @@ -27,7 +39,7 @@ development environment. Copyright --------- -Copyright (C) Proxmox Server Solutions Gmbh +Copyright (C) 2016 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