Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/daniel-km/omeka-s-module-table

Last synced: 3 days ago
JSON representation

Host: GitHub
URL: https://github.com/daniel-km/omeka-s-module-table
Owner: Daniel-KM
License: other
Created: 2023-06-05T07:39:16.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-07-22T16:01:33.000Z (4 months ago)
Last Synced: 2024-07-22T19:25:38.518Z (4 months ago)
Language: PHP
Size: 103 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

Table (module for Omeka S)
==========================

> __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.__

[Table] is a module for [Omeka S] that allows to manage tables of data, for
example a list of language codes, a list of country codes, or unimarc codes.
Each code can have multiple labels, for example for translations.

It is a library useful to normalize data or to denormalize them. It can be used
by some other modules or in themes:

- [Advanced Resource Template] to display a select for literal data. Unlike [Custom Vocab]
or [Value Suggest], the data type should be literal.
- [Advanced Search adapter for Solr] to normalize data to index and to search,
in particular when it is not possible to have consistent data because some
librarians want to fill languages, countries or other data as plain text and
other ones as an iso code with two letters, some other ones with the three
letters iso codes, some other ones with the three-letters bibliographic
variant, or when data are fetched from various external repositories with
specific codes.
- [Bulk Import] to convert codes into data (label, translation, or a more
standard code) or the reverse.
- [User Profile] to add a select in user form.

An associative table contains two columns: a code, a keyword or a uri and the
matching value or label, with an optional language.

When using a uri, the purpose is similar to a list of uris managed by the module
[Custom Vocab]. Of course, when possible, it is recommended to use online
standard vocabularies via module [Value Suggest], for example for countries or
languages.

Installation
------------

See general end user documentation for [installing a module].

This module requires the module [Common], that should be installed first.

* From the zip

Download the last release [Table.zip] from the list of releases, and
uncompress it in the `modules` directory.

* From the source and for development

If the module was installed from the source, rename the name of the folder of
the module to `Table`.

Then install it like any other Omeka module and follow the config instructions.

Usage
-----

Just fill the form: set a unique name (the slug, a lower case string starting
with a letter), a title, a language and fill the text area with a list of codes
and labels, separated with a `=`, one pair by line. A language may be appended
too when the table is not associative.

### User Profile and config of themes

To use a table in module [User Profile] or in config of themes, add it like that:

```ini
elements.userprofile_organisation.name = "userprofile_organisation"
elements.userprofile_organisation.type = "Table\Form\Element\TableSelect"
elements.userprofile_organisation.options.element_group = "profile"
elements.userprofile_organisation.options.label = "Organisation"
elements.userprofile_organisation.options.table = "organisation"
elements.userprofile_organisation.options.empty_option = ""
elements.userprofile_organisation.attributes.id = "userprofile_organisation"
elements.userprofile_organisation.attributes.class = "chosen-select"
elements.userprofile_organisation.attributes.data-placeholder = "Select an organisation…"
```

The option `table` can be the table id or the table slug.

TODO
----

- [x] Add an option to allow to use the same code for multiple values, for
example for multiple labels or languages or a code with different
meanings. The point is mainly the api representation.
- [ ] Use js [datatables] (or see packagist/github) or use direct edition (see
module Group).
- [ ] Provide common tables by default (languages, countries, unimarc).
- [ ] Finalize integration in resource template.

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 [module issues] page on GitLab.

License
-------

This module is published under the [CeCILL v2.1] license, compatible with
[GNU/GPL] and approved by [FSF] and [OSI].

This software is governed by the CeCILL license under French law and abiding by
the rules of distribution of free software. You can use, modify and/ or
redistribute the software under the terms of the CeCILL license as circulated by
CEA, CNRS and INRIA at the following URL "http://www.cecill.info".

As a counterpart to the access to the source code and 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 have only limited liability.

In this respect, the user’s attention is drawn to the risks associated with
loading, using, modifying and/or developing or reproducing the software by the
user in light of its specific status of free software, that may mean that it is
complicated to manipulate, and that also therefore means that it is reserved for
developers and experienced professionals having in-depth computer knowledge.
Users are therefore encouraged to load and test the software’s suitability 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 as regards security.

The fact that you are presently reading this means that you have had knowledge
of the CeCILL license and that you accept its terms.

Initially created for the digital Library [Numistral].

[Table]: https://gitlab.com/Daniel-KM/Omeka-S-module-Table
[Omeka S]: https://omeka.org/s
[Advanced Resource Template]: https://gitlab.com/Daniel-KM/Omeka-S-module-AdvancedResourceTemplate
[Advanced Search adapter for Solr]: https://gitlab.com/Daniel-KM/Omeka-S-module-SearchSolr
[Bulk Import]: https://gitlab.com/Daniel-KM/Omeka-S-module-BulkImport
[User Profile]: https://gitlab.com/Daniel-KM/Omeka-S-module-UserProfile
[Custom Vocab]: https://omeka.org/s/modules/CustomVocab
[Value Suggest]: https://omeka.org/s/modules/ValueSuggest
[Common]: https://gitlab.com/Daniel-KM/Omeka-S-module-Common
[installing a module]: https://omeka.org/s/docs/user-manual/modules
[Table.zip]: https://github.com/Daniel-KM/Omeka-S-module-Table/releases
[datatables]: https://datatables.net
[module issues]: https://gitlab.com/Daniel-KM/Omeka-S-module-Table/issues
[CeCILL v2.1]: https://www.cecill.info/licences/Licence_CeCILL_V2.1-en.html
[GNU/GPL]: https://www.gnu.org/licenses/gpl-3.0.html
[FSF]: https://www.fsf.org
[OSI]: http://opensource.org
[Numistral]: https://numistral.fr
[GitLab]: https://gitlab.com/Daniel-KM
[Daniel-KM]: https://gitlab.com/Daniel-KM "Daniel Berthereau"