New versions of this module and support for Omeka S version 3.0 and above are available on GitLab, which seems to respect users and privacy better than the previous repository.
Next is a module for Omeka S that brings together various features too small to be a full module. They may be integrated in the next release of Omeka S, or not.
Most of features are now integrated in Omeka S or in modules, in particular Block Plus, Common and Easy Admin.
To use features from Omeka S v3.0 to Omeka S v4.0, you should use versions of the module until 3.4.48. New versions of the module will support only Omeka S v4.1 or greater.
Determine the position of an item set in the site.
The json standard doesn’t require to escape anything, except ", "" and control characters. But php and Zend escape many other characters by default : tags, ampersand, apostrophe and overall the slashes "/" and the unicode characters, making json unreadable in many cases, whereas it’s designed to be readable by people and machines. So this feature displays the api output as unicode and unescaped, so it can be readable by people who don’t have a json viewer in their browser (#1493).
Of course, when used inside html, it must be escaped.
This feature was moved to modules Menu and Block Plus and improved since version 3.3.41.
A breadcrumb may be added on resources pages via the command echo $this->breadcrumbs();.
The default template is common/breadcrumbs.phtml, so the breadcrumb can be
themed. Some options are available too.
By default, the breadcrumb for an item uses the first item set as the parent
crumb. The first item set is the item set with the smallest id. If you want to
use another item set, set it as resource in the property that is set in the main
settings, or in the options of the view helper.
This feature was moved to module Menu and improved since version 3.3.42.
Allow to get the previous or the next resources, that simplifies browsing like in Omeka Classic. An option allows to use it in admin board. For sites, there is a specific option to limit and to order items and item sets according to a standard query.
To use it, you need to add this in the item, item set, or media show page of the theme:
<?php
$plugins = $this->getHelperPluginManager();
$hasNext = $plugins->has('previousResource');
?>
<?php if ($hasNext): ?>
<div class="previous-next-items">
<?php if ($previous = $this->previousResource($resource)): ?>
<?= $previous->link($translate('Previous item'), null, ['class' => 'previous-item']) ?>
<?php endif; ?>
<?php if ($next = $this->nextResource($resource)): ?>
<?= $next->link($translate('Next item'), null, ['class' => 'next-item']) ?>
<?php endif; ?>
</div>
<?php endif; ?>This block is now managed by module Block Plus since version 3.1.2.12.
Allow to use a page as a block, so the same page can be use in multiple sites, for example the page "About" or "Privacy". Of course, the page is a standard page and can be more complex with multiple blocks. May be fun. This is an equivalent for the shortcode as a page in Omeka classic too.
This feature is now managed by modules Block Plus since version 3.4.15.11 and module Menu since version 3.4.8.
Allow to check if the current page is the home page of the site, like in Omeka Classic.
This feature was moved to module Block Plus since version 3.3.11.8.
Allow to get the url of the thumbnail of a resource, a page or a site.
Warning: For site, the module Advanced Search Plus is needed when there is no
page with a thumbnail (the module provides the api for the url argument has_thumbnails).
Display direct links to the current resource in the public user bar in order to simplify edition and management of resources (fix #1283, included in Omeka S 1.4). The revert links are available too. They display the resource in the default site, or in the first one (fix #1259).
Display resources in a random order, for example for a carousel or a featured
resource. Simply add sort_by=random to the query when needed, in particular
in the page block Browse preview (fix #1281).
Allow to do more advanced search in public or admin board on values of the properties: start with, end with, in list (fix #1274, #1276). This feature is moved to module Advanced Search Plus in Omeka 3.
Display only the used properties and resources classes in the advanced search form, via a site setting (fix [#1423]). This feature is integrated in Omeka 3.
In some cases, a change is required in the theme. In the files themes/my-theme/common/advanced-search/properties.phtml
and themes/my-theme/common/advanced-search/resource-classes.phtml, add this option
below apply_templates:
'used_terms' => $this->siteSetting('next_search_used_terms'),This feature was moved to module Block Plus and Easy Admin since version 3.4.47.
Allow to get the previous or the next resources, that simplifies browsing like in Omeka Classic. An option allows to use it in admin board. For sites, there is a specific option to limit and to order items and item sets according to a standard query.
To use it, you need to add this in the item, item set, or media show page of the theme:
<?php
$plugins = $this->getHelperPluginManager();
$hasNext = $plugins->has('previousResource');
?>
<?php if ($hasNext): ?>
<div class="previous-next-items">
<?php if ($previous = $this->previousResource($resource)): ?>
<?= $previous->link($translate('Previous item'), null, ['class' => 'previous-item']) ?>
<?php endif; ?>
<?php if ($next = $this->nextResource($resource)): ?>
<?= $next->link($translate('Next item'), null, ['class' => 'next-item']) ?>
<?php endif; ?>
</div>
<?php endif; ?>This feature was moved to module Block Plus since version 3.4.47.
Allow to go back to the last list of results in order to browse inside item sets, items or media after a search without losing the search results. The helper is used by default in admin resources pages.
Allow to get the current site in public view, that may be missing in some cases.
Display resources in a specific order in the item set main page in front-end, for example by title or identifier. This option can be specified differently for each site.
Since 3.1.2.7, this feature has moved to module Bibliography, that uses a template view to easily customize it. The view helper doesn’t change.
Remove leading and trailing whitespaces preventively on any resource creation or update, or curatively via the batch edit, so values will be easier to find and to compare exactly (fix #1258).
Warning: This feature is removed in the version for Omeka 3, but is available in an improved version in module Bulk Edit.
Remove exact duplicated values on any new or updated resource preventively. Note: preventive deduplication is case sensitive, but curative deduplication is case insensitive (it uses a direct query and the Omeka database is case insensitive by default).
Warning: This feature is removed in the version for Omeka 3, but is available in an improved version in module Bulk Edit.
- From the site permissions to the user page (fix #1301).
Display a button "Public view" in resource show pages.
This feature was moved to module Easy Admin since version 3.4.8.
An option is added to select the metadata to display in the main browse view (fix #1497). This option in no more integrated in the module, but available through the pull request. Included in Omeka S v4 via user settings.
Allow to use $this->logger() in the views (fix #1371, included in Omeka S 1.4).
Allow to get the current site in public view, that may be missing in some cases (included in Omeka S v4).
This feature was moved to module Generic more simply, then to module Common.
A class to simplify management of generic methods of the module (install and settings).
This feature was moved to module XML Viewer since version 3.3.40.
In Omeka core, all xml files are identified as text/xml and zip files as application/zip,
so it’s not possible to make a distinction between a mets file and an ead file,
or to identify an epub, that is a zipped xhtml. This feature is required to use
the module Verovio when files don’t use the extension "mei" (#1464).
This feature was moved to module Easy Admin since version 3.3.42.
A script allows to run jobs from the command line, even if they are not initialized. It’s useful to run cron tasks. See required and optional arguments:
php /path/to/omeka/modules/Next/data/scripts/task.php --helpIn your cron tab, you can add a task like that:
/bin/su - www-data -C "php /var/www/omeka/modules/Next/data/scripts/task.php" --task MyTask --user-id 1Note: since there is no job id, the job should not require it (for example,
method shouldStop() should not be called. The use of the abstract class AbstractTask,
that extends AbstractJob, is recommended, as it takes care of this point.
This feature was moved to module Easy Admin and improved since version 3.3.42.
A task (job) allows to update all items, so all the modules that uses api events are triggered. This job can be use as a one-time task that help to process existing items when a new feature is added in a module.
php /path/to/omeka/modules/Next/data/scripts/task.php --task LoopItems --user-id 1Install module Common first, that is a required dependency.
Uncompress files and rename module folder Next. Then install it like any
other Omeka module and follow the config instructions.
See general end user documentation for installing a module.
- Normalize the breadcrumbs with Laminas navigation (module Menu).
- Move all navigation and theme helpers to module BlockPlus.
- [-] Site permission links to user page (v3)
Use it at your own risk.
It’s always recommended to backup your files and your databases and to check your archives regularly so you can roll back if needed.
See online issues on the module issues page on GitLab.
This module is published under the CeCILL v2.1 license, compatible with GNU/GPL and approved by FSF and OSI.
In consideration of access to the source code and the rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software’s author, the holder of the economic rights, and the successive licensors only have limited liability.
In this respect, the risks associated with loading, using, modifying and/or developing or reproducing the software by the user are brought to the user’s attention, given its Free Software status, which may make it complicated to use, with the result that its use is reserved for developers and experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the suitability of the software as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions of security. This Agreement may be freely reproduced and published, provided it is not altered, and that no provisions are either added or removed herefrom.
- Copyright Daniel Berthereau, 2018-2024 (see Daniel-KM on GitLab)