Recent changes to Interface

Interface modified by OmniMark Code

OmniMark Code — Thu, 16 May 2013 18:51:41 -0000

--- v3
+++ v4
@@ -15,7 +15,7 @@

-The input of resolve-referents consists of plain text, markup, and referents. Its task is to replace each referent by its resolved value and output the resultiing markup stream into destination.
+The input of resolve-referents consists of plain text, markup, and referents. Its task is to replace each referent by its resolved value and output the resulting markup stream into destination.

For the next piece of the puzzle, if the aim is to replicate the built-in OmniMark syntax as closely as possible, we'd like the equivalent of the following interface that uses the word referent both for emitting a referent and for setting its value:

WikiPage Interface modified by OmniMark Code

OmniMark Code — Mon, 14 May 2012 15:24:46 -0000

--- v2 
+++ v3 
@@ -1,41 +1,41 @@
-Interface requirements
-======================
-
-What are the essential parts of the referent mechanism?
-
-1. A sink modified with `referents-allowed` accepts referents, buffering all input until the referent values are resolved.
-1. One must be able to `output referent` into such a stream.
-1. Finally, a referent can be resolved using the `set referent`, `open ... as referent`, or `using output as referent` action.
-
-These three requirements already describe our interface. First, we need a `markup sink` filter to play the role of the `referents-allowed` modifier:
-
--export markup sink function
-   resolve-referents into value markup sink destination
-    
-
-
+Interface requirements 
+=======================
+
+What are the essential parts of the referent mechanism?  
+
+1. A sink modified with `referents-allowed` accepts referents, buffering all input until the  referent values are resolved. 
+1. One must be able to `output referent` into such a stream. 
+1. Finally, a referent can be resolved using the `set referent`, `open ... as referent`, or `using output as  referent` action. 
+
+These three requirements already describe our interface. First, we need a `markup sink` filter to play the role  of the `referents-allowed` modifier:  
+
++export markup sink function
+   resolve-referents into value markup sink destination
+    
+
+
 The input of `resolve-referents` consists of plain text, markup, and referents. Its task is to replace each  referent by its resolved value and output the resultiing markup stream into `destination`.  
 
 For the next piece of the puzzle, if the aim is to replicate the built-in OmniMark syntax as closely as  possible, we'd like the equivalent of the following interface that uses the word `referent` both for  emitting a referent and for setting its value:  
 
--export markup source function
-   referent value string referent-name
-
-export markup sink function
-   referent value string referent-name
-    
-
++export markup source function
+   referent value string referent-name
+ 
+export markup sink function
+   referent value string referent-name
+    
+
 
 This interface supports both emitting a referent with `output referent`, and setting a referent's value with  `using output as referent`. The two function definitions would unfortunately not be allowed in OmniMark, but we  can achieve the same effect by having the function `referent` return an intermediate type which then gets  converted to the desired result type by a `conversion-function`:  
 
--export markup-referent-buffer function
-   referent value string referent-name
-
-export markup source conversion-function value markup-referent-buffer b
-
-export markup sink conversion-function value markup-referent-buffer b
-    
-
++export markup-referent-buffer function
+   referent value string referent-name
+ 
+export markup source conversion-function value markup-referent-buffer b
+ 
+export markup sink conversion-function value markup-referent-buffer b
+    
+

WikiPage Interface modified by OmniMark Code

OmniMark Code — Fri, 11 May 2012 17:52:23 -0000

--- v1 
+++ v2 
@@ -9,33 +9,33 @@
 
 These three requirements already describe our interface. First, we need a `markup sink` filter to play the role of the `referents-allowed` modifier:
 
-~~~~~~
-export markup sink function
++export markup sink function
    resolve-referents into value markup sink destination
     
-~~~~~~
-
-The input of `resolve-referents` consists of plain text, markup, and referents. Its task is to replace each referent by its resolved value and output the resultiing markup stream into `destination`.
-
-For the next piece of the puzzle, if the aim is to replicate the built-in OmniMark syntax as closely as possible, we'd like the equivalent of the following interface that uses the word `referent` both for emitting a referent and for setting its value:
-
-~~~~~~
+
+
+The input of `resolve-referents` consists of plain text, markup, and referents. Its task is to replace each  referent by its resolved value and output the resultiing markup stream into `destination`.  
+
+For the next piece of the puzzle, if the aim is to replicate the built-in OmniMark syntax as closely as  possible, we'd like the equivalent of the following interface that uses the word `referent` both for  emitting a referent and for setting its value:  
+
+ export markup source function
    referent value string referent-name
 
 export markup sink function
    referent value string referent-name
     
-~~~~~~
-
-This interface supports both emitting a referent with `output referent`, and setting a referent's value with `using output as referent`. The two function definitions would unfortunately not be allowed in OmniMark, but we can achieve the same effect by having the function `referent` return an intermediate type which then gets converted to the desired result type by a `conversion-function`:
-
-~~~~~~
+
+
+This interface supports both emitting a referent with `output referent`, and setting a referent's value with  `using output as referent`. The two function definitions would unfortunately not be allowed in OmniMark, but we  can achieve the same effect by having the function `referent` return an intermediate type which then gets  converted to the desired result type by a `conversion-function`:  
+
+ export markup-referent-buffer function
    referent value string referent-name
 
 export markup source conversion-function value markup-referent-buffer b
 
 export markup sink conversion-function value markup-referent-buffer b
     
-~~~~~~
+

WikiPage Interface modified by OmniMark Code

OmniMark Code — Fri, 11 May 2012 17:04:12 -0000

Interface requirements ====================== What are the essential parts of the referent mechanism? 1. A sink modified with `referents-allowed` accepts referents, buffering all input until the referent values are resolved. 1. One must be able to `output referent` into such a stream. 1. Finally, a referent can be resolved using the `set referent`, `open ... as referent`, or `using output as referent` action. These three requirements already describe our interface. First, we need a `markup sink` filter to play the role of the `referents-allowed` modifier: ~~~~~~ export markup sink function resolve-referents into value markup sink destination ~~~~~~ The input of `resolve-referents` consists of plain text, markup, and referents. Its task is to replace each referent by its resolved value and output the resultiing markup stream into `destination`. For the next piece of the puzzle, if the aim is to replicate the built-in OmniMark syntax as closely as possible, we'd like the equivalent of the following interface that uses the word `referent` both for emitting a referent and for setting its value: ~~~~~~ export markup source function referent value string referent-name export markup sink function referent value string referent-name ~~~~~~ This interface supports both emitting a referent with `output referent`, and setting a referent's value with `using output as referent`. The two function definitions would unfortunately not be allowed in OmniMark, but we can achieve the same effect by having the function `referent` return an intermediate type which then gets converted to the desired result type by a `conversion-function`: ~~~~~~ export markup-referent-buffer function referent value string referent-name export markup source conversion-function value markup-referent-buffer b export markup sink conversion-function value markup-referent-buffer b ~~~~~~