GitHub Twitter

How to update a profile

In this how-to, we will guide you through the necessary steps for you to update a profile, i.e.,create and publish a new draft profile, you need some knowledge on spreadsheets, GitHub, git and Jekyll.

Keywords: schema.org, markup, structured data, bioschemas profile

Topics:

Audience:

  • People interested in creating and publishing a new draft profile

Authors:

Contributors:

License: CC-BY 4.0

Version: 1.0

Last Modified: 05 May 2021


◀ Previous tutorial: How to create a new draft profile | Next tutorial: How to add markup to your own resource

1. Prepare your working environment

To update a profile you need access to a couple of Bioschemas resources, here we list them all together with the main role they play in the whole process. We will explain how to use them and what to do with them in later steps.

  • Bioschemas specifications GDrive folder: to create the spreadsheet corresponding to the new draft profile, you need editing rights
    • Note 1: a specification in Bioschemas defines either a type (existing in schema.org or created by Bioschemas) or a profile (set of rules on how to use a type). A type specification corresponds to a set of relations, aka properties, between the described type and other types (for instance, the specification for the type Protein includes a property associatedDisease describing how a relation between a protein and a disease). A profile specification selects the most useful properties for a given type and provides additional information on cardinality, marginality and controlled vocabularies (for instance, the specification for the Protein profile indicates that the property associatedDisease is recommended and has cardinality MANY)
    • Note 2: a GDrive, short for Google Drive, is a file storage and synchronization service developed by Google. Bioschemas uses a GDrive folder to host information related to, for instance, specifications
  • GOWeb repository: to move from the spreadsheet to the website
  • Website repository: to publish the new draft profile, you need editing rights
  • Specifications repository: to add compliant examples regarding the new draft profile, you need editing rights

If you do not have the right permissions to edit the mentioned resources, send an email to the mailing list explaining why you should have access and what Bioschemas group you belong to. Once your case has been validated, you will get an invitation to join the GDrive and the repositories.

From now on, we will use ScholarlyArticle as an example to create and publish a new draft profile.

2. Create a new profile crosswalk

A profile crosswalk is the cornerstone of Bioschemas profile development. It is a spreadsheet with the Schema.org fields to be considered together with cardinality, marginality, suggested controlled vocabularies and examples. It is not a regular spreadsheet but one with a template and some predefined functionalities. It is then translated into structured data so that the Bioschemas web site is automatically updated.

A new profile is commonly based on the previous one so the easiest way to start is from the previous version.

  • Go to the GDrive and navigate to the folder Specifications
  • Locate and open the folder corresponding to the profile you want to update, in our example it is the ScholarlyArticle folder
  • Create a copy of the latest ScholarlyArticle Mapping file. At the time of writing, it was the ScholarlyArticle Mapping 0.2-DRAFT
    • Note: a mapping file corresponds to a Google spreadsheet and it is the way that Bioschemas uses to do a crosswalk on a profile before adding it to the website. Bioschemas groups will work first on this crosswalk (mapping file, spreadsheet) and when it is ready to go (i.e., the involved people is happy with the content, it has been reviewed and approved), it can be published to the website
  • Rename the copy so it reflects the new draft version, in this case it would be ScholarlyArticle Mapping 0.3-DRAFT

We will now discuss the different tabs in the spreadsheet and how they are used in updating a profile.

2.1. The Specification Info tab

In this tab, you need to update the “Description” column. In most cases the actual description of the profile will remain the same but the “Summary of Changes” will change. List all the changes in this new draft profile, use a HTML list markup for that, below there is an example:



<h4>Summary of Changes</h4>
    Changes since previous draft 0.1 of the ScholarlyArticle profile:
    <ul>
      <li>Add examples</li>
      <li>Updates identifier property to MANY so multiple identifiers can be included</li>
      <li>Uses name for the title (as per schema.org examples) and keeps headline (optional) for compatibility purposes</li>
      <li>Update ranges as per latest version of schema.org</li>   
    </ul>


You will also need to update:

  • the “version” column with the new version
  • the “Full Example” column with the link pointing to examples for this new version, see more on the Update examples section

You should update the column “Official Type” if and only if you modified the main parent type from Schema.org. For instance, in previous versions the Bioschemas TrainingMaterial profile had CreativeWork as the main parent Schema.org type but it was changed to LearningResource from version 0.8

2.2. The Schema.org mapping tab

Here you will make the changes to the profile. There are a couple of possibilities here.

  • You want to update a property that already exists (e.g., there is typo, description should be updated, a new controlled vocabulary will be added, a new example is necessary, expected Schema.org types have changed, etc.)
    • Go to the column you want to change and update it as needed, some examples include
      • Changing the marginality (column ‘Marginality’) or cardinality (column ‘Cardinality’) by selecting the new desired one from the provided drop-box list
      • Adding or modifying a tailor Bioschemas definition by directly entering the text in the corresponding column ‘BSC Description’
      • Adding or modifying the mini example for a particular property by entering the text in the corresponding column ‘Example’, remember to use JSON-LD syntax for this
  • You want to add a new property
    • If it is a property belonging to a parent type already recorded, see Figure 1 below. Our ScholarlyArticle example already extends ScholarlyArticle, Article, CreativeWork and Thing
      • Add a new column under the corresponding type. Let’s suppose you want to add the property “wordCount” that comes from the type Article
      • Go to the parent type in Schema.org, in this case Article and copy the property name, the expected types and the description and paste them on the first three columns of the row you just created
      • Fill in the rest of the columns as needed (remember, columns “Type” and “Type URL” should be left empty)
    • If it is a property belonging to a new parent
      • Add a new row indicating what type is being extended
      • Follow the process as described for properties belonging to a parent already recorded
