[Checkins] SVN: grok/www/ Update tutorial(s) after switching Grok
to eggs
Philipp von Weitershausen
philikon at philikon.de
Thu Jul 12 12:00:52 EDT 2007
Log message for revision 77766:
Update tutorial(s) after switching Grok to eggs
Changed:
U grok/www/minitutorials/index.html
U grok/www/tutorial.html
U grok/www/tutorial.pdf
-=-
Modified: grok/www/minitutorials/index.html
===================================================================
--- grok/www/minitutorials/index.html 2007-07-12 16:00:33 UTC (rev 77765)
+++ grok/www/minitutorials/index.html 2007-07-12 16:00:51 UTC (rev 77766)
@@ -40,16 +40,19 @@
<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>:
-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.</li>
+<ul>
+<li><p class="first"><a class="reference" href="/minitutorials/searching.html">Newbie Search Tutorial</a>:</p>
+<p>Grok supports the vanilla indexing services available in Zope 3
+straight out of the box. The 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>
+</li>
+<li><p class="first"><a class="reference" href="/minitutorials/macros.html">Macros With Grok</a>:</p>
+<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 templates, that use it.</p>
+</li>
</ul>
</div>
Modified: grok/www/tutorial.html
===================================================================
--- grok/www/tutorial.html 2007-07-12 16:00:33 UTC (rev 77765)
+++ grok/www/tutorial.html 2007-07-12 16:00:51 UTC (rev 77766)
@@ -167,11 +167,9 @@
</pre>
<p>This tells grokproject to create a new subdirectory called <tt class="docutils literal"><span class="pre">Sample</span></tt>
and set up the project in there. grokproject will automatically
-download and install Zope 3 and Grok into the project area. If you
-already have Zope 3.3.x installed, you can save some time and tell
-grokproject to reuse that installation:</p>
-<blockquote>
-$ grokproject --with-zope3=/usr/local/Zope-3.3.1 Sample</blockquote>
+download and install Zope 3 and Grok into the project area.</p>
+<!-- XXX when grokproject gains a switch for pointing to a shared egg
+directory, mention this here. -->
<p>grokproject will tell you what it will be creating:</p>
<pre class="literal-block">
Selected and implied templates:
@@ -213,22 +211,19 @@
Enter user (Name of an initial administrator user): grok
Enter passwd (Password for the initial administrator user): grok
</pre>
-<p>Now you have to wait a while as grokproject downloads Grok and
-possibly Zope 3 and sets up the project environment for you.</p>
+<p>Now you have to wait a while as grokproject downloads <a class="reference" href="http://cheeseshop.python.org/pypi/zc.buildout">zc.buildout</a>
+(the system that's used to build the project area), Grok and the Zope
+3 libraries.</p>
<p>After all that, Grok, along with a Zope 3 instance, is ready to go.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id5" id="starting-up-zope" name="starting-up-zope">Starting up Zope</a></h3>
-<p>You can go into the <tt class="docutils literal"><span class="pre">Sample</span></tt> project directory now:</p>
+<p>You can go into the <tt class="docutils literal"><span class="pre">Sample</span></tt> project directory now and start up the
+Zope instance that has been installed:</p>
<pre class="literal-block">
$ cd Sample
+$ bin/instance fg
</pre>
-<p>A Zope 3 instance has been installed in the 'parts/instance'
-directory. You can start it (into the foreground) by typing the
-following:</p>
-<pre class="literal-block">
-$ parts/instance/bin/zopectl fg
-</pre>
<p>This will make Zope 3 available on port 8080, and you can log in with
username <tt class="docutils literal"><span class="pre">grok</span></tt> and password <tt class="docutils literal"><span class="pre">grok</span></tt>. Assuming you've started up
Zope on your localhost, you can go to it here:</p>
@@ -258,7 +253,7 @@
this tutorial.</p>
<p>Practice restarting Zope now, as you'll end up doing it a lot during
this tutorial. It's just stopping Zope and starting it again:
-<cite>CTRL-c`</cite> and then <tt class="docutils literal"><span class="pre">parts/instance/bin/zopectl</span> <span class="pre">fg</span></tt> from your Sample
+<cite>CTRL-c`</cite> and then <tt class="docutils literal"><span class="pre">bin/instance</span> <span class="pre">fg</span></tt> from your Sample
project directory.</p>
</div>
<div class="section">
@@ -280,11 +275,13 @@
Python distutils and setuptools. You can use the <tt class="docutils literal"><span class="pre">setup.py</span></tt> file to
upload your project to the Python Cheeseshop. We will discuss this in
more detail later in this tutorial. (XXX)</p>
-<p>We have already seen the <tt class="docutils literal"><span class="pre">parts</span></tt> directory. This directory contains
-all software installed by grokproject that is not a simple Python
-library. The only part interesting to us right now is the <tt class="docutils literal"><span class="pre">instance</span></tt>
-directory, which contains the <tt class="docutils literal"><span class="pre">zopectl</span></tt> script to start up Zope which
-we used before.</p>
+<p>We have already seen the <tt class="docutils literal"><span class="pre">bin</span></tt> directory. It contains the startup
+script for the Zope instance (<tt class="docutils literal"><span class="pre">bin/instance</span></tt>) as well as the
+executable for the buildout system (<tt class="docutils literal"><span class="pre">bin/buildout</span></tt>) which can be
+used to re-build the Zope instance and possibly update the Grok and
+Zope packages.</p>
+<p>The <tt class="docutils literal"><span class="pre">parts</span></tt> directory contains configuration and data created by
+<tt class="docutils literal"><span class="pre">buildout</span></tt>, such as the Zope object database (ZODB) instance.</p>
<p>The actual code of the project will all be inside the <tt class="docutils literal"><span class="pre">src</span></tt>
directory. In it is a Python package directory called <tt class="docutils literal"><span class="pre">sample</span></tt> with
the <tt class="docutils literal"><span class="pre">app.py</span></tt> file that grokproject said it would create. Let's look
@@ -321,11 +318,16 @@
</pre>
<p>This is the template for your project's welcome page.</p>
<p>What's left is a <tt class="docutils literal"><span class="pre">configure.zcml</span></tt> file. Unlike in typical Zope 3
-applications, this will only ever contain a single line that registers
-this application with Zope 3. This means we can typically completely
-ignore it, but we'll show it here once for good measure:</p>
+applications, this will only ever contain a few lines that load Grok
+and then register this application with Grok. This means we can
+typically completely ignore it, but we'll show it here once for good
+measure:</p>
<pre class="literal-block">
-<grok package="." xmlns="http://namespaces.zope.org/grok" />
+<configure xmlns="http://namespaces.zope.org/zope"
+ xmlns:grok="http://namespaces.zope.org/grok">
+ <include package="grok" />
+ <grok:grok package="." />
+</configure>
</pre>
</div>
@@ -430,8 +432,8 @@
<tt class="docutils literal"><span class="pre">app_templates</span></tt> directory for <tt class="docutils literal"><span class="pre">bye.pt</span></tt>. The rule is that a the
template should have the same name as the class, but lowercased and
with the <tt class="docutils literal"><span class="pre">.pt</span></tt> postfix.</p>
-<p>Restart Zope (<tt class="docutils literal"><span class="pre">CTRL-C,</span> <span class="pre">then</span> <span class="pre">``parts/instance/bin/zopectl</span> <span class="pre">fg</span></tt>). You
-can now go to a new web page called <tt class="docutils literal"><span class="pre">bye</span></tt>:</p>
+<p>Restart Zope (<tt class="docutils literal"><span class="pre">CTRL-C,</span> <span class="pre">then</span> <span class="pre">``bin/instance</span> <span class="pre">fg</span></tt>). You can now go to a
+new web page called <tt class="docutils literal"><span class="pre">bye</span></tt>:</p>
<blockquote>
<a class="reference" href="http://localhost:8080/test/bye">http://localhost:8080/test/bye</a></blockquote>
<p>When you load this web page in a browser, you should see the following
Modified: grok/www/tutorial.pdf
===================================================================
(Binary files differ)
More information about the Checkins
mailing list