ckanext-pages

Adds simple content pages to CKAN - an About page, a guide, a licence, news in a blog - written in Markdown or with a visual editor, without touching any template. Pages can sit in the site's main menu, or belong to an organization or a group and appear as one of its tabs.

Fork of ckan/ckanext-pages, maintained by Phen-ICS (CNRS/IGBMC) for the FAIR3R catalogue. Published on PyPI as ckanext-fair3r-pages; the plugin is still called pages.

What this fork changes

• One page order everywhere, set in the page form with two choices:

  • Position: where among the menu entries the page goes - 0 before the first entry, n after the n-th.
  • Rank (1-9): its order among the pages sharing that position, ties broken by title.

  It works the same for the site menu and for an organization's or group's tabs. Stored in the existing column: no migration.

• Organization and group pages become tabs: a page with an order appears in that organization's or group's own menu (next to Datasets, Members, Activity Stream...), highlighted when open. "Not in menu" keeps it in the Pages list only. A private page is shown to members only.

• CKAN 2.12 fixes: the Pages tab of an organization's activity stream no longer crashes, group/organization menu links point to the right endpoints, the page delete form has its CSRF token.

• French translation, and CI that tests, builds and publishes to PyPI on every merge.

Installation

1. Install the package in CKAN's virtualenv:

   pip install ckanext-fair3r-pages
   

2. Enable the plugin in ckan.ini. Put it before any plugin that overrides the same templates (FAIR3R puts it before fair3r):

   ckan.plugins = ... pages
   

3. Create its tables:

   ckan -c /path/to/ckan.ini db upgrade -p pages
   

4. Restart CKAN. Logged-in users get Pages and Blog icons in the account bar; sysadmins create site pages and blog posts there, and organization/group admins their own pages from its Pages tab.

Configuration

All optional.

Extending

Extra fields on pages: IPagesSchema

Add fields to the page schema from your plugin (listed before pages in ckan.plugins):

import ckan.plugins as plugins
import ckan.plugins.toolkit as toolkit
from ckanext.pages.interfaces import IPagesSchema


class MyPlugin(plugins.SingletonPlugin):
    plugins.implements(IPagesSchema)

    def update_pages_schema(self, schema):
        schema.update(
            {
                "new_field": [
                    toolkit.get_validator("not_empty"),
                    toolkit.get_validator("boolean_validator"),
                ]
            }
        )
        return schema

and show them in the form by extending ckanext_pages/base_form.html:

{% ckan_extends %}

{% block extra_pages_form %}
  {{ form.select('new_field', id='new_field', label='New Field',
                 options=[{'value': True, 'text': _('Yes')}, {'value': False, 'text': _('No')}],
                 selected=data.new_field) }}
{% endblock extra_pages_form %}

Your own CKEditor toolbar

The default CKEditor setup is in assets/js/ckedit.js. Override it from a script of your plugin, loaded on the page form:

this.ckan = this.ckan || {};
this.ckan.pages = this.ckan.pages || {};

$(document).ready(function () {
  window.ckan.pages.override_config = {
    toolbarGroups: [/* your toolbar */],
    extraPlugins: "",  // and load their assets from your plugin
  };
});

{% ckan_extends %}
{% asset 'my-plugin/pages-extra-config.js' %}

Tests

docker exec -u ckan -it ckan-app pytest --ckan-ini=/plugins/ckanext-pages/test.ini /plugins/ckanext-pages/ckanext/pages/tests

Always pass --ckan-ini: the fixtures empty the database they run against, and refuse to run unless its name contains test.

Credits and license

Originally written by the CKAN community. Released under the GNU Affero General Public License v3.0 - see LICENSE. History in CHANGELOG.md.

Optional dependency: lxml, only used to embed resource views in pages.