tainacan/src
vnmedeiros 8765c458b2 Merge branch 'feature/568' of github.com:tainacan/tainacan into feature/568 2021-09-01 14:47:32 -03:00
..
assets Fixes style on colleciton carousel and brings theme.js strategy to carousel-related-items 2021-07-29 17:07:59 -03:00
classes feat: update validate with cardinality for multiples metadatas #568 2021-09-01 14:47:20 -03:00
views Merge branch 'feature/568' of github.com:tainacan/tainacan into feature/568 2021-09-01 14:47:32 -03:00
migrations.php feat: add migration `create_control_metadata` #144 2020-10-29 17:35:56 -03:00
readme.txt Updates tags to version 0.18.5 2021-08-13 09:57:46 -03:00
tainacan.php Updates tags to version 0.18.5 2021-08-13 09:57:46 -03:00

readme.txt

=== Tainacan ===
Contributors: andrebenedito, daltonmartins, fabianobn, jacsonp, leogermani, weryques, wetah, eduardohumberto, ravipassos, jessicafpx, marinagiolo, omarceloavila, vnmedeiros, tainacan, r-guimaraes, suelanesilva, ccaio, alanargomes, ateneagarcia123, rodrigo0freire, clarandreozzi
Tags: museums, libraries, archives, GLAM, collections, repository
Requires at least: 5.0
Tested up to: 5.8
Requires PHP: 5.6
Stable tag: 0.18.5
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-3.0.html


Tainacan is an open-source, powerful and flexible digital repository platform for WordPress. With all the tools of a professional repository platform, you can manage and publish your digital collections as easily as posting to your blog. It is versatile and can be used to create a digital collection, a digital library or a digital repository for your institutional or personal collection.
 
== Description ==
 
[Tainacan](https://tainacan.org/) is an [open-source](https://github.com/tainacan/tainacan), powerful and flexible digital repository platform for WordPress. Manage and publish your digital collections just as easily as you post to your blog, having all the tools of a professional repository platform. It can be used for the creation of a digital collection, a digital library or a digital repository for your institutional or personal collection. 

Tainacan aims to facilitate the activities of organizing, documenting, disseminating and displaying digital objects based on simple and accessible principles of digital curation. The plugin integrates with the Wordpress block engine, making it easy to reuse objects for different and varied uses.


 
= Features =
 
* "Metadata and Filters": Use a metadata standard or choose whatever set of metadata you want to describe the items in your collections. Also, choose which metadata will be used as a filter when browsing collections.
 
* "Faceted Search". Browse your collection (and let the public browse it) using a faceted search interface with the filters you have chosen.
 
* "Manage Taxonomies": Manage vocabularies that can be used across all your collections.
 
* "Themes": The Tainacan plugin has its own default theme, which helps you to showcase your collections in a beautiful and effective manner. But it can also work with any WordPress theme, so interface developers can easily add Tainacan specific features to an existing theme.
 
* "API and Interoperability": Tainacan implements a RESTful API (read and write) to allow other applications to interact with your repository. That way, you can expose your collection in different formats, such as JSON, JsonLD, OAI-PMH and others. If your collection has a specific set of metadata, you can map this metadata to match the patterns you want to use.
 
* "Gutenberg blocks": Tell stories with your collections. Tainacan offers you several Gutenberg blocks so you can present your collections to the public in many different ways!
 
== Getting Started ==
 
After installation, you will see a new menu item in your admin panel called "Tainacan". Click on it to open the Tainacan admin interface.
 
To get an overview of the main concepts of Tainacan, please visit [this page](https://tainacan.github.io/tainacan-wiki/#/general-concepts).
 
= Create a collection =
 
Click "New Collection" to create a new collection, use a mapping standard or import it using one of our importers.
 
= Configure your collection =
 
Navigate to the top menu to set your collection up. Create the metadata that items in this collection will have, and choose, from these metadata, which ones are going to be used as a filter.
 
= Add items =
 
Back to the "Items" screen, click "Add new" to create a new item.
 
= Manage and browse your collection =
 
Through this admin interface you can manage your collection and browse its item using the faceted search interface or advanced search interface.
 
If you want to visit your collections in the public side of your site, using your current theme, visit http://your-site/collections and you will get the list of your collections.
 
= Set up Taxonomies =
 
You can also have metadata as taxonomies, which you can configure with a set of hierarchical terms of your own vocabulary.
 
= Add links to your menu =
 
Edit your menu and links directly to your collections. Click "Screen options" at the top of the Menu edition page and enable "Collections".
 
If you want to add a link to the list of collections, click "View all" tab on the Collections box on the left, and then add the first item named "Collections" to the menu.
 
= Faceted search in your theme =
 
To have a fully-featured faceted search in your theme, you can either make it compatible with a few templates or use our Faceted Search Block.  
 
== Installation ==
 
Upload the files to the plugins directory and activate it. You can also install and activate directly from the admin panel.
 
If you have Imagick installed in your server, Tainacan will be able to automatically generate a thumbnail from your PDF files. This is desired but not required.
 
== Find out more ==
 
* Visit our official website: [https://tainacan.org/](https://tainacan.org/)
* Contribute to the source code: [https://github.com/tainacan/tainacan](https://github.com/tainacan/tainacan)
* Check our documentation Wiki: [https://wiki.tainacan.org/](https://wiki.tainacan.org/)
 
== Screenshots ==
 
1. Manage your repository
2. Set up your collection
3. Choose the metadata and filters for your collection
4. Add items described by your metadata
5. Set up your item as a file, link or text and attach many types of documents
6. Browse your collections with a faceted search interface
7. Navigate through rich filtering interface
8. Explore more with Advanced Search
9. Set up Taxonomies to be used across your repository
10. Bulk edit as many items as you need quickly
11. Expose your collection using Tainacan default theme
12. Use Gutenberg blocks to display your collections in posts and pages
13. Choose which items will be displayed in your block
14. Items displayed using a Gutenberg block