aboutsummaryrefslogtreecommitdiffstats
path: root/doc/expert/pre_inse
diff options
context:
space:
mode:
Diffstat (limited to 'doc/expert/pre_inse')
-rw-r--r--doc/expert/pre_inse19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/expert/pre_inse b/doc/expert/pre_inse
new file mode 100644
index 0000000..e981359
--- /dev/null
+++ b/doc/expert/pre_inse
@@ -0,0 +1,19 @@
+@Section
+ @Title { "@Insert" }
+ @Tag { insert }
+@Begin
+@PP
+insert.sym @Index { @@Insert symbol }
+The @@Insert symbol inserts its left parameter at the beginning of the
+first paragraph of its right parameter:
+@ID @Code "X @Insert { A B // C // D }"
+is equivalent to
+@ID @Code "{ XA B // C // D }"
+Notice that a zero-width space separates @Code { X } from the first
+paragraph, so if some wider space is required it must be placed at the
+end of @Code { X }. The @Code "@Insert" operation is applied to the
+value of the right parameter after evaluation.
+@PP
+The only known use for this symbol is to attach something like
+@B { Figure 6 } to the front of a multi-paragraph caption.
+@End @Section