Home

Welcome to the Help pages for Sinopia, the LD4P2 Sandbox Environment.

How to get help

There are several ways to get help or report an issue. Use the one that works best for you:

• Post on the #sinopia Slack channel in the LD4 workspace (join the workspace)
• To ask your question privately, email [email protected]
• To report an issue directly to the development team, add an issue in github
• For questions related to cataloging, send an email to the Sinopia catalogers listserv

Latest Releases

Release 0.2.1 Notes

Release 0.2.0 brings us to Milestone 2 "Profile Dress Rehearsal". Features include:

• Create profiles in Profile Editor and load into Linked Data Editor.
• Specify lookups via Questioning Authority in Profile Editor, and do lookups in the Linked Data Editor.

There's a demonstration Profile that shows how various Profile configurations will look in the Linked Data Editor. Click the Raw button and download the JSON. Then go to the Sinopia Linked Data Editor, click Import Profile, and upload the JSON file.

Full 0.2.0 release notes

What's Next

Work on Milestone 3 "Profile Opening Night" is in progress. Milestone 3 includes:

• User authentication
• Uploading Profiles to an "available profiles" menu. View mockups of profile loading workflow showing how a profile owner would add a new profile to Sinopia for use in the Linked Data Editor, and update an existing profile by uploading a new version.

Milestone 3 details

View details of all 5 milestones in the Technical Project Plan

FAQ

• I requested a Sinopia account; where is my confirmation e-mail? Check your spam/junk folder.
• How can I be sure I'm looking at the latest version of the Profile Editor? Unfortunately there's no visual indication. If you suspect you are looking at an older version, [clear your browser's local storage].
• Why does the Profile Editor keep saying "Part of the form are invalid" when I try to export my Profile? This message means that your Profile is missing some elements. A Profile has to have at least one Resource Template, and a Resource Template has to have at least one Property Template. There are also individual fields that are required; required fields are indicated with an asterisk (*). And fields that expect a URI require a value that's in the pattern of a URI.
• Does the Profile Editor generate JSON compatible with the Linked Data Editor? Yes.
• I'm getting errors when I try to load my Profile into the Linked Data Editor. Why? There are a few reasons:
  • Profiles created earlier in the development cycle may not be compatible.
  • Although the Profile Editor includes some validation, it is possible to create a profile that isn't completely compatible with the Linked Data Editor. For example, the Linked Data Editor expects "Author" to be longer than 2 characters, but the Profile Editor doesn't care. And, the Linked Data Editor does not allow Resource IDs to include spaces (because the Sinopia Server uses the Resource ID to create directories and does not allow spaces). You'll know that a space in the Resource ID is causing your problem if you get an error message like this:

    ERROR - CANNOT USE PROFILE/RESOURCE TEMPLATE: problem validating template: Error: [ { keyword: 'pattern', dataPath: '.Profile.resourceTemplates[0].id', schemaPath: '#/properties/id/pattern', params: { pattern: '^\S+$' }, message: 'should match pattern "^\S+$"', schema: '^\S+$', parentSchema: { type: 'string', title: 'Resource Template Identifier', description: 'Identifier associated with a resource template. Eventually, a URI.', minLength: 3, pattern: '^\S+$', example: [Object] }, data: 'my template' } ]

  • You created a profile "by hand" and it doesn't conform to the profile schema. The Linked Data Editor should give you an informative error message if upload fails. Use any of the Help channels if you're having difficulties.
• How can you make sure a profile created outside Sinopia will be compatible? See the JSON Schema for Profiles, version 0.0.9. That page also explains how to use the ajv CLI library for JSON schema validation. You could run that (or a different validator) against your text-editor-created profile.
• Where are the LC profiles that are compatible with Sinopia? In the Sinopia Sample Profiles repository. Choose a profile, click Raw button, then export, then import that exported JSON file into the Linked Data Editor. After Milestone 3, these Profiles will be available directly in the Linked Data Editor.
• Can I view and edit more than one Profile at a time? Yes, by having more than one instance of the Profile Editor open at the same time, you can view one profile in one tab or window, and another profile in another tab or window. These tabs and windows can be in the same browser app, or in a different browser app.
• When importing a Profile into the Linked Data Editor, where the Profile contains Resource Templates that point to Resource Templates in a different Profile, does it matter what order I import the Profiles in? No. You can import them in any order. If you open a Resource Template in the Linked Data Editor, and it points to another Resource Template that hasn't been uploaded yet, you will just see a blank area in the form where that Resource Template is called.
• How do I add a resource template to the drop down list in a property template? If you create a new resource template to which you will be referring to in a profile from a property (not directly in the profile itself), you cannot use it without it being added to the drop-down menu of resource templates. Until there is a method of doing this individually, please contact Jeremy Nelson via slack to add your new template. This is an interim practice until the profile is fully developed