Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

Planning an example site: the club portal

The book's worked planning example, a portal for a nature photography and astronomy club, turned into a recipe for planning any site: requirements, classes, the tree, with the classes written out as attribute lists.

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/book-learning/planning-an-example-site.md

On this page

Planning an example site: the club portal

The book ends its content chapter with a planning exercise, and it is a good one. The project: a portal for a nature photography and astronomy club. Use it as a template for your own planning, with the order the book follows: requirements, classes, structure, sections, groups, roles.

1. Requirements

A public part: documents, members' pictures in galleries, discussion forums, a calendar of activities, logbooks, news with a subscription service, and a few personal features for registered users. A private part for the club's management: statutory documents, meeting reports, actions and private discussions.

The book's point: with a flexible model you often have more than one way to do it. Reduce the number of classes. Ask for each: is it the same thing with a flag, or a different thing?

2. The classes

ClassAttributes (datatype)
DocumentTitle (text line); Intro (rich text); Body (rich text); Attachment (file); Keywords (keywords, an automatic "related documents"); Related items (object relation list); Allow comments (check box); Show on the home page as news (check box)
Logbook entrySubject (text line); Body (rich text); Related items published elsewhere (object relation list). The logbook itself is a folder.
ImageTitle; Description (rich text); Image; Caption (text); Equipment used (rich text); Date and time; Location (rich text); Keywords
Forum messageSubject; Message (plain text); Type (selection: question, remark, important news ...). The forum is a folder.
Calendar itemSubject; Description; Location; Start and end date and time; Keywords; Category (selection); Related items
Dummy objectName (text line). Used as a hook for special pages such as the home page, with a template of its own.
LinkThe standard link class: title, description, link.

The datatypes are in the datatypes tour; to create a class see creating a content class. Comments are added with templates (common template tasks). Today you could also use the shipped classes of the site package you installed (article, folder, image, file, link, comment) and add only what is missing.

3. The tree

Home (dummy object: aggregates news and other items)
  News (with an archive navigator)
  Documents: Technical documents, Meeting reports, Miscellaneous
  Calendar of events
  Links: Astronomy related, General photography
  Galleries: Astronomy, Nature
  Forums: Announcements, Astronomy related, Nature related
  My site (personal)
  Restricted part: Forum, Statutory documents

The structure is plain on purpose. The visual experience comes from the templates (content and presentation). Check your plan by drawing the tree and walking one visitor through it.

4. Sections, groups, roles

Next: users, groups and roles in the example.

Source and license

Adapted from chapter 2, "Content Management with eZ publish", of Learning eZ publish: Building Content Management Solutions by Paul Borgermans, Tony Wood, Paul Forsyth, Martin Bauer, Björn Dieding and Ben Pirt (additional material by Bruce Morrison), second edition, 2024, Book-Learning-eZPublish. Copyright (c) 2004-2024 7x and Graham Brookins. Licensed under the GNU Free Documentation License, version 1.3 or any later version, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts (the license). Changes: rearranged and shortened; settings, labels, datatypes, tags and URLs checked against Exponential 6 and corrected; links to the current guides added.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x