standardized call-out blocks

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

diff --git a/adoc/p_literal_string.adoc b/adoc/p_literal_string.adoc
index 5eaaec5345809a36b6df3c5c9aa0ee0b64e3e57c..ba94b0f3f7abadf97db4013aaba77123e5909f6a 100644 (file)
--- a/adoc/p_literal_string.adoc
+++ b/adoc/p_literal_string.adoc
@@ -1,15 +1,21 @@
-Word: S"
-----------
+//compile.asm: WORD p_literal_string,'S"',fasm ;; " (fool emacs)
 
 anchor:p_literal_string[]
-----
-compile.asm:   WORD p_literal_string,'S"',fasm ;; " (fool emacs)
-----
 
-"S"" is a function word for, in compaling mode, creating a string
-literal whose pname ( char* n ) gets pushed in interpreting mode.
+=== Word: S"
 
-Similar to "LIT", "S"" will insert the string into the containing
-definition, and use it from there.
+....
+Data stack: ( -- chars* n )
+....
 
+"S"" is a function word that pushes the [n:char] pointer for a string
+inlined subsequently to it in the containing definition. This is
+similar to <<p_lit,LIT>> but for a string literal.
+
+====
+.Definition concept for LIT
+****
+: LIT R> DUP @ 2DUP + 8 + >R SWAP 8 + SWAP ;
+****
+====