This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

Introduction

A simple dexterity-based directory with faceted search. Developed initially as a directory of academic staff. This is designed to be used along with a Diazo theme to present the results.

Installation

Install as any other Plone add-on, i.e. add to your buildout.cfg and then enable your add-on in your site. See official install documentation for more advice.

Configuration

Before you start creating a directory, consider what fields you want your directory entries to have. For example, “department”, “favourite animal”, etc. Initially, directory entries have 2 fields, title and image. These can be edited or new fields added. To do this:

  • Go to the Plone control panel
  • Select “Dexterity content types”
  • Select “Directory Entry”
  • Click the “Fields” tab.

Add as many fields as you require, and/or alter the title/description of the existing fields.

Once set up, you can add a Person directory anywhere to your site using “Add new”.

Facets

If you would like the “department” field you configured earlier to be sortable with facets (i.e you can filter the entries with links down the right hand side), then you need to select in in the directories’ “Fields to filter by” list.

Suggestion Fields

If a field is selected as a facet, then you can also use the SuggestionFieldWidget on a TextLine field to show previously used values. To do this you need to alter the entry schema XML (click “Edit XML Field Model”) and change it to:

<field name="research_group" type="zope.schema.TextLine">
  <title>Research Group</title>
  <form:widget type="ibme.persondirectory.widget.SuggestionFieldWidget"/>
</field>

Entry images

By default, there is an image field that can be used to, e.g. add portraits. The image will be scaled by plone.app.imaging. You can alter the dimensions in the “Image Handling” section of the Plone control panel. Edit the “pdir-image” size.

Sorting

By default, entries are sorted alphabetically. However you can change this by editing the directory object.

Credits

Authors:

Developed as part of the Oxford IBME website.

Further work

The resulting display is rather uninspiring admittedly, this is most useful in combination with your own Diazo theme. However, the initial view could be tarted up a bit.

Changelog

1.1 (2013-08-30)

  • Instead of automatically using SuggestionFieldWidget fields, manually select which should be used as facets [lentinj]
  • Reindex all content below whenever a directory object is changed [lentinj]

1.0 (2013-08-01)

  • Ensure filters are sorted by title [lentinj]

0.1 (2013-07-03)

  • Initial release [lentinj]
Release History

Release History

1.1

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
ibme.persondirectory-1.1.zip (34.4 kB) Copy SHA256 Checksum SHA256 Source Aug 30, 2013

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting