summaryrefslogtreecommitdiffabout
path: root/htdocs/quickref/metasyntax.chtml
Side-by-side diff
Diffstat (limited to 'htdocs/quickref/metasyntax.chtml') (more/less context) (show whitespace changes)
-rw-r--r--htdocs/quickref/metasyntax.chtml3
1 files changed, 2 insertions, 1 deletions
diff --git a/htdocs/quickref/metasyntax.chtml b/htdocs/quickref/metasyntax.chtml
index 4efc37c..67186f9 100644
--- a/htdocs/quickref/metasyntax.chtml
+++ b/htdocs/quickref/metasyntax.chtml
@@ -1,258 +1,259 @@
-% html(); return; /* vim:set ft=sitecing: */
+% /* vim:set ft=sitecing: */
%%derive layout = "/ancestry/layout.chtml";
+%%pragma main=page
<%constructor>
PN_PREV("/quickref/","quick reference","quick reference");
PN_NEXT("/sources","sources","source browser");
</%constructor>
<%codemethod string title() %>
return "meta syntax quick reference";
</%codemethod>
<%method void content() %>
<h1>site-C-ing meta syntax quick reference</h1>
<h2>Table of Contents</h2>
<ul class="quickref toc">
<li><a href="#qr__line">% ...</a></li>
<li><a href="#qr__inline">&lt;% ... %&gt;</a></li>
<li><a href="#qr__code">&lt;%code&gt;</a></li>
<li><a href="#qr__codemethod">&lt;%codemethod ... &gt;</a></li>
<li><a href="#qr__constructor">&lt;%constructor&gt;</a></li>
<li><a href="#qr__decl">&lt;%decl&gt;</a></li>
<li><a href="#qr___decl">%%decl</a></li>
<li><a href="#qr___derive">%%derive</a></li>
<li><a href="#qr__destructor">&lt;%destructor&gt;</a></li>
<li><a href="#qr__impl">&lt;%impl&gt;</a></li>
<li><a href="#qr___impl">%%impl</a></li>
<li><a href="#qr__method">&lt;%method ... &gt;</a></li>
<li><a href="#qr__output">&lt;%output&gt;</a></li>
<li><a href="#qr___pragma">%%pragma</a></li>
<li><a href="#qr___var">%%var</a></li>
</ul>
<dl class="metasyntax quickref">
% /* % */
<dt>
<a id="qr__line" name="qr__line" title="line of code">
<code>% <kbd>line of code</kbd></code>
</a>
</dt>
<dd>
<p>
Break out into the code mode for just one line.
</p>
<blockquote class="qr_sample">
<div>
&nbsp;&lt;body&gt;<br/>
&nbsp;&nbsp;Here is the way we count.&lt;br/&gt;<br/>
<em><a href="#qr__line" title="% description">%</a> for(int t=0;t&lt;10;t++) {<br/></em>
&nbsp;&nbsp;&nbsp;Just saying out loud: <a href="#qr__inline" title="&lt;% ... %&gt; description">&lt;%</a> t <a href="#qr__inline" title="&lt;% ... %&gt; description">%&gt;</a>&lt;br/&gt;<br/>
<em><a href="#qr__line" title="% description">%</a> }<br/></em>
&nbsp;&lt;/body&gt;
</div>
</blockquote>
</dd>
% /* <% %> */
<dt>
<a id="qr__inline" name="qr__inline" title="output expression">
<code>&lt;% <kbd>expression</kbd> %&gt;</code>
</a>
</dt>
<dd>
<p>
&lt;&lt; <kbd>expression</kbd> into output stream (think c++).
</p>
<blockquote class="qr_sample">
<div>
&nbsp;&nbsp;Here is the way we count.&lt;br/&gt;<br/>
<a href="#qr__line" title="% description">%</a> for(int t=0;t&lt;10;t++) {<br/>
<em>&nbsp;&nbsp;&nbsp;Just saying out loud: <a href="#qr__inline" title="&lt;% ... %&gt; description">&lt;%</a> t <a href="#qr__inline" title="&lt;% ... %&gt; description">%&gt;</a>&lt;br/&gt;<br/></em>
<a href="#qr__line" title="% description">%</a> }
</div>
</blockquote>
</dd>
% /* %code */
<dt>
<a id="qr__code" name="qr__code" title="switching to code mode">
<code>
&lt;%code&gt; <kbd>...</kbd> &lt;/%code&gt;
</code>
</a>
</dt>
<dd>
<p>
Escape from the output mode to code mode. Opposite to <code><a href="#qr__output" title="&lt;%output&gt; description">&lt;%output&gt;</a></code>. Roughly the same as <code><a href="#qr__output" title="&lt;%output&gt; description">&lt;/%output&gt;</a> <kbd>...</kbd> <a href="#qr__output" title="&lt;%output&gt; description">&lt;%output&gt;</a></code> (note the reverse order), but more self-explanatory and applies to more cases.
</p>
<blockquote class="qr_sample">
<div>
&lt;body&gt;<br/>
<em>&nbsp;<a href="#qr__code" title="&lt;%code&gt; descrption">&lt;%code&gt;</a><br/></em>
&nbsp;&nbsp;for(int t=0;t&lt;10;t++) {<br/>
&nbsp;&nbsp;&nbsp;<a href="#qr__output" title="&lt;%output&gt; descrption">&lt;%output&gt;</a><br/>
&nbsp;&nbsp;&nbsp;&nbsp;Here is the way we count.&lt;br/&gt;<br/>
&nbsp;&nbsp;&nbsp;&nbsp;Just saying out loud: <a href="#qr__inline" title="&lt;% ... %&gt; description">&lt;%</a> t <a href="#qr__inline" title="&lt;% ... %&gt; description">%&gt;</a>&lt;br/&gt;<br/>
&nbsp;&nbsp;&nbsp;<a href="#qr__output" title="&lt;%output&gt; descrption">&lt;/%output&gt;</a><br/>
<em>&nbsp;<a href="#qr__code" title="&lt;%code&gt; descrption">&lt;/%code&gt;</a><br/></em>
&lt;/body&gt;
</div>
</blockquote>
</dd>
% /* %codemethod */
<dt>
<a id="qr__codemethod" name="qr__codemethod" title="member function definition">
<code>
&lt;%codemethod <kbd>return_type_t</kbd> <kbd>member_name</kbd>(<kbd>args,...</kbd>) %&gt;<br/>
&nbsp;<kbd>code</kbd><br/>
&lt;/%codemethod&gt;
</code>
</a>
</dt>
<dd>
<p>
Define the member function. Essentially equivalent to <code><a href="#qr__method" title="&lt;%method ... %&gt; description" class="internal">&lt;%method</a> <kbd>...</kbd> <a href="#qr__method" title="&lt;%method ... %&gt; description" class="internal">%&gt;</a><a href="#qr__code" title="&lt;%code&gt; description" class="internal">&lt;%code&gt;</a> <kbd>...</kbd> <a href="#qr__code" title="&lt;%code&gt; description" class="internal">&lt;/%code&gt;</a><a href="#qr__method" title="&lt;%method ... %&gt; description" class="internal">&lt;/%method&gt;</a></code>.
</p>
<blockquote class="qr_sample">
<div>
<em><a href="#qr__codemethod" title="&lt;%codemethod ... %&gt; description">&lt;%codemethod</a> std::string ua() <a href="#qr__codemethod" title="&lt;%codemethod ... %&gt; description">%&gt;</a><br/>
&nbsp;return __CGI-&gt;get_meta("USER_AGENT");<br/>
<a href="#qr__codemethod" title="&lt;%codemethod ... %&gt; description">&lt;/%codemethod&gt;</a><br/></em>
The user agent is: <a href="#qr__inline" title="&lt;% ... %&gt; description">&lt;%</a> ua() <a href="#qr__inline" title="&lt;% ... %&gt; description">%&gt;</a><br/>
</div>
</blockquote>
</dd>
% /* %constructor */
<dt>
<a id="qr__constructor" name="qr__constructor" title="constructor code">
<code>
&lt;%constructor&gt;<br/>
&nbsp;<kbd>code</kbd><br/>
&lt;/%constructor&gt;
</code>
</a>
</dt>
<dd>
<p>
Provide the code for constructor.
</p>
<blockquote class="qr_sample">
<div>
<a href="#qr___var" title="%%var description">%%var</a> bool is_msie;<br/>
<em><a href="#qr__constructor" title="&lt;%constructor&gt; description">&lt;%constructor&gt;</a><br/>
&nbsp;is_msie = (__CGI-&gt;get_meta("USER_AGENT").find("MSIE")!=string::npos);<br/>
<a href="#qr__constructor" title="&lt;%constructor&gt; description">&lt;/%constructor&gt;</a><br/></em>
</div>
</blockquote>
</dd>
% /* %decl / %%decl */
<dt>
<a id="qr___decl" name="qr___decl" title="verbatim declaration">
<code>%%decl <kbd>line of code</kbd></code>
</a>
</dt>
<dt>
<a id="qr__decl" name="qr__decl" title="verbatim declaration">
<code>
&lt;%decl&gt;<br/>
&nbsp;<kbd>lines of code</kbd><br/>
&lt;/%decl&gt;
</code>
</a>
</dt>
<dd>
<p>
Put the line(s) of code into the resulting <em>.h</em> file before the
class declaration.
</p>
<blockquote class="qr_sample">
<div>
<em><a href="#qr___decl" title="%%decl description">%%decl</a> #include &lt;string&gt;<br/></em>
<a href="#qr___var" title="%%var description">%%var</a> std::string str = "default"<br/>
<em><a href="#qr__decl" title="&lt;%decl&gt; description">&lt;%decl&gt;</a><br/>
&nbsp;typedef int integer_t;<br/>
<a href="#qr__decl" title="&lt;%decl&gt; description">&lt;/%decl&gt;</a><br/></em>
<a href="#qr__method" title="&lt;%method ... %&gt; description">&lt;%method</a> void do_nothing(integer_t input) <a href="#qr__method" title="&lt;%method ... %&gt; description">%&gt;</a><br/>
&nbsp;nothing is done<br/>
<a href="#qr__method" title="&lt;%method ... %&gt; description">&lt;/%method&gt;</a>
</div>
</blockquote>
</dd>
% /* %%derive */
<dt>
<a id="qr___derive" name="qr___derive" title="base class(es) specification">
<code>%%derive <kbd>name</kbd> = "<kbd>base-component</kbd>";</code>
</a>
</dt>
<dd>
<p>
Inherit what is there to be inherited from the base component specified.
</p>
<blockquote class="qr_sample">
<div>
<em><a href="#qr___derive" title="%%derive description">%%derive</a> pagelayout = "/ancestry/page_layout.chtml";<br/></em>
<a href="#qr__line" title="% description">%</a> pagelayout::member_function();
</div>
</blockquote>
</dd>
% /* %destructor */
<dt>
<a id="qr__destructor" name="qr__destructor" title="destructor code">
<code>
&lt;%destructor&gt;<br/>
&nbsp;<kbd>code</kbd><br/>
&lt;/%destructor&gt;
</code>
</a>
</dt>
<dd>
<p>
Provide the code for destructor.
</p>
<blockquote class="qr_sample">
<div>
<a href="#qr___var" title="%%var description">%%var</a> type_t *tmp = 0;<br/>
<a href="#qr__constructor" title="&lt;%constructor&gt; description">&lt;%constructor&gt;</a><br/>
&nbsp;tmp = new type_t(type_t::option_1);<br/>
<a href="#qr__constructor" title="&lt;%constructor&gt; description">&lt;/%constructor&gt;</a><br/>
<em><a href="#qr__destructor" title="&lt;%destructor&gt; description">&lt;%destructor&gt;</a><br/>
&nbsp;delete tmp;<br/>
<a href="#qr__destructor" title="&lt;%destructor&gt; description">&lt;/%destructor&gt;</a><br/></em>
</div>
</blockquote>
</dd>
% /* %impl / %%impl */
<dt>
<a id="qr___impl" name="qr__impl" title="verbatim definition">
<code>%%impl <kbd>line of code</kbd></code>
</a>
</dt>
<dt>
<a id="qr__impl" name="qr__impl" title="verbatim definition">
<code>
&lt;%impl&gt;<br/>
&nbsp;<kbd>lines of code</kbd><br/>
&lt;/%impl&gt;
</code>
</a>
</dt>
<dd>
<p>
Put the line(s) of code into the resulting <em>.cc</em> implementation file
before any members definitions.
</p>
<blockquote class="qr_sample">
<div>
<em><a href="#qr___impl" title="%%impl description">%%impl</a> #include &lt;string.h&gt;<br/></em>
<a href="#qr__method" title="&lt;%method ... %gt; description">&lt;%method</a> void output_if_contains(const char *haystack,const char *needle) <a href="#qr__method" title="&lt;%method ... %gt; description">%&gt;</a><br/>
<a href="#qr__line" title="% description">%</a> if(strstr(haystack,needle)) {<br/>
&nbsp;&nbsp;&nbsp;<a href="#qr__inline" title="&lt;% ... %&gt; description">&lt;%</a> haystack <a href="#qr__inline" title="&lt;% ... %&gt; description">%&gt;</a><br/>
<a href="#qr__line" title="% description">%</a> }<br/>
<a href="#qr__method" title="&lt;%method ... %&gt; description">&lt;/%method&gt;</a><br/>