Index: openacs-4/packages/edit-this-page/www/doc/applications.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/edit-this-page/www/doc/applications.html,v
diff -u
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ openacs-4/packages/edit-this-page/www/doc/applications.html 9 Jan 2003 20:23:10 -0000 1.1
@@ -0,0 +1,101 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ETP applications</title>
+</head>
+<body bgcolor="white"><table border="1" width="100%"><tbody><tr><td><table border="1" bgcolor="#ffffff" cellpadding="10" cellspacing="0" width="100%" color="#ffffff"><tbody><tr><td><font face="arial,sans-serif" color="black" size="-1">This is <b><font color="#0039b6">G</font> <font color="#c41200">o</font> <font color="#f3c518">o</font> <font color="#0039b6">g</font> <font color="#30a72f">l</font> <font color="#c41200">e</font></b>'s <a href="http://www.google.com/help/features.html#cached"><font color="blue">cache</font></a> of <a href="http://etp.museatech.net/etpdoc/applications"><font color="blue">http://etp.museatech.net/etpdoc/applications</font></a>.<br>
+<b><font color="#0039b6">G</font> <font color="#c41200">o</font> <font color="#f3c518">o</font> <font color="#0039b6">g</font> <font color="#30a72f">l</font> <font color="#c41200">e</font></b>'s cache is the snapshot that we took of the page as we crawled the web.<br>
+The page may have changed since that time. Click here for the <a href="http://etp.museatech.net/etpdoc/applications"><font color="blue">current page</font></a> without highlighting.<br>To link to or bookmark this page, use the following url: <code>http://www.google.com/search?q=cache:pwZIPa5DPGUC:etp.museatech.net/etpdoc/applications+etp+documentation+site:etp.museatech.net&hl=en&ie=UTF-8</code></font><br><br><center><font size="-2"><i>Google is not affiliated with the authors of this page nor responsible for its content.</i></font></center></td></tr>
+<tr><td>
+<table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td><font face="arial,sans-serif" color="black" size="-1">These search terms have been highlighted:�</font></td><td bgcolor="#ffff66"><b><font face="arial,sans-serif" color="black" size="-1">etp�</font></b></td><td bgcolor="#a0ffff"><b><font face="arial,sans-serif" color="black" size="-1">documentation�</font></b></td></tr></tbody></table>
+</td></tr></tbody></table></td></tr></tbody></table>
+<hr>
+
+
+
+
+
+
+
+<a href="http://www.museatech.net/">
+<img border="0" align="right" width="179" height="115" src="applications_files/musealogo.jpg" alt="A Musea Technologies Project">
+</a>
+
+<h2><b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> applications</h2>
+
+<span class="text">
+<a href="http://etp.museatech.net/">Edit This Page Demonstration</a> : <a href="http://etp.museatech.net/etpdoc/"><b style="color: black; background-color: rgb(255, 255, 102);">ETP </b><b style="color: black; background-color: rgb(160, 255, 255);">Documentation</b></a> : <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> applications
+</span>
+
+<br clear="right">
+<hr>
+
+<span class="text">
+
+
+<h3>What is an <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> Application?</h3>
+
+After you've created a package instance of <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b>,
+you've got a virtual directory on your website where you can create and edit
+pages, links, or subdirectories. The pages you create have a very plain
+appearance and behavior: the index page displays a list of the other pages,
+and the other pages simply display whatever content you enter for them.
+This behavior is governed by what's known as the "default application".<p>
+The default application is defined by the <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> package at server startup time as follows:
+</p><blockquote><pre><b style="color: black; background-color: rgb(255, 255, 102);">etp</b>::define_application default {
+ index_template packages/editthispage/templates/article-index
+ index_content_type content_revision
+ index_object_name "subtopic"
+ index_title_attr_name "Title"
+ index_description_attr_name "Description"
+ index_content_attr_name "Content"
+
+ content_template packages/editthispage/templates/article-content
+ content_content_type content_revision
+ content_object_name "page"
+ content_title_attr_name "Title"
+ content_description_attr_name "Description"
+ content_content_attr_name "Content"
+
+ allow_subtopics t
+ allow_extlinks t
+ allow_symlinks t
+
+ auto_page_name ""
+}
+</pre></blockquote>You may customize the default application, or create new
+applications based on it, thereby changing the appearance and content of
+your web pages.<p>
+</p><h3>Modifying the default application</h3>
+It's a good bet that you'll want to alter the appearance of the pages generated by <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b>.
+ I highly recommend designing a master template for your site, and ensuring
+that all packages you've installed are using it. (If you don't know what
+a master template is, the <a href="http://etp.museatech.net/doc/acs-templating/tagref/">ACS Templating Reference</a> will tell you). First, make a copy of the templates you want from <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b>:
+<blockquote><pre>cd /web/MYSERVER/www
+mkdir templates
+cp ../packages/editthispage/www/templates/* templates
+</pre></blockquote>
+Now you can change the <code></code> tag at the top of <code>article-index.adp</code> and <code>article-content.adp</code> to refer to your master template. Next, create a file in the MYSERVER/tcl directory, and add the following code:
+<blockquote><pre><b style="color: black; background-color: rgb(255, 255, 102);">etp</b>::modify_application default {
+ index_template www/templates/article-index
+ content_template www/templates/article-content
+}
+</pre></blockquote>
+After restarting your server, every instance of <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> that's using the "default" application will be rendered using your master template.
+
+<h3>Creating new applications</h3>
+When you edit a content section in <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b>, you'll see a link that says "Choose <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b>
+Application". At first this list contains just a few entries: default, faq,
+news, and whatever other example applications were included with the <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> package. You can add your own entries to the list by calling the <code>etp_define_application</code>
+procedure. The real power of defining new applications is that you can create
+templates that reference structured data that is stored for each page in
+the content repository, and <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> gives you the means to edit and organize the structured data. To learn about how that works, please go on to read about <a href="http://etp.museatech.net/etpdoc/contenttypes">Content Types</a>.
+
+</span>
+
+<hr>
+<table width="100%">
+<tbody><tr>
+<td><address><a href="mailto:luke@museatech.net">luke@museatech.net</a></address></td>
+
+</tr>
+</tbody></table>
+
+</body></html>
\ No newline at end of file
Index: openacs-4/packages/edit-this-page/www/doc/contenttypes.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/edit-this-page/www/doc/contenttypes.html,v
diff -u
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ openacs-4/packages/edit-this-page/www/doc/contenttypes.html 9 Jan 2003 20:23:10 -0000 1.1
@@ -0,0 +1,118 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Content Types</title></head>
+<body bgcolor="white"><table border="1" width="100%"><tbody><tr><td><table border="1" bgcolor="#ffffff" cellpadding="10" cellspacing="0" width="100%" color="#ffffff"><tbody><tr><td><font face="arial,sans-serif" color="black" size="-1">This is <b><font color="#0039b6">G</font> <font color="#c41200">o</font> <font color="#f3c518">o</font> <font color="#0039b6">g</font> <font color="#30a72f">l</font> <font color="#c41200">e</font></b>'s <a href="http://www.google.com/help/features.html#cached"><font color="blue">cache</font></a> of <a href="http://etp.museatech.net/etpdoc/contenttypes"><font color="blue">http://etp.museatech.net/etpdoc/contenttypes</font></a>.<br>
+<b><font color="#0039b6">G</font> <font color="#c41200">o</font> <font color="#f3c518">o</font> <font color="#0039b6">g</font> <font color="#30a72f">l</font> <font color="#c41200">e</font></b>'s cache is the snapshot that we took of the page as we crawled the web.<br>
+The page may have changed since that time. Click here for the <a href="http://etp.museatech.net/etpdoc/contenttypes"><font color="blue">current page</font></a> without highlighting.<br>To link to or bookmark this page, use the following url: <code>http://www.google.com/search?q=cache:k8Vr8F1LNI4C:etp.museatech.net/etpdoc/contenttypes+etp+documentation+site:etp.museatech.net&hl=en&ie=UTF-8</code></font><br><br><center><font size="-2"><i>Google is not affiliated with the authors of this page nor responsible for its content.</i></font></center></td></tr>
+<tr><td>
+<table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td><font face="arial,sans-serif" color="black" size="-1">These search terms have been highlighted:�</font></td><td bgcolor="#ffff66"><b><font face="arial,sans-serif" color="black" size="-1">etp�</font></b></td><td bgcolor="#a0ffff"><b><font face="arial,sans-serif" color="black" size="-1">documentation�</font></b></td></tr></tbody></table>
+</td></tr></tbody></table></td></tr></tbody></table>
+<hr>
+
+
+
+
+
+
+
+<a href="http://www.museatech.net/">
+<img border="0" align="right" width="179" height="115" src="contenttypes_files/musealogo.jpg" alt="A Musea Technologies Project">
+</a>
+
+<h2>Content Types</h2>
+
+<span class="text">
+<a href="http://etp.museatech.net/">Edit This Page Demonstration</a> : <a href="http://etp.museatech.net/etpdoc/"><b style="color: black; background-color: rgb(255, 255, 102);">ETP </b><b style="color: black; background-color: rgb(160, 255, 255);">Documentation</b></a> : Content Types
+</span>
+
+<br clear="right">
+<hr>
+
+<span class="text">
+
+
+<h3>Standard page attributes</h3>
+
+The content repository data model (a standard part of OpenACS 4) primarily keeps track of <i>content items</i>, each of which may have multiple <i>content revisions</i>. The <code>content_revision</code> object type refers to a row in the <code>cr_revisions</code> table. Each revision contains the standard attributes of the pages you create with <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b>, such as Title, Description, and Content. Additionally, the standard <code>acs_object</code> attributes are stored for each revision, such as the creation date and creating user.
+<p>
+Referring back to the definition of the default <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> application, you'll notice that it specifies that the <code>content_revision</code>
+content type is to be used for the index page and for all content pages.
+ This means that the page templates used by the default application may refer
+to only the standard page attributes stored in the <code>cr_revisions</code> table.
+
+</p><h3>Extended page attributes: why do we need them?</h3>The standard page
+attributes, while providing all the basic functionality for a collaboratively
+edited website, are rarely sufficient to implement real world designs.<p>Imagine you're creating an online scientific journal. The graphic design
+mockup shows you that each issue of the journal contains a table of contents
+listing all the articles in that issue. However, the table of contents is
+organized into multiple sections: Editorial, Research, Corrections, and so
+on. You also notice that the design assumes that each journal issue has
+a distinguishable publication date, and that each journal article has a distinguishable
+abstract (a quick summary of the writers' findings which can be skimmed or
+searched).</p><p>All the standard page attributes (Title, Description, Content, etc.)
+are still useful, but in order to provide the structured data elements implied
+by the journal templates, we need to define some extended page attributes.
+ In particular, we know that journal issues need to have a publication date,
+and journal articles need to have a section and an abstract. </p><h3>Defining a new content type</h3>
+Creating a new content type is done by calling the <code><b style="color: black; background-color: rgb(255, 255, 102);">etp</b>::define_content_type</code> procedure from one of your tcl library files. Here's how you would accomplish the journal example discussed above:
+
+<blockquote><pre><b style="color: black; background-color: rgb(255, 255, 102);">etp</b>::define_content_type journal_issue "Journal Issue" "Journal Issues" {
+ { publication_date "Publication Date" "Publication Dates" string "size=60" "" }
+}
+
+<b style="color: black; background-color: rgb(255, 255, 102);">etp</b>::define_content_type journal_article "Journal Article" "Journal Articles" {
+ { section Section Sections string "" "" }
+ { abstract Abstract Abstracts string "rows=24 cols=80" "" }
+}
+</pre></blockquote>
+
+The first 3 parameters to <code>define_content_type</code>
+are the internal name of the content type, the name to display, and the plural
+form of that name. The fourth parameter is a list of records describing
+each extended page attribute. Each record is a list containing the following
+values (in sequence):<ul>
+ <li>attribute_name
+ </li><li>pretty_name
+ </li><li>pretty_plural
+ </li><li>datatype (must be one of the entries in acs_datatypes:
+ string, boolean, number, integer, date, etc.)
+ </li><li>html (a string containing html attributes for the input
+ control. useful attributes are "size=X" to specify
+ the size of standard input controls, and "rows=X cols=X"
+ to specify the size of a textarea. Textareas will be
+ used only if the datatype is string and html specifies
+ rows or cols.)
+ </li><li>default_value (can either be a string denoting a single default
+ value, or the name of a callback function you've
+ defined in the <b style="color: black; background-color: rgb(255, 255, 102);">etp</b> namespace which is used to
+ provide values for select lists).
+</li></ul>
+
+Once you've defined a content type, you may refer to it when calling the <code><b style="color: black; background-color: rgb(255, 255, 102);">etp</b>::define_application</code> procedure to set up a new application. To continue with our journal example, you'd want to do this as follows:
+
+<blockquote><pre><b style="color: black; background-color: rgb(255, 255, 102);">etp</b>::define_application journal {
+ index_template www/templates/journal-issue
+ index_object_name "Journal Issue"
+ index_content_type journal_issue
+
+ content_template www/templates/journal-article
+ content_object_name "Article"
+ content_content_type journal_article
+}
+</pre></blockquote>
+
+Creating the templates that make use of your custom content types is the subject of the <a href="http://etp.museatech.net/etpdoc/templates">next page</a>.
+ After that's been done, the authors of the journal will be able to create
+a new issue of the journal simply by creating a new instance of the <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> package (a process that's automated within the <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b>
+interface by the "create subtopic" command) and ensuring that the new content
+section is using the journal application. This setup can be automated, since
+it's possible to specify the application to use for any subtopic created
+within a particular directory.</span>
+
+<hr>
+<table width="100%">
+<tbody><tr>
+<td><address><a href="mailto:luke@museatech.net">luke@museatech.net</a></address></td>
+
+</tr>
+</tbody></table>
+
+</body></html>
\ No newline at end of file
Index: openacs-4/packages/edit-this-page/www/doc/index.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/edit-this-page/www/doc/index.html,v
diff -u
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ openacs-4/packages/edit-this-page/www/doc/index.html 9 Jan 2003 20:23:10 -0000 1.1
@@ -0,0 +1,68 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ETP Documentation</title>
+</head>
+<body bgcolor="white"><table border="1" width="100%"><tbody><tr><td><table border="1" bgcolor="#ffffff" cellpadding="10" cellspacing="0" width="100%" color="#ffffff"><tbody><tr><td><font face="arial,sans-serif" color="black" size="-1">This is <b><font color="#0039b6">G</font> <font color="#c41200">o</font> <font color="#f3c518">o</font> <font color="#0039b6">g</font> <font color="#30a72f">l</font> <font color="#c41200">e</font></b>'s <a href="http://www.google.com/help/features.html#cached"><font color="blue">cache</font></a> of <a href="http://etp.museatech.net/etpdoc/"><font color="blue">http://etp.museatech.net/etpdoc/</font></a>.<br>
+<b><font color="#0039b6">G</font> <font color="#c41200">o</font> <font color="#f3c518">o</font> <font color="#0039b6">g</font> <font color="#30a72f">l</font> <font color="#c41200">e</font></b>'s cache is the snapshot that we took of the page as we crawled the web.<br>
+The page may have changed since that time. Click here for the <a href="http://etp.museatech.net/etpdoc/"><font color="blue">current page</font></a> without highlighting.<br>To link to or bookmark this page, use the following url: <code>http://www.google.com/search?q=cache:mbY4OODrFn0C:etp.museatech.net/etpdoc/+documentation+site:etp.museatech.net&hl=en&ie=UTF-8</code></font><br><br><center><font size="-2"><i>Google is not affiliated with the authors of this page nor responsible for its content.</i></font></center></td></tr>
+<tr><td>
+<table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td><font face="arial,sans-serif" color="black" size="-1">These search terms have been highlighted:�</font></td><td bgcolor="#ffff66"><b><font face="arial,sans-serif" color="black" size="-1">documentation�</font></b></td></tr></tbody></table>
+</td></tr></tbody></table></td></tr></tbody></table>
+<hr>
+
+
+
+
+
+
+
+<a href="http://www.museatech.net/">
+<img border="0" align="right" width="179" height="115" src="index_files/musealogo.jpg" alt="A Musea Technologies Project">
+</a>
+
+<h2>ETP <b style="color: black; background-color: rgb(255, 255, 102);">Documentation</b></h2>
+
+<span class="text">
+<a href="http://etp.museatech.net/">Edit This Page Demonstration</a> : ETP <b style="color: black; background-color: rgb(255, 255, 102);">Documentation</b>
+</span>
+
+<br clear="right">
+<hr>
+
+<span class="text">
+
+<blockquote>
+
+<a href="http://etp.museatech.net/etpdoc/install">Installation instructions</a>
+
+<br>
+
+<a href="http://etp.museatech.net/etpdoc/applications">ETP applications</a>
+
+ - Describes the default behavior of the ETP package, and how it can be extended and customized.
+
+<br>
+
+<a href="http://etp.museatech.net/etpdoc/contenttypes">Content Types</a>
+
+ - How to specialize the pages you create with additional structured data fields
+
+<br>
+
+<a href="http://etp.museatech.net/etpdoc/templates">Templates</a>
+
+ - Customizing the appearance of pages managed by ETP
+
+<br>
+
+</blockquote>
+
+</span>
+
+<hr>
+<table width="100%">
+<tbody><tr>
+<td><address><a href="mailto:luke@museatech.net">luke@museatech.net</a></address></td>
+
+</tr>
+</tbody></table>
+
+</body></html>
\ No newline at end of file
Index: openacs-4/packages/edit-this-page/www/doc/install.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/edit-this-page/www/doc/install.html,v
diff -u
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ openacs-4/packages/edit-this-page/www/doc/install.html 9 Jan 2003 20:23:10 -0000 1.1
@@ -0,0 +1,62 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Installation instructions</title></head>
+<body bgcolor="white"><table border="1" width="100%"><tbody><tr><td><table border="1" bgcolor="#ffffff" cellpadding="10" cellspacing="0" width="100%" color="#ffffff"><tbody><tr><td><font face="arial,sans-serif" color="black" size="-1">This is <b><font color="#0039b6">G</font> <font color="#c41200">o</font> <font color="#f3c518">o</font> <font color="#0039b6">g</font> <font color="#30a72f">l</font> <font color="#c41200">e</font></b>'s <a href="http://www.google.com/help/features.html#cached"><font color="blue">cache</font></a> of <a href="http://etp.museatech.net/etpdoc/install"><font color="blue">http://etp.museatech.net/etpdoc/install</font></a>.<br>
+<b><font color="#0039b6">G</font> <font color="#c41200">o</font> <font color="#f3c518">o</font> <font color="#0039b6">g</font> <font color="#30a72f">l</font> <font color="#c41200">e</font></b>'s cache is the snapshot that we took of the page as we crawled the web.<br>
+The page may have changed since that time. Click here for the <a href="http://etp.museatech.net/etpdoc/install"><font color="blue">current page</font></a> without highlighting.<br>To link to or bookmark this page, use the following url: <code>http://www.google.com/search?q=cache:ReiRsgzboSsC:etp.museatech.net/etpdoc/install+etp+documentation+site:etp.museatech.net&hl=en&ie=UTF-8</code></font><br><br><center><font size="-2"><i>Google is not affiliated with the authors of this page nor responsible for its content.</i></font></center></td></tr>
+<tr><td>
+<table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td><font face="arial,sans-serif" color="black" size="-1">These search terms have been highlighted:�</font></td><td bgcolor="#ffff66"><b><font face="arial,sans-serif" color="black" size="-1">etp�</font></b></td><td bgcolor="#a0ffff"><b><font face="arial,sans-serif" color="black" size="-1">documentation�</font></b></td></tr></tbody></table>
+</td></tr></tbody></table></td></tr></tbody></table>
+<hr>
+
+
+
+
+
+
+
+<a href="http://www.museatech.net/">
+<img border="0" align="right" width="179" height="115" src="install_files/musealogo.jpg" alt="A Musea Technologies Project">
+</a>
+
+<h2>Installation instructions</h2>
+
+<span class="text">
+<a href="http://etp.museatech.net/">Edit This Page Demonstration</a> : <a href="http://etp.museatech.net/etpdoc/"><b style="color: black; background-color: rgb(255, 255, 102);">ETP </b><b style="color: black; background-color: rgb(160, 255, 255);">Documentation</b></a> : Installation instructions
+</span>
+
+<br clear="right">
+<hr>
+
+<span class="text">I'm assuming you've already installed OpenACS 4, loaded
+the data model, and you can see the "Congratulations!" page in your web browser.
+ First, install the <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> package by navigating to the package manager (found at <code>acs-admin/apm</code>), and selecting "Load a new package from a URL or local directory". You may install the latest <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> distribution by entering <code>http://<b style="color: black; background-color: rgb(255, 255, 102);">etp</b>.museatech.net/download/editthispage-1.0.apm</code>.
+<p>
+The Package Manager will retrieve the package code, place it in your server's
+<code>packages/editthispage</code> directory, and perform the necessary database
+setup. When that's done, you'll need to restart your server to load all
+of the package's tcl code.</p><p>
+Now you may test the package by visiting the Site Map (found at <code>admin/site-map</code>),
+creating a new directory, selecting "new application", and choosing Edit
+This Page. Within that directory, anyone who has "write" permission will
+see a link that takes them to the <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> interface from which they may edit the content of the page.
+</p><p>However, you're not really having fun until you can modify your home
+page through your web browser. By entering the following commands, you'll
+set up your site so that Edit This Page can also serve pages at the top level
+of the URL hierarchy, including your home page. Doing this will not prevent
+access to the top-level admin pages; the acs-subsite package remains mounted
+at the top level.</p><blockquote><pre>cd /web/MYSERVER/www
+mkdir index-backup
+mv index* index-backup
+ln -s ../packages/edittthispage/www/index.vuh .
+</pre></blockquote>
+
+</span>
+
+<hr>
+<table width="100%">
+<tbody><tr>
+<td><address><a href="mailto:luke@museatech.net">luke@museatech.net</a></address></td>
+
+</tr>
+</tbody></table>
+
+</body></html>
\ No newline at end of file
Index: openacs-4/packages/edit-this-page/www/doc/templates.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/edit-this-page/www/doc/templates.html,v
diff -u
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ openacs-4/packages/edit-this-page/www/doc/templates.html 9 Jan 2003 20:23:10 -0000 1.1
@@ -0,0 +1,114 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Templates</title>
+</head>
+<body bgcolor="white"><table border="1" width="100%"><tbody><tr><td><table border="1" bgcolor="#ffffff" cellpadding="10" cellspacing="0" width="100%" color="#ffffff"><tbody><tr><td><font face="arial,sans-serif" color="black" size="-1">This is <b><font color="#0039b6">G</font> <font color="#c41200">o</font> <font color="#f3c518">o</font> <font color="#0039b6">g</font> <font color="#30a72f">l</font> <font color="#c41200">e</font></b>'s <a href="http://www.google.com/help/features.html#cached"><font color="blue">cache</font></a> of <a href="http://etp.museatech.net/etpdoc/templates"><font color="blue">http://etp.museatech.net/etpdoc/templates</font></a>.<br>
+<b><font color="#0039b6">G</font> <font color="#c41200">o</font> <font color="#f3c518">o</font> <font color="#0039b6">g</font> <font color="#30a72f">l</font> <font color="#c41200">e</font></b>'s cache is the snapshot that we took of the page as we crawled the web.<br>
+The page may have changed since that time. Click here for the <a href="http://etp.museatech.net/etpdoc/templates"><font color="blue">current page</font></a> without highlighting.<br>To link to or bookmark this page, use the following url: <code>http://www.google.com/search?q=cache:kaDJjn1RdBYC:etp.museatech.net/etpdoc/templates+etp+documentation+site:etp.museatech.net&hl=en&ie=UTF-8</code></font><br><br><center><font size="-2"><i>Google is not affiliated with the authors of this page nor responsible for its content.</i></font></center></td></tr>
+<tr><td>
+<table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td><font face="arial,sans-serif" color="black" size="-1">These search terms have been highlighted:�</font></td><td bgcolor="#ffff66"><b><font face="arial,sans-serif" color="black" size="-1">etp�</font></b></td><td bgcolor="#a0ffff"><b><font face="arial,sans-serif" color="black" size="-1">documentation�</font></b></td></tr></tbody></table>
+</td></tr></tbody></table></td></tr></tbody></table>
+<hr>
+
+
+
+
+
+
+
+<a href="http://www.museatech.net/">
+<img border="0" align="right" width="179" height="115" src="templates_files/musealogo.jpg" alt="A Musea Technologies Project">
+</a>
+
+<h2>Templates</h2>
+
+<span class="text">
+<a href="http://etp.museatech.net/">Edit This Page Demonstration</a> : <a href="http://etp.museatech.net/etpdoc/"><b style="color: black; background-color: rgb(255, 255, 102);">ETP </b><b style="color: black; background-color: rgb(160, 255, 255);">Documentation</b></a> : Templates
+</span>
+
+<br clear="right">
+<hr>
+
+<span class="text">
+
+
+To use <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b>, or in fact to effectively use OpenACS 4, it's essential that you become familiar with the <a href="http://etp.museatech.net/doc/acs-templating/">ArsDigita Templating System</a>. <b style="color: black; background-color: rgb(255, 255, 102);">ETP's</b>
+support for rapid application development includes procedures for creating
+the data sources that will be used by your page templates. You can copy
+code from the examples in the <code>packages/editthispage/templates</code> directory to get started, but here's an overview of what you need to know.
+
+<h3>Providing the "Edit this page" link</h3>
+As demonstrated in <code>packages/editthispage/www/master.tcl</code>, you should call the procedure <b><b style="color: black; background-color: rgb(255, 255, 102);">etp</b>::get_etp_link</b>
+from your own master template, in order to determine whether or not to present
+the user with the "Edit this page" option. The procedure returns the html
+link only within an instance of the <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> package, and then only if the user has write access. Otherwise an empty string is returned.
+
+<h3>Retrieving page attributes for the template to display</h3>
+Every <b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> template will make use of the <b><b style="color: black; background-color: rgb(255, 255, 102);">etp</b>::get_page_attributes</b> procedure. It creates an array variable called <code>pa</code> in the caller's stack frame,
+containing all the attributes necessary to render the current page.
+These attributes include the standard elements from the cr_revisions
+table such as title, description, and content. If the page is using
+a <a href="http://etp.museatech.net/etpdoc/contenttype">custom content type</a>, any extended page
+attributes that correspond to it will be included.
+ <p>
+ The complete list of standard attributes in the pa array is as follows:
+ </p><ul>
+ <li>item_id
+ </li><li>name
+ </li><li>revision_id
+ </li><li>title
+ </li><li>context_bar
+ </li><li>description
+ </li><li>publish_date
+ </li><li>content
+ </li><li><i>extended attributes, if any, defined by <b style="color: black; background-color: rgb(255, 255, 102);">etp</b>::make_content_type</i>
+ </li></ul>
+The procedure is designed to be efficient under heavy load. The database
+is accessed once to retrieve the attributes, and a second time to generate
+the page's context bar. The resulting array is then cached in the server's
+memory until someone edits it.<p>
+Once the <code>pa</code> array variable has been created as a template
+data source, the template itself may reference the values it contains using
+the standard syntax for "onerow" data sources; for example, <code>@pa.content@</code>.
+
+</p><h3>Retrieving the list of pages in a content section</h3>
+<b style="color: black; background-color: rgb(255, 255, 102);">ETP</b> templates used for the index page will almost always make use of the <b><b style="color: black; background-color: rgb(255, 255, 102);">etp</b>::get_content_items</b> procedure. It creates a variable called <code>content_items</code>
+in the caller's stack frame. This is a multirow result set suitable for
+passing to an index template, containing all the structured data necessary
+to present a list of links to content pages, folders, extlinks, or symlinks.
+ By making use of the procedure's switches you may modify the query results
+it produces: <code>
+<ul>
+<li> -attributes [list] - list of additional page attributes to return (when required for display)
+</li><li> -orderby [list] - list of columns on which to sort.
+</li><li> -where [list] - list of SQL where clauses to restrict the query.
+</li></ul></code>
+
+ Each row in the result set always contains values for the following page attributes:
+ <ul>
+ <li>name
+ </li><li>url (use this to generate a link to this item)
+ </li><li>title
+ </li><li>description
+ </li><li>object_type
+ </li><li>publish_date
+ </li><li>item_id
+ </li></ul>
+
+ Additionally, you may name additional attributes that will be
+ returned, either from the standard page attributes stored in
+ cr_revisions, or extended page attributes defined with
+ <b style="color: black; background-color: rgb(255, 255, 102);">etp</b>::make_content_type.
+ <p>
+ The content_items variable is created with a single db query,
+ and currently is never cached.
+
+</p></span>
+
+<hr>
+<table width="100%">
+<tbody><tr>
+<td><address><a href="mailto:luke@museatech.net">luke@museatech.net</a></address></td>
+
+</tr>
+</tbody></table>
+
+</body></html>
\ No newline at end of file