[Checkins] SVN: grok/www/ Added HowTo link,
moved howtos to own directory, added index page for same directory
Darryl Cousins
darryl at darrylcousins.net.nz
Sat Jul 7 18:20:58 EDT 2007
Log message for revision 77595:
Added HowTo link, moved howtos to own directory, added index page for same directory
Changed:
U grok/www/about.html
U grok/www/index.html
A grok/www/minitutorials/
A grok/www/minitutorials/index.html
A grok/www/minitutorials/macros.html
A grok/www/minitutorials/searching.html
D grok/www/searching.html
U grok/www/tutorial.html
-=-
Modified: grok/www/about.html
===================================================================
--- grok/www/about.html 2007-07-07 22:19:52 UTC (rev 77594)
+++ grok/www/about.html 2007-07-07 22:20:57 UTC (rev 77595)
@@ -6,23 +6,25 @@
<head>
<title>Grok: now even cavemen can use Zope 3</title><meta name="description" content="Grok - now even cavemen can use Zope3" />
<meta name="keywords" content="Grok, internet, zope, zope3, software, web apps, web applications, python" />
- <style type="text/css"><!-- @import url(./resources/grok.css); --></style>
+ <style type="text/css"><!-- @import url(/resources/grok.css); --></style>
</head>
<body>
<div class="header">
<a href="http://grok.zope.org">
- <img src="./resources/grok-header.jpg" alt="GROK" /></a>
+ <img src="/resources/grok-header.jpg" alt="GROK" /></a>
<ul id="navigation">
<li>
<a href="/index.html" class="" title="Home">Home</a></li>
<li>
- <a href="/about.html" class="selected"
- title="About">About</a></li>
+ <a href="/about.html" class="" title="About">About</a></li>
<li>
<a href="/tutorial.html" class=""
title="Tutorial">Tutorial</a></li>
+ <li>
+ <a href="/minitutorials/index.html" class=""
+ title="How Tos">How Tos</a></li>
</ul>
</div>
@@ -30,7 +32,7 @@
<div class="roundcont">
<div class="roundtop">
- <img src="./resources/corner-topleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
+ <img src="/resources/corner-topleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
</div>
<div class="content">
@@ -149,7 +151,7 @@
</div>
<div class="roundbottom">
- <img src="./resources/corner-bottomleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
+ <img src="/resources/corner-bottomleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
</div>
</div>
@@ -158,10 +160,10 @@
<table><tr><td>
Grok cooks around the campfire of <br />
- <a href="http://wiki.zope.org/zope3/FrontPage"><img src="./resources/zopelogo.gif" alt="Zope" style="padding: 0.5em;" /></a>
+ <a href="http://wiki.zope.org/zope3/FrontPage"><img src="/resources/zopelogo.gif" alt="Zope" style="padding: 0.5em;" /></a>
</td><td>
and roams free on the savannah of<br />
- <a href="http://www.python.org"><img src="./resources/python-logo.gif" style="padding: 0.5em;" alt="Python" /></a>
+ <a href="http://www.python.org"><img src="/resources/python-logo.gif" style="padding: 0.5em;" alt="Python" /></a>
</td></tr>
</table>
Modified: grok/www/index.html
===================================================================
--- grok/www/index.html 2007-07-07 22:19:52 UTC (rev 77594)
+++ grok/www/index.html 2007-07-07 22:20:57 UTC (rev 77595)
@@ -6,23 +6,25 @@
<head>
<title>What is Grok?</title><meta name="description" content="Grok - now even cavemen can use Zope3" />
<meta name="keywords" content="Grok, internet, zope, zope3, software, web apps, web applications, python" />
- <style type="text/css"><!-- @import url(./resources/grok.css); --></style>
+ <style type="text/css"><!-- @import url(/resources/grok.css); --></style>
</head>
<body>
<div class="header">
<a href="http://grok.zope.org">
- <img src="./resources/grok-header.jpg" alt="GROK" /></a>
+ <img src="/resources/grok-header.jpg" alt="GROK" /></a>
<ul id="navigation">
<li>
- <a href="/index.html" class="selected"
- title="Home">Home</a></li>
+ <a href="/index.html" class="" title="Home">Home</a></li>
<li>
<a href="/about.html" class="" title="About">About</a></li>
<li>
<a href="/tutorial.html" class=""
title="Tutorial">Tutorial</a></li>
+ <li>
+ <a href="/minitutorials/index.html" class=""
+ title="How Tos">How Tos</a></li>
</ul>
</div>
@@ -30,7 +32,7 @@
<div class="roundcont">
<div class="roundtop">
- <img src="./resources/corner-topleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
+ <img src="/resources/corner-topleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
</div>
<div class="content">
@@ -110,9 +112,10 @@
</pre>
</div>
<div class="section">
-<h2><a id="me-grok-mini-tutorials" name="me-grok-mini-tutorials">ME GROK MINI-TUTORIALS</a></h2>
+<h2><a id="me-grok-mini-tutorials" name="me-grok-mini-tutorials">ME GROK MINI-TUTORIALS!</a></h2>
<ul class="simple">
-<li><a class="reference" href="searching.html">Newbie Search Tutorial</a></li>
+<li><a class="reference" href="minitutorials/searching.html">Newbie Search HowTo</a></li>
+<li><a class="reference" href="minitutorials/macros.html">Newbie Macros HowTo</a></li>
</ul>
</div>
<div class="section">
@@ -130,7 +133,7 @@
</div>
<div class="roundbottom">
- <img src="./resources/corner-bottomleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
+ <img src="/resources/corner-bottomleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
</div>
</div>
@@ -139,10 +142,10 @@
<table><tr><td>
Grok cooks around the campfire of <br />
- <a href="http://wiki.zope.org/zope3/FrontPage"><img src="./resources/zopelogo.gif" alt="Zope" style="padding: 0.5em;" /></a>
+ <a href="http://wiki.zope.org/zope3/FrontPage"><img src="/resources/zopelogo.gif" alt="Zope" style="padding: 0.5em;" /></a>
</td><td>
and roams free on the savannah of<br />
- <a href="http://www.python.org"><img src="./resources/python-logo.gif" style="padding: 0.5em;" alt="Python" /></a>
+ <a href="http://www.python.org"><img src="/resources/python-logo.gif" style="padding: 0.5em;" alt="Python" /></a>
</td></tr>
</table>
Added: grok/www/minitutorials/index.html
===================================================================
--- grok/www/minitutorials/index.html (rev 0)
+++ grok/www/minitutorials/index.html 2007-07-07 22:20:57 UTC (rev 77595)
@@ -0,0 +1,79 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Grok Mini-HowTos</title><meta name="description" content="Grok - now even cavemen can use Zope3" />
+ <meta name="keywords" content="Grok, internet, zope, zope3, software, web apps, web applications, python" />
+ <style type="text/css"><!-- @import url(/resources/grok.css); --></style>
+</head>
+
+<body>
+<div class="header">
+
+ <a href="http://grok.zope.org">
+ <img src="/resources/grok-header.jpg" alt="GROK" /></a>
+ <ul id="navigation">
+ <li>
+ <a href="/index.html" class="" title="Home">Home</a></li>
+ <li>
+ <a href="/about.html" class="" title="About">About</a></li>
+ <li>
+ <a href="/tutorial.html" class=""
+ title="Tutorial">Tutorial</a></li>
+ <li>
+ <a href="/minitutorials/index.html" class=""
+ title="How Tos">How Tos</a></li>
+ </ul>
+</div>
+
+
+<div class="roundcont">
+
+ <div class="roundtop">
+ <img src="/resources/corner-topleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
+ </div>
+
+ <div class="content">
+
+ <h1 class="title">Grok Mini-HowTos</h1>
+<img alt="Now even cavemen can use Zope3" class="right" src="/resources/evencaveman.jpg" />
+<p>These mini-tutorials have been contributed by members of the Grok community.</p>
+<ul class="simple">
+<li><a class="reference" href="/minitutorials/searching.html">Newbie Search Tutorial</a>:
+Grok supports the vanilla indexing services available in Zope 3 straight out of
+the box. Catalog uses developer defined indexes for searching. In other words,
+you have to define the indexes you want to use to search you objects before you
+perform the actual search.</li>
+<li><a class="reference" href="/minitutorials/macros.html">Macros With Grok</a>:
+Grok supports the vanilla indexing services available in Zope 3 straight out of
+the box. Catalog uses developer defined indexes for searching. In other words,
+you have to define the indexes you want to use to search you objects before you
+perform the actual search.</li>
+</ul>
+
+ </div>
+
+ <div class="roundbottom">
+ <img src="/resources/corner-bottomleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
+ </div>
+
+</div>
+
+<div class="footer">
+
+ <table><tr><td>
+ Grok cooks around the campfire of <br />
+ <a href="http://wiki.zope.org/zope3/FrontPage"><img src="/resources/zopelogo.gif" alt="Zope" style="padding: 0.5em;" /></a>
+ </td><td>
+ and roams free on the savannah of<br />
+ <a href="http://www.python.org"><img src="/resources/python-logo.gif" style="padding: 0.5em;" alt="Python" /></a>
+ </td></tr>
+ </table>
+
+ <p>Hosting provided by <a href="http://quintagroup.com/"><b>Quintagroup</b></a></p>
+</div>
+
+</body>
+</html>
Added: grok/www/minitutorials/macros.html
===================================================================
--- grok/www/minitutorials/macros.html (rev 0)
+++ grok/www/minitutorials/macros.html 2007-07-07 22:20:57 UTC (rev 77595)
@@ -0,0 +1,280 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Mini-Howto: Macros with Grok</title><meta name="description" content="Grok - now even cavemen can use Zope3" />
+ <meta name="keywords" content="Grok, internet, zope, zope3, software, web apps, web applications, python" />
+ <style type="text/css"><!-- @import url(/resources/grok.css); --></style>
+</head>
+
+<body>
+<div class="header">
+
+ <a href="http://grok.zope.org">
+ <img src="/resources/grok-header.jpg" alt="GROK" /></a>
+ <ul id="navigation">
+ <li>
+ <a href="/index.html" class="" title="Home">Home</a></li>
+ <li>
+ <a href="/about.html" class="" title="About">About</a></li>
+ <li>
+ <a href="/tutorial.html" class=""
+ title="Tutorial">Tutorial</a></li>
+ <li>
+ <a href="/minitutorials/index.html" class=""
+ title="How Tos">How Tos</a></li>
+ </ul>
+</div>
+
+
+<div class="roundcont">
+
+ <div class="roundtop">
+ <img src="/resources/corner-topleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
+ </div>
+
+ <div class="content">
+
+ <h1 class="title">Mini-Howto: Macros with Grok</h1>
+<p>Intended Audience:</p>
+<blockquote>
+<ul class="simple">
+<li>Python Developers</li>
+<li>Zope 2 Developers</li>
+<li>Zope 3 Developers</li>
+</ul>
+</blockquote>
+<div class="section">
+<h2><a id="introduction" name="introduction">Introduction</a></h2>
+<p>Macros are a way to define a chunk of presentation in one template,
+and share it in others. Changes to the macro are immediately reflected
+in all of the places, that share it.</p>
+<p>Such, a developer can easily write some sort of 'page-skeleton' (the
+macro), which can be reused in other pages to take care, for instance,
+for a certain and consistent look-and-feel of a whole site with less
+maintenance.</p>
+<p>Technically, macros are made available by <tt class="docutils literal"><span class="pre">METAL</span></tt>, a Macro Expansion
+for TAL, which ships with nearly every Zope installation. They can be
+used in Zope Page Templates. See the <a class="reference" href="http://wiki.zope.org/ZPT/TAL">TAL</a> and <a class="reference" href="http://wiki.zope.org/ZPT/METAL">METAL</a> pages for
+details.</p>
+</div>
+<div class="section">
+<h2><a id="defining-a-simple-macro" name="defining-a-simple-macro">Defining a simple macro</a></h2>
+<p>In Grok macros are defined in usual views, where the associated page
+templates contain <cite>metal</cite>-statements to define the desired
+macros. Macros generally are attributes of the page template wherein they
+are defined, but to get them rendered, we usually use views.</p>
+<p>We define a view <tt class="docutils literal"><span class="pre">MyMacros</span></tt> the usual way in <tt class="docutils literal"><span class="pre">app.py</span></tt>:</p>
+<pre class="literal-block">
+import grok
+
+class Sample(grok.Application, grok.Container):
+ pass
+
+class Index(grok.View):
+ pass # see app_templates/index.pt
+
+class MyMacros(grok.View):
+ """The macro holder"""
+ grok.context(Sample) # The default model this view is bound to.
+</pre>
+<p>In the associated page template <tt class="docutils literal"><span class="pre">app_templates/mymacros.pt</span></tt> we
+define the macros we like to have available. You define macros with
+the <tt class="docutils literal"><span class="pre">METAL</span></tt> attribute:</p>
+<pre class="literal-block">
+metal:define-macro="<macro-name>"
+</pre>
+<p>and the slots therein with:</p>
+<pre class="literal-block">
+metal:define-slots=<slot-name>
+</pre>
+<p>Let's define a very plain page macro:</p>
+<pre class="literal-block">
+<html metal:define-macro="mypage">
+ <head></head>
+ <body>
+ The content:
+ <div metal:define-slot="mycontent">
+ Put your content here...
+ </div>
+ </body>
+</html>
+</pre>
+<p>Here we defined a single macro <tt class="docutils literal"><span class="pre">mypage</span></tt> with only one slot
+<tt class="docutils literal"><span class="pre">mycontent</span></tt>.</p>
+<p>If we restart our Zope instance (don't forget to put some <tt class="docutils literal"><span class="pre">index.pt</span></tt>
+into <tt class="docutils literal"><span class="pre">app_templates/</span></tt>) and have created our application as <tt class="docutils literal"><span class="pre">test</span></tt>,
+we now can go to the following URL:</p>
+<pre class="literal-block">
+http://localhost:8080/test/mymacros
+</pre>
+<p>and see the output:</p>
+<pre class="literal-block">
+The content:
+Put your content here...
+</pre>
+<p>Allright.</p>
+</div>
+<div class="section">
+<h2><a id="referencing-a-simple-macro" name="referencing-a-simple-macro">Referencing a simple macro</a></h2>
+<p>In <tt class="docutils literal"><span class="pre">index.pt</span></tt> we now want to <em>use</em> the macro defined in
+<tt class="docutils literal"><span class="pre">mymacros.pt</span></tt>. Using a macro means to let it render a part of
+another page template, especially, filling the slots defined in
+<tt class="docutils literal"><span class="pre">mymacros.pt</span></tt> with content defined in <tt class="docutils literal"><span class="pre">index.pt</span></tt>. You call macros
+with the <tt class="docutils literal"><span class="pre">METAL</span></tt> attribute:</p>
+<pre class="literal-block">
+metal:use-macro="<macro-location>"
+</pre>
+<p>Our <tt class="docutils literal"><span class="pre">app_templates/index.pt</span></tt> can be that simple:</p>
+<pre class="literal-block">
+<html metal:use-macro="context/@@mymacros/mypage">
+</html>
+</pre>
+<p>Watching:</p>
+<pre class="literal-block">
+http://localhost:8080/test/index
+</pre>
+<p>should now give the same result as above, although we didn't call
+<tt class="docutils literal"><span class="pre">mymacros</span></tt> in browser, but <tt class="docutils literal"><span class="pre">index</span></tt>. That's what macros are made
+for.</p>
+<p>When we fill the slots, we get different content rendered within
+the same macro. You can fill slots using</p>
+<blockquote>
+metal:fill-slot="<slot-name>"</blockquote>
+<p>where the slot-name must be defined in the macro. Now, change
+<tt class="docutils literal"><span class="pre">indext.pt</span></tt> to:</p>
+<pre class="literal-block">
+<html metal:use-macro="context/@@mymacros/mypage">
+ <body>
+ <div metal:fill-slot="body">
+ My content from index.pt
+ </div>
+ </body>
+</html>
+</pre>
+<p>and you will get the output:</p>
+<pre class="literal-block">
+The content:
+My content from index.pt
+</pre>
+<p>The pattern of the macro reference (the <macro-location>) used here
+is:</p>
+<pre class="literal-block">
+context/<view-name>/<macro-name>
+</pre>
+<p>whereas <tt class="docutils literal"><span class="pre">context</span></tt> references the object being viewed, which in our
+case is the <tt class="docutils literal"><span class="pre">Sample</span></tt> application. In plain English we want Zope to
+look for a view for a <tt class="docutils literal"><span class="pre">Sample</span></tt> application object (<tt class="docutils literal"><span class="pre">test</span></tt>) which
+is called <tt class="docutils literal"><span class="pre">mymacros</span></tt> and contains a macro called <tt class="docutils literal"><span class="pre">mypage</span></tt>.</p>
+<p>The logic behind this is, that views are always registered for certain
+object types. Registering a view with some kind of object (using
+<tt class="docutils literal"><span class="pre">grok.context()</span></tt> for example), means, that we promise, that this
+view can render objects of that type. (It is up to you to make sure,
+that the view can handle rendering of that object type).</p>
+<p>It is not a bad idea to register views for interfaces (instead of
+implementing classes), because it means, that a view will remain
+usable, while an implementation of an interface can change. [FIXME: Is
+this a lie?] This is done in the section <a class="reference" href="#defining-all-purpose-macros">Defining 'all-purpose'
+macros</a> below.</p>
+</div>
+<div class="section">
+<h2><a id="background-how-grok-view-and-macros-interact" name="background-how-grok-view-and-macros-interact">Background: how <tt class="docutils literal"><span class="pre">grok.View</span></tt> and macros interact</a></h2>
+<p>In case of <tt class="docutils literal"><span class="pre">grok.View</span></tt> views are in fact <tt class="docutils literal"><span class="pre">BrowserPage</span></tt> objects
+with an attribute <tt class="docutils literal"><span class="pre">template</span></tt>, which is the associated page
+template. The associated page template in turn has got an attribute
+<tt class="docutils literal"><span class="pre">macros</span></tt>, which is a dictionary containing all the macros defined in
+the page template with their names as keys (or <tt class="docutils literal"><span class="pre">None</span></tt>).</p>
+<p>This means, that you can also reference a macro of a <tt class="docutils literal"><span class="pre">grok.View</span></tt>
+using:</p>
+<pre class="literal-block">
+context/<view-name>/template/macros/<macro-name>
+</pre>
+<p>Grok shortens this path for you by mapping the <tt class="docutils literal"><span class="pre">macros</span></tt> dictionary
+keys to the associated <tt class="docutils literal"><span class="pre">grok.View</span></tt>. If you define a macro
+<tt class="docutils literal"><span class="pre">mymacro</span></tt> in a template associated with a <tt class="docutils literal"><span class="pre">grok.View</span></tt> called
+<tt class="docutils literal"><span class="pre">myview</span></tt>, this view will map <tt class="docutils literal"><span class="pre">mymacro</span></tt> as an own attribute, so
+that you can ask for the attribute <tt class="docutils literal"><span class="pre">mymacro</span></tt> of the <em>view</em>, wheras
+it is in fact an attribute of the associated template.</p>
+<p>Such, you can write in short for the above pattern:</p>
+<pre class="literal-block">
+context/<view-name>/<macro-name>
+</pre>
+<p>View names always start with the 'eyes' (<tt class="docutils literal"><span class="pre">@@</span></tt>) which is a shortcut
+for <tt class="docutils literal"><span class="pre">++view++<view-name></span></tt>.</p>
+</div>
+<div class="section">
+<h2><a id="defining-all-purpose-macros" name="defining-all-purpose-macros">Defining 'all-purpose' macros</a></h2>
+<p>To define an 'all-purpose' macro, i.e. a macro, that can render
+objects of (nearly) any type and thus be accessed from any
+other page template, just set a very general context for your macro
+view:</p>
+<pre class="literal-block">
+from zope.interface import Interface
+import grok
+
+class Master(grok.View):
+ grok.context(Interface)
+</pre>
+<p>and reference the macros of the associated pagetemplate like this:</p>
+<pre class="literal-block">
+context/@@master/<macro-name>
+</pre>
+<p>Because the macros in <tt class="docutils literal"><span class="pre">Master</span></tt> now are 'bound' (in fact their view
+is bound) to <tt class="docutils literal"><span class="pre">Interface</span></tt> and every Grok application, model or
+container implements some interface, the <tt class="docutils literal"><span class="pre">Master</span></tt> macros will be
+accessible from nearly every other context. <tt class="docutils literal"><span class="pre">Master</span></tt> promises to be
+a view for every object, which implements <tt class="docutils literal"><span class="pre">Interface</span></tt>.</p>
+</div>
+<div class="section">
+<h2><a id="accessing-zope3-standard-macros" name="accessing-zope3-standard-macros">Accessing Zope3 standard macros</a></h2>
+<p>The standard macros of Zope 3, which render also the default ZMI
+pages, are accessible under the view-name <tt class="docutils literal"><span class="pre">standard_macros</span></tt> and usually
+provide slots <tt class="docutils literal"><span class="pre">title</span></tt>, <tt class="docutils literal"><span class="pre">headers</span></tt> and <tt class="docutils literal"><span class="pre">body</span></tt>. It is
+good style to provide this slots with your homegrown views as well.</p>
+<p>To give your pages standard Zope3 look, you can do something like
+this in your page template:</p>
+<pre class="literal-block">
+<html metal:use-macro="context/@@standard_macros/page">
+ <head>
+ <title metal:fill-slot="title">
+ Document Title
+ </title>
+ <metal:headers fill-slot="headers">
+ <!-- Additional headers here... -->
+ </metal:headers>
+ </head>
+ <body>
+ <div metal:fill-slot="body">
+ Your content here...
+ </div>
+ </body>
+</html>
+</pre>
+</div>
+
+ </div>
+
+ <div class="roundbottom">
+ <img src="/resources/corner-bottomleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
+ </div>
+
+</div>
+
+<div class="footer">
+
+ <table><tr><td>
+ Grok cooks around the campfire of <br />
+ <a href="http://wiki.zope.org/zope3/FrontPage"><img src="/resources/zopelogo.gif" alt="Zope" style="padding: 0.5em;" /></a>
+ </td><td>
+ and roams free on the savannah of<br />
+ <a href="http://www.python.org"><img src="/resources/python-logo.gif" style="padding: 0.5em;" alt="Python" /></a>
+ </td></tr>
+ </table>
+
+ <p>Hosting provided by <a href="http://quintagroup.com/"><b>Quintagroup</b></a></p>
+</div>
+
+</body>
+</html>
Added: grok/www/minitutorials/searching.html
===================================================================
--- grok/www/minitutorials/searching.html (rev 0)
+++ grok/www/minitutorials/searching.html 2007-07-07 22:20:57 UTC (rev 77595)
@@ -0,0 +1,187 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Newbie Search Tutorial</title><meta name="description" content="Grok - now even cavemen can use Zope3" />
+ <meta name="keywords" content="Grok, internet, zope, zope3, software, web apps, web applications, python" />
+ <style type="text/css"><!-- @import url(/resources/grok.css); --></style>
+</head>
+
+<body>
+<div class="header">
+
+ <a href="http://grok.zope.org">
+ <img src="/resources/grok-header.jpg" alt="GROK" /></a>
+ <ul id="navigation">
+ <li>
+ <a href="/index.html" class="" title="Home">Home</a></li>
+ <li>
+ <a href="/about.html" class="" title="About">About</a></li>
+ <li>
+ <a href="/tutorial.html" class=""
+ title="Tutorial">Tutorial</a></li>
+ <li>
+ <a href="/minitutorials/index.html" class=""
+ title="How Tos">How Tos</a></li>
+ </ul>
+</div>
+
+
+<div class="roundcont">
+
+ <div class="roundtop">
+ <img src="/resources/corner-topleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
+ </div>
+
+ <div class="content">
+
+ <h1 class="title">Newbie Search Tutorial</h1>
+<div class="section">
+<h2><a id="introduction" name="introduction">Introduction</a></h2>
+<p>Grok supports the vanilla indexing services available in Zope 3 straight out of
+the box. Catalog uses developer defined indexes for searching. In other words,
+you have to define the indexes you want to use to search you objects before you
+perform the actual search.</p>
+<ul class="simple">
+<li>FieldIndex: search matching an entire field</li>
+<li>SetIndex: search for keywords in a field</li>
+<li>TextIndex: full-text searching</li>
+<li>ValueSearch: search for values using ranges</li>
+</ul>
+<p>The time for Zope to generate a new index is proportional to the amount of
+objects that need to be analysed.</p>
+</div>
+<div class="section">
+<h2><a id="setup" name="setup">Setup</a></h2>
+<p>The egg (package) containing the search functionality is called
+[zc.catalog-x.x.x-py2.x.egg] and is installed when "buildout.cfg" contains
+"zope.app.catalog" in the list of the directive "zcml=". This is the default
+configuration.</p>
+<p>Some applications might require specific versions of catalog. This is specified
+in the "setup.py" script. The following directive indicates that zc.catalog
+version 1.1.1 is required.</p>
+<pre class="literal-block">
+install_requires=['setuptools',
+ 'grok',
+ 'zc.catalog==1.1.1',
+ 'hurry.query',
+ 'hurry.workflow',
+ ],
+</pre>
+<p>The "hurry.query" package gives you some simple tools to perform advanced
+searching. (add "hurry.query" to "zcml=" in "buildout.cfg")</p>
+</div>
+<div class="section">
+<h2><a id="example" name="example">Example</a></h2>
+<pre class="literal-block">
+# interfaces.py
+class IProtonObject(Interface):
+ """
+ This is an interface to the class who's objects I want to index.
+ """
+ body = schema.Text(title=u'Body', required=False)
+</pre>
+<pre class="literal-block">
+# protonobject.py
+class ProtonObject(grok.Model):
+ """
+ This is the actual class.
+ """
+ interface.implements(interfaces.IProtonObject)
+
+ def __init__(self, body):
+ self.body = body
+</pre>
+<pre class="literal-block">
+# app.py
+from hurry.query.query import Query, Text
+# hurry.query is a simplified search query language that
+# allows you to create ANDs and ORs.
+
+class ContentIndexes(grok.Indexes):
+ """
+ This is where I setup my indexes. I have two indexes;
+ one full-text index called "text_body",
+ one field index called "body".
+ """
+ grok.site(ProtonCMS)
+
+ grok.context(interfaces.IProtonObject)
+ # grok.context() tells Grok that objects implementing
+ # the interface IProtonObject should be indexed.
+
+ grok.name('proton_catalog')
+ # grok.name() tells Grok what to call the catalog.
+ # if you have named the catalog anything but "catalog"
+ # you need to specify the name of the catalog in your
+ # queries.
+
+ text_body = index.Text(attribute='body')
+ body = index.Field(attribute='body')
+ # The attribute='body' parameter is actually unnecessary if the attribute to
+ # be indexed has the same name as the index.
+
+class Index(grok.View):
+ grok.context(ProtonCMS)
+
+ def search_content(self, search_query):
+ # The following query does a search on the field index "body".
+ # It will return a list of object where the entire content of the body attribute
+ # matches the search term exactly. I.e. search_query == body
+ result_a = Query().searchResults(
+ query.Eq(('proton_catalog', 'body'), search_query)
+ )
+
+ # The following query does a search on the full-text index "text_body".
+ # It will return objects that match the search_query. You can use wildcards and
+ # boolean operators.
+ #
+ # Examples:
+ # "grok AND zope" returns objects where "body" contains the words "grok" and "zope"
+ # "grok or dev*" returns objects where "body" contains the word "grok" or any word
+ # beginning with "dev"
+ result_b = Query().searchResults(
+ Text( ('proton_catalog', 'text_body'), search_query)
+ )
+
+ return result_a, result_b
+</pre>
+</div>
+<div class="section">
+<h2><a id="note" name="note">Note</a></h2>
+<p>In the above example, the indexes are only added when a new application is
+installed. You will have to manually create new indexes if you wish to add them
+to an existing application.</p>
+</div>
+<div class="section">
+<h2><a id="learning-more" name="learning-more">Learning More</a></h2>
+<p>The "hurry.query" package contains the DocTest "query.txt" that shows how to
+perform more complex search queries.</p>
+</div>
+
+ </div>
+
+ <div class="roundbottom">
+ <img src="/resources/corner-bottomleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
+ </div>
+
+</div>
+
+<div class="footer">
+
+ <table><tr><td>
+ Grok cooks around the campfire of <br />
+ <a href="http://wiki.zope.org/zope3/FrontPage"><img src="/resources/zopelogo.gif" alt="Zope" style="padding: 0.5em;" /></a>
+ </td><td>
+ and roams free on the savannah of<br />
+ <a href="http://www.python.org"><img src="/resources/python-logo.gif" style="padding: 0.5em;" alt="Python" /></a>
+ </td></tr>
+ </table>
+
+ <p>Hosting provided by <a href="http://quintagroup.com/"><b>Quintagroup</b></a></p>
+</div>
+
+</body>
+</html>
Deleted: grok/www/searching.html
===================================================================
--- grok/www/searching.html 2007-07-07 22:19:52 UTC (rev 77594)
+++ grok/www/searching.html 2007-07-07 22:20:57 UTC (rev 77595)
@@ -1,171 +0,0 @@
-
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Newbie Search Tutorial</title><meta name="description" content="Grok - now even cavemen can use Zope3" />
- <meta name="keywords" content="Grok, internet, zope, zope3, software, web apps, web applications, python" />
- <style type="text/css"><!-- @import url(./resources/grok.css); --></style>
-</head>
-
-<body>
-<div class="header">
-
- <a href="http://grok.zope.org">
- <img src="./resources/grok-header.jpg" alt="GROK" /></a>
- <ul id="navigation">
- <li>
- <a href="/index.html" class="" title="Home">Home</a></li>
- <li>
- <a href="/about.html" class="" title="About">About</a></li>
- <li>
- <a href="/tutorial.html" class=""
- title="Tutorial">Tutorial</a></li>
- </ul>
-</div>
-
-
-<div class="roundcont">
-
- <div class="roundtop">
- <img src="./resources/corner-topleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
- </div>
-
- <div class="content">
-
- <h1 class="title">Newbie Search Tutorial</h1>
-<div class="section">
-<h2><a id="introduction" name="introduction">Introduction</a></h2>
-<p>Grok supports the vanilla indexing services available in Zope 3 straight out of the box. Catalog uses developer defined indexes for searching. In other words, you have to define the indexes you want to use to search you objects before you perform the actual search.</p>
-<ul class="simple">
-<li>FieldIndex: search matching an entire field</li>
-<li>SetIndex: search for keywords in a field</li>
-<li>TextIndex: full-text searching</li>
-<li>ValueSearch: search for values using ranges</li>
-</ul>
-<p>The time for Zope to generate a new index is proportional to the amount of objects that need to be analysed.</p>
-</div>
-<div class="section">
-<h2><a id="setup" name="setup">Setup</a></h2>
-<p>The egg (package) containing the search functionality is called [zc.catalog-x.x.x-py2.x.egg] and is installed when "buildout.cfg" contains "zope.app.catalog" in the list of the directive "zcml=". This is the default configuration.</p>
-<p>Some applications might require specific versions of catalog. This is specified in the "setup.py" script. The following directive indicates that zc.catalog version 1.1.1 is required.</p>
-<pre class="literal-block">
-install_requires=['setuptools',
- 'grok',
- 'zc.catalog==1.1.1',
- 'hurry.query',
- 'hurry.workflow',
- ],
-</pre>
-<p>The "hurry.query" package gives you some simple tools to perform advanced searching. (add "hurry.query" to "zcml=" in "buildout.cfg")</p>
-</div>
-<div class="section">
-<h2><a id="example" name="example">Example</a></h2>
-<pre class="literal-block">
-# interfaces.py
-class IProtonObject(Interface):
- """
- This is an interface to the class who's objects I want to index.
- """
- body = schema.Text(title=u'Body', required=False)
-</pre>
-<pre class="literal-block">
-# protonobject.py
-class ProtonObject(grok.Model):
- """
- This is the actual class.
- """
- interface.implements(interfaces.IProtonObject)
-
- def __init__(self, body):
- self.body = body
-</pre>
-<pre class="literal-block">
-# app.py
-from hurry.query.query import Query, Text
-# hurry.query is a simplified search query language that
-# allows you to create ANDs and ORs.
-
-class ContentIndexes(grok.Indexes):
- """
- This is where I setup my indexes. I have two indexes;
- one full-text index called "text_body",
- one field index called "body".
- """
- grok.site(ProtonCMS)
-
- grok.context(interfaces.IProtonObject)
- # grok.context() tells Grok that objects implementing
- # the interface IProtonObject should be indexed.
-
- grok.name('proton_catalog')
- # grok.name() tells Grok what to call the catalog.
- # if you have named the catalog anything but "catalog"
- # you need to specify the name of the catalog in your
- # queries.
-
- text_body = index.Text(attribute='body')
- body = index.Field(attribute='body')
- # The attribute='body' parameter is actually unnecessary if the attribute to
- # be indexed has the same name as the index.
-
-class Index(grok.View):
- grok.context(ProtonCMS)
-
- def search_content(self, search_query):
- # The following query does a search on the field index "body".
- # It will return a list of object where the entire content of the body attribute
- # matches the search term exactly. I.e. search_query == body
- result_a = Query().searchResults(
- query.Eq(('proton_catalog', 'body'), search_query)
- )
-
- # The following query does a search on the full-text index "text_body".
- # It will return objects that match the search_query. You can use wildcards and
- # boolean operators.
- #
- # Examples:
- # "grok AND zope" returns objects where "body" contains the words "grok" and "zope"
- # "grok or dev*" returns objects where "body" contains the word "grok" or any word
- # beginning with "dev"
- result_b = Query().searchResults(
- Text( ('proton_catalog', 'text_body'), search_query)
- )
-
- return result_a, result_b
-</pre>
-</div>
-<div class="section">
-<h2><a id="note" name="note">Note</a></h2>
-<p>In the above example, the indexes are only added when a new application is installed. You will have to manually create new indexes if you wish to add them to an existing application.</p>
-</div>
-<div class="section">
-<h2><a id="learning-more" name="learning-more">Learning More</a></h2>
-<p>The "hurry.query" package contains the DocTest "query.txt" that shows how to perform more complex search queries.</p>
-</div>
-
- </div>
-
- <div class="roundbottom">
- <img src="./resources/corner-bottomleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
- </div>
-
-</div>
-
-<div class="footer">
-
- <table><tr><td>
- Grok cooks around the campfire of <br />
- <a href="http://wiki.zope.org/zope3/FrontPage"><img src="./resources/zopelogo.gif" alt="Zope" style="padding: 0.5em;" /></a>
- </td><td>
- and roams free on the savannah of<br />
- <a href="http://www.python.org"><img src="./resources/python-logo.gif" style="padding: 0.5em;" alt="Python" /></a>
- </td></tr>
- </table>
-
- <p>Hosting provided by <a href="http://quintagroup.com/"><b>Quintagroup</b></a></p>
-</div>
-
-</body>
-</html>
Modified: grok/www/tutorial.html
===================================================================
--- grok/www/tutorial.html 2007-07-07 22:19:52 UTC (rev 77594)
+++ grok/www/tutorial.html 2007-07-07 22:20:57 UTC (rev 77595)
@@ -6,22 +6,25 @@
<head>
<title>Grok tutorial</title><meta name="description" content="Grok - now even cavemen can use Zope3" />
<meta name="keywords" content="Grok, internet, zope, zope3, software, web apps, web applications, python" />
- <style type="text/css"><!-- @import url(./resources/grok.css); --></style>
+ <style type="text/css"><!-- @import url(/resources/grok.css); --></style>
</head>
<body>
<div class="header">
<a href="http://grok.zope.org">
- <img src="./resources/grok-header.jpg" alt="GROK" /></a>
+ <img src="/resources/grok-header.jpg" alt="GROK" /></a>
<ul id="navigation">
<li>
<a href="/index.html" class="" title="Home">Home</a></li>
<li>
<a href="/about.html" class="" title="About">About</a></li>
<li>
- <a href="/tutorial.html" class="selected"
+ <a href="/tutorial.html" class=""
title="Tutorial">Tutorial</a></li>
+ <li>
+ <a href="/minitutorials/index.html" class=""
+ title="How Tos">How Tos</a></li>
</ul>
</div>
@@ -29,7 +32,7 @@
<div class="roundcont">
<div class="roundtop">
- <img src="./resources/corner-topleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
+ <img src="/resources/corner-topleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
</div>
<div class="content">
@@ -1644,7 +1647,7 @@
</div>
<div class="roundbottom">
- <img src="./resources/corner-bottomleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
+ <img src="/resources/corner-bottomleft.jpg" alt="" width="45" height="45" class="corner" style="display: none" />
</div>
</div>
@@ -1653,10 +1656,10 @@
<table><tr><td>
Grok cooks around the campfire of <br />
- <a href="http://wiki.zope.org/zope3/FrontPage"><img src="./resources/zopelogo.gif" alt="Zope" style="padding: 0.5em;" /></a>
+ <a href="http://wiki.zope.org/zope3/FrontPage"><img src="/resources/zopelogo.gif" alt="Zope" style="padding: 0.5em;" /></a>
</td><td>
and roams free on the savannah of<br />
- <a href="http://www.python.org"><img src="./resources/python-logo.gif" style="padding: 0.5em;" alt="Python" /></a>
+ <a href="http://www.python.org"><img src="/resources/python-logo.gif" style="padding: 0.5em;" alt="Python" /></a>
</td></tr>
</table>
More information about the Checkins
mailing list