Skip to content

Earlier release notes

michelleif edited this page Dec 9, 2019 · 23 revisions

Editor Release 1.6.0

plus Profile Editor Release 0.5.0, Exporter Release 0.4.0, and Indexing Pipeline Release 0.8.1 (21-22-November-2019)

New Features

Editing

  • On fields that are lookups to Sinopia BIBFRAME Works or Instances, a Create New menu offers an easy way to open a relevant Resource Template for creating a new Work or Instance. This is useful if your Sinopia search doesn't yield what you're looking for and you want to create a new Work or Instance. Select a Resource Template from the list and Sinopia opens it in a new tab and moves your focus to that tab. Create your new resource, save, use the Copy URI button to grab the newly minted URI, and return to your original resource to paste the new URI in the field you started in. (Bug to be fixed: Create New should not be displayed with lookup to "all" Sinopia resources.)
  • Language choices for literal fields draw from ISO 639-2 instead of 639-1. (Note: There is ongoing discussion about whether to use ISO 639-3 in Sinopia.)
  • Literal fields include a new language option "No language specified".
  • Wikidata available as a lookup source

Searching

  • When you select a value from a lookup while Editing, Sinopia now indexes the labels, so Resources are searchable by the text of those labels. (Note: this applies only to labels that are selected and saved going forward from this release. Labels that were saved as of Release 1.4.0 were not yet indexed.)
  • Extended context is shown in search results for external sources, including DISCOGS.
  • Modified date for Sinopia search results now shown as absolute date instead of relative date.

UX Improvements

  • Header redesigned to give more vertical space to the rest of the page.
  • Download link is now an icon on Resource Templates tab.
  • When attempting to open a resource on Search tab results in an error, focus shifts to top of page so you can see the error message.
  • Several improvements to look and consistency of buttons, links, and headers.

Bug Fixes

  • Language of literal restored to table preview.
  • Sort order retained when paging through results.
  • Editing previously seleted language tag on literal applies to correct literal.

Editor Release 1.5.0

plus Profile Editor Release 0.4.0, Exporter Release 0.3.0, and Indexing Pipeline Release 0.7.0 (15-November-2019)

New Features and Improvements

Editing

  • You can now have multiple Resource Templates open in one window. Each time you open a Resource Template, a new tab within the Edit tab is opened. The title of the tab is the name of the Resource Template. Each tab can be closed individually. You can click back and forth between the tabs.
  • When you open an existing Resource, Sinopia now expands all nested templates that contain data. Previously, only the first instance was expanded, making it appear as if you lost data you had entered.
  • Save and Close buttons are available at the bottom of page in addition to the top. (Note you still need to scroll to top to see the newly minted URI)
  • When you select a value from a lookup, Sinopia now retains the label, not just the URI. (Note indexing and searching of those labels in progress)

Selecting Resource Templates

