Class: HowToStep

An individual step which is part of a HowTo.

__

_There must be a single 'primary' HowToStep which groups all of your sub-steps together; _

your HowTo should link to the identifier of the primary step.

__

Make sure to describe any configuration or parameters in a HowToTip.

__

URI: schema:HowToStep

diagram

Slots

Name	Cardinality and Range	Description	Inheritance
id	1 String	An identifier chosen from the range given to your work package by WP1	direct
metadataPublisherId	1 PersonOrOrganization	The MBO Persistent IDentifier (mPID) of the person who entered this row of da...	direct
metadataDescribedForActionId	1 Action	The Action which resulted in this metadata record being described	direct
name	1 String	A name/title	direct
positionInParent	1 Integer	A sort order for this step with respect to other steps in its parent	direct
abstract	0..1 String	A short description summarising this entity	direct
description	0..1 String	A description for this entity	direct
contributorIds	* PersonOrOrganization	The Permanent Identifiers of people or organizations who contributed to the e...	direct
providerId	0..1 PersonOrOrganization	The Permanent Identifier of an person or organization who provides or provide...	direct
citeSourceCodeMboIds	* SoftwareSourceCode	The MBO identifiers for source code used in this HowToStep	direct
citeSoftwareApplicationMboIds	* SoftwareApplication	The MBO identifiers for software or web applications used in this HowToStep	direct
citeServiceMboIds	* Service	The MBO identifiers for services used in this HowToStep	direct
citeDocumentMboIds	* Document	The MBO identifiers for documents used in this HowToStep	direct
childStepMboIds	* HowToStep	The MBO identifiers for steps which are children of this one	direct
howToImplementTipMboIds	* HowToTip	MBO identifiers pointing to tips which detail parameters and other configurat...	direct
audienceMboIds	* Audience	The intended audiences for this entity	direct
usePlatformMboIds	* Platform	The MBO identifiers for platforms used in this methodology step	direct
useInstrumentMboIds	* Instrument	The MBO identifiers for instruments (sensors) used in this methodology step	direct
url	0..1 SchemaURL	The URL of the entity you are describing	direct

Usages

used by	used in	type	used
HowTo	howToStepMboId	range	HowToStep
HowToStep	childStepMboIds	range	HowToStep

Identifier and Mapping Information

Schema Source

from schema: https://w3id.org/marco-bolo/csv-input-classes

Mappings

Mapping Type	Mapped Value
self	schema:HowToStep
native	mbo:HowToStep

LinkML Source

Direct

name: HowToStep
description: "An individual step which is part of a `HowTo`.\n\nThere must be a single\
  \ 'primary' HowToStep which groups all of your sub-steps together; \nyour `HowTo`\
  \ should link to the identifier of the primary step.\n\nMake sure to describe any\
  \ configuration or parameters in a HowToTip.\n"
from_schema: https://w3id.org/marco-bolo/csv-input-classes
slots:
- id
- metadataPublisherId
- metadataDescribedForActionId
- name
- positionInParent
- abstract
- description
- contributorIds
- providerId
- citeSourceCodeMboIds
- citeSoftwareApplicationMboIds
- citeServiceMboIds
- citeDocumentMboIds
- childStepMboIds
- howToImplementTipMboIds
- audienceMboIds
- usePlatformMboIds
- useInstrumentMboIds
- url
class_uri: schema:HowToStep

Induced

name: HowToStep
description: "An individual step which is part of a `HowTo`.\n\nThere must be a single\
  \ 'primary' HowToStep which groups all of your sub-steps together; \nyour `HowTo`\
  \ should link to the identifier of the primary step.\n\nMake sure to describe any\
  \ configuration or parameters in a HowToTip.\n"
