From cd05a7867706b38807d515d4cd4c2b4d21793411 Mon Sep 17 00:00:00 2001 From: Ivan Herman Date: Sun, 11 Feb 2024 15:35:45 +0100 Subject: [PATCH] Updated documentation --- docs/classes/index.VocabGeneration.html | 12 ++++++------ docs/classes/lib_common.StatusCounter.html | 4 ++-- docs/enums/lib_common.Status.html | 4 ++-- docs/functions/index.generateVocabularyFiles.html | 2 +- docs/functions/index.generate_vocabulary_files.html | 2 +- docs/functions/lib_context.toContext.html | 2 +- docs/functions/lib_convert.getData.html | 2 +- docs/functions/lib_html.toHTML.html | 2 +- docs/functions/lib_jsonld.toJSONLD.html | 2 +- docs/functions/lib_schema.validateWithSchema.html | 2 +- docs/functions/lib_turtle.toTurtle.html | 2 +- docs/interfaces/lib_common.Contexts.html | 2 +- docs/interfaces/lib_common.Example.html | 4 ++-- docs/interfaces/lib_common.Link.html | 4 ++-- docs/interfaces/lib_common.OntologyProperty.html | 4 ++-- docs/interfaces/lib_common.RDFClass.html | 4 ++-- docs/interfaces/lib_common.RDFDatatype.html | 4 ++-- docs/interfaces/lib_common.RDFIndividual.html | 4 ++-- docs/interfaces/lib_common.RDFPrefix.html | 4 ++-- docs/interfaces/lib_common.RDFProperty.html | 4 ++-- docs/interfaces/lib_common.RDFTerm.html | 4 ++-- docs/interfaces/lib_common.RawVocab.html | 4 ++-- docs/interfaces/lib_common.RawVocabEntry.html | 4 ++-- docs/interfaces/lib_common.ValidationError.html | 4 ++-- docs/interfaces/lib_common.ValidationResults.html | 6 +++--- docs/interfaces/lib_common.Vocab.html | 4 ++-- docs/modules/index.html | 2 +- docs/modules/lib_common.html | 2 +- docs/modules/lib_context.html | 2 +- docs/modules/lib_convert.html | 2 +- docs/modules/lib_html.html | 2 +- docs/modules/lib_jsonld.html | 2 +- docs/modules/lib_schema.html | 2 +- docs/modules/lib_turtle.html | 2 +- docs/variables/lib_common.EXTRA_DATATYPES.html | 2 +- docs/variables/lib_common.global.html | 2 +- 36 files changed, 58 insertions(+), 58 deletions(-) diff --git a/docs/classes/index.VocabGeneration.html b/docs/classes/index.VocabGeneration.html index 4200077..efdd10a 100644 --- a/docs/classes/index.VocabGeneration.html +++ b/docs/classes/index.VocabGeneration.html @@ -1,5 +1,5 @@ VocabGeneration | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

Class VocabGeneration

Conversion class for YAML to the various syntaxes.

-

Hierarchy

  • VocabGeneration

Constructors

constructor +

Hierarchy

  • VocabGeneration

Constructors

constructor

Methods

getContext getHTML getJSONLD @@ -10,12 +10,12 @@ get_turtle

Constructors

constructor

  • Parameters

    • yml_content: string

      the YAML content in string (before parsing)

    Returns VocabGeneration

    Throws

    Error raised by either the YAML parser or the Schema Validator

    -

Methods

getContext

  • Get the minimal JSON-LD Context file for the vocabulary

    +

Methods

getContext

  • Get the minimal JSON-LD Context file for the vocabulary

    Returns string

    The JSON-LD content

    -

getHTML

  • Get the HTML/RDFa representation of the vocabulary based on an HTML template

    +

getHTML

  • Get the HTML/RDFa representation of the vocabulary based on an HTML template

    Parameters

    • template: string

      Textual version of the vocabulary template

      -

    Returns string