Figure 1. From Schema.org to profile spreadsheet
Figure 1. From Schema.org to profile spreadsheet

3. Get the code for the new draft profile

Now you are ready to generate the machine-processable Bioschemas version of your new draft profile.

  • Go to GOWeb repository and get the executable version corresponding to your Operating System. If you need assistance with GOWeb send an email to the mailing list.
  • Run GOWeb using the CSV file you created on the previous section Publish the Bioschemas fields to the Web
  • A YAML file will be created that is then used in the webpage for the new draft version

3.1 Publish the Bioschemas fields to the Web

Once you have finished with the changes on the spreadsheet, see previous section Create a new profile crosswalk, go to the menu File/Publish to the web/, select “Bioschemas Fields” and “CSV”, publish and copy the link, see Figure 2 below.

Figure 2. Publish Bioschemas fields to the web
Figure 2. Publish Bioschemas fields to the web

4. Update the website

You are now ready to publish the new draft version on the Bioschemas website.

4.1. Create a new version page

  • If you have not done so yet, clone the Bioschemas website repository so you have a local copy
  • Open your local copy in your preferred editor
  • Go to _profiles/<your profile>, in this case _profiles/ScholarlyArticle
  • Create a copy of the latest profile, in our case it is 0.2-DRAFT-2020_12_03.html
  • Rename the copy so it reflects the new draft version, in our case it would be 0.3-DRAFT.html (having the dates as part of the draft name is no longer needed/desired)

4.2. Update the redirects

Updating the redirects depends on the status of the previous version

  • If the previous version is a draft profile then remove the redirect_from property
  • If the previous version is a release then the redirect_from property should be updated to
redirect_from:
- "/profiles/ScholarlyArticle/"

and the new draft version should have the following redirect_from property:

redirect_from:
- "devSpecs/ScholarlyArticle/specification"
- "devSpecs/ScholarlyArticle/specification/"
- "/devSpecs/ScholarlyArticle/"
- "/specifications/drafts/ScholarlyArticle"

4.3. Update the content

Now on the new draft version file

  • Update the previous version, in our case it would be previous_version: 0.2-DRAFT-2020_12_03
  • Update the cross_walk_url to point to the spreadsheet on the GDrive
  • If you changed the parent type (very rarely it happens), you need to update the section parent_type

Now you are ready to update the part corresponding to the spreadsheet, go to the spec_info section, it start with the lines

  # spec_info content generated using GOWeb
  # DO NOT MANUALLY EDIT THE CONTENT
  • Keep the two first lines only, i.e., remove from the line spec_info all the way to a line with three dashes ---, which is right before the line <!DOCTYPE HTML>
  • Add all the lines coming from the YAML file that you got from GO Web
  • Save the file!

4.4. Update the profile version

You are now ready to update the profile version

  • Go to the folder _data and locate the file profile_versions.yaml
  • Find there the profile you are updating, in this case ScholarlyArticle, and update the version, in this case it would be version 0.3-DRAFT
ScholarlyArticle:
    name: "ScholarlyArticle"
    latest_publication: "0.3-DRAFT"
    latest_release:
    status: "active"

5. Get an overview on your local copy

Now you are ready to run the website locally, open a terminal and run jekyll serve (how to get Jekyll running is out of the scope of this tutorial, you will find more information on the topic in the corresponding GitHub Help pages).

Open the local URL and navigate the pages corresponding to the profile that you just changed to make sure everything is working well.

6. Update examples

Regardless whether it was a minor or major change, it is always a good idea to have full examples on the Specifications repository

  • You can choose adding the examples directly on GitHub or on a local version
  • Navigate to the examples folder corresponding to your profile, in this case it would be ScholarlyArticle/examples
  • Create a new folder corresponding to your new draft, 0.3-DRAFT in this case
  • Add there the new examples in JSON-LD format using the extension file json
  • If the examples for the previous version are fully compatible with the new version, it is ok if you add a note pointing to the previous examples rather than adding new ones
  • On the examples, always remember to add the dct:conformsTo property so it points to your profile version, for example
"http://purl.org/dc/terms/conformsTo": "https://bioschemas.org/profiles/ScholarlyArticle/0.3-DRAFT",

7. Create a Pull Request

Congratulations, you have created a new draft profile and are now ready to create a Pull Request on the Bioschemas website repository. Always suggest at least one possible reviewer as your PR cannot be merged unless one reviewer has approved it.


◀ Previous tutorial: How to create a new draft profile | Next tutorial: How to add markup to your own resource

Top ▲