Difference between pages "Zope HOWTO" and "Help:Funtoo Editing Guidelines"

From Funtoo
(Difference between pages)
Jump to: navigation, search
(fixing syntax highlighting and console output highlighting)
 
(<console>)
 
Line 1: Line 1:
This page documents how to use Zope with Funtoo Experimental, which currently has good Zope support thanks to [[Progress Overlay Python]] integration.
+
This guide is meant to serve as a reference for those who are interested in helping improve the Funtoo wiki.  
  
== About Zope ==
+
== &#123;&#123;Kernelop&#125;&#125; ==
 +
To display kernel options, we encourage you to use the <tt>kernelop</tt> template. To use the <tt>kernelop</tt> template, create an entry similar to the following example:
 +
<pre>
 +
{{kernelop|title=foo,bar|desc=
 +
kernel options pasted from "make menuconfig"
 +
<&#47;pre>}}
 +
</pre>
  
Zope is an Open Source application server framework written in Python. It has an interesting history which you should familiarize yourself with before starting Zope development, as it contains several interesting twists and turns.
+
Adding this entry will give you the following output:
 +
{{kernelop|title=foo,bar|desc=
 +
kernel options
 +
}}
  
=== Zope History ===
+
Here's a more concrete example:
 +
{{kernelop|title=File systems|desc=
 +
<M> Second extended fs support         
 +
[ ]  Ext2 extended attributes         
 +
[ ]  Ext2 execute in place support   
 +
<M> Ext3 journalling file system support
 +
}}
  
{{fancynote| This HOWTO targets Zope 2.13, which includes Five. It is typically the version you should be using for new Zope projects.}}
+
Examples of usage:
 +
* [[Fglrx]]
 +
* [[Acpid]]
 +
* [[Microcode]]
  
* There are two versions of Zope, Zope 2 and Zope 3. One might assume that Zope 3 is the version that people should use for new software development projects by default, but this is not the case. Most Zope-based projects continue to use Zope 2. Zope 3 was an attempt to redesign Zope 2 from scratch, and is completely different from Zope 2, but it was not adopted by the community.
+
== &#123;&#123;File&#125;&#125; ==
 +
To display the contents of a file, use the <tt>file</tt> template.  
 +
<pre>
 +
{{file
 +
| file name | <pre>
 +
contents of the file
 +
<&#47;pre>}}
 +
</pre>
  
* There is also something called [http://codespeak.net/z3/five/ Five] (named because it is "2 + 3") that backports many of the new features of Zope 3 into the Zope 2 framework. Several projects will use Zope 2 plus Five in order to use some of the newer features in Zope. Five was merged into mainline Zope 2 in early 2010, and first appeared in Zope 2.8.
+
This produces:
 +
{{file
 +
| file name | <pre>
 +
contents of the file
 +
</pre>}}
  
* You can learn more about the history of Zope 2, 3 and Five in the [http://svn.zope.org/Zope/trunk/src/Products/Five/README.txt?view=markup Five README].
+
Examples of usage:
 +
* [[UEFI Install Guide]]
 +
* [[MediaWiki]]
 +
* [[Clang]]
  
* To make things even more interesting, work on [http://docs.zope.org/zope2/releases/4.0/ Zope 4] is underway, and it will be based on 2.13 rather than 3.x. It includes a number of [http://docs.zope.org/zope2/releases/4.0/CHANGES.html#restructuring incompatible changes] with prior versions.
+
== &#60;tt&#62; and &#60;code&#62; ==
=== Zope Resources ===
+
To emphasize filenames, commands, and other technical "jargon," use the  <tt>&#60;tt&#62;</tt> or <tt>&#60;code&#62;</tt> option. To use these, follow the example below:
 +
<pre>
 +
The <tt>/etc/fstab</tt> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.
 +
</pre>
  
Now that you understand what version of Zope you should be targeting (2.13), we can point you towards the correct documentation :)
+
This example produces the following output (notice the difference between the fonts?): <br> The <tt>/etc/fstab</tt> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.
  
; '''[http://docs.zope.org/zope2/zope2book/ The Zope 2 Book]'''
+
== &#60;console&#62; ==
: This book provides a general introduction to Zope concepts and ZMI. It is a good place to start, but doesn't provide a direct introduction to Zope development. It's recommended that you skim through this book to familiarize yourself with Zope. It generally does not assume much prior knowledge about Web development or Python.
+
To display console output, use the <tt>&#60;console&#62;</tt> tag:
; '''[http://docs.zope.org/zope2/zdgbook/ Zope Developer's Guide]'''
+
: This guide will give you a better introduction to Zope development. It assumes you already know Python. Skip chapters 1 and 2 and start in [http://docs.zope.org/zope2/zdgbook/ComponentsAndInterfaces.html chapter 3], which covers components and interfaces. [http://docs.zope.org/zope2/zdgbook/Products.html Chapter 5] covers the creation of your first product.
+
; '''[http://codespeak.net/z3/five/manual.html The Five Manual]'''
+
: We're not done yet. There is a bunch of stuff in Zope 2.13 that is not in the official documentation. Namely, the stuff in Five.
+
; '''[http://docs.zope.org/ztkpackages.html ZTK Documentation]'''
+
: ZTK 
+
; '''ZCA'''
+
: [http://www.muthukadan.net/docs/zca.html A Comprehensive Guide to Zope Component Architecture] offers a good introduction to the programming concepts of ZCA. We also have a new page on [[Zope Component Architecture]] which will help you to understand the big picture of ZCA and why it is useful. ZCML ("Z-camel") is a part of ZCA and  was introduced in Zope 3, so typically you will find ZCML documented within Zope 3 documentation and book.
+
; '''Content Components'''
+
: Views and Viewlets: [http://docs.zope.org/zope.viewlet/index.html This tutorial on viewlets] also contains some viewlet-related ZCML examples near the end. The "Content Component way" of developing in Zope seems to be a Zope 3 thing and tied to ZCML. Chapter 13+ of Stephan Richter's ''Zope 3 Developer's Handbook'' (book) seems to cover this quite well. You will probably also want to check out Philipp Weitershausen's ''Web Component Development with Zope 3'' (book).
+
; '''[http://wiki.zope.org/zope2/Zope2Wiki Zope 2 Wiki]'''
+
: Main wiki page for all things related to Zope 2.
+
; '''[http://docs.zope.org docs.zope.org]'''
+
: This is the main site for Zope documentation.
+
  
== First Steps ==
+
For a root console:
 
+
<pre>
First, you will need to emerge {{Package|net-zope/zope}}:
+
 
<console>
 
<console>
###i## emerge zope
+
###i## run a command as root
 
</console>
 
</console>
 
+
</pre>
Zope is now installed.
+
Produces:
 
+
== Project Skeleton ==
+
 
+
{{fancynote| Zope should be run by a regular user account, not as the root user.}}
+
 
+
The first step in using Zope is to ensure that you are using a regular user account. Create a new directory called <tt>zope_test</tt>:
+
 
<console>
 
<console>
$##i## cd
+
###i## run a command as root
$##i## mkdir zope_test
+
 
</console>
 
</console>
  
Now, enter the directory, and create an "instance", which is a set of files and directories that are used to contain a Zope project:
+
{{Fancyimportant|The <tt>##i##</tt> text tags the rest of the line as being ''user input'' ("i" is for "input"). It is then highlighted in a noticeable color so it stands out from text that is not typed in by the user.}}
<console>
+
$##i## cd zope_test
+
$##i## /usr/lib/zope-2.13/bin/mkzopeinstance
+
</console>
+
  
You will see the following output, and will be prompted to answer a few questions:
+
Examples of usage:
 +
* [[Rootfs over encrypted lvm]]
 +
* [[Boot-Update]]
 +
* [[Fonts]]
 +
For a non-root console:
 +
<pre>
 
<console>
 
<console>
Please choose a directory in which you'd like to install
+
$##i## run a command as user
Zope "instance home" files such as database files, configuration
+
files, etc.
+
 
+
Directory: instance
+
Please choose a username and password for the initial user.
+
These will be the credentials you use to initially manage
+
your new Zope instance.
+
 
+
Username: admin
+
Password: ****
+
Verify password: ****
+
 
</console>
 
</console>
 
+
</pre>
Now, we will start our Zope instance:
+
Produces:
<console>
+
$##i## cd instance
+
$##i## bin/runzope
+
</console>
+
 
+
Now that Zope is running, you can visit <tt>localhost:8080</tt> in your Web browser. You will see a nice introductory page to Zope.
+
 
+
If you now go to the <tt>localhost:8080/manage</tt> URL, you will be prompted to log in. Enter the username and password you specified. You are now logged in to the ZMI (Zope Management Interface.)
+
 
+
You can stop your application by pressing Control-C. In the future, you can start and stop your Zope instance using the following commands:
+
 
+
<console>
+
$##i## zopectl start
+
$##i## zopectl stop
+
</console>
+
 
+
{{fancynote| <tt>zopectl start</tt> will cause your instance to run in the background rather than consuming a shell console.}}
+
 
+
== First Project ==
+
 
+
We will create a single very primitive Zope package, consisting of an Interface for a TODO class, and a TODO class.
+
 
+
Create the following files and directories relative to your project root:
+
 
+
* Create the directory <tt>lib/python/example</tt>.
+
* Create the file <tt>lib/python/example/__init__.py</tt> by typing <tt>touch lib/python/example/__init__.py</tt>.
+
* Create these files:
+
 
+
=== <tt>example-configure.zcml</tt> ===
+
 
+
This file registers the <tt>example</tt> directory you created in <tt>lib/python</tt> as a ''package'', so that it is seen by Zope. Edit <code>/etc/package-includes/example-configure.zcml</code>:
+
{{File
+
|/etc/package-includes/example-configure.zcml|<pre>
+
<include package="example" />
+
</pre>}}
+
 
+
=== <tt>interfaces.py</tt> ===
+
 
+
The following file defines the <tt>ITODO</tt> interface, and also uses some Zope Schema functions to define what kind of data we expect to store in objects that implement <tt>ITODO</tt>. Edit <code>/lib/python/example/interfaces.py</code> with your favorite text editor:
+
 
+
<syntaxhighlight lang="python">
+
from zope.interface import Interface
+
from zope.schema import List, Text, TextLine, Int
+
 
+
class ITODO(Interface):
+
    name = TextLine(title=u'Name', required=True)
+
    todo = List(title=u"TODO Items", required=True, value_type=TextLine(title=u'TODO'))
+
    daysleft = Int(title=u'Days left to complete', required=True)
+
    description = Text(title=u'Description', required=True)
+
</syntaxhighlight>
+
 
+
=== <tt>TODO.py</tt> ===
+
 
+
Now, we define <tt>TODO</tt> to be a ''persistent'' object, meaning it can be stored in the ZODB. We specify that it implements our previously-defined <tt>ITODO</tt> interface, and provide reasonable defaults for all values when we create a new TODO object. Edit <code>/lib/python/example/TODO.py<code> using your favorite text editor:
+
<syntaxhighlight lang="python">
+
from persistent import Persistent
+
from zope.interface import implements
+
from example.interfaces import ITODO
+
 
+
class TODO(Persistent):
+
    implements(ITODO)
+
    name = u''
+
    todo = []
+
    daysleft = 0
+
    description = u''
+
</syntaxhighlight>
+
 
+
=== <tt>configure.zcml</tt> ===
+
 
+
Create the <tt>/lib/python/example/configure.zcml</tt> configuration file:
+
<syntaxhighlight lang="xml">
+
<configure xmlns="http://namespaces.zope.org/zope"
+
    xmlns:five="http://namespaces.zope.org/five"
+
    xmlns:browser="http://namespaces.zope.org/browser">
+
</configure>
+
</syntaxhighlight>
+
 
+
== Debug Mode ==
+
 
+
We can test our first project by entering debug mode:
+
<console>
+
$##i## bin/zopectl debug
+
Starting debugger (the name "app" is bound to the top-level Zope object)
+
</console>
+
 
+
Now, let's try creating a new TODO object and writing it out to a ZODB database:
+
 
<console>
 
<console>
>>> from ZODB import FileStorage, DB
+
$##i## run a command as user
>>> storage = FileStorage.FileStorage('mydatabase.fs')
+
>>> db = DB(storage)
+
>>> connection = db.open()
+
>>> import transaction
+
>>> root = connection.root()
+
>>> from example.TODO import TODO
+
>>> a = TODO
+
>>> a.name = u'My TODOs'
+
>>> a.TODOS = [ u'Do Laundry', u'Wash Dishes' ]
+
>>> a.daysleft = 1
+
>>> a.description = u'Things I need to do today.'
+
>>> root[u'today'] = a
+
>>> transaction.commit()
+
 
</console>
 
</console>
 +
Examples of usage:
 +
* [[Zope HOWTO]]
 +
* [[Benchmarking]]
  
[[Category:HOWTO]]
+
[[Category:Wiki Development]]
[[Category:Featured]]
+

Revision as of 09:00, 18 February 2014

This guide is meant to serve as a reference for those who are interested in helping improve the Funtoo wiki.

Contents

{{Kernelop}}

To display kernel options, we encourage you to use the kernelop template. To use the kernelop template, create an entry similar to the following example:

{{kernelop|title=foo,bar|desc=
kernel options pasted from "make menuconfig"
</pre>}} 

Adding this entry will give you the following output: Under foo-->bar:

kernel options

Here's a more concrete example: Under File systems:

<M> Second extended fs support          
[ ]   Ext2 extended attributes          
[ ]   Ext2 execute in place support     
<M> Ext3 journalling file system support

Examples of usage:

{{File}}

To display the contents of a file, use the file template.

{{file
| file name | <pre>
contents of the file
</pre>}}

This produces:

contents of the file

Examples of usage:

<tt> and <code>

To emphasize filenames, commands, and other technical "jargon," use the <tt> or <code> option. To use these, follow the example below:

The <tt>/etc/fstab</tt> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.

This example produces the following output (notice the difference between the fonts?):
The /etc/fstab file is an important one. Another important file is /boot/grub/grub.cfg.

<console>

To display console output, use the <console> tag:

For a root console:

<console>
###i## run a command as root
</console>

Produces:

# run a command as root
Important: The ##i## text tags the rest of the line as being user input ("i" is for "input"). It is then highlighted in a noticeable color so it stands out from text that is not typed in by the user.

Examples of usage:

For a non-root console:

<console>
$##i## run a command as user
</console>

Produces:

$ run a command as user

Examples of usage: