Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bio.tools ID to be a subset of xs:NCName (fixes #79) #93

Merged
merged 2 commits into from
Nov 15, 2017

Conversation

matuskalas
Copy link
Member

Slighly limited the xs:pattern of the bio.tools ID, so that it is always an xs:NCName. This is required for usage in RDF/XML (Linked Data).

This fixes the last open point (the 3rd) of #79 (comment).

Also slightly clarified the xs:documentation of biotoolsUrlType and urlType, and moved the detailed xs:documentation from otherID/type and biotoolsID to biotoolsIdType accordingly (updated version of

<xs:documentation>bio.tools toolIDs are a URL-safe derivative of (often identical to) the tool name. Unreserved characters (uppercase and lowercase letters, decimal digits, hyphen, period, underscore, and tilde) are allowed. All other characters including reserved characters and other characters deemed unsafe are not allowed. Spaces can be preserved as underscore ("_").</xs:documentation>
and
<xs:documentation>The ID is a URL-safe derivative of (often identical to) the tool name restricted to 12 characters maximum. Unreserved characters (uppercase and lowercase letters, decimal digits, hyphen, period, underscore, and tilde) are allowed. All other characters including reserved characters and other characters deemed unsafe are not allowed. Spaces can be preserved as underscore ("_").</xs:documentation>
).

N.B.: As much as could search through the bio.tools GUI, it seems like all the assigned bio.tools IDs anyway satisfy this new pattern. But must be double-checked, and if needed fixed.

Slighly limited the `xs:pattern` of the bio.tools ID, so that it is always an `xs:NCName`. This is required for usage in RDF/XML (Linked Data).
This fixes the last open point (the 3rd) of #79 (comment).
Also slightly clarified the `xs:documentation` of `biotoolsUrlType` and `urlType`, and moved the detailed `xs:documentation` from `otherID`/`type` and `biotoolsID` to `biotoolsIdType` accordingly (updated version of https://github.com/bio-tools/biotoolsSchema/blob/753c572781d8d23a37eba2eb1d37a7728ec83b99/biotools_dev.xsd#L212 and https://github.com/bio-tools/biotoolsSchema/blob/753c572781d8d23a37eba2eb1d37a7728ec83b99/biotools_dev.xsd#L136).
_N.B._: As much as could search through the bio.tools GUI, it seems like all the assigned bio.tools IDs anyway satisfy this new pattern. But must be double-checked, and if needed fixed.
And removed the first and misleading copied&pasted title "November 17, 2016 biotoolsSchema-2.0.0.xsd released".
Copy link
Member

@joncison joncison left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is excellent, thanks a million! Just to be clear, am I right that biotools toolIDs must now start with an underscore, a letter or a number?

@joncison joncison merged commit b7edbbe into master Nov 15, 2017
@joncison joncison deleted the fix_biotoolsID_pattern branch November 15, 2017 09:41
@matuskalas
Copy link
Member Author

To clarify: bio.tools tool ID must now start with an underscore or an English letter. Not a number! This is requirement for being a valid NCName, usable in RDF/XML (and perhaps also other Linked Data formats).

@hansioan
Copy link
Member

@joncison @matuskalas
Well, I don't know what to say about that, I don't think it's realistic for bio.tools, many tools start with a number (a good example are tools that do something with 3D and thus the id starts with 3D...)
I could add an underscore to those ids that start with a number, but this would mean breaking the existing ids and also not representing the tool name as it is (personally I think they would look ugly)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants