1
0
Fork 0

Give example on use of rewrite-inactive

Explain about <uninit>. Does <unknown> need removing?
This commit is contained in:
Sam Liddicott 2012-06-06 17:34:57 +00:00
parent c93081b807
commit 39197da9ce
1 changed files with 18 additions and 0 deletions

View File

@ -9,11 +9,20 @@
only. They are documented for the sake of completeness, but you should only only. They are documented for the sake of completeness, but you should only
use them if you really know what you are doing. use them if you really know what you are doing.
<\explain|<explain-macro|uninit><explain-synopsis|unknown content or
unintialized data>>
This primitive is mainly used for default uninialized value of
environment variables; the main advantage of this tag is to be distinct
from the empty string.
</explain>
<\explain|<explain-macro|unknown><explain-synopsis|unknown content or <\explain|<explain-macro|unknown><explain-synopsis|unknown content or
unintialized data>> unintialized data>>
This primitive is mainly used for default uninialized value of This primitive is mainly used for default uninialized value of
environment variables; the main advantage of this tag is to be distinct environment variables; the main advantage of this tag is to be distinct
from the empty string. from the empty string.
This value is less likely to be encountered than <src-macro|uninit>
</explain> </explain>
<\explain|<explain-macro|error|message><explain-synopsis|error messages>> <\explain|<explain-macro|error|message><explain-synopsis|error messages>>
@ -88,6 +97,15 @@
<|explain> <|explain>
This internal primitive is used for rewriting an inactive tree into a new This internal primitive is used for rewriting an inactive tree into a new
tree whose rendering corresponds to the rendering of the inactive tree. tree whose rendering corresponds to the rendering of the inactive tree.
It may be successfully invoked from within a macro.
e.g. <inactive*|<assign|show-inactive|<macro|x|<rewrite-inactive|<arg|x>|>>>>
which might be invoked to show itself or another assigned variable using
<src-macro|quasiquote> in this manner:
<inactive*|<quasiquote|<show-inactive|<unquote|<value|show-inactive>>>>>
\;
</explain> </explain>
<\explain> <\explain>