Welcome to the OpenCities help centre. Search for what you're after, or browse the categories.
Can't find what you're looking for? Submit a support ticket and we'll be in touch.


About the Document Libraries module

avatar of OpenCities Product Team

OpenCities Product Team

Last updated

The Document Libraries module is great for collecting and presenting groups of documents, either pertaining to one subject, or for the whole council or city. The module uses the OC Module Interface and OC Document content types to create a document listing and document entries.

An example of a document library listing

Document Libraries

The Document Library listing is built to present multiple documents in an efficient way. The listing presents in a stream and in alphabetical order, with an accordion entry for each OC Document page. Each accordion expands to reveal any WYSIWYG content and each document attached to the page. There are two WYSIWYG Editors on the listing page for introductory or supplemental content, and a search function that will allow your community to search documents by keyword.

Document Library listings can be used for different purposes. We've seen some councils or cities use them to create an overall listing of all their forms and documents, and link them to their Top Tasks, creating a pathway to find key forms easily.

We've also seen the use of them to list documents from just one section of the site such as listing all the governance policies, or list budgets and other financial documents by year. How you organize your documents will depend on which template you use for your listing page.

Create a Document Library listing page:

  1. Right-click in the site tree where you would like to create your listing page.
  2. Select Create Page.
  3. Choose the OC Module Interface content type.
  4. Select the OC Document Library - Global or OC Document Library - Relative template from the Template Name dropdown menu. For more information about the document listing templates see below.
  5. Fill out the necessary fields on your listing page.
  6. Save and Publish your page.

Document Library templates

There are 2 templates for document libraries. Each template will show accordion panels with the document title for each OC Document page. Both templates have a search function that your community can use to search for a document by phrase or keyword.

OC Document Library - Global:

  • Lists all document pages created on your site, regardless of where they exist in the site tree. (It’s best practice, though, to make OC Document pages child pages of this listing page so they’re easy to find) 
  • Stream layout
  • Search function on the right
  • 2 WYSIWYG content areas
  • Organized alphabetically
  • Use for an overall forms, policies and documents listing, which can apply to your whole site
A document library listing with the global template

OC Document Library - Relative:

  • Only lists document pages that are direct child pages of your listing page
  • Stream layout
  • Search function on the right
  • 2 WYSIWYG content areas
  • Organized alphabetically
  • Use for listing forms, policies or documents that fall under one section, such as government policies, or financial documents.
A document library listing with a relative template

Document library listing order

Both of the document library listing templates display documents in alphabetical order. A common request we've seen is to change this to a sequential order which mirrors your site tree. Here's how to do this:

What's next?

  1. Create an OC Document page
  2. Manage the Document Library module settings
Was this article helpful?
0 out of 2 found this helpful