diff options
author | David Robillard <d@drobilla.net> | 2020-03-22 16:36:44 +0100 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2020-04-10 19:46:04 +0200 |
commit | 430284545345539c9ffb31df889debac1d3888b5 (patch) | |
tree | dc9bb1f32f0d6fe34a7339221389048e199f14a5 /lv2/time | |
parent | c4514483da1ab4f49148f9c4fe4ff5b559323217 (diff) | |
download | lv2-430284545345539c9ffb31df889debac1d3888b5.tar.xz |
Move documentation to metadata files and convert it to Markdown
Diffstat (limited to 'lv2/time')
-rw-r--r-- | lv2/time/time.meta.ttl | 63 | ||||
-rw-r--r-- | lv2/time/time.ttl | 68 |
2 files changed, 84 insertions, 47 deletions
diff --git a/lv2/time/time.meta.ttl b/lv2/time/time.meta.ttl index c735f22..2b99cb7 100644 --- a/lv2/time/time.meta.ttl +++ b/lv2/time/time.meta.ttl @@ -1,12 +1,14 @@ @prefix dcs: <http://ontologi.es/doap-changeset#> . @prefix doap: <http://usefulinc.com/ns/doap#> . @prefix foaf: <http://xmlns.com/foaf/0.1/> . +@prefix lv2: <http://lv2plug.in/ns/lv2core#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . +@prefix time: <http://lv2plug.in/ns/ext/time#> . <http://lv2plug.in/ns/ext/time> a doap:Project ; doap:name "LV2 Time" ; - doap:shortdesc "Properties for describing time." ; + doap:shortdesc "A vocabulary for describing musical time." ; doap:created "2011-10-05" ; doap:developer <http://drobilla.net/drobilla#me> ; doap:release [ @@ -49,5 +51,62 @@ rdfs:label "Initial release." ] ] - ] . + ] ; + lv2:documentation """ + +This is a vocabulary for describing a position in time and the speed of time +passage, in both real and musical terms. + +In addition to real time (based on seconds), two units of time are used: +_frames_ and _beats_. A frame is a numbered quantum of time. Frame time is +related to real-time by the _frame rate_ or _sample rate_, +time:framesPerSecond. A beat is a single pulse of musical time. Beat time is +related to real-time by the _tempo_, time:beatsPerMinute. + +Musical time additionally has a _meter_ which describes passage of time in +terms of musical _bars_. A bar is a higher level grouping of beats. The meter +describes how many beats are in one bar. + +"""^^lv2:Markdown . + +time:Position + lv2:documentation """ + +A point in time and/or the speed at which time is passing. A position is both +a point and a speed, which precisely defines a time within a timeline. + +"""^^lv2:Markdown . + +time:Rate + lv2:documentation """ + +The rate of passage of time in terms of one unit with respect to another. + +"""^^lv2:Markdown . + +time:beat + lv2:documentation """ + +This is not the beat within a bar like time:barBeat, but relative to the same +origin as time:bar and monotonically increases unless the transport is +repositioned. + +"""^^lv2:Markdown . + +time:beatUnit + lv2:documentation """ + +Beat unit, the note value that counts as one beat. This is the bottom number +in a time signature: 2 for half note, 4 for quarter note, and so on. + +"""^^lv2:Markdown . + +time:speed + lv2:documentation """ + +The rate of the progress of time as a fraction of normal speed. For example, a +rate of 0.0 is stopped, 1.0 is rolling at normal speed, 0.5 is rolling at half +speed, -1.0 is reverse, and so on. + +"""^^lv2:Markdown . diff --git a/lv2/time/time.ttl b/lv2/time/time.ttl index 75c164c..1be04d6 100644 --- a/lv2/time/time.ttl +++ b/lv2/time/time.ttl @@ -8,51 +8,38 @@ <http://lv2plug.in/ns/ext/time> a owl:Ontology , lv2:Specification ; + rdfs:label "LV2 Time" ; + rdfs:comment "A vocabulary for describing musical time." ; rdfs:seeAlso <time.h> , - <time.meta.ttl> ; - lv2:documentation """ -<p>This is a vocabulary for precisely describing a position in time and the -passage of time itself, in both real and musical terms.</p> - -<p>In addition to real time (e.g. seconds), two units of time are used: -<q>frames</q> and <q>beats</q>. A frame is a numbered quantum of time. Frame -time is related to real-time by the <q>frame rate</q> or <q>sample rate</q>, -time:framesPerSecond. A beat is a single pulse of musical time. Beat time is -related to real-time by the <q>tempo</q>, time:beatsPerMinute.</p> - -<p>Musical time additionally has a <q>meter</q> which describes passage of time -in terms of musical <q>bars</q>. A bar is a higher level grouping of beats. -The meter describes how many beats are in one bar.</p> -""" . + <time.meta.ttl> . time:Time - a rdfs:Class ; + a rdfs:Class , + owl:Class ; rdfs:subClassOf time:Position ; rdfs:label "Time" ; rdfs:comment "A point in time in some unit/dimension." . time:Position - a rdfs:Class ; + a rdfs:Class , + owl:Class ; rdfs:label "Position" ; - lv2:documentation """ -<p>A point in time and/or the speed at which time is passing. A position is -both a point and a speed, which precisely defines a time within a timeline.</p> -""" . + rdfs:comment "A point in time and/or the speed at which time is passing." . time:Rate - a rdfs:Class ; + a rdfs:Class , + owl:Class ; rdfs:subClassOf time:Position ; rdfs:label "Rate" ; - lv2:documentation """ -<p>The rate of passage of time in terms of one unit with respect to -another.</p> """ . + rdfs:comment "The rate of passage of time." . time:position a rdf:Property , owl:ObjectProperty , owl:FunctionalProperty ; rdfs:range time:Position ; - rdfs:label "position" . + rdfs:label "position" ; + rdfs:comment "A musical position." . time:barBeat a rdf:Property , @@ -61,7 +48,7 @@ time:barBeat rdfs:domain time:Time ; rdfs:range xsd:float ; rdfs:label "beat within bar" ; - rdfs:comment "The beat number within the bar, from 0 to beatsPerBar." . + rdfs:comment "The beat number within the bar, from 0 to time:beatsPerBar." . time:bar a rdf:Property , @@ -69,7 +56,8 @@ time:bar owl:FunctionalProperty ; rdfs:domain time:Time ; rdfs:range xsd:long ; - rdfs:label "bar" . + rdfs:label "bar" ; + rdfs:comment "A musical bar or measure." . time:beat a rdf:Property , @@ -78,11 +66,7 @@ time:beat rdfs:domain time:Time ; rdfs:range xsd:double ; rdfs:label "beat" ; - rdfs:comment """ -The global running beat number. This is not the beat within a bar like barBeat, -but relative to the same origin as time:bar and monotonically increases unless -the transport is repositioned. -""" . + rdfs:comment "The global running beat number." . time:beatUnit a rdf:Property , @@ -91,10 +75,7 @@ time:beatUnit rdfs:domain time:Rate ; rdfs:range xsd:nonNegativeInteger ; rdfs:label "beat unit" ; - lv2:documentation """ -<p>Beat unit, the note value that counts as one beat. This is the bottom number -in a time signature: 2 for half note, 4 for quarter note, and so on.</p> -""" . + rdfs:comment "The note value that counts as one beat." . time:beatsPerBar a rdf:Property , @@ -102,7 +83,8 @@ time:beatsPerBar owl:FunctionalProperty ; rdfs:domain time:Rate ; rdfs:range xsd:float ; - rdfs:label "beats per bar" . + rdfs:label "beats per bar" ; + rdfs:comment "The number of beats in one bar." . time:beatsPerMinute a rdf:Property , @@ -119,7 +101,8 @@ time:frame owl:FunctionalProperty ; rdfs:domain time:Time ; rdfs:range xsd:long ; - rdfs:label "frame" . + rdfs:label "frame" ; + rdfs:comment "A time stamp in audio frames." . time:framesPerSecond a rdf:Property , @@ -137,10 +120,5 @@ time:speed rdfs:domain time:Rate ; rdfs:range xsd:float ; rdfs:label "speed" ; - lv2:documentation """ -<p>The rate of the progress of time as a fraction of normal speed. For -example, a rate of 0.0 is stopped, 1.0 is rolling at normal speed, 0.5 is -rolling at half speed, -1.0 is reverse, and so on. -</p> -""" . + rdfs:comment "The rate of the progress of time as a fraction of normal speed." . |