diff --git a/devel/scheme/overview/overview-meta.en.tm b/devel/scheme/overview/overview-meta.en.tm index 52188a3..95bfcf3 100644 --- a/devel/scheme/overview/overview-meta.en.tm +++ b/devel/scheme/overview/overview-meta.en.tm @@ -1,4 +1,4 @@ - + @@ -10,7 +10,7 @@ complete overview of the program, it is a good practive to associate additional to the individual routines and data. This meta-information typically serves documentation purposes, but becomes even - more interesting if it can be used in an automized fashion to implement + more interesting if it can be used in an automated fashion to implement more general additional functionality. The macro supports several options for associating @@ -19,7 +19,7 @@ associate short documentation strings to the function, its arguments and its return value: - <\scm-fragment> + <\scm-code> (tm-define (square x) \ \ (:synopsis "Compute the square of @x") @@ -29,14 +29,15 @@ \ \ (:returns "The square of @x") \ \ (* x x)) - + This information is exploited by in several ways. For instance, the synopsis of the function can be retrieved by executing . More interestingly, assuming that we defined as - above, typing followed by and - allows you to execute in an interactive way: you will be - prompted for ``A number'' on the footer. Moreover, after typing , + above, typing followed by + and allows you to execute + in an interactive way: you will be prompted for ``A number'' on the footer. + Moreover, after typing , you will be able to use ``tab-completion'' in order to enter : typing will usually complete into. @@ -45,32 +46,32 @@ or when it should give rise to a check-mark when used in a menu. For instance, the statement - <\scm-fragment> + <\scm-code> (tm-property (choose-file fun text type) \ \ (:interactive #t)) - + in the source code of states that is an interactive command. As a consquence, the entry, which is defined by - <\scm-fragment> + <\scm-code> ("Load" (choose-file load-buffer "Load file" "")) - + will be followed by dots in the menu. The interesting point here is that, although the command may be reused several times in different menu entries, we only have to specify once that it is an interactive command. Similarly, consider the definition - <\scm-fragment> + <\scm-code> (tm-define (toggle-session-math-input) \ \ (:check-mark "v" session-math-input?) \ \ (session-use-math-input (not (session-math-input?)))) - + Given a menu item with as its associated action, this definition specifies in particular that a check-mark should be @@ -78,14 +79,15 @@ predicate holds. Another frequently used option is , which specifies that a - given routine is secure. For instance, the default implementation of the - tag allows the user to click on the - ``>>'' before the folded text so as to unfold - the tag. When doing this, the scheme script is - launched. However, for this to work, the function needs - to be secure: + given routine can be used inside documents, in particular inside + and macros. For instance, the default + implementation of the tag allows the user to click on the + ``>>'' before the folded text so as to unfold the tag. + When doing this, the scheme script is launched. + However, for this to work, the function needs to be + secure: - <\scm-fragment> + <\scm-code> (tm-define (mouse-unfold) \ \ (:secure #t) @@ -95,11 +97,11 @@ \ \ \ \ (tree-go-to t :start) \ \ \ \ (fold))) - + - The option is also needed in combination with which depend on scripts, - like . + You can read more about the tags which depend on scripts in + `` scrips from + markup|overview-start.en.tm#markup-scripts>''.\ In the future, the number of options for entering meta-information is likely to increase. also supports an additional mechanism for the