-rw-r--r-- | htdocs/ancestry/layout.chtml | 4 | ||||
-rw-r--r-- | htdocs/ancestry/sources.chtml | 4 | ||||
-rw-r--r-- | htdocs/examples/calendar.chtml | 1 | ||||
-rw-r--r-- | htdocs/index.chtml | 8 | ||||
-rw-r--r-- | htdocs/quickref/index.chtml | 3 | ||||
-rw-r--r-- | htdocs/quickref/metasyntax.chtml | 193 | ||||
-rw-r--r-- | htdocs/style.css | 8 |
7 files changed, 131 insertions, 90 deletions
diff --git a/htdocs/ancestry/layout.chtml b/htdocs/ancestry/layout.chtml index df34ad7..4551d04 100644 --- a/htdocs/ancestry/layout.chtml +++ b/htdocs/ancestry/layout.chtml @@ -22,10 +22,10 @@ % if(descPrev.empty() && descNext.empty()) return; <div class="prevnext"> % if(!(urlPrev.empty() || descPrev.empty())) { - <a class="prevnext-prev" href="<% urlPrev %>" title="<% sitecing::html_escape(titlePrev.empty()?descPrev:titlePrev) %>"><% sitecing::html_escape(descPrev) %></a> + <a class="prevnext-prev" href="<% urlPrev %>" title="<% sitecing::html_escape(titlePrev.empty()?descPrev:titlePrev) %>">◄ <% sitecing::html_escape(descPrev) %></a> % } % if(!(urlNext.empty() || descNext.empty())) { - <a class="prevnext-next" href="<% urlNext %>" title="<% sitecing::html_escape(titleNext.empty()?descNext:titleNext) %>"><% sitecing::html_escape(descNext) %></a> + <a class="prevnext-next" href="<% urlNext %>" title="<% sitecing::html_escape(titleNext.empty()?descNext:titleNext) %>"><% sitecing::html_escape(descNext) %> ►</a> % } </div> </%method> diff --git a/htdocs/ancestry/sources.chtml b/htdocs/ancestry/sources.chtml index 35ced64..1d9fcc9 100644 --- a/htdocs/ancestry/sources.chtml +++ b/htdocs/ancestry/sources.chtml @@ -60,6 +60,10 @@ { "htdocs/exceptions/production", "erroneous.h", "the file to include for more errors" }, { "htdocs/exceptions/production", "compile.html", "compile-time exception handler output" }, { 0,0,0 }, + { "htdocs/quickref", 0, "reference documentation" }, + { "htdocs/quickref", "index.chtml", "the overview" }, + { "htdocs/quickref", "metasyntax.chtml", "component meta syntax quick reference" }, + { 0,0,0 }, { 0,0,0 }, { "htdocs/handlers", 0, "exception handlers" }, { "htdocs/handlers", ".htaccess", "apache access-control file" }, diff --git a/htdocs/examples/calendar.chtml b/htdocs/examples/calendar.chtml index eea20cb..85aa7ba 100644 --- a/htdocs/examples/calendar.chtml +++ b/htdocs/examples/calendar.chtml @@ -4,6 +4,7 @@ #include <konforka/exception.h> </%impl> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +% __SCIF->flush(); <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <head> <title>really simple page</title> diff --git a/htdocs/index.chtml b/htdocs/index.chtml index e8cedda..20d34c2 100644 --- a/htdocs/index.chtml +++ b/htdocs/index.chtml @@ -33,9 +33,11 @@ get it working with apache 1.3.x, although I haven't tried and so I am not sure if it will run out of the box (your patches are <a href="mailto:sitecing-patches@klever.net">welcome</a>). Also note that you - will need <a href="http://fastcgi.com/">mod_fastcgi</a> apache module, which - is the only CGI-interface supported by the <em>site-C-ing</em> engine at the - moment. + may need <a href="http://fastcgi.com/">mod_fastcgi</a> apache module, + although now that fastcgi is not the only supported interface you may get the + thing running with 'plain' CGI with a bit of tweaking. Again, if you got it + working without breaking the fastcgi part your patches are <a + href="mailto:sitecing-patches@klever.net">welcome</a>. </p> <p> Once you get it all done you will want to restart your apache and start the diff --git a/htdocs/quickref/index.chtml b/htdocs/quickref/index.chtml index 20ef217..d139190 100644 --- a/htdocs/quickref/index.chtml +++ b/htdocs/quickref/index.chtml @@ -11,6 +11,7 @@ <h1>site-C-ing quick reference</h1> <p> I am hoping to put together some quick reference documentation here. For now, - I am adding the component meta-syntax quick reference. + I am adding the <a href="/quickref/metasyntax">component meta-syntax quick + reference</a>. </p> </%method> diff --git a/htdocs/quickref/metasyntax.chtml b/htdocs/quickref/metasyntax.chtml index a63f596..4efc37c 100644 --- a/htdocs/quickref/metasyntax.chtml +++ b/htdocs/quickref/metasyntax.chtml @@ -43,12 +43,14 @@ Break out into the code mode for just one line. </p> <blockquote class="qr_sample"> - <body><br/> - <em><a href="#qr__line" title="% description">%</a> for(int t=0;t<10;t++) {<br/></em> - Here is the way we count.<br/><br/> - Just saying out loud: <a href="#qr__inline" title="<% ... %> description"><%</a> t <a href="#qr__inline" title="<% ... %> description">%></a><br/><br/> - <em><a href="#qr__line" title="% description">%</a> }<br/></em> - </body> + <div> + <body><br/> + Here is the way we count.<br/><br/> + <em><a href="#qr__line" title="% description">%</a> for(int t=0;t<10;t++) {<br/></em> + Just saying out loud: <a href="#qr__inline" title="<% ... %> description"><%</a> t <a href="#qr__inline" title="<% ... %> description">%></a><br/><br/> + <em><a href="#qr__line" title="% description">%</a> }<br/></em> + </body> + </div> </blockquote> </dd> @@ -63,10 +65,12 @@ << <kbd>expression</kbd> into output stream (think c++). </p> <blockquote class="qr_sample"> - <a href="#qr__line" title="% description">%</a> for(int t=0;t<10;t++) {<br/> - Here is the way we count.<br/><br/> - <em> Just saying out loud: <a href="#qr__inline" title="<% ... %> description"><%</a> t <a href="#qr__inline" title="<% ... %> description">%></a><br/><br/></em> - <a href="#qr__line" title="% description">%</a> } + <div> + Here is the way we count.<br/><br/> + <a href="#qr__line" title="% description">%</a> for(int t=0;t<10;t++) {<br/> + <em> Just saying out loud: <a href="#qr__inline" title="<% ... %> description"><%</a> t <a href="#qr__inline" title="<% ... %> description">%></a><br/><br/></em> + <a href="#qr__line" title="% description">%</a> } + </div> </blockquote> </dd> @@ -79,18 +83,21 @@ </a> </dt> <dd> - Escape from the output mode to code mode. Opposite to <code><a href="#qr__output" title="<%output> description"><%output></a></code>. Roughly the same as <code><a href="#qr__output" title="<%output> description"></%output></a> <kbd>...</kbd> <a href="#qr__output" title="<%output> description"><%output></a></code> (note the reverse order), but more self-explanatory and applies to more cases. + <p> + Escape from the output mode to code mode. Opposite to <code><a href="#qr__output" title="<%output> description"><%output></a></code>. Roughly the same as <code><a href="#qr__output" title="<%output> description"></%output></a> <kbd>...</kbd> <a href="#qr__output" title="<%output> description"><%output></a></code> (note the reverse order), but more self-explanatory and applies to more cases. </p> <blockquote class="qr_sample"> - <body><br/> - <em> <a href="#qr__code" title="<%code> descrption"><%code></a><br/></em> - for(int t=0;t<10;t++) {<br/> - <a href="#qr__output" title="<%output> descrption"><%output></a><br/> - Here is the way we count.<br/><br/> - Just saying out loud: <a href="#qr__inline" title="<% ... %> description"><%</a> t <a href="#qr__inline" title="<% ... %> description">%></a><br/><br/> - <a href="#qr__output" title="<%output> descrption"></%output></a><br/> - <em> <a href="#qr__code" title="<%code> descrption"></%code></a><br/></em> - </body> + <div> + <body><br/> + <em> <a href="#qr__code" title="<%code> descrption"><%code></a><br/></em> + for(int t=0;t<10;t++) {<br/> + <a href="#qr__output" title="<%output> descrption"><%output></a><br/> + Here is the way we count.<br/><br/> + Just saying out loud: <a href="#qr__inline" title="<% ... %> description"><%</a> t <a href="#qr__inline" title="<% ... %> description">%></a><br/><br/> + <a href="#qr__output" title="<%output> descrption"></%output></a><br/> + <em> <a href="#qr__code" title="<%code> descrption"></%code></a><br/></em> + </body> + </div> </blockquote> </dd> @@ -109,10 +116,12 @@ Define the member function. Essentially equivalent to <code><a href="#qr__method" title="<%method ... %> description" class="internal"><%method</a> <kbd>...</kbd> <a href="#qr__method" title="<%method ... %> description" class="internal">%></a><a href="#qr__code" title="<%code> description" class="internal"><%code></a> <kbd>...</kbd> <a href="#qr__code" title="<%code> description" class="internal"></%code></a><a href="#qr__method" title="<%method ... %> description" class="internal"></%method></a></code>. </p> <blockquote class="qr_sample"> - <em><a href="#qr__codemethod" title="<%codemethod ... %> description"><%codemethod</a> std::string ua() <a href="#qr__codemethod" title="<%codemethod ... %> description">%></a><br/> - return __CGI->get_meta("USER_AGENT");<br/> - <a href="#qr__codemethod" title="<%codemethod ... %> description"></%codemethod></a><br/></em> - The user agent is: <a href="#qr__inline" title="<% ... %> description"><%</a> ua() <a href="#qr__inline" title="<% ... %> description">%></a><br/> + <div> + <em><a href="#qr__codemethod" title="<%codemethod ... %> description"><%codemethod</a> std::string ua() <a href="#qr__codemethod" title="<%codemethod ... %> description">%></a><br/> + return __CGI->get_meta("USER_AGENT");<br/> + <a href="#qr__codemethod" title="<%codemethod ... %> description"></%codemethod></a><br/></em> + The user agent is: <a href="#qr__inline" title="<% ... %> description"><%</a> ua() <a href="#qr__inline" title="<% ... %> description">%></a><br/> + </div> </blockquote> </dd> @@ -131,10 +140,12 @@ Provide the code for constructor. </p> <blockquote class="qr_sample"> - <a href="#qr___var" title="%%var description">%%var</a> bool is_msie;<br/> - <em><a href="#qr__constructor" title="<%constructor> description"><%constructor></a><br/> - is_msie = (__CGI->get_meta("USER_AGENT").find("MSIE")!=string::npos);<br/> - <a href="#qr__constructor" title="<%constructor> description"></%constructor></a><br/></em> + <div> + <a href="#qr___var" title="%%var description">%%var</a> bool is_msie;<br/> + <em><a href="#qr__constructor" title="<%constructor> description"><%constructor></a><br/> + is_msie = (__CGI->get_meta("USER_AGENT").find("MSIE")!=string::npos);<br/> + <a href="#qr__constructor" title="<%constructor> description"></%constructor></a><br/></em> + </div> </blockquote> </dd> @@ -159,14 +170,16 @@ class declaration. </p> <blockquote class="qr_sample"> - <em><a href="#qr___decl" title="%%decl description">%%decl</a> #include <string><br/></em> - <a href="#qr___var" title="%%var description">%%var</a> std::string str = "default"<br/> - <em><a href="#qr__decl" title="<%decl> description"><%decl></a><br/> - typedef int integer_t;<br/> - <a href="#qr__decl" title="<%decl> description"></%decl></a><br/></em> - <a href="#qr__method" title="<%method ... %> description"><%method</a> void do_nothing(integer_t input) <a href="#qr__method" title="<%method ... %> description">%></a><br/> - nothing is done<br/> - <a href="#qr__method" title="<%method ... %> description"></%method></a> + <div> + <em><a href="#qr___decl" title="%%decl description">%%decl</a> #include <string><br/></em> + <a href="#qr___var" title="%%var description">%%var</a> std::string str = "default"<br/> + <em><a href="#qr__decl" title="<%decl> description"><%decl></a><br/> + typedef int integer_t;<br/> + <a href="#qr__decl" title="<%decl> description"></%decl></a><br/></em> + <a href="#qr__method" title="<%method ... %> description"><%method</a> void do_nothing(integer_t input) <a href="#qr__method" title="<%method ... %> description">%></a><br/> + nothing is done<br/> + <a href="#qr__method" title="<%method ... %> description"></%method></a> + </div> </blockquote> </dd> @@ -181,8 +194,10 @@ Inherit what is there to be inherited from the base component specified. </p> <blockquote class="qr_sample"> - <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> + <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> @@ -201,13 +216,15 @@ Provide the code for destructor. </p> <blockquote class="qr_sample"> - <a href="#qr___var" title="%%var description">%%var</a> type_t *tmp = 0;<br/> - <a href="#qr__constructor" title="<%constructor> description"><%constructor></a><br/> - tmp = new type_t(type_t::option_1);<br/> - <a href="#qr__constructor" title="<%constructor> description"></%constructor></a><br/> - <em><a href="#qr__destructor" title="<%destructor> description"><%destructor></a><br/> - delete tmp;<br/> - <a href="#qr__destructor" title="<%destructor> description"></%destructor></a><br/></em> + <div> + <a href="#qr___var" title="%%var description">%%var</a> type_t *tmp = 0;<br/> + <a href="#qr__constructor" title="<%constructor> description"><%constructor></a><br/> + tmp = new type_t(type_t::option_1);<br/> + <a href="#qr__constructor" title="<%constructor> description"></%constructor></a><br/> + <em><a href="#qr__destructor" title="<%destructor> description"><%destructor></a><br/> + delete tmp;<br/> + <a href="#qr__destructor" title="<%destructor> description"></%destructor></a><br/></em> + </div> </blockquote> </dd> @@ -232,25 +249,27 @@ before any members definitions. </p> <blockquote class="qr_sample"> - <em><a href"#qr___impl" title="%%impl description">%%impl</a> #include <string.h><br/></em> - <a href="#qr__method" title="<%method ... %gt; description"><%method</a> void output_if_contains(const char *haystack,const char *needle) <a href="#qr__method" title="<%method ... %gt; description">%></a><br/> - <a href="#qr__line" title="% description">%</a> if(strstr(haystack,needle)) {<br/> - <a href="#qr__inline" title="<% ... %> description"><%</a> haystack <a href="#qr__inline" title="<% ... %> description">%></a><br/> - <a href="#qr__line" title="% description">%</a> }<br/> - <a href="#qr__method" title="<%method ... %> description"></%method></a><br/> - <em><a href="#qr__impl" title="<%impl> description"><%impl></a><br/> - #include <konforka/exception.h> - static const char *tokens[] = {<br/> - "token 1", "token 2", "token 3"<br/> - };<br/> - <a href="#qr__impl" title="<%impl> description"></%impl></a><br/></em> - <a href="#qr__method" title="<%method ... %gt; description"><%method</a> void output_token(int toknum) <a href="#qr__method" title="<%method ... %gt; description">%></a><br/> - <a href="#qr__code" title="<%code> description"><%code></a><br/> - if(toknum<0 || toknum>=(sizeof(tokens)/sizeof(*tokens)))<br/> - throw konforka::exception(CODEPOINT,"out of bounds");<br/> - <a href="#qr__code" title="<%code> description"></%code></a><br/> - <a href="#qr__inline" title="<% ... %> description"><%</a> tokens[toknum] <a href="#qr__inline" title="<% ... %> description">%></a><br/> - <a href="#qr__method" title="<%method ... %> description"></%method></a><br/> + <div> + <em><a href="#qr___impl" title="%%impl description">%%impl</a> #include <string.h><br/></em> + <a href="#qr__method" title="<%method ... %gt; description"><%method</a> void output_if_contains(const char *haystack,const char *needle) <a href="#qr__method" title="<%method ... %gt; description">%></a><br/> + <a href="#qr__line" title="% description">%</a> if(strstr(haystack,needle)) {<br/> + <a href="#qr__inline" title="<% ... %> description"><%</a> haystack <a href="#qr__inline" title="<% ... %> description">%></a><br/> + <a href="#qr__line" title="% description">%</a> }<br/> + <a href="#qr__method" title="<%method ... %> description"></%method></a><br/> + <em><a href="#qr__impl" title="<%impl> description"><%impl></a><br/> + #include <konforka/exception.h> + static const char *tokens[] = {<br/> + "token 1", "token 2", "token 3"<br/> + };<br/> + <a href="#qr__impl" title="<%impl> description"></%impl></a><br/></em> + <a href="#qr__method" title="<%method ... %gt; description"><%method</a> void output_token(int toknum) <a href="#qr__method" title="<%method ... %gt; description">%></a><br/> + <a href="#qr__code" title="<%code> description"><%code></a><br/> + if(toknum<0 || toknum>=(sizeof(tokens)/sizeof(*tokens)))<br/> + throw konforka::exception(CODEPOINT,"out of bounds");<br/> + <a href="#qr__code" title="<%code> description"></%code></a><br/> + <a href="#qr__inline" title="<% ... %> description"><%</a> tokens[toknum] <a href="#qr__inline" title="<% ... %> description">%></a><br/> + <a href="#qr__method" title="<%method ... %> description"></%method></a><br/> + </div> </blockquote> </dd> @@ -269,10 +288,12 @@ Define the member function. Essentially equivalent to <code><a href="#qr__codemethod" title="<%codemethod ... %> description" class="internal"><%codemethod</a> <kbd>...</kbd> <a href="#qr__codemethod" title="<%codemethod ... %> description" class="internal">%></a><a href="#qr__output" title="<%output> description" class="internal"><%output></a> <kbd>...</kbd> <a href="#qr__output" title="<%output> description" class="internal"></%output></a><a href="#qr__codemethod" title="<%codemethod ... %> description" class="internal"></%codemethod></a></code>. </p> <blockquote class="qr_sample"> - <em><a href="#qr__method" title="<%method ... %> description"><%method</a> void emphasized(const char *t) <a href="#qr__method" title="<%method ... %> description">%></a><br/> - <em><a href="#qr__inline" title="<% ... %> description"><%</a> t <a href="#qr__inline" title="<% ... %> description">%></a></em><br/> - <a href="#qr__codemethod" title="<%codemethod ... %> description"></%method></a><br/></em> - <a href="#qr__line" title="% description">%</a> emphasized("emphasized text"); + <div> + <em><a href="#qr__method" title="<%method ... %> description"><%method</a> void emphasized(const char *t) <a href="#qr__method" title="<%method ... %> description">%></a><br/> + <em><a href="#qr__inline" title="<% ... %> description"><%</a> t <a href="#qr__inline" title="<% ... %> description">%></a></em><br/> + <a href="#qr__codemethod" title="<%codemethod ... %> description"></%method></a><br/></em> + <a href="#qr__line" title="% description">%</a> emphasized("emphasized text"); + </div> </blockquote> </dd> @@ -289,14 +310,16 @@ Escape from the code mode to output mode. Opposite to <code><a href="#qr__code" title="<%code> description"><%code></a></code>. Roughly the same as <code><a href="#qr__code" title="<%code> description"></%code></a> <kbd>...</kbd> <a href="#qr__code" title="<%code> description"><%code></a></code> (note the reverse order), but more self-explanatory and applies to more cases. </p> <blockquote class="qr_sample"> - <a href="#qr__codemethod" title="<%codemethod ... %> description"><%codemethod</a> void count() <a href="#qr__codemethod" title="<%codemethod ... > description">%></a><br/> - for(int t=0;t<10;t++) {<br/> - <em> <a href="#qr__output" title="<%output> descrption"><%output></a><br/> - Here is the way we count.<br/><br/> - Just saying out loud: <a href="#qr__inline" title="<% ... %> description"><%</a> t <a href="#qr__inline" title="<% ... %> description">%></a><br/><br/> - <a href="#qr__output" title="<%output> descrption"></%output></a><br/></em> - <a href="#qr__codemethod" title="</%codemethod ... %> description"></%codemethod></a><br/> - <a href="#qr__line" title="% description">%</a> count(); + <div> + <a href="#qr__codemethod" title="<%codemethod ... %> description"><%codemethod</a> void count() <a href="#qr__codemethod" title="<%codemethod ... > description">%></a><br/> + for(int t=0;t<10;t++) {<br/> + <em> <a href="#qr__output" title="<%output> descrption"><%output></a><br/> + Here is the way we count.<br/><br/> + Just saying out loud: <a href="#qr__inline" title="<% ... %> description"><%</a> t <a href="#qr__inline" title="<% ... %> description">%></a><br/><br/> + <a href="#qr__output" title="<%output> descrption"></%output></a><br/></em> + <a href="#qr__codemethod" title="</%codemethod ... %> description"></%codemethod></a><br/> + <a href="#qr__line" title="% description">%</a> count(); + </div> </blockquote> </dd> @@ -315,16 +338,18 @@ the 'main' member that would be generated for the component and call the <code>main</code> member of the named base class.</p> <blockquote class="qr_sample"> - <a href="#qr___derive" title="%%derive description">%%derive</a> pagelayout = "/ancestry/page_layout.chtml";<br/> - <em><a href="#qr___pragma" title="%%pragma description">%%pragma</a> main=pagelayout</em> + <div> + <a href="#qr___derive" title="%%derive description">%%derive</a> pagelayout = "/ancestry/page_layout.chtml";<br/> + <em><a href="#qr___pragma" title="%%pragma description">%%pragma</a> main=pagelayout</em> + </div> </blockquote> </dd> % /* %%var */ <dt> <a id="qr___var" name="qr___var" title="member variable declaration"> - <code>%%var <kbd>type_t</kbd> <kbd>varname</kbd>;<br/> - <code>%%var <kbd>type_t</kbd> <kbd>varname</kbd> = <kbd>initalizer</kbd>;<br/> + <code>%%var <kbd>type_t</kbd> <kbd>varname</kbd>;</code><br/> + <code>%%var <kbd>type_t</kbd> <kbd>varname</kbd> = <kbd>initalizer</kbd>;</code><br/> </a> </dt> <dd> @@ -334,9 +359,11 @@ part of the c++ constructor. </p> <blockquote class="qr_sample"> - <em><a href="#qr___var" title="%%var description">%%var</a> std::string strval = "default value";<br/> - <a href="#qr___var" title="%%var description">%%var</a> int usecount = 0;<br/> - <a href="#qr___var" title="%%var description">%%var</a> int whatnot;</em> + <div> + <em><a href="#qr___var" title="%%var description">%%var</a> std::string strval = "default value";<br/> + <a href="#qr___var" title="%%var description">%%var</a> int usecount = 0;<br/> + <a href="#qr___var" title="%%var description">%%var</a> int whatnot;</em> + </div> </blockquote> </dd> diff --git a/htdocs/style.css b/htdocs/style.css index 96e4c59..28aa8df 100644 --- a/htdocs/style.css +++ b/htdocs/style.css @@ -214,6 +214,7 @@ div.prevnext a:hover { background: gray; border: black 1px solid; color: white; + text-decoration: none; } ul.quickref.toc { @@ -224,6 +225,7 @@ ul.quickref.toc { dl.quickref { margin: 1ex 1em; + overflow: hidden; } dl.quickref dt { margin: 0.4ex; @@ -234,7 +236,8 @@ dl.quickref dt { dl.quickref dd { margin: 0px 0.4ex 0.4ex 10%; padding: 0px; - border: 1px solid grey; + border: 1px solid gray; + overflow: hidden; } dl.quickref code kbd { font-style: italic; @@ -245,6 +248,8 @@ dl.quickref blockquote { padding: 4px; border: dotted 1px gray; font-family: monospace; + font-size: 90%; + overflow: hidden; } dl.quickref blockquote em { display: block; @@ -253,4 +258,5 @@ dl.quickref blockquote em { font-weight: inherit !important; font-style: inherit !important; background: #ffc0c0; + overflow: hidden; } |