major touch-up into presentable form

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

diff --git a/adoc/p_current_wordlist.adoc b/adoc/p_current_wordlist.adoc
index 340cabd73fb4cc349ed752469600846af6497407..6f086a6adb539e318e7d7e7dac5d8db798d2a8dd 100644 (file)
--- a/adoc/p_current_wordlist.adoc
+++ b/adoc/p_current_wordlist.adoc
@@ -1,9 +1,25 @@
+// wordlists.asm:      WORD p_wordlist,'CURRENT-WORDLIST',dovariable
+
 anchor:p_wordlist[]
 
-Word: CURRENT-WORDLIST
-----------------------
+=== Word: CURRENT-WORDLIST
+....
+Data stack: ( -- a )
+....
 
+"CURRENT-WORDLIST" is a variable word that points out the DFA of the
+current word list word for <<p_find,FIND>> to use finding words. The
+word list word content is as follows:
+====
+.word list word content
+[caption='Layout {counter:layout}: ']
 ----
-wordlists.asm: WORD p_wordlist,'CURRENT-WORDLIST',dovariable
+  8 TFA of latest word in the word list
+  8 DFA of the/a subsequent word list to search through
 ----
+====
+
+Note that word lists are chained by "extension" and in general it ends
+with the <<p_forth,FORTH>> word list. Initially the
+<<p_system,SYSTEM>> word list is the only other word list.