from_schema: https://w3id.org/marco-bolo/csv-input-classes
attributes:
  id:
    name: id
    description: 'An identifier chosen from the range given to your work package by
      WP1.

      '
    title: MBO Permanent Identifier
    comments:
    - "This is the identifier (mPID) for this row of the spreadsheet \nand for whatever\
      \ information is being described in this row. \nIt must start with `mbo_`, only\
      \ use printable ASCII characters\nand should be unique in this column. \n"
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    identifier: true
    alias: id
    owner: HowToStep
    domain_of:
    - Action
    - HowTo
    - HowToStep
    - HowToTip
    - Dataset
    - PersonOrOrganization
    - ContactPoint
    - License
    - PropertyValue
    - DataDownload
    - DatasetComment
    - SoftwareSourceCode
    - SoftwareApplication
    - Service
    - EmbargoStatement
    - DefinedTerm
    - Place
    - GeoShape
    - MonetaryGrant
    - Taxon
    - Audience
    - Document
    - Instrument
    - Platform
    range: string
    required: true
    pattern: ^mbo_[a-zA-Z0-9_-]+$
  metadataPublisherId:
    name: metadataPublisherId
    description: 'The MBO Persistent IDentifier (mPID) of the person who entered this
      row of data.

      '
    title: Data Entry Person (mPID - you)
    comments:
    - 'Should be an mPID from the first column of Person.csv

      '
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:creator
    alias: metadataPublisherId
    owner: HowToStep
    domain_of:
    - Action
    - HowTo
    - HowToStep
    - HowToTip
    - Dataset
    - Person
    - Organization
    - ContactPoint
    - License
    - PropertyValue
    - DataDownload
    - DatasetComment
    - SoftwareSourceCode
    - SoftwareApplication
    - Service
    - EmbargoStatement
    - DefinedTerm
    - Place
    - GeoShape
    - MonetaryGrant
    - Taxon
    - Audience
    - Document
    - Instrument
    - Platform
    range: PersonOrOrganization
    required: true
    multivalued: false
  metadataDescribedForActionId:
    name: metadataDescribedForActionId
    description: 'The [Action](#action) which resulted in this metadata record being
      described.


      Is likely to be the Action associated with a MARCO-BOLO Task.

      '
    title: Data Entered for Action (mPID)
    comments:
    - "The mPID from the first column of the Action.csv. \nNote that you can reference\
      \ the same mPID in multiple rows.\n\nUses the <https://w3id.org/marco-bolo/isResultOf>\
      \ predicate but ultimately ends up being \nrepresented as a triple in the form\
      \ `<action> schema:result <this-entity>`.\n"
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: mbo:isResultOf
    alias: metadataDescribedForActionId
    owner: HowToStep
    domain_of:
    - Action
    - HowTo
    - HowToStep
    - HowToTip
    - Dataset
    - Person
    - Organization
    - ContactPoint
    - License
    - PropertyValue
    - DataDownload
    - DatasetComment
    - SoftwareSourceCode
    - SoftwareApplication
    - EmbargoStatement
    - DefinedTerm
    - Place
    - GeoShape
    - MonetaryGrant
    - Taxon
    - Audience
    - Document
    - Instrument
    - Platform
    range: Action
    required: true
    multivalued: false
  name:
    name: name
    description: A name/title
    title: Name
    comments:
    - "The commonly used name. \nFor example: `MBA` for Marine Biological Association\n"
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:name
    alias: name
    owner: HowToStep
    domain_of:
    - Action
    - HowTo
    - HowToStep
    - HowToTip
    - Dataset
    - Organization
    - ContactPoint
    - License
    - PropertyValue
    - DataDownload
    - SoftwareSourceCode
    - SoftwareApplication
    - Service
    - Place
    - GeoShape
    - MonetaryGrant
    - Taxon
    - Audience
    - Document
    - Instrument
    - Platform
    range: string
    required: true
    multivalued: false
  positionInParent:
    name: positionInParent
    description: A sort order for this step with respect to other steps in its parent.
    title: Position in Parent
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:position
    alias: positionInParent
    owner: HowToStep
    domain_of:
    - HowToStep
    - HowToTip
    range: integer
    required: true
    multivalued: false
  abstract:
    name: abstract
    description: A short description summarising this entity.
    title: Abstract
    comments:
    - "A brief summary that captures the essence of this entity in ~ 1-5 sentences.\
      \ \nThink of this as what would appear in search results or catalog listings,\n\
      it should quickly convey the main purpose or key points without technical details.\n"
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:abstract
    alias: abstract
    owner: HowToStep
    domain_of:
    - Action
    - HowToStep
    - Document
    range: string
    required: false
    multivalued: false
  description:
    name: description
    description: A description for this entity.
    title: Description
    comments:
    - 'A concise one-sentence summary of the main point or purpose.

      '
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:description
    alias: description
    owner: HowToStep
    domain_of:
    - Action
    - HowTo
    - HowToStep
    - HowToTip
    - Dataset
    - Organization
    - ContactPoint
    - License
    - PropertyValue
    - DataDownload
    - SoftwareSourceCode
    - SoftwareApplication
    - Service
    - DefinedTerm
    - Place
    - GeoShape
    - MonetaryGrant
    - Document
    - Instrument
    - Platform
    range: string
    required: false
    multivalued: false
  contributorIds:
    name: contributorIds
    description: The Permanent Identifiers of people or organizations who contributed
      to the entity.
    title: Contributors (mPIDs)
    comments:
    - 'Should be an mPID from the first column of either Person.csv or Organization.csv

      Pipe-delimited when there are multiple values.

      '
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:contributor
    alias: contributorIds
    owner: HowToStep
    domain_of:
    - HowToStep
    - Dataset
    - DataDownload
    - SoftwareSourceCode
    - SoftwareApplication
    - Document
    range: PersonOrOrganization
    required: false
    multivalued: true
  providerId:
    name: providerId
    description: The Permanent Identifier of an person or organization who provides
      or provided the service.
    title: Provider (mPID)
    comments:
    - 'Should be an mPID from the first column of either Person.csv or Organization.csv

      '
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:provider
    alias: providerId
    owner: HowToStep
    domain_of:
    - HowToStep
    - SoftwareApplication
    range: PersonOrOrganization
    required: false
    multivalued: false
  citeSourceCodeMboIds:
    name: citeSourceCodeMboIds
    description: The MBO identifiers for source code used in this HowToStep.
    title: Source Code Citations (mPIDs)
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:citation
    alias: citeSourceCodeMboIds
    owner: HowToStep
    domain_of:
    - HowToStep
    range: SoftwareSourceCode
    required: false
    multivalued: true
  citeSoftwareApplicationMboIds:
    name: citeSoftwareApplicationMboIds
    description: The MBO identifiers for software or web applications used in this
      HowToStep.
    title: Software Application Citations (mPIDs)
    comments:
    - 'mPID(s) from the first column of SoftwareApplication.csv

      Pipe-delimited when there are multiple values

      '
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:citation
    alias: citeSoftwareApplicationMboIds
    owner: HowToStep
    domain_of:
    - HowToStep
    range: SoftwareApplication
    required: false
    multivalued: true
  citeServiceMboIds:
    name: citeServiceMboIds
    description: The MBO identifiers for services used in this HowToStep.
    title: Service Citations (mPIDs)
    comments:
    - 'mPID(s) from the first column of Service.csv

      Pipe-delimited when there are multiple values

      '
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:citation
    alias: citeServiceMboIds
    owner: HowToStep
    domain_of:
    - HowToStep
    range: Service
    required: false
    multivalued: true
  citeDocumentMboIds:
    name: citeDocumentMboIds
    description: The MBO identifiers for documents used in this HowToStep.
    title: Document Citations (mPIDs)
    comments:
    - 'mPID(s) from the first column of Document.csv

      Pipe-delimited when there are multiple values

      '
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:citation
    alias: citeDocumentMboIds
    owner: HowToStep
    domain_of:
    - HowTo
    - HowToStep
    range: Document
    required: false
    multivalued: true
  childStepMboIds:
    name: childStepMboIds
    description: The MBO identifiers for steps which are children of this one.
    title: Child Steps (mPIDs)
    comments:
    - 'mPID(s) from the first column of HowToStep.csv

      Pipe-delimited when there are multiple values

      '
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:itemListElement
    alias: childStepMboIds
    owner: HowToStep
    domain_of:
    - HowToStep
    range: HowToStep
    required: false
    multivalued: true
  howToImplementTipMboIds:
    name: howToImplementTipMboIds
    description: 'MBO identifiers pointing to tips which detail parameters and other
      configuration used in the step.

      '
    title: Implementation Tips (mPIDs)
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:usageInfo
    alias: howToImplementTipMboIds
    owner: HowToStep
    domain_of:
    - HowToStep
    range: HowToTip
    required: false
    multivalued: true
  audienceMboIds:
    name: audienceMboIds
    description: 'The intended audiences for this entity.

      '
    title: Audiences (mPIDs)
    comments:
    - 'Should be an mPID from the first column of Audience.csv

      '
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:audience
    alias: audienceMboIds
    owner: HowToStep
    domain_of:
    - HowToStep
    - HowToTip
    - Dataset
    - DataDownload
    - Service
    - Document
    range: Audience
    required: false
    multivalued: true
  usePlatformMboIds:
    name: usePlatformMboIds
    description: 'The MBO identifiers for platforms used in this methodology step.

      '
    title: Platforms Used (mPIDs)
    comments:
    - 'mPID(s) from the first column of Platform.csv

      Pipe-delimited when there are multiple values


      Links this methodology step to the platforms involved.

      For example, a transect survey step might reference a research vessel or AUV.

      '
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:mentions
    alias: usePlatformMboIds
    owner: HowToStep
    domain_of:
    - HowToStep
    range: Platform
    required: false
    multivalued: true
    inlined: false
  useInstrumentMboIds:
    name: useInstrumentMboIds
    description: 'The MBO identifiers for instruments (sensors) used in this methodology
      step.

      '
    title: Instruments Used (mPIDs)
    comments:
    - 'mPID(s) from the first column of Instrument.csv

      Pipe-delimited when there are multiple values


      Links this methodology step to the specific instruments used.

      For example, a water sampling step might reference a CTD and Niskin bottles.

      '
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:mentions
    alias: useInstrumentMboIds
    owner: HowToStep
    domain_of:
    - HowToStep
    range: Instrument
    required: false
    multivalued: true
    inlined: false
  url:
    name: url
    description: The URL of the entity you are describing.
    title: URL
    comments:
    - 'Must include the protocol (scheme) and should follow RFC 3986 standards


      For example: `https://example.com`, `http://example.com`

      `ftp://ftp.example.org/data`, `doi:10.1000/example123`, `urn:isbn:1234567890`,
      `mailto:contact@example.com`

      '
    from_schema: https://w3id.org/marco-bolo/csv-input-classes
    rank: 1000
    slot_uri: schema:url
    alias: url
    owner: HowToStep
    domain_of:
    - HowTo
    - HowToStep
    - Organization
    - Service
    - MonetaryGrant
    - Document
    - Instrument
    - Platform
    range: schemaURL
    required: false
    multivalued: false
class_uri: schema:HowToStep