doc fiddling

[rrq/rrqforth.git] / adoc / p_allot.adoc

diff --git a/adoc/p_allot.adoc b/adoc/p_allot.adoc
index cf6e3b9e1e27f553b3e021259ce77be2a31e127e..78440106c47e3047635324c63d9256882035d51b 100644 (file)
--- a/adoc/p_allot.adoc
+++ b/adoc/p_allot.adoc
@@ -1,26 +1,31 @@
+// compile.asm:        WORD p_allot,'ALLOT',fasm
+
 anchor:p_allot[]
 
-Word: ALLOT
------------
-
-----
-compile.asm:   WORD p_allot,'ALLOT',fasm
-----
+=== Word: ALLOT
 
+....
 Data stack: ( n -- )
+....
 
-"ALLOT" is a function word that merely increments the "HERE" variable
-with +n+ so as to claim that amount of the allocation space.
+"ALLOT" is a function word that merely increments the <<p_here,HERE>>
+variable with +n+ so as to claim that amount of the heap.
 
-.Execution semantics expressed in RRQFORTH
 ====
-: ALLOT
-  HERE @ + HERE !
-;
+.Word: ALLOT
+[caption='Defintion concept {counter:exec}: ']
+----
+: ALLOT HERE @ + HERE ! ;
+----
 ====
 
-.Usage example
 ====
+.Usage example
+****
 HERE @ 16 ALLOT ( -- p ; Claiming 16 bytes )
+****
 ====
 
+See also <<p_colon,:>>, <<p_here,HERE>>, <<p_get,@>>, <<p_plus,+>>,
+<<p_put,!>> and <<p_semicolon,;>>.
+