Two new features were added to make it easier to work with a large set of Resource Templates.

  • Search box where you can search for Resource Templates by id, label, author, resource URI, or remark (a.k.a. Guiding Statement); the list of Resource Templates is filtered as you type you search. (Note that the ability to sort the list has been removed, since you can now winnow the list by any of the criteria you could previously sort by. And if you don't enter a search, Sinopia only shows you the first x templates in alphabetical order by ID, to avoid having to load the entire long list.)
  • "Most recently used resource templates" menu shows you Resource Templates you have used in your current session
  • Improved error catching and reporting for Resource Templates that include unsupported lookup sources. (Known issue: duplicate error messages)

Searching

  • In Sinopia search results, the Modified Date now shown as a relative date.
  • Instructions added on Sinopia search conventions, including link to longer explanation on this help site: Searching in Sinopia

Exporting

  • Exports now include the subject URI.
  • Exports now include the date and time the resource was created and last modified.

Profile Editor

  • Added trash can for cleaner deletion of Value Data Type (previously the only way to delete was by removing the value from the text box, which left an empty value that Sinopia didn't like; please note that the Value Data Type is not being used in Sinopia)
  • Added new lookup choices for DISCOGS Release and Masters.
  • Added new lookup choices for Sinopia BIBFFRAME Works and Sinopia BIBFRAME Instances, in addition to the existing Sinopia lookup, which was renamed "Sinopia resources". (Note that previously, fields with a Sinopia lookup supported the use of a wildcard (*) with no other characters; fields with Sinopia lookups now require you to enter at least 3 characters preceding the wildcard.)

Bug Fixes

Selecting and Importing Resource Templates

  • Fixed issue where if you opened a Resource Template that generated an error, you could not open any further Resource Templates
  • Previously when you uploaded a revised version of an existing Resource Template, the revised label didn't show up in the list of Resource Templates, and clicking on the Resource Template still opened the earlier version. Now the revised label shows up as expected (Note you do have to re-search to see the revised label in the results list; but if you clicked on the existing label it will properly open the revised version. Also, in the "recently used" menu, the label is not updated, but does correctly open the newly imported version.)

Searching

  • Fixed issue with re-indexing service where previously indexed items were getting dropped from the index; Note: this fix needs to be verified once new release is on stage and re-indexing process is complete

Editing

  • Popovers no longer persist when you leave the Edit tab
  • Correct URI is recorded for Sinopia resources selected from a lookup (previously URI had "undefinedrepository" in URI instead of trellis domain)

Release 1.4.1 (01-November-2019)

Demo: https://youtu.be/dahdRoMOT7Q Patch release 1.4.2: fixes problem with exported files; no user impact

New Features: Search tab

  • Additional metadata about each item shown, including type
  • Sort by different parameters (label, modified date, relevance)
  • Edit and copy buttons
  • Search any literal field in the resource (previously only title fields were searchable)
  • Search any Sinopia resource, including searching by the resource URI (previously, only resources with titles were searchable)
  • RDA title properties now treated as titles (previously only BIBFRAME title properties were handled as titles; titles get higher relevance in search results, and the title is displayed as the label in search result)
  • DISCOGS now searchable

New Features: Resource Templates tab

  • Resource Templates accessible via URLs for bookmarking and sharing
  • Import button accepts Resource Template JSON file (in addition to Profile JSON file)
  • when there's an error upon opening a Resource Template, you are scrolled to top so you can see the error
  • If there's more than one error message upon opening a Resource Template, they are shown separately for easier reading
  • Removed confusing "prompting" message when overwriting existing Resource Template

New Feature: Exports tab

  • New tab for downloading zipped export files (in JSON-LD) of Sinopia resources by group; also includes single .zip file of resources from all groups

New Features and Bug Fixes: Edit tab

  • Copy URI now looks like a button and gives feedback that your URI was copied
  • Vertical scrolling added to Preview
  • When using up and down arrow keys to step through lookup results in fields with extended context, selection no longer disappears or becomes hard to read when selected
  • Info icon on fields is clickable to see help text
  • When a lookup field has multiple sources, those sources are now listed in the order specified in the Resource Template, rather than alphabetically

Release 1.3.0 (18-October 2019)

Demo of Release 1.3.0 and 1.2.1: https://youtu.be/IAekfhmqB2g

New features

  • Friendlier RDF preview: choice of table, N-triples or Turtle. Defaults to table view. This improvement appears on Preview from the Edit tab, as well as in the "remainder" RDF that is displayed when loading from the Load RDF tab or copying from the Search tab.
  • The Edit tab has a new Copy URI button that lets you copy a resource's newly minted URI to your buffer (clipboard) as soon as a resource is saved. This is useful for pasting the new URI in a Sinopia lookup field, especially if the Resource is not a resource that will be found by a Sinopia lookup (i.e., it's not a resource with a title field). Known issue: on Firefox/Mac the Copy URI link doesn't look like a button, and it doesn't give visual feedback that it has been clicked.
  • In Search tab, you can find Sinopia resources by their URI. Note that this only works for indexed Sinopia resources, and currently we only index resources that have titles. Also note that the "Load by URI" option has been removed from the Load RDF tab since you can now search by URI on the Search tab.
  • Sinopia search finds matching strings with and without diacritics.
  • Sinopia search is now case insensitive.
  • Sinopia search defaults to AND when search string has multiple terms
  • Visual indications of which environment you are in (development, stage, production): the page title and the header on the page both include the name of the environment.
  • Upgraded to latest version of the Bootstrap framework that controls many aspects of the UI. This fixes some issues noted previously including fields jumping to new positions on the page and search result labels not wrapping.

Bug fixes

  • Fixed bug where nested Resource Templates with property type resource (not pointing to Resource Templates, but instead expecting a URI) did not work.
  • Fixed bug related to loading triples. Details

Known issue ticketed for fix:

  • For lookup fields with QA sources with extended context, when you use arrow keys to move up and down the list of matching values, the highlight text changes to white, making the text disappear against the white background.

Release 1.2.1 (11-October-2019)

Bug fixes

Opening a Resource when original Resource Template no longer exists

  • From Search tab when you try to open a Resource created with a Resource Template that no longer exists, you will get a message explaining why the Resource cannot be opened.
  • Previously, Sinopia would either take you to the most recent Resource you had opened, or do nothing.
  • Note that even if the Resource Template no longer exists, you can still view the Resource description in triple form by pasting the URI of the Resource into your browser. In a future release, we hope to offer a way to select a different Resource Template to use to open the Resource.

More checking of Resource Templates upon attempting to open them

  • From Resource Template tab, Sinopia now checks for problems with a Resource Template before opening, and reports those problems. If your Resource Template has a problem, Sinopia will report a useful error message and will not open the Resource Template.

  • Previously, Sinopia allowed you to open the Resource Template in these cases, but then there were unexpected results when the issue was encountered.

  • Problems Sinopia checks for include:

    1. Resource Template refers to (nests) another Resource Template that doesn't exist in Sinopia.
    2. Resource Template contains lookup fields that refer to lookup sources that don't exist in Sinopia.
    3. Resource Template contains property template with an unsupported property type (supported types are literal, lookup, and resource).
  • The error messages for cases ii. and iii. will refer to the property URI of the Property Template that has the unsupported lookup or property type.

  • Note that items ii. and iii. will only occur in a template that is created or edited outside the Profile Editor.

Fixes issue where Resources were not getting saved

New feature

Lookup fields now support having multiple sources that are direct lookups to id.loc.gov.

Release 1.1.0 (07-October-2019)

Demo of Release 1.1.0: https://youtu.be/kNX_JDEftRU

Deriving new descriptions

This release adds the ability to copy existing an description to start a new one, both for Sinopia-created resources and external data

  • When viewing a saved resource on the Editor tab, a new Copy icon lets you copy the current description, creating a new, unsaved description in the same Resource Template, which you can then edit and save as a new description.
  • To support the ability to copy an external description, the Search tab now includes a choice of external sources to search. These are searched via the Questioning Authority service. New sources added in this release:
    • MARC datasets of LD4P cohort institutions, converted to RDF by Share-VDE service
    • Discogs music database.
  • When searching an external data source, a new Copy icon next to a search result lets you copy that "record" into a Resource Template of your choice. Any data from the selected record that does not match the chosen Resource Template is displayed in a "remainder" box.

Known issues with Search tab when searching external sources

  • only the top 8 results are shown
  • Discogs search does not work
  • response time is slow

Loading RDF

The Load RDF tab is another route for using external data to create a new description. This release adds several improvements to loading RDF

  • help text explaining which formats are accepted and clarifying that Base URI is not required
  • if you don't specify a destination Resource Template in your data (with the http://sinopia.io/vocabulary/hasResourceTemplate property), Sinopia prompts you to select a destination Resource Template from a list of available templates
  • any loaded data that does not match the chosen Resource Template is displayed in a "remainder" box

Additional Features

  • Extended context: If a Questioning Authority lookup offers extended context, this contextual information is always shown. (This is an improvement from previous releases in which extended context had to be explicitly specified in a Resource Template in order for it to be displayed, which in turn had required an update to the Sinopia Resource Template schema.) Authority Status for Lookups through QA shows which sources have extended context.
  • Lookups to multiple sources: To improve the response time of lookup fields that search multiple Questioning Authority sources, Sinopia displays results from each source as soon as available. In previous releases, Sinopia waited for results from all sources before displaying any.
  • Literals and URIs in lookup fields: Fields that are lookups to Sinopia resources or to LC vocabularies now accept literals or URIs as entries (previously only Questioning Authority lookups supported this feature)

Bug Fixes

  • Defaults in nested templates are now editable
  • Indexing pipeline does not stop working after period of inactivity (this was preventing new and changed resources from showing up in Search results)

Additional Known Issues

  • Previously created Sinopia resources will not open from the Search tab if the Resource Template used to create the resource no longer exists. Either nothing will happen when you click the search result, or you will be taken to the Editor tab, but will see a previously opened resource. Issue 1447

Release 1.0.2 (September-2019)

  • Fixes bug where QA lookups did not work if they were in templates nested in other templates.

Release 1.0.1 (September-2019)

  • Adds support for lookups to Share-VDE data and fixes bug where validation messages weren't properly cleared

Release 1.0 (09-August-2019)

This release completes the Sinopia MVP (minimum viable product) -- offering enough functionality to start cataloging! This release completes Milestone 4 (https://github.com/LD4P/sinopia/issues/167): finding data created in Sinopia, referring to resources created in Sinopia, and editing existing data in Sinopia.

Demo of Release 1.0 (and previous releases since last demo): https://youtu.be/vOfcpd9w0fQ

Finding data (Search tab)

  • Simple search of descriptions created in Sinopia (currently searching only titles)
  • Click on search result to open the description in the Editor tab
  • Search supports wildcard

Cataloging (Editor tab)

  • Your description is indexed upon Save & Publish so that it can be searched
  • Sinopia-created resources are now a source for lookups
  • After selecting a value from a lookup, the selected literal is displayed as a link to the corresponding URI, so you can visit the URI for context
  • Improvements to validation of entered data
    • Validation of entries in mandatory fields is recursive (nested Resource Templates are checked)
    • The mandatory fields message updates dynamically as you fill in missing entries
    • Fields that expect a URI warn you if you enter a literal (*These are fields configured with property type = resource, but not pointing to another Resource Template)
  • More UI improvements
    • Sinopia warns you if you try to go to another tab and you have unsaved entries.
    • If you enter data in a literal field, save is disabled until you hit Enter or move to another field, preventing you from typing a literal and saving without "entering" the value.

Off-menu items

  • Export data. No UI. Requires command line and admin access. Exports can be requested via issue in github. Documentation to follow.
  • Extended context on some lookups. Requires manual editing of Profile to configure. Documentation to follow.

Release 0.3.10 (08-August-2019)

a quick point release to check the indexing pipeline

Release 0.3.9 (02-August-2019)

Cataloging

  • Buttons properly aligned depending on context
  • Language handling improvement for input literal
  • Leaving a literal input with text now saves the value, without having to hit "Enter"

Load RDF

  • Can load known Trellis URI into Editor to bring up corresponding description

Search

  • Search feature in progress; results now have pagination

Release 0.3.8 (30-July-2019)

feature list includes 0.3.3 through 0.3.7 point release features

Importing and Selecting Resource Templates

  • Author and Remark shown for each Resource Template in the list
  • List is sortable by Template Name, ID, or Author
  • List is sorted by default by Template Name, and newly added Templates are automatically sorted
  • Column text wraps
  • Resource Template JSON is downloadable (Note: You're downloading JSON for a Resource Template, not a Profile, so you can't load that same JSON back in to the Editor or the Profile Editor, both of which require Profiles. If you need to load a Resource Template you can try https://github.com/LD4P/sinopia/wiki/How-to-turn-a-Resource-Template-into-an-importable-Profile)
  • When you load a revised version of an existing Resource Template, changes to Template Name, Author or Remark are reflected immediately in the list

Cataloging

  • Minted URI and confirmation message appear when you Save & Publish
  • This minted URI is deferenceable (paste in a browser and see your created statements)
  • Repeats of repeatable items are removable
  • Lookup fields allow you to enter a URI or literal instead of selecting a value from the lookup
  • Fields that expect a URI warn you if you enter a literal
  • URIs entered into fields are clickable
  • Editor validates whether mandatory fields are filled in within nested Resource Templates

New Feature: Load RDF

  • Given a set of triples (including a triple specifying what Resource Template to load the triples into), Sinopia loads your triples, creating a new resource description. (To get a model of triples to load, choose a Resource Template, fill in some fields, click Preview. Paste these triples into the Load RDF tab.

Profile Creation

  • New option to specify Sinopia as a source for lookups (Note that the Sinopia search is in progress)

Other

  • Sinopia Editor version number now visible upper left of Editor window
  • Issue templates for bug reports and feature requests and updated Help menu with direct links to those templates

Release 0.3.3 (20-June-2019)

feature list includes 0.3.1 and 0.3.2 point release features

Achieves first part of milestone 4: Creating, previewing and saving RDF

  • RDF is generated from resource template + cataloger description
  • User can preview RDF while cataloging
  • User can save resource descriptions
  • User can choose which group to save resource descriptions to
  • When saving, user is prompted to fill in required fields
  • Sinopia mints a URI for the resource when user saves description
  • Fixed bugs resulting in blank screen

Release 0.3.0 (30-May-2019)

Achieves milestone 3: User Login and “Profile Opening Night”

User log in

  • User can create new account
  • User can retrieve forgotten password or reset password
  • Only logged-in users are allowed to access the Linked Data Editor
  • User is prompted to log in if trying to access the Linked Data Editor

Adding and Updating Profiles

  • Logged-in user can upload new profile to a list of "available resource templates" that others can then use to catalog
  • Logged-in user can overwrite existing resource templates with new version of same
  • User is asked to confirm overwrite when trying to upload resource templates that already exist

Cataloging with Profiles

  • User can choose a resource template from a list of available resource templates, open the "form", and try entering data.
  • All types of "fields" and field options are working:
    • type = literal
    • type = lookup
    • type = resource
    • repeatable (true or false)
    • tooltips (hyperlink or text)
    • default values for literals and lookups
    • mandatory (true or false; if true, field marked with asterisk)

Casalini/Share-VDE data

  • Profile creator can specify a Share-VDE dataset as option for lookup in Profile Editor
  • In Linked Data Editor, user can search for and select entities/values from Share-VDE data, as specified in profile

Release 0.2.1 (14-March 2019)

  • Resource Template tab validates and loads Resource Templates into Editor Tab
  • Cognito Authenication for Import Resource Template
  • Editor UI updated to use blocks and outlines

Release 0.2.0 (19-Feb-2019)

  • Load profile into Editor to see the form
  • Enter data into literal field
  • Search for and select values in authoritative sources as specified in Profile
  • Add multiple values to literal and lookup fields where allowed (n/a for type = resource)
  • UX improvements for repeatable literal and lookup fields
  • UX prevents user from adding multiple values where not allowed, in literal and lookup fields
  • For properties where object is another "form", see a button to open that "form" NOTE: this will generate a blank button until future release when Profiles are stored in Sinopia server
  • For property type Resource, get visual confirmation that you indeed entered something in the modal form (NOTE: this doesn't work properly yet for type=Resource and repeatable=true)
  • See help text as hyperlink or tooltip per Profile
  • Use tab key to advance through fields (in addition to mousing)
  • Enter diacritics and non-Roman script (tested using Mac language keyboards)
  • Optionally indicate language of entered literal in Linked Data Editor
Clone this wiki locally