Upgrade to Omeka Semantic

This repository contains the sources to build the pages that list the plugins, modules and themes of Omeka Classic and Omeka S.

To get the plugin that allows to upgrade automatically an Omeka Classic installation into Omeka Semantic, go to this page.

Update of the list of plugins, modules and themes

The lists are automatically generated from public sources on github and gitlab. Nevertheless, the new addons should be well referenced (via a readme or via a topic). To be sure it will be included, add the topic omeka, omeka-s, omeka-plugin, omeka-s-module, omeka-theme or omeka-s-theme to it on the main page of the addon, or use "Omeka" in the main readme of the addon repository.

To add badly referenced addons, simply fill its main url in the matching csv file in the directory _data/ and run the php script:

php _scripts/update_data.php

It is recommended to create API tokens for faster and more reliable data fetching:

• GitHub token (recommended): Save it in _data/token_github.txt. With a token, the script uses the GraphQL API (1 request per addon instead of ~8 REST calls). Without a token, the REST API is used with a limit of 60 requests/hour. Create a token at: https://github.com/settings/tokens (select "public_repo" scope).

• GitLab token (recommended): Save it in _data/token_gitlab.txt. A token increases GitLab API rate limits for addons hosted on GitLab. Create a token at: https://gitlab.com/-/user_settings/personal_access_tokens (select "read_api" scope).

Note that the first run of the script may take a while depending on your connection, since there are multiple requests per addon. With a GitHub token, the process is significantly faster (about 2 hours instead of 8+ hours).

Installation and development for Jekyll with theme Minima

For more info on local testing, see documentation on github pages. Github pages use currently these versions of Jekyll and Ruby.

For Debian 13:

sudo apt install ruby-full build-essential
# Exports should be added in .bashrc to avoid to export them each time.
export GEM_HOME="$HOME/gems"
export PATH="$HOME/gems/bin:$PATH"

# May or may not be sudo according to your installation.
sudo gem install rubygems-update
sudo update_rubygems
sudo gem update

# May be not installed by default.
gem install bundler eventmachine http_parser.rb sass-embedded

# The main process to run the site locally.
# Important: It should be done every time the file _config.yml is updated.
cd UpgradeToOmekaS
bundle install
bundle exec jekyll serve --incremental

By default, the site is served on http://localhost:4000/.

The site uses the theme minima. It is installed in the home directory (set above: ~/gems). To override a default file of the theme under ~/gems/gems/minima-2.5.2/, for example _includes/header.html, just copy it under the same hierarchy in the current directory.

TODO

• Check and choice of thumbnailer.
• Preload and preinstall during form filling.
• Fully install selections, not only download and unzip files.
• Selections with vocabularies, resource templates and custom vocabs.
• Reorder row in csv for forks: main first, forks next, gone last.
• Deeper plugin-to-module mapping: compare by description/functionality.
• Improve management of homonymous: some addons have a same name and features, but designed totally separately (e.g. ZipDownload).
• GitHub/GitLab synced repos: some addons have a repository on both platforms: sum stats.
• Unregistered forks: some repos are forks (same git history) but not declared in metadata (manual copy without fork button). Identify these cases by comparing initial commits or SHA history. Get the divergence commit, date and version.

Warning

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.

Troubleshooting

See online issues on the issues page on GitHub.

License

This tool is published under the CeCILL v2.1 licence, 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

• Copyright Daniel Berthereau, 2017-2026 (see Daniel-KM on GitLab)