describo / profiles

Describo profiles - instrument describo to create metadata

Describo Profiles

Describo is driven by profiles. A profile is a set of instructions to the UI to describe how it should act. This repository is the documentation for writing a profile. It also contains a small application you can use to validate your profile. And there are example profiles in the repository as well.

Comprehensive documentation is available @ https://describo.github.io/documentation/profiles/get-started.html

profiles's Issues

Create a basic ro-crate profile

• create a profile which expands out the properties required to be a valid, minimum ro-crate.

Create a licence editor in the UI that works like the github licence selector

• must be able to be toggled on or off
• have a set of CC licences to choose from for use with the data
• be able to take other licences to choose from
• inject the licence file into the dataset and register it in the crate file

Be able to define a context in a profile

• override whatever context is in the crate file when it loads.
• disable enable context editor as the profile owner is specifying the context for this data

define metadata licence

• add a licence property to the metadata section of the profile which is expected to be a URL. That URL should then be injected into the root descriptor as the metadata licence.

Define reverse links to be automatically created

@beepsoft I'm thinking about putting this in for my app which is more around cultural collection management. It doesn't have to be in the crate-builder / profile layer (I could just do it in my app) but I think it could be generally useful. What do you think? Does the proposed implementation make sense?

---

To link one entity to another we define a forward looking relationship in the profile, viz:

File : keywords -> DefinedTerm

This gives us a link from the keywords prop on a File to a Defined Term.

However, when we look at the term, we don't have a forward looking link from it back to the file, viz:

DefinedTerm : appliesTo -> File

We can get that association by looking at the @reverse links but that, semantically, doesn't mean as much as having a definite forward looking association.

So, it would be nice for a profile to be able to define a set of associations to be created automatically, ala:

{
  metadata: {},
  reverseMappings: [
    { property: 'keywords', reverse: 'appliesTo' },
    { property: 'memberOf', reverse: 'hasMember' },
    ...
  ],
  resolve: {},
  ...
}

Then, whenever an association is made from the keywords prop on any entity to another entity, the reverse will automatically be created by describo. That is, the target entity will get an appliesTo property linking back to the original entity.

When unlinking an entity from a property, if reverseMappings is defined, then both links should be removed.

If this configuration is not found in the profile then nothing happens.

define data licence

Similar to #2 but for adding a licence ot the data via the profile

Need the ability to define properties as readonly

Currently, the whole crate can be set to readonly mode but we also need to be able to define properties as being readonly; rather than just the whole crate. This likely follows the same pattern as hide and layouts.