getJSONLD

  • Get the JSON-LD representation of the vocabulary

    +

Returns string

getJSONLD

  • Get the JSON-LD representation of the vocabulary

    Returns string

    The JSON-LD content

    -

getTurtle

  • Get the Turtle representation of the vocabulary

    +

getTurtle

  • Get the Turtle representation of the vocabulary

    Returns string

    The Turtle content

    -

get_context

  • Returns string

get_html

  • Parameters

    • template: string

    Returns string

get_jsonld

  • Returns string

get_turtle

  • Returns string

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

get_context

get_html

get_jsonld

get_turtle

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/lib_common.StatusCounter.html b/docs/classes/lib_common.StatusCounter.html index 3eceb86..06eb033 100644 --- a/docs/classes/lib_common.StatusCounter.html +++ b/docs/classes/lib_common.StatusCounter.html @@ -1,5 +1,5 @@ StatusCounter | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

Class StatusCounter

Simple counter to track how many terms are defined as stable, reserved, or deprecated.

-

Hierarchy

  • StatusCounter

Constructors

constructor +

Hierarchy

  • StatusCounter

Constructors

constructor

Methods

add counter -

Constructors

constructor

Methods

add

counter

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Methods

add

counter

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/enums/lib_common.Status.html b/docs/enums/lib_common.Status.html index f865b91..09769d5 100644 --- a/docs/enums/lib_common.Status.html +++ b/docs/enums/lib_common.Status.html @@ -1,5 +1,5 @@ Status | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

Enumeration Status

Characterization of a class/property/individual on whether it is stable or not.

-

Enumeration Members

deprecated +

Enumeration Members

deprecated reserved stable -

Enumeration Members

deprecated

deprecated: "deprecated"

reserved

reserved: "reserved"

stable

stable: "stable"

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Enumeration Members

deprecated

deprecated: "deprecated"

reserved

reserved: "reserved"

stable

