@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

31 lines (25 loc) • 6.29 kB

HTML

<!DOCTYPE HTML><html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><meta name="theme-color" content="#273f79"/><link rel="stylesheet" href="lpdoc.css" type="text/css"/><script type="text/javascript" src="lpdoc.js"></script><title>Text templates — The Ciao System v1.22</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton"><span id="sidebar-button-arrow">☰</span></a><div id="sidebar" class="lpdoc-sidebar"><div style="height: 40px; margin-left: auto; margin-right: auto"><img src="ciao-logo_autofig.png" width=auto height=100%></div><div class="lpdoc-nav"><span class="lpdoc-on-right"><a class="lpdoc-navbutton" href="ExtraLibs.html">↑</a><a class="lpdoc-navbutton" href="regexp_code.html">←</a><a class="lpdoc-navbutton" href="messages.html">→</a><a class="lpdoc-navbutton" href="ciaosearch.html">🔍</a></span><span><a href="ciaofulltoc.html">TOC</a></span></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciao.html">The Ciao System</a> »<br/> </li><li><a href="ExtraLibs.html">PART VIII - Additional libraries</a> »<br/> </li><li><a href=""><strong>Text templates</strong></a></li></ul><hr></hr><em>ON THIS PAGE</em><ul><li><a href="#Usage and interface">Usage and interface</a></li><li><a href="#Documentation on exports">Documentation on exports</a></li><li><a href="#Documentation on imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>Text templates</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#text_template"></a> <strong>Author(s):</strong> <a class="lpdoc-idx-anchor" id="Jose F. Morales" href="ciaosearch.html#Jose F. Morales">Jose F. Morales</a>, <a class="lpdoc-idx-anchor" id="The Ciao Development Team" href="ciaosearch.html#The Ciao Development Team">The Ciao Development Team</a>.<p> A template is a text marked-up with special tags that contain expressions. Template evaluation replaces tags with the evaluation of such expressions, w.r.t. a substitution of parameters.<p>Tags must have the form <tt>{{</tt><em>Expr</em><tt>}}</tt>, where <em>Expr</em> is a parameter name.<p>Example: given the file <tt>n.txt.skel</tt>: <pre class="lpdoc-codeblock">Dear {{Author}}, on behalf of the program committee of {{Conf}}, we are pleased to inform you that your paper {{Title}} has been accepted for inclusion in the post-conference proceedings. </pre> <p>then the query:<p><pre class="lpdoc-codeblock">?- eval_template_file('n.txt.skel', [ 'Author' = 'Alain', 'Title' = 'The Birth of Prolog', 'Conf' = 'CACM 93' ], 'n.txt'). </pre> <p>produces the following text:<p><pre class="lpdoc-codeblock">Dear Alain, on behalf of the program committee of CACM 93, we are pleased to inform you that your paper The Birth of Prolog has been accepted for inclusion in the post-conference proceedings. </pre> <br/><div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li><strong>Library usage:</strong><br/><tt>:- use_module(library(text_template)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="0" href="#eval_template_file/3"><tt>eval_template_file/3</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#eval_template_string/3"><tt>eval_template_string/3</tt></a>. </ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="eval_template_file/3" href="ciaosearch.html#eval_template_file/3">eval_template_file/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>eval_template_file(InFile,Subst,OutFile)</tt> </span><p>Like <a class="lpdoc-idx-anchor" id="2" href="#eval_template_string/3"><tt>eval_template_string/3</tt></a>, using files.</p><ul class="lpdoc-itemize-minus"></ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="eval_template_string/3" href="ciaosearch.html#eval_template_string/3">eval_template_string/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>eval_template_string(In,Subst,Out)</tt> </span><p>Evaluate the template string <span class="lpdoc-var">In</span> to generate <span class="lpdoc-var">Out</span> using the values in <span class="lpdoc-var">Subst</span>.</p><ul class="lpdoc-itemize-minus"></ul></div></div><p> </div><div id="Documentation on imports"><h2>Documentation on imports</h2>This module has the following direct dependencies:<ul class="lpdoc-itemize-minus"><li><em>System library modules:</em><br/><a class="lpdoc-idx-anchor" id="3" href="regexp_code.html"><tt>regexp_code</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="lists.html"><tt>lists</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="stream_utils.html"><tt>stream_utils</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="dict.html"><tt>dict</tt></a>. <li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="7" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="regtypes_doc.html"><tt>regtypes</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="isomodes_doc.html"><tt>isomodes</tt></a>, <a class="lpdoc-idx-anchor" id="14" href="ciaosearch.html#hiord"><tt>hiord</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="regexp_doc.html"><tt>regexp</tt></a>. </ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>