https://wiki.folger.edu/collections-architecture-portal/_mw/api.php?action=feedcontributions&user=EricJohnson&feedformat=atomMiranda Behind-the-Scenes Portal - User contributions [en]2024-03-29T11:17:01ZUser contributionsMediaWiki 1.39.6https://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=Main_Page&diff=159Main Page2019-01-11T22:28:52Z<p>EricJohnson: /* Table of contents */</p>
<hr />
<div>Welcome to the <strong>Behind-the-Scenes Portal </strong>for the Miranda Digital Asset Platform<strong>.</strong> This portal documents the human and technical development processes that make the Miranda project possible. The Miranda prototype was made public in fall 2017, with an alpha release in May 2018 and a beta launch in January 2019. We will continue to update the platform throughout 2019 and beyond. <br />
<br />
This portal contains information about what is currently available on the Miranda platform (beta) and outlines some of the work we will be doing in the concluding phase of the project. For technical (and technical-leaning) folks, there is also information on how the platform itself works, how to interact with the platform's APIs, and how data imports are processed. <br />
<br />
All of the platform code will be linked here by the project's conclusion. However, we regret that we cannot provide support for other installations of the platform outside of [http://collections.folger.edu the official site]. The code repository for the 2017 Miranda [https://github.com/ParsonsTKO/FolgerMirandaClient prototype client] and the [https://github.com/ParsonsTKO/FolgerMirandaServer prototype server] is hosted on Github. Our primary technical partner is [https://parsonstko.com ParsonsTKO]. The Miranda project is made possible with generous support from the [https://www.mellon.org Andrew W. Mellon Foundation]. <br />
<br />
Miranda is a work in progress. We would love to hear your comments, questions, and ideas. Send us a note at miranda@folger.edu - we look forward to hearing from you. <br />
<br />
== Table of contents ==<br />
* [[Introduction to the platform]]<br />
* [[What's in Miranda: Content Types|Platform contents]]<br />
* [[International Image Interoperability Framework|International Image Interoperability Framework (IIIF)]]<br />
* [[My Shelf]]<br />
* [[Topics and Stories]]<br />
* [[Taxonomies]]<br />
* [[Data model]]<br />
* [[The Miranda API]]<br />
* [[Advanced search]]<br />
* [[Technical Architecture]]<br />
* [[Licensing Agreements]]<br />
* [[Team]]<br />
* [[Advisory committee]]</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=Advanced_search&diff=158Advanced search2019-01-11T22:27:07Z<p>EricJohnson: </p>
<hr />
<div>Most online platforms offer two means of searching their holdings: a basic search, with a few limited options for discovering and narrowing the results, and an advanced search, with a far wider number of ways to slice and dice what you get back from a search.<br />
<br />
Currently, Miranda offers only the first: When you hit the main page, you'll see a keyword box. A dropdown option next to the keyword box lets you restrict your search by type of material: whether you want to find sound, video, manuscript texts, or printed works, among other options. Selecting "more search options" below this box offers the opportunity to restrict your keyword search by date, language, or genre, and whether records hold a digital object that is "available online." <br />
<br />
In the next phase of the project (through the end of 2019), we will be working to provide an advanced search function for users who need the enhanced capabilities that it will bring.</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=The_Miranda_API&diff=157The Miranda API2019-01-11T22:24:48Z<p>EricJohnson: copyedits</p>
<hr />
<div>Miranda has a web interface available at [https://collections.folger.edu/ collections.folger.edu/], but that's not the only way to access the Folger's unified collections. Our interface relies upon a GraphQL API available to all comers at https://collections.folger.edu/graphql. <br />
<br />
An API, or Application Programming Interface, is a way for programs to talk to each other. (Or, sometimes, for dedicated individuals to talk to computer programs.) [https://graphql.org GraphQL] offers an approach to APIs that lets the requestor define what is returned.<br />
<br />
[[:File:Miranda API Introduction (1).pdf|Read our API guide]] written by the technical team at ParsonsTKO. Please note that this version was written in accompaniment to our Miranda beta launch, and represents work done so far. It is not final documentation.</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=Taxonomies&diff=156Taxonomies2019-01-11T22:22:48Z<p>EricJohnson: copyedits</p>
<hr />
<div>Through the Miranda project, we worked to adapt the Folger's current taxonomies to best describe our collections for our users. We came up with [[:File:Taxonomies Draft: Folger Shakespeare Library.xlsx|unified taxonomies]] which we employed in Miranda, and which we will continue to refine and adjust our taxonomies as the project moves forward. We will make every effort to keep this page up to date, but there may be slight differences between this list and what is available on the Miranda platform. <br />
<br />
Below, we have included definitions for our genre and format taxonomy terms.<br />
<br />
'''Genre Taxonomy''' <br />
<br />
Categories in this taxonomy describe the intellectual content of items, as opposed to their format or structure. We are working through places where there are gaps or overlaps in categories with the Format taxonomy. <br />
<br />
* Art: Visual (artistic) materials, including architectural drawings, historical art, landscapes, art related to performances or other events, portraits, and prints and printmaking materials <br />
* Commentary: Treatises or series of comments that explain or annotate another work. <br />
* Communications: Items intended to convey awareness, knowledge, or information to others. Including but not limited to: cards, telegrams, letters. <br />
* Derivative works: Works that are based on one or more pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which a work may be recast, transformed, or adapted. <br />
* Humor: Comical works intended to provoke laughter and provide amusement <br />
* Literary and performing arts: Works of drama, dance, music, prose, poetry, cinema, television, etc... <br />
<br />
* News: Letters, reports, serials, newsbooks, corantos, or other written communications that communicate news. May be published at stated, frequent, or regular intervals and contain news, articles, editorials, features, advertisements, and/or other items of current interest. This category also includes news clippings: illustrations, pages, articles, or columns of text removed from books, newspapers, journals, or other printed sources and kept for their informational content. <br />
* Official Documents: Records, in law, having the legally recognized and judicially enforceable quality of establishing some fact (from AAT, "official documents"). May be related to financial, legal, government or personal official documents. May include deeds, licenses, legal notices, or official documents of a personal nature <br />
* Performance materials: Documents or materials used in or related to a performance. May be used by performers, or ephemera that results from a performance, intended for audiences. Examples include playbills, prompt books. <br />
* Promotional materials: Printed matter or objects devised to advertise or promote products, causes, or other concerns, especially those items given away to prospective consumers, clients, or contributors. <br />
* Realia: Physical objects (not books or audio-visual materials) that were produced for use, decoration, or entertainment. <br />
* Reference: Works intended primarily for consultation rather than for continuous reading. <br />
<br />
<br />
'''Format Taxonomy'''<br />
<br />
These categories describe the original format of an item, not the format of its digital representation. They describe the structure or format of an item, not its intellectual content. We are working through gaps and overlaps in these two taxonomies.<br />
<br />
* Text: a manuscript or printed document, including books and letters.<br />
* Audio: Refers to sound recordings, stored electronically, in any media. May include items such as podcasts or audiobook recordings, or recordings of lectures or performances<br />
* Image: Refers to images, in any medium but usually referring to paintings, drawings, prints, photography, or digital works.<br />
* 3D object: Items Having, or appearing to have, the three dimensions of length, width, and height. May include ceramics, human hair, statues, a bust of Shakespeare carved in salt<br />
* Dataset: a set of data or information that can be interpreted and reinterpreted in quantitative analysis of a subject<br />
* Interactive resource: Use to describe two-way systems involving feedback from a viewer or user, to obtain data or commands and to give immediate results or updated information. <br />
* Video: Refers to manifestations of motion pictures, stored electronically, in any media.</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=Stories_and_Topics&diff=155Stories and Topics2019-01-11T22:18:01Z<p>EricJohnson: copyedits</p>
<hr />
<div>As Miranda develops, we are integrating curated content and multimedia-driven narratives as means of navigating Miranda and learning more about the world of the Folger. These are our Topics and Stories sites. <br />
<br />
Both sets of sites are built in a WordPress multisite template that has been made for the Folger's use, with partner Sites by Coop. The template is modular, composed of modules for different text blocks and media elements. With the multisite capabilities, we want to make it easier for Folger staff to share knowledge in a technically sustainable and simple manner, and to ensure we can maintain these sites over time.<br />
<br />
'''Topics'''<br />
[[File:Screen Shot 2019-01-09 at 1.43.23 PM.png|right|frameless]]<br />
Topics are brief introductions to an area of the collection, and to items which can spur a user on their search. For the beta version, we are beginning with an initial set of short Topic pages on popular Shakespeare plays. We will expand the Topic pages beyond Shakespeare's works and into different aspects of the Folger's holdings, reference questions, and more.<br />
<br />
[[File:Screen Shot 2019-01-09 at 1.44.27 PM.png|left|frameless]]<br />
'''Stories'''<br />
<br />
Stories are longer narratives that offer a thematic tour through an area of the Folger's collection and sometimes with the collections of other cultural institutions. Stories sites can be both stand-alone or complementary to physical exhibitions on the Folger's campus. <br />
<br />
'''Featured Results'''<br />
<br />
Featured Results is a means of promoting certain Folger content pages to the top of broad search results. Searches for "king john" or "king john shakespeare," for example, will lead to a first ranking Featured Result that is the Topic page for Shakespeare's play King John. As we build up Topic pages over time, our goal is for Featured Results to help orient users to content that may be interesting to them.<br />
<br />
'''WordPress Plugin'''<br />
<br />
We are in the process of completing a Miranda WordPress plugin, using the IIIF-produced Universal Viewer. Once it is installed on WordPress-powered sites, the plugin allows users to insert Miranda records with digital objects using a simple shortcode and the alphanumeric Miranda ID. We will be installing the plugin first on Topics and Stories sites, and then will release it to the public by the time the project concludes.</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=Main_Page&diff=154Main Page2019-01-11T22:15:13Z<p>EricJohnson: </p>
<hr />
<div>Welcome to the <strong>Behind-the-Scenes Portal </strong>for the Miranda Digital Asset Platform<strong>.</strong> This portal documents the human and technical development processes that make the Miranda project possible. The Miranda prototype was made public in fall 2017, with an alpha release in May 2018 and a beta launch in January 2019. We will continue to update the platform throughout 2019 and beyond. <br />
<br />
This portal contains information about what is currently available on the Miranda platform (beta) and outlines some of the work we will be doing in the concluding phase of the project. For technical (and technical-leaning) folks, there is also information on how the platform itself works, how to interact with the platform's APIs, and how data imports are processed. <br />
<br />
All of the platform code will be linked here by the project's conclusion. However, we regret that we cannot provide support for other installations of the platform outside of [http://collections.folger.edu the official site]. The code repository for the 2017 Miranda [https://github.com/ParsonsTKO/FolgerMirandaClient prototype client] and the [https://github.com/ParsonsTKO/FolgerMirandaServer prototype server] is hosted on Github. Our primary technical partner is [https://parsonstko.com ParsonsTKO]. The Miranda project is made possible with generous support from the [https://www.mellon.org Andrew W. Mellon Foundation]. <br />
<br />
Miranda is a work in progress. We would love to hear your comments, questions, and ideas. Send us a note at miranda@folger.edu - we look forward to hearing from you. <br />
<br />
== Table of contents ==<br />
* [[Introduction to the platform]]<br />
* [[What's in Miranda: Content Types|Platform contents]]<br />
* [[International Image Interoperability Framework|International Image Interoperability Framework (IIIF)]]<br />
* [[My Shelf]]<br />
* [[Topics and Stories]]<br />
* [[Taxonomies]]<br />
* [[Data model]]<br />
* [[The Miranda API]]<br />
* [[Advanced search]]<br />
* [[Technical Architecture]]<br />
* [https://wiki.folger.edu/collections-architecture-portal/Licensing_Agreements Licensing agreements]<br />
* [[Team]]<br />
* [[Advisory committee]]</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=Main_Page&diff=153Main Page2019-01-11T22:14:01Z<p>EricJohnson: </p>
<hr />
<div>Welcome to the <strong>Behind-the-Scenes Portal </strong>for the Miranda Digital Asset Platform<strong>.</strong> This portal documents the human and technical development processes that make the Miranda project possible. The Miranda prototype was made public in fall 2017, with an alpha release in May 2018 and a beta launch in January 2019. We will continue to update the platform throughout 2019 and beyond. <br />
<br />
This portal contains information about what is currently available on the Miranda platform (beta) and outlines some of the work we will be doing in the concluding phase of the project. For technical (and technical-leaning) folks, there is also information on how the platform itself works, how to interact with the platform's APIs, and how data imports are processed. <br />
<br />
All of the platform code will be linked here by the project's conclusion. However, we regret that we cannot provide support for other installations of the platform outside of [http://collections.folger.edu the official site]. The code repository for the 2017 Miranda [https://github.com/ParsonsTKO/FolgerMirandaClient prototype client] and the [https://github.com/ParsonsTKO/FolgerMirandaServer prototype server] is hosted on Github. Our primary technical partner is [https://parsonstko.com ParsonsTKO]. The Miranda project is made possible with generous support from the [https://www.mellon.org Andrew W. Mellon Foundation]. <br />
<br />
Miranda is a work in progress. We would love to hear your comments, questions, and ideas. Send us a note at miranda@folger.edu - we look forward to hearing from you. <br />
<br />
== Table of contents ==<br />
* [[Introduction to the platform]]<br />
* [[What's in Miranda: Content Types|Platform contents]]<br />
* [[International Image Interoperability Framework|International Image Interoperability Framework (IIIF)]]<br />
* [https://wiki.folger.edu/collections-architecture-portal/The_%22My_Shelf%22_Feature My Shelf]<br />
* [[Topics and Stories]]<br />
* [[Taxonomies]]<br />
* [[Data model]]<br />
* [[The Miranda API]]<br />
* [[Advanced search]]<br />
* [[Technical Architecture]]<br />
* [https://wiki.folger.edu/collections-architecture-portal/Licensing_Agreements Licensing agreements]<br />
* [[Team]]<br />
* [[Advisory committee]]</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=The_%22My_Shelf%22_Feature&diff=152The "My Shelf" Feature2019-01-11T22:11:58Z<p>EricJohnson: EricJohnson moved page The "My Shelf" Feature to My Shelf: no need for quotation marks</p>
<hr />
<div>#REDIRECT [[My Shelf]]</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=My_Shelf&diff=151My Shelf2019-01-11T22:11:58Z<p>EricJohnson: EricJohnson moved page The "My Shelf" Feature to My Shelf: no need for quotation marks</p>
<hr />
<div>On Miranda, users have the ability to add Miranda records and their digital media to a personal collection titled "My Shelf," located on the upper right hand of the interface. We want to provide ways for users to keep track of, annotate, and share groups of items that they find in Miranda for future use.<br />
<br />
Users must make a persistent Miranda account in order to create a Shelf. My Shelf items appear in a list on the page. Users can create folders and name the folders, as seen on the left. Titles of folders can be renamed at will. Users can lightly annotate both individual items and folder descriptions with a small amount of unformatted text.<br />
[[File:Screen Shot 2019-01-07 at 3.03.40 PM.png|left|frameless|500x500px|My Shelf on Miranda beta]]<br />
Users can also share a folder within the Shelf publicly, if they select 'Share Folder'. A link is then generated which can be shared as the user chooses. If the user decides to un-share a folder, this can be done with the 'Unshare Folder' button.<br />
<br />
We are interested in exploring more ways that My Shelf can be useful to all of our audiences, both as it currently stands and as it can be improved through the last phase of the project.</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=International_Image_Interoperability_Framework&diff=150International Image Interoperability Framework2019-01-11T22:11:00Z<p>EricJohnson: copyedits</p>
<hr />
<div>The Folger is a Founding Member of the International Image Interoperability Framework (IIIF) Consortium, and seeks to use IIIF standards and tools as part of the Miranda platform project. <br />
<br />
In the Miranda alpha released in May 2018, we integrated [http://universalviewer.io Universal Viewer] to display digital images in our collection with a [https://medusa-project.github.io/cantaloupe/ Cantaloupe server] in place behind the scenes. <br />
<br />
[[File:Screen Shot 2019-01-07 at 2.57.09 PM.png|left|frameless]]<br />
In the beta version of Miranda, we added the [http://projectmirador.org Mirador] viewer as an option for users who wish to have a more in-depth look at Miranda images, and compare them to images from elsewhere in our collection or in other IIIF-compliant collections. <br />
<br />
We also have used the Universal Viewer in our WordPress plugin currently in development, which will be deployed to our Topics and Stories sites. <br />
<br />
Read more about the framework on the [https://iiif.io/about/ IIIF website].</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=Introduction_to_the_platform&diff=149Introduction to the platform2019-01-11T22:07:00Z<p>EricJohnson: /* Web Client */</p>
<hr />
<div><br />
== What is Miranda? ==<br />
<br />
Miranda is a digital asset ''platform,'' a foundation for the Folger's digital collections and one upon which further applications, publications, and initiatives can be built. Miranda's goal is to improve discovery and access in libraries, from making it easier for all users to explore what the Folger has to offer, to improving tools for staff to provide context and information, to increasing efficiency and cost-effectiveness in our digital storage and hosting. <br />
<br />
Miranda is being built to help fill a need in the mid-sized cultural institution space that is currently not well served by existing open or closed source solutions. As "born digital" or "digital native" types of content such as databases, blog posts, mobile applications and the like become more commonplace, the existing systems that libraries and cultural institutions have relied on are either too limited, too expensive, or too inflexible to fit our institution's particular needs. <br />
<br />
Miranda is an open source software system (licensed under the GNU General Public License v3.0) that allows for the storage of arbitrary binary files and assets and their associated metadata and inter-asset relationships. It has been designed to allow for flexible definition of the kinds of assets it stores, flexible binary file asset storage, enterprise class search, and is built from the ground up to leverage APIs. The DAP has an import component for rapidly ingesting data, an indexing service to manage what metadata is made available for public search, a GraphQL API for asset consumption, and a microservice to publicize configured asset types and their validation schemas. <br />
<br />
This project is made possible through the generous support of the [https://www.mellon.org Andrew W. Mellon Foundation]. Miranda's platform has been designed and built by the [https://www.parsonstko.org ParsonsTKO] firm in partnership with the Folger; the WordPress multisite installation has been built by [https://sitesbycoop.com/ Sites by Coop]. <br />
<br />
==== How Miranda helps the Folger: ====<br />
<br />
* '''Enhanced remote access''' -- Not everyone can physically travel to the Folger in Washington, DC. Existing tools were designed to facilitate discovery of assets but not as helpful in the consumption of these assets. <br />
* '''Audience expansion''' -- The Folger currently serves an audience of over 2 million people annually, online and in person. However, many audiences could not be easily targeted with library- or institution-specific data formats, data exchange standards, and other types of technical roadblocks of high learning curves. By developing a system utilizing widely adopted, well-documented standards and solutions, the DAP makes it much more likely that new audiences and organizations can and will leverage Folger assets.<br />
* '''International partnerships''' -- As the Folger seeks to develop strong partnerships with similar organizations across the globe it needed a non-proprietary mechanism for connecting with organizations that had chosen different technical infrastructures for managing their own internal assets. In many ways this is the Folger’s own internal use case for audience expansion, and the partnerships will allow the Folger to develop the DAP with real world experience in sharing, connecting, and juxtaposing their assets with other organizations’ holdings.<br />
* '''Digital Acquisition and Basic Preservation''' -- While many of the original assets the Folger collected were well understood, and the universe of types of content was fairly static (as it is rare that a new kind of 16th-century manuscript is discovered), the digital world is in flux and new content types come into being regularly. Some recent content types are already no longer being developed. In addition, the Folger is creating new kinds of digital assets out of the physical holdings, such as the Folger Digital Texts archive and surveys of female owners of early modern books. <br />
<br />
== Major platform components ==<br />
<br />
=== Content Importer === <br />
Imports JSON structured content<br />
=== Content Validator === <br />
Validates imported JSON by matching it against an available configured schema.<br />
Allows for a hierarchy of validation schemas to be defined with fallbacks. <br />
=== Content Search === <br />
System allows individual content items to be flagged as “searchable” or not, allowing you to keep internal metadata in the system but not junk up your search results with it. <br />
=== GraphQL API === <br />
System allows individual content items to be flagged as “published” or not, allowing you to keep some data in the system as private / draft content.<br />
=== Schema Microservice === <br />
Allows developers to easily see what content types are configured in any particular installation of Miranda and to retrieve the JSON validation schema that is used to test each content type during import.<br />
=== Web Client === <br />
A web client that leverages both elastic search and our GraphQL API.<br />
The client also demonstrates how various system integrations can happen in this client middleware. (For instance using third-party viewers to let web users browse and navigate visual assets in the client.)<br />
<br />
=== Repository (AWS) ===<br />
Our cloud-based storage system <br />
<br />
=== WordPress Plugin ===<br />
Employing the IIIF Universal Viewer, the plugin allows users to insert Miranda items directly with a shortcode (using the alphanumeric Miranda ID string), which displays the digital object and some top-line metadata.<br />
<br />
== What software and systems is the DAP built with? ==<br />
* PHP 7 - http://php.net/manual/en/<br />
* Symfony 3 - https://symfony.com/doc/current/index.html<br />
* GraphQL - http://graphql.org<br />
* JSON - http://www.json.org<br />
* Postgresql - https://www.postgresql.org<br />
* ElasticSearch - https://www.elastic.co/guide/index.html<br />
* Pattern Lab - http://patternlab.io<br />
* Amazon Web Services - https://aws.amazon.com <br />
* Cantaloupe - https://medusa-project.github.io/cantaloupe/</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=Introduction_to_the_platform&diff=148Introduction to the platform2019-01-11T22:05:45Z<p>EricJohnson: copyedits</p>
<hr />
<div><br />
== What is Miranda? ==<br />
<br />
Miranda is a digital asset ''platform,'' a foundation for the Folger's digital collections and one upon which further applications, publications, and initiatives can be built. Miranda's goal is to improve discovery and access in libraries, from making it easier for all users to explore what the Folger has to offer, to improving tools for staff to provide context and information, to increasing efficiency and cost-effectiveness in our digital storage and hosting. <br />
<br />
Miranda is being built to help fill a need in the mid-sized cultural institution space that is currently not well served by existing open or closed source solutions. As "born digital" or "digital native" types of content such as databases, blog posts, mobile applications and the like become more commonplace, the existing systems that libraries and cultural institutions have relied on are either too limited, too expensive, or too inflexible to fit our institution's particular needs. <br />
<br />
Miranda is an open source software system (licensed under the GNU General Public License v3.0) that allows for the storage of arbitrary binary files and assets and their associated metadata and inter-asset relationships. It has been designed to allow for flexible definition of the kinds of assets it stores, flexible binary file asset storage, enterprise class search, and is built from the ground up to leverage APIs. The DAP has an import component for rapidly ingesting data, an indexing service to manage what metadata is made available for public search, a GraphQL API for asset consumption, and a microservice to publicize configured asset types and their validation schemas. <br />
<br />
This project is made possible through the generous support of the [https://www.mellon.org Andrew W. Mellon Foundation]. Miranda's platform has been designed and built by the [https://www.parsonstko.org ParsonsTKO] firm in partnership with the Folger; the WordPress multisite installation has been built by [https://sitesbycoop.com/ Sites by Coop]. <br />
<br />
==== How Miranda helps the Folger: ====<br />
<br />
* '''Enhanced remote access''' -- Not everyone can physically travel to the Folger in Washington, DC. Existing tools were designed to facilitate discovery of assets but not as helpful in the consumption of these assets. <br />
* '''Audience expansion''' -- The Folger currently serves an audience of over 2 million people annually, online and in person. However, many audiences could not be easily targeted with library- or institution-specific data formats, data exchange standards, and other types of technical roadblocks of high learning curves. By developing a system utilizing widely adopted, well-documented standards and solutions, the DAP makes it much more likely that new audiences and organizations can and will leverage Folger assets.<br />
* '''International partnerships''' -- As the Folger seeks to develop strong partnerships with similar organizations across the globe it needed a non-proprietary mechanism for connecting with organizations that had chosen different technical infrastructures for managing their own internal assets. In many ways this is the Folger’s own internal use case for audience expansion, and the partnerships will allow the Folger to develop the DAP with real world experience in sharing, connecting, and juxtaposing their assets with other organizations’ holdings.<br />
* '''Digital Acquisition and Basic Preservation''' -- While many of the original assets the Folger collected were well understood, and the universe of types of content was fairly static (as it is rare that a new kind of 16th-century manuscript is discovered), the digital world is in flux and new content types come into being regularly. Some recent content types are already no longer being developed. In addition, the Folger is creating new kinds of digital assets out of the physical holdings, such as the Folger Digital Texts archive and surveys of female owners of early modern books. <br />
<br />
== Major platform components ==<br />
<br />
=== Content Importer === <br />
Imports JSON structured content<br />
=== Content Validator === <br />
Validates imported JSON by matching it against an available configured schema.<br />
Allows for a hierarchy of validation schemas to be defined with fallbacks. <br />
=== Content Search === <br />
System allows individual content items to be flagged as “searchable” or not, allowing you to keep internal metadata in the system but not junk up your search results with it. <br />
=== GraphQL API === <br />
System allows individual content items to be flagged as “published” or not, allowing you to keep some data in the system as private / draft content.<br />
=== Schema Microservice === <br />
Allows developers to easily see what content types are configured in any particular installation of Miranda and to retrieve the JSON validation schema that is used to test each content type during import.<br />
=== Web Client === <br />
A web client that leverages both elastic search and our graphQL api.<br />
The client also demonstrates how various system integrations can happen in this client middleware. (For instance using 3rd party viewers to let web users browse and navigate visual assets in the client.)<br />
<br />
=== Repository (AWS) ===<br />
Our cloud-based storage system <br />
<br />
=== WordPress Plugin ===<br />
Employing the IIIF Universal Viewer, the plugin allows users to insert Miranda items directly with a shortcode (using the alphanumeric Miranda ID string), which displays the digital object and some top-line metadata.<br />
<br />
== What software and systems is the DAP built with? ==<br />
* PHP 7 - http://php.net/manual/en/<br />
* Symfony 3 - https://symfony.com/doc/current/index.html<br />
* GraphQL - http://graphql.org<br />
* JSON - http://www.json.org<br />
* Postgresql - https://www.postgresql.org<br />
* ElasticSearch - https://www.elastic.co/guide/index.html<br />
* Pattern Lab - http://patternlab.io<br />
* Amazon Web Services - https://aws.amazon.com <br />
* Cantaloupe - https://medusa-project.github.io/cantaloupe/</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=Main_Page&diff=146Main Page2019-01-11T21:55:58Z<p>EricJohnson: copyedits</p>
<hr />
<div>Welcome to the <strong>Behind-the-Scenes Portal </strong>for the Miranda Digital Asset Platform<strong>.</strong> This portal documents the human and technical development processes that make the Miranda project possible. The Miranda prototype was made public in fall 2017, with an alpha release in May 2018 and a beta launch in January 2019. We will continue to update the platform throughout 2019 and beyond. <br />
<br />
There is information about what is currently available on the Miranda platform beta and outlines some of the work we will be doing in advance of the full beta launch. For technical (and technical-leaning) folks, there is also information on how the platform itself works, how to interact with the platform's APIs, and data import processes. <br />
<br />
All of the platform code will be linked here by the project's conclusion. However, we regret that we cannot provide support for other installations of the platform besides [http://collections.folger.edu the official site]. The code repository for the 2017 Miranda [https://github.com/ParsonsTKO/FolgerMirandaClient prototype client] and the [https://github.com/ParsonsTKO/FolgerMirandaServer prototype server] is hosted on Github. Our primary technical partner is [https://parsonstko.com ParsonsTKO]. The Miranda project is made possible with generous support from the [https://www.mellon.org Andrew W. Mellon Foundation]. <br />
<br />
Miranda is a work in progress. We would love to hear your comments, questions, and ideas. Send us a note at miranda@folger.edu and we look forward to speaking with you. <br />
<br />
== Table of contents ==<br />
* [[Introduction to the platform]]<br />
* [[What's in Miranda: Content Types|Platform contents]]<br />
* [[International Image Interoperability Framework|International Image Interoperability Framework (IIIF)]]<br />
* [https://wiki.folger.edu/collections-architecture-portal/The_%22My_Shelf%22_Feature "My Shelf"]<br />
* [[Topics and Stories]]<br />
* [[Taxonomies]]<br />
* [[Data model]]<br />
* [[The Miranda API]]<br />
* [[Advanced search]]<br />
* [[Technical Architecture]]<br />
* [https://wiki.folger.edu/collections-architecture-portal/Licensing_Agreements Licensing agreements]<br />
* [[Team]]<br />
* [[Advisory committee]]</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=Main_Page&diff=30Main Page2017-12-28T22:10:56Z<p>EricJohnson: reworked intro language</p>
<hr />
<div>Welcome to the <strong>Folger's Miranda Digital Asset Platform Developer Portal.</strong> This portal has been created to help technical (and technical-leaning) folks learn how to interact with the platform's APIs, data import processes, and learn more about how the platform itself works. <br />
<br />
All of the Platform code will be linked here, and it will be perfectly usable for anyone who wants to examine it or learn from it. However, we regret that we cannot provide technical support for other installations of the Portal besides [http://collections.folger.edu the official site]. <br />
<br />
The code repository for the Miranda [https://github.com/ParsonsTKO/FolgerMirandaClient prototype client] and the [https://github.com/ParsonsTKO/FolgerMirandaServer prototype server] is hosted on Github.<br />
<br />
== Table of contents ==<br />
* [[Introduction to the platform]]<br />
* [[Technical Architecture]]<br />
* [[Data model]]<br />
* [[Taxonomies]]<br />
* [[Elasticsearch API]]<br />
* [[GraphQL API]]<br />
* [[Schema microservice]]<br />
* [[Reporting Bugs]]<br />
* [[Keep up with developments (Join our mailing list)]]<br />
* [[Development Roadmap]]</div>EricJohnsonhttps://wiki.folger.edu/collections-architecture-portal/_mw/index.php?title=Main_Page&diff=29Main Page2017-12-28T21:50:14Z<p>EricJohnson: </p>
<hr />
<div>Welcome to the <strong>Folger's Miranda Digital Asset Platform Developer Portal.</strong><br />
<br />
This portal has been created to help technical (and technical-leaning) folks learn how to interact with the Platform's APIs, data import processes, and learn more about how the platform itself works. Eventually this space will include directions on how to install and configure your very own copy of the Digital Asset Platform!<br />
<br />
The code repository for the Miranda [https://github.com/ParsonsTKO/FolgerMirandaClient prototype client] and the [https://github.com/ParsonsTKO/FolgerMirandaServer prototype server] is hosted on Github.<br />
<br />
== Table of contents ==<br />
* [[Introduction to the platform]]<br />
* [[Technical Architecture]]<br />
* [[Data model]]<br />
* [[Taxonomies]]<br />
* [[Elasticsearch API]]<br />
* [[GraphQL API]]<br />
* [[Schema microservice]]<br />
* [[Reporting Bugs]]<br />
* [[Keep up with developments (Join our mailing list)]]<br />
* [[Development Roadmap]]</div>EricJohnson