Skip to main content

A referencebrowser implementation for Archetypes

Project description


This is an implementation of referencebrowser widget. It provides a widget used for Archetypes reference-fields. The widget can be used on its own or as a dropin replacement of the ATReferenceBrowserWidget in Plone 3 and is included in Plone >= 4. Unlike the ATReferenceBrowserWidget, archetypes.refencebrowserwidget uses an overlay instead of a popup to display the referencebrowser.


Version 1 of the product is a classical popup and works with Plone 3 and 4. Version 2 of the product displays the browser as a jQuery overlay. Currently it is only tested with Plone 4 and Plone 5.

Change history


2.5.11 (2020-03-21)

Bug fixes:

  • Minor packaging updates. [various] (#1)

2.5.10 (2017-12-11)

Bug fixes:

  • Drop dependency on [MatthewWilkes]

2.5.9 (2017-03-09)

Bug fixes:

  • Fix import location for Products.ATContentTypes.interfaces. [thet]

2.5.8 (2016-08-10)


  • Use zope.interface decorator. [gforcada]

2.5.7 (2016-02-12)


  • Fixed to work with Plone 5. [vangheem]

  • Updated to work with new plone.batching pagination selector as well as with old one. [thet]

2.5.6 (2015-11-27)


  • Do not fail if a level of the path we are adding the object using the ReferenceBrowser widget is not accessible by the current user. [gbastien]

2.5.5 (2015-10-27)


  • Show elements that the reader has no access to as “Undisclosed” instead of throwing Unauthorized. [pbauer]

2.5.4 (2015-09-27)

  • Follow README/CHANGES best practice. [tisto]

  • saner check for isNotSelf(), which was throwing KeyError [alecpm, tkimnguyen]

2.5.3 (2015-04-15)

  • #23 added parameter ‘use_wildcard_search’ to widget, True by default [gbastien]

  • Replaced jq usage with $ [keul]

  • Fixing reference sorting issue due to global function refactoring done on recent versions [keul]

  • Add labels for images in the popup widget. [mitakas]

  • #16 fix browsing for widgets in case field has set allowed_types

    (Warning: changed return value of view/getResult from [`brain1, brain2,..]` to [dict(item=brain1,browsable=True, referenceable=False),...] in case you customized [fRiSi]

2.5.2 (2014-09-11)

  • Fix the “Clear Reference” button, which was not working due to the refbrowser_removeReference function hidden in a anonymous function. [thet]

  • fixed allowed_types [agitator]

2.5.1 (2014-07-10)

  • Fix JavaScript for compatibility with jQuery 1.9 by using jQuery’s on, attached to document, instead of live. [thet]

  • Use foward compatable test for checked items with jQuery >=1.7 fixes [arterrey]

  • Fix non-multi reference selection when the referenced object no longer exists. [mattss]

2.5.0 (2014-02-23)

  • Do not use portal_interface tool but @@plone_interface_info (PLIP #13770). [ale-rt]

  • Filter out references that are None. This may happen when the reference_catalog has links from a source to a no longer existing target. [maurits]

2.4.19 (2013-08-13)

  • Modified pagination links selector to use only “.listingBar” instead of “div.listingBar”. The template can be customized in a theme and use a different structure, “ul.listingBar” for example. [vincentfretin]

  • If we have a sort_on parameter in base_query, use it instead of getObjPositionInParent to display folder content. [thomasdesvenain]

2.4.18 (2013-05-23)

  • Added two widget properties that allow to add help messages on popup, in two slots (top and bottom). [thomasdesvenain]

  • Added css ids in popup. [thomasdesvenain]

  • Wrap jQuery functions for better compatibility. [esteele]

2.4.17 (2013-03-05)

2.4.16 (2013-01-13)

  • Add an option of searching for related items by path. [plamut]

2.4.15 (2012-12-14)

  • Make new added references sortable with already existing ones while editing a content. Fixes [gbastien]

  • Use HTML5 placeholder attribute on search box. Replaces deprecated inputLabel class. [danjacka] (2012-11-07)

  • Fixed typo [tomgross]

2.4.14 (2012-10-18)

  • Use normalizeString to create class names for an item’s portal type and review state. Fixes [danjacka]

  • don’t let search fail on broken catalog [tomgross]

2.4.13 (2012-10-11)

  • Restored a “view” link on linkable items (as with Plone 3): It will open a preview of the element in a popup window. [keul]

  • Fixed referenced elements sort order on widget view. [gbastien]

  • Take search_index into account while used in popup search form. [gbastien]

2.4.12 (2012-08-11)

  • Show item icons in popup. [thomasdesvenain]

  • Limit the width of checkboxes column in popup. [thomasdesvenain]

2.4.11 (2012-04-09)

  • Fixed breadcrumbs internationalization in popup. [thomasdesvenain]

2.4.10 (2012-02-09)

  • We can restrict browsable types, with browsable_types parameter on widget. [thomasdesvenain]

2.4.9 (2011-12-08)

  • updated query to take allowed_types into account [hpeteragitator]

  • fixed form submission issue in ie #11984 [tom_gross]

2.4.8 (2011-11-23)

  • Completed [tom_gross]

2.4.7 (2011-11-23)

  • Added [tom_gross]

2.4.6 (2011-11-23)

  • Fixed release [tom_gross]

2.4.5 (2011-11-23)

  • Fixed tests for plone.uuid >= 1.0.2 [tom_gross]

2.4.4 (2011-08-19)

  • Fix: text searches should search outside navigation root [gotcha]

2.4.3 (2011-07-04)

  • Use label tags for selectable items. [esteele]

  • Fix: text search searches from navigation root. [thomasdesvenain]

  • moved checkPermission from widget template to helper [tom_gross]

  • Fix referencebrowser.js error when using allow_sorting = 1 [toutpt]

2.4.2 (2011-06-02)

  • Fix: overlay is not closed at item selection when field is multivalued. [thomasdesvenain]

  • Fix undefined variable checkPermission [kiorky]

  • Fix error in refbrowser_moveReferenceDown and refbrowser_moveReferenceUp which caused page reloads when a referenced item was moved twice. Refs [cewing]

  • Fix errors in sorting scripts which caused failure to detect items at head or tail of list of referenced items. Refs [cewing]

2.4.1 (2011-05-12)

2.4 (2011-04-11)

  • Fix regression in UID lookup in cases where plone.uuid is present, but not used for Archetypes content (such as with 1.0 on Plone 4.0) [davisagli]

2.3 (2011-04-01)

  • Fixed: widget did not work when search was disallowed. [thomasdesvenain]

2.2 (2011-02-25)

  • Fixed getStartupDirectory method if a startup_directory_method was defined, which cannot be traversed to. [hannosch]

  • check the references in the overlay that are checked in the widget when the overlay is constructed or refreshed. [csenger]

  • Don’t disable checkboxes in overlay when an item is selected. Remove the item from the value list when it is unchecked in the value list. fixes [csenger]

2.1 (2011-01-03)

2.0 (2010-09-06)

  • Fixed i18n of “You are here:”. [vincentfretin]

  • Set a minimum version for jquerytools, to avoid this problem #10939 [do3cc]

  • Encode search-URL. Fixes [tom_gross]

2.0rc2 (2010-07-29)

  • Make sure the popup can be closed by the same ways as other popups in Plone 4. Fixes [davisagli]

  • Fixed bug: pop-up didn’t render id of file with empty title because of improper use of TALES Path expression. Now uses browser method instead. [kleist]

2.0rc1 (2010-07-12)

  • Fixed link rebinding of pagination links (thanks Mustapha Benali!) [tom_gross]

2.0b4 (2010-06-02)

  • Fixed display of title (introduced in 2.0b3)

2.0b3 (2010-06-02)

2.0b2 (2010-04-23)

  • Adding missing return falses to prevent page reloads on reordering [cah190,esteele]

  • Mark already related objects visually in referencebrowser [tom_gross]

  • Only show sorting arrows on adding, if field is really sortable [tom_gross]

  • use Python doctest instead of zope.testing.doctest [tom_gross]

2.0b1 (2010-04-08)

  • Updated package description [tom_gross]

  • Merged javascript files to one, which is included only with the widget [tom_gross]

Detailed Documentation


The archetypes.referencebrowserwidget is a Plone/Archetype-widget for relation- fields. It adds a new reference widget that allows you to search or browse the portal when creating references. It can be used as a dropin-replacement for the default ATReferenceBrowserWidget or as a standalone widget.

To install it as a replacement just install the product via the quickinstaller. For using it as a standalone widget see the demotype in The widget tries to be ui-compatible with its predecessor ATReferenceBrowserWidget. You can use the same properties as for the standard ReferenceField and for the ATReferenceBrowserWidget.

When you use this widget, there are two buttons presented for each widget. One that opens a popup-window that let’s you do the search/browsing and one that let’s you clear the reference or selected references (will be in effect after the form’s Save).

The popop window basically consists of two parts. The top half is a search form and the bottom half is the browser/search results part. Both parts can be turned off or on using the widget’s properties.

The search part has additional configuration in the widget (see properties below).

The widget supports:

  • catalog-only query of popup-contents. This is massive! permformance win compared with ATReferenceBrowserWidget. Try accessing a folder with 10k+ objects with both widgets.

  • generic referencefield implementation via adapter. OOTB it supports Archetypes.ReferenceField and plonerelations.ATField.

  • overwrite the popup-template via namedtemplate-implementation

  • resizeable popup via simple properties

  • a good unittest and integrationtest coverage


The popup window can be configured using the following widget properties:

  • default_search_index: when a user searches in the popup, this index is used by default. It points to “SearchableText” by default.

  • show_indexes: in the popup, when set to True, a drop-down list is shown with the index to be used for searching. If set to False, default_search_index will be used.

  • size: in case of single-select widget, the default is set to 30. In case of multi-select, default is 8.

  • available_indexes: optional dictionary that lists all the indexes that can be used for searching. Format: {‘<catalog index>’:’<friendly name’>, … } The friendly name is what the end-users sees to make the indexes more sensible for him. If you do not use this property then all the indexes will be shown (I think nobody should allow this to happen!).

  • allow_search: shows the search section in the popup

  • allow_sorting: allows you change the order of referenced objects (requires multiValued=1)

  • allow_browse: shows the browse section in the popup

  • search_catalog: Catalog to use. Defaults to: portal_catalog

  • startup_directory: directory where the popup opens. Optional. When omitted, the current folder is used or in the case where a property refwidget_startupdirectories under site_properties is found it is searched for a startup_directory.

    Property is a lines field having the following format:


    path1 is the path where all widgets being under it set startup_directory to path2 if no startup_directory is set.

  • startup_directory_method: the name of a method or variable that, if available at the instance, will be used to obtain the path of the startup directory. If present, ‘startup_directory’ will be ignored.

  • restrict_browsing_to_startup_directory: allows you to restrict the breadcrumbs (‘allow_browse’ property) to contents inside the ‘startup_directory’ only. So you are not able to walk up in the hierarchy. (default: 0 = disabled)

  • image_portal_types: specify a list of image portal_types. Instances of these portal types are being previewed within the popup widget

  • image_method: specifies the name of a method that is added to the image URL to preview the image in a particular resolution (e.g. ‘mini’ for thumbnails)

  • show_review_state: allows you to display the workflow state for objects (off by default)

  • show_path: display the relative path (relative to the portal object) of referenced objects

  • only_for_review_states: items are only referencable if their workflow state matches the ones a specified (default: None = no filtering by workflow state)

  • history_length: enable a history feature that show the paths of the last N visited folders (default : 0 = no history)

  • force_close_on_insert: closes the popup when the user choses insert. This overrides the behavior in multiselect mode.

  • base_query: defines query terms that will apply to all searches, mainly useful to create specific restrictions when allow_browse=0. Can be either a dictonary with query parameters, or the name of a method or callable available in cotext that will return such a dictionary.

  • hide_inaccessible: don’t show inaccessible objects (no permission) in view mode.

  • show_results_without_query: Don’t ignore empty queries, but display results.

  • popup_width: Width of popup-window in pixel. Defaults to: 500

  • popup_height: height of popup-window in pixel. Defaults to: 550

  • popup_name: Name of template to be used for popup. To use another template you have to register a named adapter for this template. Like:


    for=”Products.Five.BrowserView” factory=”.view.default_popup_template” name=”popup” provides=”zope.formlib.namedtemplate.INamedTemplate” />

    See default implementation and unittests for examples.

Design notes

This notes were taken from the original ATReferenceBrowserWidget. Since I didn’t changed the ui, they are still valid (I think!?).

Both the templates (widget and popup) are prototypes. There are still some inline styles, especially in the popup because I didn’t want to tweak with plone’s css stuff and I didn’t want to do hacking and tricking to incorporate a stylesheet myself.So, that’s still a point of interest.

Furthermore I made some design decisions. Right now, in the popup window, all objects are shown (when browsing) and objects that may be referenced to are bold and the other objects are greyed out. I chose to show the non-referenceable objects too because they may be an important part of the context that help the user search for the desired objects to browse to. Another thing that I chose for is that in case of a multi-value widget, the popup remains open so that you can continue to add references without having to reopen the popup over and over again. Problem is that you have to close the window yourself. This may change if it turns out to be an annoyance.

A thing that is more related to forms in general is that the items in the multiselect listbox need to be selected before Save is clicked otherwise only the selected items are submitted. That kinda sucks usability-wise because now the user basically has to make two selections: first by choosing the items in the popup and secondly by selecting them again in the listbox. Right now I made it so that the items are selected by default but if the user starts clicking in the list, then there might be an issue. Btw, the inandout widget has the same problem. Best would be to select all the items in a script just before the form is submitted so that the complete list is submitted. But that requires changes in the base_edit form I think. But it’s something to think about since there are now already two widgets that needs to be prepared like this (inandout and this one, haven’t looked at picklist though, could have the same problem).

Anyway, have fun with it and if you have suggestions please let me know. If you see problems, please fix them when you can.



Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

archetypes.referencebrowserwidget-2.5.11.tar.gz (57.0 kB view hashes)

Uploaded Source

Built Distribution

archetypes.referencebrowserwidget-2.5.11-py2.py3-none-any.whl (54.1 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page