@plone-collective/volto-bookmarks

volto-bookmarks

Plone (Volto) add-on

Features

Add and manage bookmarks of pages and searchkit queries.

Bookmarks are grouped by the value of a selectable content type field.

Getting started

There are two options:

• Buttons in toolbar
• Buttons somewhere else

Installation

• Provide the necessary REST API endpoints for your Plone backend by installing collective.bookmarks

• Remember to install souper in Plone backend control panel.

• Install this Plone (Volto) add-on @plone-collective/volto-bookmarks. See Volto docs for instructions.

• Merge add-on translations into your Volto app. Available translations so far:

  • german.

yarn
yarn i18n

Integration of the two bookmark buttons

Option 1 - buttons in toolbar

This requires Volto >= 16.10.0 with a pluggable toolbar.

Include bookmarking in your Volto project by creating and integrating a component Bookmarking.

Bookmarking.jsx:

import { Plug } from '@plone/volto/components/manage/Pluggable';
import {
  ToggleBookmarkButton,
  ShowBookmarksToolbarButton,
} from '@plone-collective/volto-bookmarks/components';

const Bookmarks = () => {
  return (
    <>
      <Plug pluggable="main.toolbar.top" id="toggle-bookmarks">
        <ToggleBookmarkButton />
      </Plug>
      <ShowBookmarksToolbarButton />
    </>
  );
};
export default Bookmarks;

config.js:

import Bookmarking from './components/Bookmarking';

import '@plone/volto/config';

export default function applyConfig(config) {
  config.settings.appExtras = [
    ...config.settings.appExtras,
    {
      match: '/',
      component: Bookmarking,
    },
  ];
  return config;
}

This adds two buttons in toolbar: one for toggling the bookmark of the current page and one for displaying a menu with a list of bookmarks.

Option 2 - buttons not in toolbar, but somewhere else

Add the two buttons to components of your choice:

import { ShowBookmarksContentButton } from '@plone-collective/volto-bookmarks/components';

    <ShowBookmarksContentButton />

import { ToggleBookmarkButton } from '@plone-collective/volto-bookmarks/components';

    <ToggleBookmarkButton />

Further configuration for both options

Add a mapping for bookmark groups labels and the name of the field for grouping bookmarks list.

config.settings.bookmarks = {
  ...config.settings.bookmarks,
  bookmarkgroupmapping: {
    manual: 'Manuals and HowTos',
    releasenote: 'Release Notes',
    default_search: 'Search',
    default_nogroup: 'Miscellaneous',
  },
  bookmarkgroupfield: 'informationtype',
};

Add a mapping for search filters:

    config.settings.bookmarks.filtermapping = {
      facet_fields: {
        '5237dc43-c573-4651-a5b8-cf24bfde13a6': 'Datendrehscheibe',
        allgemeines: 'Allgemeines',
        arbeitsliste: 'Arbeitsliste',
        beb2k: 'BEB2k',
        'release-note': 'Release-Note',
        tutorial: 'Tutorial',
        'superuser-innen': 'Superuser/innen',
        ai: 'AI',
        andere: 'Andere',
        tg: 'TG',
        zh: 'ZH',
      },
      search_sections: {
        others: 'Website',
        dokumentation: 'Dokumentation',
        inside: 'IGIB-Inside',
        geologie: 'Geologie',
      },
    },

Copyright and License

Author Katja Süss, Rohberg, @ksuess https://www.rohberg.ch

Copyright (c) 2023 Plone Foundation

See LICENSE.md for details.