proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-06-14 22:58:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

readme: extend macro section

Browse Source
This commit is contained in:
Fabian Grünbichler 2016-10-04 14:10:23 +02:00 committed by Dietmar Maurer
parent 3eafe338a8
commit 8ff3e5f7c1
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.adoc
View File

@ -3,7 +3,7 @@ Proxmox VE Documentation
include::attributes.txt[]
We try to generate high quality documentation for
http://www.proxmox.com[Proxmox VE], and choose to use
{website}[{pve}], and choose to use
http://www.methods.co.nz/asciidoc/[AsciiDoc] as base format.
The basic idea is to generate high quality manual pages, and assemble
@ -48,8 +48,24 @@ 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.
expands to "Proxmox VE".
For URLs which are used more than once, two macros should be defined:
* `{name-url}`, which just contains the http(s) URL
* `{name}`, which contains the complete link including the canonical
description
For example, the macro `{forum-url}` expands to {forum-url}, and the macro
`{forum}` expands to {forum}.
The plan is to add more such definitions for terms which are used more than once.
WARNING: When asciidoc encounters a misspelled macro name, it will silently drop
the containing line!
WARNING: Never use macros in document titles or the ``NAME'' section of man pages,
as these get parsed before the `attributes.txt` file gets included.
Autogenerated CLI Command Synopsis
----------------------------------