X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=adventure.yaml;h=629060a40bc2b4868e194cfa845e033c0adffd48;hb=39eed7d678588438a7abe97354987816e9305096;hp=60177932c5514b59a0795ff6ec2730d922c344d7;hpb=c3a2816821512b59a09866a594a9bec699193271;p=open-adventure.git

diff --git a/adventure.yaml b/adventure.yaml
index 6017793..629060a 100644
--- a/adventure.yaml
+++ b/adventure.yaml
@@ -77,6 +77,22 @@
 # These correspond to sections 1, 2, 5, 6, 9, 10, 11, 13, and 14 in the old
 # adventure.text format.  Sections 3, 4, 7, and 8 haven't moved yet.
 # Section 12 was obsolete.
+#
+# Message strings may include certain special character sequences to
+# denote that the program must provide parameters to insert into a
+# message when the message is printed.  These sequences are:
+#	%S = The letter 'S' or nothing (if a given value is exactly 1)
+#	%W = A word (up to 10 characters)
+#	%L = A word mapped to lower-case letters
+#	%U = A word mapped to upper-case letters
+#	%C = A word mapped to lower-case, first letter capitalised
+#	%T = Several words of text, ending with a word of -1
+#	%1 = A 1-digit number
+#	%2 = A 2-digit number
+#	...
+#	%9 = A 9-digit number
+#	%B = Variable number of blanks
+#	%! = The entire message should be suppressed
 
 # FIXME: Hint texts shouldn't be in arbitrary_messages, but inlined here
 hints: