summaryrefslogtreecommitdiffabout
authorMichael Krelin <hacker@klever.net>2005-02-03 00:17:58 (UTC)
committer Michael Krelin <hacker@klever.net>2005-02-03 00:17:58 (UTC)
commitd379841850daab4693d596784b790b13e20e3a03 (patch) (side-by-side diff)
treeeafa246cd99308ea349aef90a708ef9f6d7a0418
parent870963df2dac72e433fd7f94cd1cccc8cd6ea2d0 (diff)
downloadsitecing-d379841850daab4693d596784b790b13e20e3a03.zip
sitecing-d379841850daab4693d596784b790b13e20e3a03.tar.gz
sitecing-d379841850daab4693d596784b790b13e20e3a03.tar.bz2
1. added a 'browse-through' navigation
2. improved performance by passing -flush to FastCgiExternalServer 3. emphasized links in text
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--conf/httpd.conf.in2
-rw-r--r--htdocs/ancestry/layout.chtml24
-rw-r--r--htdocs/exceptions/compile.chtml2
-rw-r--r--htdocs/exceptions/index.chtml4
-rw-r--r--htdocs/exceptions/preprocess.chtml2
-rw-r--r--htdocs/exceptions/runtime.chtml2
-rw-r--r--htdocs/index.chtml3
-rw-r--r--htdocs/simple.chtml2
-rw-r--r--htdocs/sources.chtml1
-rw-r--r--htdocs/style.css28
10 files changed, 69 insertions, 1 deletions
diff --git a/conf/httpd.conf.in b/conf/httpd.conf.in
index 5910620..2184627 100644
--- a/conf/httpd.conf.in
+++ b/conf/httpd.conf.in
@@ -1,29 +1,29 @@
-FastCgiExternalServer @web_run_root@/fastcgi-bin/site-c-ing -socket @web_run_root@/run/sitecing-socket
+FastCgiExternalServer @web_run_root@/fastcgi-bin/site-c-ing -socket @web_run_root@/run/sitecing-socket -flush
<VirtualHost *:80>
ServerName @v_hostname@
DocumentRoot @web_src_root@/htdocs
<Directory @web_src_root@/htdocs>
AllowOverride All
allow from all
</Directory>
<DirectoryMatch /.svn/>
deny from all
</DirectoryMatch>
<Files .*>
deny from all
</Files>
<Files Makefile*>
deny from all
</Files>
CustomLog @web_run_root@/logs/access.log combined
ErrorLog @web_run_root@/logs/error.log
LogLevel error
Alias /fastcgi-bin/ @web_run_root@/fastcgi-bin/
<Directory @web_run_root@/fastcgi-bin/>
allow from all
</Directory>
DefaultLanguage en
Action site-c-ing /fastcgi-bin/site-c-ing
AddHandler site-c-ing .chtml
DirectoryIndex index
</VirtualHost>
diff --git a/htdocs/ancestry/layout.chtml b/htdocs/ancestry/layout.chtml
index 6147d37..0c167bc 100644
--- a/htdocs/ancestry/layout.chtml
+++ b/htdocs/ancestry/layout.chtml
@@ -1,45 +1,69 @@
% html(); return; /* vim:set ft=sitecing: */
%%derive page = "/ancestry/page.chtml";
+<%decl>
+ #define PN_PREV(h,d,t) urlPrev=h; descPrev=d; titlePrev=t;
+ #define PN_NEXT(h,d,t) urlNext=h; descNext=d; titleNext=t;
+</%decl>
+%%impl #include <sitecing/util.h>
%%impl #include "acconfig.h"
%%var bool b_svn = false;
+%%var std::string urlPrev;
+%%var std::string descPrev;
+%%var std::string titlePrev;
+%%var std::string urlNext;
+%%var std::string descNext;
+%%var std::string titleNext;
<%constructor>
if(strstr(PACKAGE_STRING,"svn"))
b_svn = true;
</%constructor>
+<%method void prevnext() %>
+% if(urlPrev.empty() && urlNext.empty()) return;
+% 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>
+% }
+% if(!(urlNext.empty() || descNext.empty())) {
+ <a class="prevnext-next" href="<% urlNext %>" title="<% sitecing::html_escape(titleNext.empty()?descNext:titleNext) %>"><% sitecing::html_escape(descNext) %></a>
+% }
+ </div>
+</%method>
<%method void body() %>
<div id="content">
<%code>
if(!access(WEB_RUN_ROOT "/conf/banner_top",R_OK)) {
pass_file_through(WEB_RUN_ROOT "/conf/banner_top");
}
+ prevnext();
content();
if(b_strict && !access(WEB_RUN_ROOT "/conf/banner_bottom",R_OK)) {
pass_file_through(WEB_RUN_ROOT "/conf/banner_bottom");
}
</%code>
</div>
<div id="sidepanel">
% sidepanel();
</div>
</%method>
<%method void content() %>
</%method>
<%method void sidepanel() %>
<h1><% PACKAGE_STRING %></h1>
% if(b_svn) {
<h2>The site is running source from the source repository which may differ
from the one available for download. You can check it out from the <a
href="http://kin.klever.net/sitecing/repository">source repository</a>.</h2>
% }
% /* thank MSIE for this awful formatting */
<ul><li><a href="/" title="introduction to site-C-ing">overview</a><ul><li><a href="/simple" title="building a really simple page">simple page</a></li></ul></li><li><a href="/exceptions/" title="exceptions handling">exceptions</a><ul><li><a href="/exceptions/preprocess" title="preprocessor errors">preprocess</a></li><li><a href="/exceptions/compile" title="compiler errors">compile-time</a></li><li><a href="/exceptions/runtime" title="runtime exceptions">runtime</a></li></ul></li><li><a href="/sources" title="browse this site source files">sources</a></li></ul>
<%code>
if(!access(WEB_RUN_ROOT "/conf/banner_side",R_OK)) {
pass_file_through(WEB_RUN_ROOT "/conf/banner_side");
}
</%code>
<ul><li><a href="http://kin.klever.net/sitecing/" title="main site-C-ing page">site-C-ing</a></li><li><a href="http://kin.klever.net/sitecing/sources" title="site-C-ing download page">downloads</a></li></ul>
<div class="copyright">
&copy; <a href="http://www.klever.net/">Klever Group</a>
</div>
</%method>
diff --git a/htdocs/exceptions/compile.chtml b/htdocs/exceptions/compile.chtml
index aa4c8df..68dd034 100644
--- a/htdocs/exceptions/compile.chtml
+++ b/htdocs/exceptions/compile.chtml
@@ -1,50 +1,52 @@
% html(); return; /* vim:set ft=sitecing: */
%%derive layout = "/ancestry/layout.chtml";
<%constructor>
b_strict = false;
+ PN_PREV("/exceptions/preprocess","preprocess","preprocessing errors");
+ PN_NEXT("/exceptions/runtime","runtime","runtime exceptions");
</%constructor>
<%codemethod string title() %>
return "compile-time exceptions handling";
</%codemethod>
<%method void content() %>
<h1>site-C-ing compile-time exception handling</h1>
<p>
Similar to <a href="/exceptions/preprocess">preprocessing exceptions</a>
there is a wide range of errors you may put into your code which will pass
through preprocessor and will be caught later at the compile-time.
</p>
<p>
Once you complete writing your <a
href="/view/htdocs/exceptions/development/compile.chtml" target="insert"
title="the link opens in the frame below">erroneous code</a> and
<em>site-C-ing</em> is done preprocessing it, it will feed the preprocessed
code into c++ compiler which will refuse to compile the code like this. This
is where <a href="/view/htdocs/handlers/exception_dev" target="insert"
title="the link opens in the frame below">the exception handler</a>,
specified in <a href="/view/htdocs/exceptions/development/.scrc"
target="insert" title="the link opens in the frame below">the configuration
file</a>, takes over the process and gives you <a
href="/exceptions/development/compile" target="insert" title="the link opens
in the frame below">the report</a>. Like with any handler, you may wish to
set some <a href="/view/htdocs/handlers/exception_prod" target="insert"
title="the link opens in the frame below">different handler</a> in your <a
href="/view/htdocs/exceptions/production/.scrc" target="insert" title="the
link opens in the frame below">production configuration</a>, which just gives
user <a href="/exceptions/production/preprocess" target="insert" title="the
link opens in the frame below">a friendly yet lame excuse</a>.
</p>
<p class="note">
Note, that these output pages are fakes -- I do not want to spawn the
compiler each time you want to see the output and put this unnecessary load
on cpu. These static pages are in fact saved output of the real exception
handlers.
</p>
<div class="insert">
<iframe id="insert" name="insert" src="about:blank" width="95%" height="300">
<p>I wanted to put an &lt;iframe&gt; here, but your browser does not seem to
support it. That is okay, it still will open links somehow.</p>
</iframe>
</div>
</%method>
diff --git a/htdocs/exceptions/index.chtml b/htdocs/exceptions/index.chtml
index cc0ed8a..e66620a 100644
--- a/htdocs/exceptions/index.chtml
+++ b/htdocs/exceptions/index.chtml
@@ -1,50 +1,54 @@
% html(); return; /* vim:set ft=sitecing: */
%%derive layout = "/ancestry/layout.chtml";
+<%constructor>
+ PN_PREV("/simple","simple page","building a really simple page");
+ PN_NEXT("/exceptions/preprocess","preprocess","preprocessing errors");
+</%constructor>
<%codemethod string title() %>
return "exceptions handling";
</%codemethod>
<%method void content() %>
<h1>site-C-ing exception handling</h1>
<p>
The purpose of this section is to give an overview of the <em>site-C-ing</em>
exception handling mechanism. Before the web visitor can see the page each
site-C-ing component goes through a few stages, namely, preprocessing,
compiling and execution. Having three stages to go through also means the
stages one can fail to go through and three exciting opportunities to handle
different errors.
</p>
<p>
First each component is preprocessed so that you can feed the valid c++ code
to the compiler. Here is where the preprocessor can choke at your broken
source code. Once preprocessor failes to parse your code it will throw an
exception which <em>site-C-ing</em> will catch and pass to <a
href="/sources/htdocs/handlers/exception_dev" title="development mode
exception handler source">the exception handler component</a>. Want to <a
href="/exceptions/preprocess">read more</a> about preprocessor exception
handling?
</p>
<p>
After the preprocessing stage is over we have a great opportunity to catch
the compile-time errors. After <em>site-C-ing</em> fails to compile the
component it throws another exception and passes it to the same handler which
may show you some information on what's gone wrong with your source code from
the compiler's perspective. If you've gone this far you definitely want to <a
href="/exceptions/compile">read more</a> about the compiler error handling.
</p>
<p class="note">
Note, that it is likely that you will want to disable the steps above for the
production environment to save time on unnecessary checking whether the
component is up to date.
</p>
<p>
Finally, we need to execute the component and present its output to the web
site visitor. This is also where things may go wrong and here is where your
component may throw an exception for the engine to catch and pass to the
handler. Feel free to <a href="/exceptions/runtime">learn more</a> about it
as well.
</p>
<p class="note">
One more thing you will likely want to have differently in production
environment is <a href="/sources/htdocs/handlers/exception_prod"
title="production mode exception handler source">an exception handler</a>
which will not give out that much unnecessary information to the user.
diff --git a/htdocs/exceptions/preprocess.chtml b/htdocs/exceptions/preprocess.chtml
index 8516139..88b8741 100644
--- a/htdocs/exceptions/preprocess.chtml
+++ b/htdocs/exceptions/preprocess.chtml
@@ -1,46 +1,48 @@
% html(); return; /* vim:set ft=sitecing: */
%%derive layout = "/ancestry/layout.chtml";
<%constructor>
b_strict = false;
+ PN_PREV("/exceptions","exceptions","exception handling overview");
+ PN_NEXT("/exceptions/compile","compile-time","compile-time errors");
</%constructor>
<%codemethod string title() %>
return "preprocessor exceptions handling";
</%codemethod>
<%method void content() %>
<h1>site-C-ing preprocessor exception handling</h1>
<p>
It was one of those days when you just can't type right and can't think of
what you're typing. It is not unusual that, under such circumstances, you end
up with a code like <a
href="/view/htdocs/exceptions/development/preprocess.chtml" target="insert"
title="the link opens in the frame below">this</a> -- by the time you were
about to close your <code>&lt;%code&gt;</code> block you were thinking about
some constructor in some component elsewhere in the universe.
</p>
<p>
<em>site-C-ing</em> parser will see the inconsistency and throw an exception
which will be caught and passed to <a
href="/view/htdocs/handlers/exception_dev" target="insert" title="the link
opens in the frame below">the handler</a>, specified in <a
href="/view/htdocs/exceptions/development/.scrc" target="insert" title="the
link opens in the frame below">the configuration file</a>, which will produce
some nice, human-readable <a href="/exceptions/development/preprocess"
target="insert" title="the link opens in the frame below">output</a>. Well,
you may not wish to give out all this information in the production
environment, so you just put in your <a
href="/view/htdocs/exceptions/production/.scrc" target="insert" title="the
link opens in the frame below">configuration file</a> some <a
href="/view/htdocs/handlers/exception_prod" target="insert" title="the link
opens in the frame below">different handler</a>, which just gives user <a
href="/exceptions/production/preprocess" target="insert" title="the link
opens in the frame below">a friendly yet lame excuse</a>.
</p>
<div class="insert">
<iframe id="insert" name="insert" src="about:blank" width="95%" height="300">
<p>I wanted to put an &lt;iframe&gt; here, but your browser does not seem to
support it. That is okay, it still will open links somehow.</p>
</iframe>
</div>
</%method>
diff --git a/htdocs/exceptions/runtime.chtml b/htdocs/exceptions/runtime.chtml
index d0a8e14..9a72afd 100644
--- a/htdocs/exceptions/runtime.chtml
+++ b/htdocs/exceptions/runtime.chtml
@@ -1,47 +1,49 @@
% html(); return; /* vim:set ft=sitecing: */
%%derive layout = "/ancestry/layout.chtml";
<%constructor>
b_strict = false;
+ PN_PREV("/exceptions/compile","compile-time","compile-time errors");
+ PN_NEXT("/sources","sources","source browser");
</%constructor>
<%codemethod string title() %>
return "runtime exceptions handling";
</%codemethod>
<%method void content() %>
<h1>site-C-ing runtime exception handling</h1>
<p>
The component may throw an exception while executing and the
<em>site-C-ing</em> will gladly pass it to the handler component which will
give the user appropriate output (unless it throws an exception itself, of
course). Here you will see an example output provided by the handler bundled
with the <em>site-C-ing</em>.
</p>
<p>
Suppose you have <a href="/view/htdocs/exceptions/development/runtime.chtml"
target="insert" title="the link opens in the frame below">a component</a>,
which at some point throws an exception. Of course, <em>site-C-ing</em> will
catch the exception and pass it to <a
href="/view/htdocs/handlers/exception_dev" target="insert" title="the link
opens in the frame below">the handler</a>, specified in <a
href="/view/htdocs/exceptions/development/.scrc" target="insert" title="the
link opens in the frame below">the configuration file</a>, which will produce
some nice, human-readable <a href="/exceptions/development/runtime"
target="insert" title="the link opens in the frame below">output</a>. Well,
you may not wish to give out all this information in the production
environment, so you just put in your <a
href="/view/htdocs/exceptions/production/.scrc" target="insert" title="the
link opens in the frame below">configuration file</a> some <a
href="/view/htdocs/handlers/exception_prod" target="insert" title="the link
opens in the frame below">different handler</a>, which just gives user <a
href="/exceptions/production/runtime" target="insert" title="the link opens
in the frame below">a friendly yet lame excuse</a>.
</p>
<div class="insert">
<iframe id="insert" name="insert" src="about:blank" width="95%" height="300">
<p>I wanted to put an &lt;iframe&gt; here, but your browser does not seem to
support it. That is okay, it still will open links somehow.</p>
</iframe>
</div>
</%method>
diff --git a/htdocs/index.chtml b/htdocs/index.chtml
index aa0979a..e8cedda 100644
--- a/htdocs/index.chtml
+++ b/htdocs/index.chtml
@@ -1,46 +1,49 @@
% html(); return; /* vim:set ft=sitecing: */
%%derive layout = "/ancestry/layout.chtml";
+<%constructor>
+ PN_NEXT("/simple","simple page","building a really simple page");
+</%constructor>
<%codemethod string title() %>
return "introduction";
</%codemethod>
<%method void content() %>
<h1>introduction to site-C-ing</h1>
<p>
This is a sample site, which is supposed to demonstrate <em>site-C-ing</em>
features. Since the <em>site-C-ing</em> is still at the early stages of
development or rather proof of concept, this site is also far from being
complete. I am planning to add more pages as the time permits, though.
</p>
<p>
Once you download and install <a
href="http://kin.klever.net/sitecing/">site-C-ing</a> you may wish to try
this sample site for yourself. The source is available from <a
href="http://kin.klever.net/sitecing/sources">the site-C-ing download
page</a>. After you download the source code, you should configure it using
the ever so popular <code>configure</code> script. It is likely that you will
want to pass the <code>--with-vhostname</code> option to configure to name
the apache virtual host.
</p>
<p>
The configure script will generate the apache vhost configuration for you,
which you can <code>Include</code> in the main apache configuration file.
</p>
<p class="note">
Note, that the configuration is tailored for apache 2.x. It is no problem to
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.
</p>
<p>
Once you get it all done you will want to restart your apache and start the
<em>site-C-ing</em> fastcgi server by issuing the <code>make restart</code>
command.
</p>
<p>
Before you download it, you may wish to <a href="/sources" title="source
browser">examine the sources</a> to learn more about how it is done.
</p>
</%method>
diff --git a/htdocs/simple.chtml b/htdocs/simple.chtml
index 9900f00..845b840 100644
--- a/htdocs/simple.chtml
+++ b/htdocs/simple.chtml
@@ -1,31 +1,33 @@
% html(); return; /* vim:set ft=sitecing: */
%%derive layout = "/ancestry/layout.chtml";
<%constructor>
b_strict = false;
+ PN_PREV("/","overview","introduction to site-C-ing");
+ PN_NEXT("/exceptions","exceptions","exception handling overview");
</%constructor>
<%codemethod string title() %>
return "simple page";
</%codemethod>
<%method void content() %>
<h1>building a really simple page</h1>
<p>
Building a really simple page is really simple. I will not go into much detail
here. The example provided should speak for itself.
</p>
<p>
The component being written doesn't do much but show you the calendar for the
current month. First, take a look at <a
href="/view/htdocs/examples/calendar.chtml" title="the link opens in the frame
below" target="insert">the code</a> and, after you examined it, feel free to check out
<a href="/examples/calendar" title="the link opens in the frame below"
target="insert">the output</a>.
</p>
<div class="insert">
<iframe id="insert" name="insert" src="about:blank" width="95%" height="300">
<p>I wanted to put an &lt;iframe&gt; here, but your browser does not seem to
support it. That is okay, it still will open links somehow.</p>
</iframe>
</div>
</%method>
diff --git a/htdocs/sources.chtml b/htdocs/sources.chtml
index b1eeed3..6341f49 100644
--- a/htdocs/sources.chtml
+++ b/htdocs/sources.chtml
@@ -1,47 +1,48 @@
% html(); return; /* vim:set ft=sitecing: */
%%derive layout = "/ancestry/layout.chtml";
%%derive sources = "/ancestry/sources.chtml";
<%impl>
#include <sitecing/sitecing_util.h>
</%impl>
<%constructor>
b_strict = false;
+ PN_PREV("/exceptions/runtime","runtime","runtime exceptions");
</%constructor>
<%codemethod string title() %>
return "runtime exceptions handling";
</%codemethod>
<%method void content() %>
<h1>browse this site sources</h1>
<ul class="sourcebrowser">
% for(int n=0;n<source_files_count;n++) {
% sourcefile_t& sf = source_files[n];
% if(!sf.name) { /* the beginning or the end of the directory */
% if(sf.dir) { /* the beginning */
<li class="dir"><% sf.dir %>/<ul class="dir">
% }else{ /* the end */
</ul></li>
% }
% }else{
<li class="file"><a href="/view/<% sf.dir %>/<% sf.name %>" title="<% sf.desc %>" target="insert"><% sf.name %></a></li>
% }
% }
</ul>
<%code>
string rfile = sitecing::normalize_path(
sitecing::strip_prefix(__CGI->get_meta("PATH_INFO"),"/sources.chtml"),
sitecing::restrict_dotdot|sitecing::strip_leading_slash );
if(rfile.empty())
rfile = "about:blank";
else
rfile = "/view/"+rfile;
</%code>
<div class="insert">
<iframe id="insert" name="insert" src="<% rfile %>" width="95%" height="300">
<p>I wanted to put an &lt;iframe&gt; here, but your browser does not seem to
support it. That is okay, it still will open links somehow.</p>
</iframe>
</div>
</%method>
diff --git a/htdocs/style.css b/htdocs/style.css
index 3ab1b6f..83e308f 100644
--- a/htdocs/style.css
+++ b/htdocs/style.css
@@ -71,107 +71,135 @@ div#sidepanel h2 {
color: gray;
margin: 1ex 1ex;
}
div#sidepanel ul {
padding: 1ex 0.5ex 1ex 1ex;
margin: 0.5ex;
border-color: #c0c0c0 #404040 #404040 #c0c0c0;
border-width: 1px 2px 2px 1px;
border-style: solid;
background: #d0d0d0;
list-style-type: none;
}
div#sidepanel ul ul {
margin: 0px; padding: 0px;
border: none 0px;
}
div#sidepanel li {
list-style-type: none;
margin: 0px; padding: 0px;
display: block;
}
div#sidepanel ul a {
display: block;
padding: 1px 1ex;
margin: 0.5ex;
border: 1px solid gray;
text-decoration: none;
background: white;
color: black;
}
div#sidepanel ul a:hover {
background: gray;
color: white;
}
div#sidepanel ul ul a {
padding-left: 2.5ex;
background: #e0e0e0;
}
div#sidepanel div.copyright {
text-align: center;
}
div#content h1 {
font-size: 140%;
color: gray;
font-weight: bold;
text-align: center;
margin: 1em;
+ clear: both;
+}
+div#content p a {
+ font-weight: bold;
}
div.insert {
text-align: center;
}
iframe#insert {
border: 1px solid black;
}
div.source h1 {
background: #e0e0e0;
border: 1px solid #808080;
padding-left: 1em;
margin: 0px;
font-size: 100%;
color: #000060;
overflow: hidden;
}
div.source ul {
background: #80c0c0;
margin: 0px;
padding: 1px 0px;
font-family: monospace;
font-size: 80%;
overflow: hidden;
width:100%;
}
div.source li {
list-style-type: none;
white-space: nowrap;
margin: 0px 0.5ex;
}
ul.sourcebrowser {
font-size: 70%;
}
ul.sourcebrowser ul.dir {
padding: 1px 0px 2px 1em;
margin: 1px 0px 1px 0px;
}
ul.sourcebrowser li.dir {
margin: 1px 0px 1px 0px;
}
ul.sourcebrowser li.file {
list-style-type: none;
white-space: nowrap;
display: inline;
}
ul.sourcebrowser li.file a {
border: 1px solid gray;
padding: 1px 0.5ex;
text-decoration: none;
font-family: monospace;
}
ul.sourcebrowser li.file a:hover {
background: gray;
border: 1px solid black;
color: white;
}
+
+div.prevnext {
+ margin: 1ex;
+}
+div.prevnext a {
+ margin: 0.5ex 1em; padding: 0.2ex 0.5ex;
+ display: block; width: 30%;
+ border: solid 1px gray;
+ color: black;
+ text-decoration: none;
+}
+div.prevnext a.prevnext-prev {
+ float: left;
+ text-align: left;
+}
+div.prevnext a.prevnext-next {
+ float: right;
+ text-align: right;
+}
+div.prevnext a:hover {
+ background: gray;
+ border: black 1px solid;
+ color: white;
+}