stable: "stable"

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/functions/index.generateVocabularyFiles.html b/docs/functions/index.generateVocabularyFiles.html index 4fa57a6..c4c2d98 100644 --- a/docs/functions/index.generateVocabularyFiles.html +++ b/docs/functions/index.generateVocabularyFiles.html @@ -7,4 +7,4 @@
  • template_file_name: string

    the HTML template file

  • context: boolean

    whether the JSON-LD context file should also be generated

    • Returns Promise<void>

    Throws

    on error situation in reading the input files, in yml validation, or when writing the result

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/index.generate_vocabulary_files.html b/docs/functions/index.generate_vocabulary_files.html index dd9f671..adc2409 100644 --- a/docs/functions/index.generate_vocabulary_files.html +++ b/docs/functions/index.generate_vocabulary_files.html @@ -1 +1 @@ -generate_vocabulary_files | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Function generate_vocabulary_files

    • Parameters

      • yaml_file_name: string
      • template_file_name: string
      • context: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +generate_vocabulary_files | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Function generate_vocabulary_files

    • Parameters

      • yaml_file_name: string
      • template_file_name: string
      • context: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/lib_context.toContext.html b/docs/functions/lib_context.toContext.html index 229d752..998223a 100644 --- a/docs/functions/lib_context.toContext.html +++ b/docs/functions/lib_context.toContext.html @@ -1,3 +1,3 @@ toContext | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Function toContext

    • Generate the minimal JSON-LD context for the vocabulary.

      Parameters

      • vocab: Vocab

        The internal representation of the vocabulary

        -

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/lib_convert.getData.html b/docs/functions/lib_convert.getData.html index e0e63ef..e23662c 100644 --- a/docs/functions/lib_convert.getData.html +++ b/docs/functions/lib_convert.getData.html @@ -6,4 +6,4 @@ in a separate function for a better readability of the code.

    Parameters

    Returns Vocab

    Throws

    Error in the schema validation or when parsing the YAML content

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/lib_html.toHTML.html b/docs/functions/lib_html.toHTML.html index b1d01f7..33c448c 100644 --- a/docs/functions/lib_html.toHTML.html +++ b/docs/functions/lib_html.toHTML.html @@ -10,4 +10,4 @@ that useful and it complicates the code; at some point we may decide to remove this.

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/lib_jsonld.toJSONLD.html b/docs/functions/lib_jsonld.toJSONLD.html index 42879d9..7e0c88e 100644 --- a/docs/functions/lib_jsonld.toJSONLD.html +++ b/docs/functions/lib_jsonld.toJSONLD.html @@ -9,4 +9,4 @@ (reversed) rdfs:isDefinedBy. (See the definition of the 'rdfs_classes', 'rdfs_properties', and 'rdfs_instances'). Thanks to Gregg Kellogg for that trick...

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/lib_schema.validateWithSchema.html b/docs/functions/lib_schema.validateWithSchema.html index b0e4e79..dcf9fb3 100644 --- a/docs/functions/lib_schema.validateWithSchema.html +++ b/docs/functions/lib_schema.validateWithSchema.html @@ -1,4 +1,4 @@ validateWithSchema | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Function validateWithSchema

    • Perform a JSON Schema validation on the YAML content. Done by converting the YAML content into a Javascript object (using the YAML parser) and checking the object against a schema.

      Parameters

      • yaml_raw_content: string

        The raw textual content of the YAML file (i.e, presumably after reading the file itself)

        -

      Returns ValidationResults

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns ValidationResults

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/lib_turtle.toTurtle.html b/docs/functions/lib_turtle.toTurtle.html index 43b565d..07e1be5 100644 --- a/docs/functions/lib_turtle.toTurtle.html +++ b/docs/functions/lib_turtle.toTurtle.html @@ -1,4 +1,4 @@ toTurtle | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Function toTurtle

    • Generate the Turtle representation of the vocabulary. Nothing complex, just a straightforward conversion of the information into the turtle syntax.

      Parameters

      • vocab: Vocab

        The internal representation of the vocabulary

        -

      Returns string

      Async

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string

    Async

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.Contexts.html b/docs/interfaces/lib_common.Contexts.html index 1444fc8..f1ea961 100644 --- a/docs/interfaces/lib_common.Contexts.html +++ b/docs/interfaces/lib_common.Contexts.html @@ -1,2 +1,2 @@ Contexts | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface Contexts

    Context references

    -

    Hierarchy

    • Contexts

    Indexable

    [ctx: string]: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Hierarchy

    Indexable

    [ctx: string]: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.Example.html b/docs/interfaces/lib_common.Example.html index beb024d..146b955 100644 --- a/docs/interfaces/lib_common.Example.html +++ b/docs/interfaces/lib_common.Example.html @@ -1,4 +1,4 @@ Example | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface Example

    Common structure for an example that can be added to the code and shown in the HTML version of the data.

    -

    Hierarchy

    • Example

    Properties

    json +

    Hierarchy

    • Example

    Properties

    json label? -

    Properties

    json

    json: string

    Optional label

    label?: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    json

    json: string

    Optional label

    label?: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.Link.html b/docs/interfaces/lib_common.Link.html index aeeed12..7237b5d 100644 --- a/docs/interfaces/lib_common.Link.html +++ b/docs/interfaces/lib_common.Link.html @@ -1,4 +1,4 @@ Link | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface Link

    Generic structure for a hyperlink

    -

    Hierarchy

    • Link

    Properties

    label +

    Hierarchy

    • Link

    Properties

    label url -

    Properties

    label

    label: string

    url

    url: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    label

    label: string

    url

    url: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.OntologyProperty.html b/docs/interfaces/lib_common.OntologyProperty.html index e45ad9b..2530eb9 100644 --- a/docs/interfaces/lib_common.OntologyProperty.html +++ b/docs/interfaces/lib_common.OntologyProperty.html @@ -1,7 +1,7 @@ OntologyProperty | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface OntologyProperty

    Information for the ontology properties, i.e., properties that are defined on the top level.

    The third value (url) indicates whether the property is a URL value. For values extracted from the CSV this is decided by checking whether the string can be considered to be a valid URL or not.

    -

    Hierarchy

    • OntologyProperty

    Properties

    property +

    Hierarchy

    • OntologyProperty

    Properties

    property url value -

    Properties

    property

    property: string

    url

    url: boolean

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    property

    property: string

    url

    url: boolean

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.RDFClass.html b/docs/interfaces/lib_common.RDFClass.html index 298cfc8..7847e02 100644 --- a/docs/interfaces/lib_common.RDFClass.html +++ b/docs/interfaces/lib_common.RDFClass.html @@ -1,7 +1,7 @@ RDFClass | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface RDFClass

    Extra information necessary for a class: its superclasses. The cross references for domains and ranges are calculated. None is required.

    -

    Hierarchy

    Properties

    comment? +

    Hierarchy

    Properties

    comment? context defined_by? deprecated? @@ -16,4 +16,4 @@ status? subClassOf? type -

    Properties

    Optional comment

    comment?: string

    context

    context: string[]

    Optional defined_by

    defined_by?: string

    Optional deprecated

    deprecated?: boolean

    domain_of

    domain_of: string[]

    Optional example

    example?: Example[]

    id

    id: string

    included_in_domain_of

    included_in_domain_of: string[]

    includes_range_of

    includes_range_of: string[]

    label

    label: string

    range_of

    range_of: string[]

    Optional see_also

    see_also?: Link[]

    Optional status

    status?: Status

    Optional subClassOf

    subClassOf?: string[]

    type

    type: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional comment

    comment?: string

    context

    context: string[]

    Optional defined_by

    defined_by?: string

    Optional deprecated

    deprecated?: boolean

    domain_of

    domain_of: string[]

    Optional example

    example?: Example[]

    id

    id: string

    included_in_domain_of

    included_in_domain_of: string[]

    includes_range_of

    includes_range_of: string[]

    label

    label: string

    range_of

    range_of: string[]

    Optional see_also

    see_also?: Link[]

    Optional status

    status?: Status

    Optional subClassOf

    subClassOf?: string[]

    type

    type: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.RDFDatatype.html b/docs/interfaces/lib_common.RDFDatatype.html index 80118a5..03183b6 100644 --- a/docs/interfaces/lib_common.RDFDatatype.html +++ b/docs/interfaces/lib_common.RDFDatatype.html @@ -1,6 +1,6 @@ RDFDatatype | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface RDFDatatype

    Extra optional information is the superclass (ie, the datatypes that was used to derive this one). The cross references for domains and ranges are calculated.

    -

    Hierarchy

    Properties

    comment? +

    Hierarchy

    Properties

    comment? context defined_by? deprecated? @@ -13,4 +13,4 @@ status? subClassOf? type -

    Properties

    Optional comment

    comment?: string

    context

    context: string[]

    Optional defined_by

    defined_by?: string

    Optional deprecated

    deprecated?: boolean

    Optional example

    example?: Example[]

    id

    id: string

    includes_range_of

    includes_range_of: string[]

    label

    label: string

    range_of

    range_of: string[]

    Optional see_also

    see_also?: Link[]

    Optional status

    status?: Status

    Optional subClassOf

    subClassOf?: string[]

    type

    type: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional comment

    comment?: string

    context

    context: string[]

    Optional defined_by

    defined_by?: string

    Optional deprecated

    deprecated?: boolean

    Optional example

    example?: Example[]

    id

    id: string

    includes_range_of

    includes_range_of: string[]

    label

    label: string

    range_of

    range_of: string[]

    Optional see_also

    see_also?: Link[]

    Optional status

    status?: Status

    Optional subClassOf

    subClassOf?: string[]

    type

    type: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.RDFIndividual.html b/docs/interfaces/lib_common.RDFIndividual.html index 105890a..f4badca 100644 --- a/docs/interfaces/lib_common.RDFIndividual.html +++ b/docs/interfaces/lib_common.RDFIndividual.html @@ -1,7 +1,7 @@ RDFIndividual | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface RDFIndividual

    No extra information is necessary for an individual, but it makes the code more readable if there is a separate interface for it. And one may never know how things will evolve...

    -

    Hierarchy

    Properties

    comment? +

    Hierarchy

    Properties

    comment? context defined_by? deprecated? @@ -11,4 +11,4 @@ see_also? status? type -

    Properties

    Optional comment

    comment?: string

    context

    context: string[]

    Optional defined_by

    defined_by?: string

    Optional deprecated

    deprecated?: boolean

    Optional example

    example?: Example[]

    id

    id: string

    label

    label: string

    Optional see_also

    see_also?: Link[]

    Optional status

    status?: Status

    type

    type: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional comment

    comment?: string

    context

    context: string[]

    Optional defined_by

    defined_by?: string

    Optional deprecated

    deprecated?: boolean

    Optional example

    example?: Example[]

    id

    id: string

    label

    label: string

    Optional see_also

    see_also?: Link[]

    Optional status

    status?: Status

    type

    type: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.RDFPrefix.html b/docs/interfaces/lib_common.RDFPrefix.html index afdd033..eb09245 100644 --- a/docs/interfaces/lib_common.RDFPrefix.html +++ b/docs/interfaces/lib_common.RDFPrefix.html @@ -1,4 +1,4 @@ RDFPrefix | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface RDFPrefix

    Information for a prefix (to be used either as a prefix in Turtle or in the context of a JSON-LD).

    -

    Hierarchy

    • RDFPrefix

    Properties

    prefix +

    Hierarchy

    • RDFPrefix

    Properties

    prefix url -

    Properties

    prefix

    prefix: string

    url

    url: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    prefix

    prefix: string

    url

    url: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.RDFProperty.html b/docs/interfaces/lib_common.RDFProperty.html index 3dc71f5..fcf790c 100644 --- a/docs/interfaces/lib_common.RDFProperty.html +++ b/docs/interfaces/lib_common.RDFProperty.html @@ -1,6 +1,6 @@ RDFProperty | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface RDFProperty

    Extra information necessary for a property: its superproperties, range, and domain. None of these are required.

    -

    Hierarchy

    Properties

    comment? +

    Hierarchy

    Properties

    comment? context dataset? defined_by? @@ -14,4 +14,4 @@ status? subPropertyOf? type -

    Properties

    Optional comment

    comment?: string

    context

    context: string[]

    Optional dataset

    dataset?: boolean

    Optional defined_by

    defined_by?: string

    Optional deprecated

    deprecated?: boolean

    Optional domain

    domain?: string[]

    Optional example

    example?: Example[]

    id

    id: string

    label

    label: string

    Optional range

    range?: string[]

    Optional see_also

    see_also?: Link[]

    Optional status

    status?: Status

    Optional subPropertyOf

    subPropertyOf?: string[]

    type

    type: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional comment

    comment?: string

    context

    context: string[]

    Optional dataset

    dataset?: boolean

    Optional defined_by

    defined_by?: string

    Optional deprecated

    deprecated?: boolean

    Optional domain

    domain?: string[]

    Optional example

    example?: Example[]

    id

    id: string

    label

    label: string

    Optional range

    range?: string[]

    Optional see_also

    see_also?: Link[]

    Optional status

    status?: Status

    Optional subPropertyOf

    subPropertyOf?: string[]

    type

    type: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.RDFTerm.html b/docs/interfaces/lib_common.RDFTerm.html index 6043c27..cd1c834 100644 --- a/docs/interfaces/lib_common.RDFTerm.html +++ b/docs/interfaces/lib_common.RDFTerm.html @@ -1,5 +1,5 @@ RDFTerm | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface RDFTerm

    Top level class for a term in general. Pretty much self-explanatory...

    -

    Hierarchy

    Properties

    comment? +

    Hierarchy

    Properties

    comment? context defined_by? deprecated? @@ -9,4 +9,4 @@ see_also? status? type -

    Properties

    Optional comment

    comment?: string

    context

    context: string[]

    Optional defined_by

    defined_by?: string

    Optional deprecated

    deprecated?: boolean

    Optional example

    example?: Example[]

    id

    id: string

    label

    label: string

    Optional see_also

    see_also?: Link[]

    Optional status

    status?: Status

    type

    type: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional comment

    comment?: string

    context

    context: string[]

    Optional defined_by

    defined_by?: string

    Optional deprecated

    deprecated?: boolean

    Optional example

    example?: Example[]

    id

    id: string

    label

    label: string

    Optional see_also

    see_also?: Link[]

    Optional status

    status?: Status

    type

    type: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.RawVocab.html b/docs/interfaces/lib_common.RawVocab.html index 4136ec6..cd7c41e 100644 --- a/docs/interfaces/lib_common.RawVocab.html +++ b/docs/interfaces/lib_common.RawVocab.html @@ -1,9 +1,9 @@ RawVocab | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface RawVocab

    This is the structure of the YAML file itself. Note that only vocab and ontology is required, everything else is optional

    -

    Hierarchy

    • RawVocab

    Properties

    class? +

    Hierarchy

    • RawVocab

    Properties

    class? datatype? individual? ontology prefix? property? vocab -

    Properties

    Optional class

    class?: RawVocabEntry[]

    Optional datatype

    datatype?: RawVocabEntry[]

    Optional individual

    individual?: RawVocabEntry[]

    ontology

    ontology: RawVocabEntry[]

    Optional prefix

    prefix?: RawVocabEntry[]

    Optional property

    property?: RawVocabEntry[]

    vocab

    vocab: RawVocabEntry[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional class

    class?: RawVocabEntry[]

    Optional datatype

    datatype?: RawVocabEntry[]

    Optional individual

    individual?: RawVocabEntry[]

    ontology

    ontology: RawVocabEntry[]

    Optional prefix

    prefix?: RawVocabEntry[]

    Optional property

    property?: RawVocabEntry[]

    vocab

    vocab: RawVocabEntry[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.RawVocabEntry.html b/docs/interfaces/lib_common.RawVocabEntry.html index 370fa4d..524ed2d 100644 --- a/docs/interfaces/lib_common.RawVocabEntry.html +++ b/docs/interfaces/lib_common.RawVocabEntry.html @@ -1,7 +1,7 @@ RawVocabEntry | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface RawVocabEntry

    Superset of all YAML entries expressed in TS. Look at the Readme.md file for what they are meant for.

    Used to induce some extra checks by TS compile time; the classes are converted into the common classes in this module

    -

    Hierarchy

    • RawVocabEntry

    Properties

    comment? +

    Hierarchy

    • RawVocabEntry

    Properties

    comment? context? dataset? defined_by? @@ -16,4 +16,4 @@ status? upper_value? value? -

    Properties

    Optional comment

    comment?: string

    Optional context

    context?: string[]

    Optional dataset

    dataset?: boolean

    Optional defined_by

    defined_by?: string

    Optional deprecated

    deprecated?: boolean

    Optional domain

    domain?: string[]

    Optional example

    example?: Example[]

    id

    id: string

    label

    label: string

    Optional property

    property?: string

    Optional range

    range?: string[]

    Optional see_also

    see_also?: Link[]

    Optional status

    status?: Status

    Optional upper_value

    upper_value?: string[]

    Optional value

    value?: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional comment

    comment?: string

    Optional context

    context?: string[]

    Optional dataset

    dataset?: boolean

    Optional defined_by

    defined_by?: string

    Optional deprecated

    deprecated?: boolean

    Optional domain

    domain?: string[]

    Optional example

    example?: Example[]

    id

    id: string

    label

    label: string

    Optional property

    property?: string

    Optional range

    range?: string[]

    Optional see_also

    see_also?: Link[]

    Optional status

    status?: Status

    Optional upper_value

    upper_value?: string[]

    Optional value

    value?: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.ValidationError.html b/docs/interfaces/lib_common.ValidationError.html index 54f2ee5..d51e850 100644 --- a/docs/interfaces/lib_common.ValidationError.html +++ b/docs/interfaces/lib_common.ValidationError.html @@ -1,6 +1,6 @@ ValidationError | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface ValidationError

    This is a shortened version of the full Ajv error message (the schema is very simple, the generic Ajv error message is way to complex for this use)

    -

    Hierarchy

    • ValidationError

    Properties

    data? +

    Hierarchy

    • ValidationError

    Properties

    data? message? params? -

    Properties

    Optional data

    data?: any

    Optional message

    message?: string

    Optional params

    params?: any

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional data

    data?: any

    Optional message

    message?: string

    Optional params

    params?: any

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.ValidationResults.html b/docs/interfaces/lib_common.ValidationResults.html index d3cb4a1..23547a0 100644 --- a/docs/interfaces/lib_common.ValidationResults.html +++ b/docs/interfaces/lib_common.ValidationResults.html @@ -1,8 +1,8 @@ ValidationResults | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface ValidationResults

    Type needed for the JSON Schema validation interface

    One of the two values are null, depending on the validation result.

    -

    Hierarchy

    • ValidationResults

    Properties

    error +

    Hierarchy

    • ValidationResults

    Properties

    error vocab -

    Properties

    error

    error: ValidationError[]

    vocab

    vocab: RawVocab

    The YAML content converted into a JSON object; ready to be converted further. +

    Properties

    error

    error: ValidationError[]

    vocab

    vocab: RawVocab

    The YAML content converted into a JSON object; ready to be converted further. If the content is valid, the error array is empty. Otherwise, the vocab field is null, and the validation error(s) are returned.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/lib_common.Vocab.html b/docs/interfaces/lib_common.Vocab.html index 811e307..6f2980b 100644 --- a/docs/interfaces/lib_common.Vocab.html +++ b/docs/interfaces/lib_common.Vocab.html @@ -1,9 +1,9 @@ Vocab | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Interface Vocab

    A vocabulary consists of prefixes, top level (ontology) properties, classes, properties and, possibly, datatypes and individuals…

    -

    Hierarchy

    • Vocab

    Properties

    classes +

    Hierarchy

    • Vocab

    Properties

    classes datatypes individuals ontology_properties prefixes properties -

    Properties

    classes

    classes: RDFClass[]

    datatypes

    datatypes: RDFDatatype[]

    individuals

    individuals: RDFIndividual[]

    ontology_properties

    ontology_properties: OntologyProperty[]

    prefixes

    prefixes: RDFPrefix[]

    properties

    properties: RDFProperty[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    classes

    classes: RDFClass[]

    datatypes

    datatypes: RDFDatatype[]

    individuals

    individuals: RDFIndividual[]

    ontology_properties

    ontology_properties: OntologyProperty[]

    prefixes

    prefixes: RDFPrefix[]

    properties

    properties: RDFProperty[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html index 9a4d2bc..80163fe 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1,4 +1,4 @@ -index | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Module index

    Index

    Classes

    VocabGeneration +index | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Module index

    Index

    Classes

    VocabGeneration

    Functions

    generateVocabularyFiles generate_vocabulary_files

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/lib_common.html b/docs/modules/lib_common.html index 048fa6d..0268246 100644 --- a/docs/modules/lib_common.html +++ b/docs/modules/lib_common.html @@ -1,5 +1,5 @@ lib/common | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Module lib/common

    Common types and variables.

    -

    Index

    Enumerations

    Status +

    Index

    Enumerations

    Status

    Classes

    StatusCounter

    Interfaces

    Contexts Example diff --git a/docs/modules/lib_context.html b/docs/modules/lib_context.html index 742bec9..1438c72 100644 --- a/docs/modules/lib_context.html +++ b/docs/modules/lib_context.html @@ -1,4 +1,4 @@ lib/context | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Module lib/context

    Generate a (minimal) JSON-LD context file for the vocabulary (see the 'Vocab' interface).

    -

    Index

    Functions

    toContext +

    Index

    Functions

    toContext

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/lib_convert.html b/docs/modules/lib_convert.html index ce9a06a..d87c45f 100644 --- a/docs/modules/lib_convert.html +++ b/docs/modules/lib_convert.html @@ -1,4 +1,4 @@ lib/convert | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Module lib/convert

    Convert the raw YAML description of the vocabulary into an internal representation (see the 'Vocab' interface).

    -

    Index

    Functions

    getData +

    Index

    Functions

    getData

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/lib_html.html b/docs/modules/lib_html.html index a78697b..dac3fd4 100644 --- a/docs/modules/lib_html.html +++ b/docs/modules/lib_html.html @@ -1,4 +1,4 @@ lib/html | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Module lib/html

    Convert the internal representation of the vocabulary into HTML (see the 'Vocab' interface).

    -

    Index

    Functions

    toHTML +

    Index

    Functions

    toHTML

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/lib_jsonld.html b/docs/modules/lib_jsonld.html index 620cc4a..35ca0bd 100644 --- a/docs/modules/lib_jsonld.html +++ b/docs/modules/lib_jsonld.html @@ -1,4 +1,4 @@ lib/jsonld | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Module lib/jsonld

    Convert the internal representation of the vocabulary into JSON-LD (see the 'Vocab' interface).

    -

    Index

    Functions

    toJSONLD +

    Index

    Functions

    toJSONLD

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/lib_schema.html b/docs/modules/lib_schema.html index 940b154..25ca4a5 100644 --- a/docs/modules/lib_schema.html +++ b/docs/modules/lib_schema.html @@ -1,3 +1,3 @@ lib/schema | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Module lib/schema

    Import the YAML file, validate against a JSON schema, and return the data as an object...

    -

    Index

    Functions

    validateWithSchema +

    Index

    Functions

    validateWithSchema

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules/lib_turtle.html b/docs/modules/lib_turtle.html index 679d052..8f531c8 100644 --- a/docs/modules/lib_turtle.html +++ b/docs/modules/lib_turtle.html @@ -1,4 +1,4 @@ lib/turtle | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Module lib/turtle

    Convert the internal representation of the vocabulary into turtle (see the 'Vocab' interface).

    -

    Index

    Functions

    toTurtle +

    Index

    Functions

    toTurtle

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/lib_common.EXTRA_DATATYPES.html b/docs/variables/lib_common.EXTRA_DATATYPES.html index ae5caf6..b3bb708 100644 --- a/docs/variables/lib_common.EXTRA_DATATYPES.html +++ b/docs/variables/lib_common.EXTRA_DATATYPES.html @@ -1,3 +1,3 @@ EXTRA_DATATYPES | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Variable EXTRA_DATATYPESConst

    EXTRA_DATATYPES: string[] = ...

    List of datatypes that are formally defined in the RDF World, and are beyond the list of core, XSD datatypes

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/lib_common.global.html b/docs/variables/lib_common.global.html index 935fc1b..5d6f427 100644 --- a/docs/variables/lib_common.global.html +++ b/docs/variables/lib_common.global.html @@ -1,2 +1,2 @@ global | Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.4.7

    Variable globalConst

    global: GlobalData = ...

    As it name says: some global data that are needed by most of the media type specific modules.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file