From 551c66e099c2b58a876e418d57db50b85d1c51b8 Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 10:15:28 +0100 Subject: [PATCH 01/19] fix(chapter 13): add introduction to chapter --- _guidelines-v4/13-linkingdata.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_guidelines-v4/13-linkingdata.md b/_guidelines-v4/13-linkingdata.md index aacfb982464..0c83051f1d4 100644 --- a/_guidelines-v4/13-linkingdata.md +++ b/_guidelines-v4/13-linkingdata.md @@ -8,4 +8,4 @@ sectionid: "linkingdata" {% include version-warning %} -This is a placeholder that needs to be filled. +This chapter describes the use of elements in MEI for linking and referencing. This includes the elements, models, and attributes that are part of the MEI.ptrref module. This module contains declarations, techniques and approaches to establish references within a single MEI document, or to link out from one MEI document to another or to another external source. This chapter also addresses possibilities to link into an MEI document from external sources which makes MEI highly interoperable and serviceable in the context of Linked (Open) Data approaches. From 4da246c5ebed75e4859d20dd5099e3d4db5b6a47 Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 10:16:13 +0100 Subject: [PATCH 02/19] fix(chapter 13): add general section about links --- _guidelines-v4/13-linkingdata/01-links.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 _guidelines-v4/13-linkingdata/01-links.md diff --git a/_guidelines-v4/13-linkingdata/01-links.md b/_guidelines-v4/13-linkingdata/01-links.md new file mode 100644 index 00000000000..6251077b163 --- /dev/null +++ b/_guidelines-v4/13-linkingdata/01-links.md @@ -0,0 +1,7 @@ +--- +sectionid: links +title: "Links" +version: "v4" +--- + +An element is a ‘link’ when it has an attribute whose value is a reference to the ID of one or more other elements (cross-reference). These link elements indicate an association between themselves (or one of their ancestors) and one or more other entities, either inside the same document or elsewhere. An association between two elements in the same document is said to be an ‘internal’ link, while an association that involves an entity outside the current document is called an ‘external’ link. However, either of the elements discussed in the following section can be used for either purpose. From 352e93a5ea9511b670964251c4dedafba0e684b0 Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 10:17:46 +0100 Subject: [PATCH 03/19] fix(chapter 13): move and restructure explanations for ptrref Module --- _guidelines-v4/13-linkingdata/01-ptrref.md | 9 -- .../01-ptrref/01-ptrrefmodule.md | 100 ------------------ .../01-ptrrefmodule/01-ptrrefdifference.md | 21 ---- _guidelines-v4/13-linkingdata/02-ptrref.md | 20 ++++ .../02-ptrref/01-ptrrefmodule.md | 42 ++++++++ 5 files changed, 62 insertions(+), 130 deletions(-) delete mode 100644 _guidelines-v4/13-linkingdata/01-ptrref.md delete mode 100644 _guidelines-v4/13-linkingdata/01-ptrref/01-ptrrefmodule.md delete mode 100644 _guidelines-v4/13-linkingdata/01-ptrref/01-ptrrefmodule/01-ptrrefdifference.md create mode 100644 _guidelines-v4/13-linkingdata/02-ptrref.md create mode 100644 _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule.md diff --git a/_guidelines-v4/13-linkingdata/01-ptrref.md b/_guidelines-v4/13-linkingdata/01-ptrref.md deleted file mode 100644 index 1df90d840a9..00000000000 --- a/_guidelines-v4/13-linkingdata/01-ptrref.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: sidebar -sidebar: s1 -version: "v4" -title: "Pointers and References" -sectionid: "ptrRef" ---- - -This chapter describes the use of elements for linking and referencing. diff --git a/_guidelines-v4/13-linkingdata/01-ptrref/01-ptrrefmodule.md b/_guidelines-v4/13-linkingdata/01-ptrref/01-ptrrefmodule.md deleted file mode 100644 index 06547e8e08b..00000000000 --- a/_guidelines-v4/13-linkingdata/01-ptrref/01-ptrrefmodule.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -sectionid: ptrrefModule -title: "Links" -version: "v4" ---- - -An element is a ‘link’ when it has an attribute whose value is a reference to the ID of one or more other elements. The links discussed in this chapter are the {% include link elem="ptr" %} and the {% include link elem="ref" %} elements. These elements indicate an association between themselves (or one of their ancestors) and one or more other entities, either inside the same document or elsewhere. An association between two elements in the same document is said to be an ‘internal’ link, while an association that involves an entity outside the current document is called an ‘external’ link. However, either element can be used for either purpose. - -The two elements share a set of common attributes that are inherited from the {% include link att="pointing" %} class: - -{:.gloss} -**@target**: allows the use of one or more previously-undeclared URIs to identify an external electronic object. - -{:.gloss} -**@targettype**: in contrast with the role attribute, allows the target resource to be characterized using any convenient classification scheme or typology. - -{:.gloss} -**@xlink:actuate**: defines whether a link occurs automatically or must be requested by the user. - -{:.gloss} -**@xlink:show**: defines how a remote resource is rendered. - -{:.gloss} -**@xlink:title**: contains a human-readable description of the entire link. - -{:.gloss} -**@xlink:role**: indicates a property of the entire link. The value of the role attribute must be a URI. - -The **@target** attribute specifies the destination of a pointer or reference using a method standardized by the W3C consortium, known as the XPointer mechanism. The XPointer framework is described at [http://www.w3.org/TR/xptr-framework/](http://www.w3.org/TR/xptr-framework/){:.link_ref}. This mechanism permits a range of complexity, from the very simple (a reference to the value of the target element's **@xml:id** attribute) to the more complex usage of a full URI with embedded XPointers: - -{% include mei example="ptrRef/ptrRef-sample336.txt" valid="" %} -{% include mei example="ptrRef/ptrRef-sample337.txt" valid="" %} -{% include mei example="ptrRef/ptrRef-sample338.txt" valid="" %} -{% include mei example="ptrRef/ptrRef-sample339.txt" valid="" %} -{% include mei example="ptrRef/ptrRef-sample340.txt" valid="" %} - -The **@targettype** attribute allows the target resource to be characterized using any convenient classification scheme or typology. This is often useful when the target requires special processing, e.g., for display purposes. The pointers in the examples below may be formatted differently, e.g., the bibliographic citation may result in special typography while the pointer to the audio file may be used to embed an audio player: - -{% include mei example="ptrRef/ptrRef-sample341.txt" valid="" %} -{% include mei example="ptrRef/ptrRef-sample342.txt" valid="" %} - -The **@xlink:actuate** and **@xlink:show** attributes are used in conjunction to determine the link's behavior. The attribute **@xlink:actuate** defines whether the resolution of a link occurs automatically or must be requested by the user. - -The following values are allowed for the **@xlink:actuate** attribute: - -{:.gloss} -**'onLoad'**: load the target resource immediately - -{:.gloss} -**'onRequest'**: load the target resource upon user request, e.g., after a mouse click - -{:.gloss} -**'other'**: traversal behavior is unconstrained; application should look for other markup to determine appropriate behavior - -{:.gloss} -**'none'**: traversal behavior is unconstrained; no other markup is provided to determine appropriate behavior - -The value "none" may be used to indicate that the link is un-traversable; it may or may not render the link invisible to the user. When the value of **@xlink:actuate** is "other", an application must base a determination of appropriate behavior on factors other than the value of **@xlink:actuate**. - -The **@show** attribute defines how a remote resource is to be rendered. The following values are permitted: - -{:.gloss} -**'new'**: target of the link appears in a new window - -{:.gloss} -**'replace'**: target of the link replaces the current resource - -{:.gloss} -**'embed'**: the content of the target appears at the point of the link - -{:.gloss} -**'other'**: traversal behavior is unconstrained; application should look for other markup to determine appropriate behavior - -{:.gloss} -**'none'**: traversal behavior is unconstrained; no other markup is provided to determine appropriate behavior - -When the value of **@xlink:show** is "other", an application must base a determination of appropriate behavior on factors other than the value of **@xlink:show**. The value "none" may be used to indicate a link that is not displayed or is not displayable. - -The following example illustrates a pointer that results in the automatic creation of a new window with the content of the target loaded in it: - -{% include mei example="ptrRef/ptrRef-sample343.txt" valid="" %} - -The **@xlink:title** and **@xlink:role** attributes describe the meaning of resources within the context of a link. The **@xlink:title** attribute is used to label or describe a link or resource in a human-readable fashion. The value here is highly dependent on the kind of processing being done. It may be used, for example, to make link titles available to applications used by visually impaired users, or to create a table of links, or to present help text that appears when a user's mouse hovers over the link. - -{% include mei example="ptrRef/ptrRef-sample344.txt" valid="" %} - -The attribute**@ xlink:role** serves a similar function to that of **@xlink:title**. Whereas the value of **@xlink:title** may be any string, the value of **@xlink:role** must be an absolute URI reference as defined in IETF RFC 3986, available at [http://tools.ietf.org/html/rfc3986](http://tools.ietf.org/html/rfc3986){:.link_ref}. The URI reference identifies a resource that describes the intended property. When no value is supplied, no particular role value is to be inferred. - -{% include mei example="ptrRef/ptrRef-sample345.txt" valid="" %} -{% include mei example="ptrRef/ptrRef-sample346.txt" valid="" %} - -In the preceding example, the value of the **@xlink:role** attribute may be used to re-write the value of **@xlink:title**, depending on the target resource role. - -In addition to the attributes in the {% include link att="pointing" %} class, the **@mimetype** attribute is also available on {% include link elem="ptr" %} and {% include link elem="ref" %}. The function of the **@mimetype** attribute is similar to that of **@targettype** in that they both allow classification of the destination. Unlike **@targettype**, however, **@mimetype** explicitly defines the destination type using a standard taxonomy. Its value should be a valid MIME (Multimedia Internet Mail Extension) type defined by the Internet Engineering Task Force in RFC 2046, available at [http://www.ietf.org/rfc/rfc2046.txt](http://www.ietf.org/rfc/rfc2046.txt){:.link_ref}. The following are all valid mimetype values: - -{% include mei example="ptrRef/ptrRef-sample347.txt" valid="feasible" %} - -The **@mimetype** attribute is particularly useful for documenting the nature of the destination when the value of **@target** does not provide a filename extension or when the destination is a non-standard file type: - -{% include mei example="ptrRef/ptrRef-sample348.txt" valid="feasible" %} diff --git a/_guidelines-v4/13-linkingdata/01-ptrref/01-ptrrefmodule/01-ptrrefdifference.md b/_guidelines-v4/13-linkingdata/01-ptrref/01-ptrrefmodule/01-ptrrefdifference.md deleted file mode 100644 index a7037a47af0..00000000000 --- a/_guidelines-v4/13-linkingdata/01-ptrref/01-ptrrefmodule/01-ptrrefdifference.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -sectionid: ptrRefDifference -title: "Difference between Pointers and References" -version: "v4" ---- - -The {% include link elem="ptr" %} element is an empty linking element that uses only attributes to provide for movement from one place to another. Unlike the {% include link elem="ref" %} element, it cannot contain text or sub-elements to describe the referenced object. Its primary function is simply to point to another location. The next example shows targets that are page numbers; or more precisely, the targets are page break elements bearing these identifiers: - -{% include mei example="ptrRef/ptrRef-sample349.txt" valid="" %} - -As shown above, the {% include link elem="ptr" %} element can be used to ‘point to’ a digital image. However, when the intention is to *display* a digital image as part of the rendering of an MEI file, the {% include link elem="graphic" %} element provides a convenient and recommended alternative: - -{% include mei example="ptrRef/ptrRef-sample350.txt" valid="" %} - -While {% include link elem="ptr" %} cannot contain other markup, the {% include link elem="ref" %} element can include text and sub-elements that name or describe the destination: - -{% include mei example="ptrRef/ptrRef-sample351.txt" valid="" %} - -The **@target** attribute is not required in order to mark the textual content as a cross-reference, as demonstrated in the example below; however, without this attribute the reference will not be resolvable. - -{% include mei example="ptrRef/ptrRef-sample352.txt" valid="" %} diff --git a/_guidelines-v4/13-linkingdata/02-ptrref.md b/_guidelines-v4/13-linkingdata/02-ptrref.md new file mode 100644 index 00000000000..8dd0ac989d7 --- /dev/null +++ b/_guidelines-v4/13-linkingdata/02-ptrref.md @@ -0,0 +1,20 @@ +--- +layout: sidebar +sidebar: s1 +version: "v4" +title: "Pointers and References" +sectionid: "ptrRef" +--- + +The link elements discussed in this section are the {% include link elem="ptr" %} and the {% include link elem="ref" %} elements which are declared in the MEI.ptrref module. + +{% include desc elem="ptr" %} +{% include desc elem="ref" %} + +The {% include link elem="ptr" %} element is a traversible pointer to another location. It is an empty linking element that uses only attributes to describe its link destination. It cannot contain text or sub-elements to describe the referenced object. The next example shows the use of the {% include link elem="ptr" %} element to target a certain identifier (here e.g. a page number, or more precisely, page break elements, {% include link elem="pb" %}, bearing these identifiers) from within a {% include link elem="list" %} of item descriptions: + +{% include mei example="ptrRef/ptrRef-sample349.txt" valid="" %} + +The {% include link elem="ref" %} element defines a traversible reference to another location. While {% include link elem="ptr" %} cannot contain other markup, the {% include link elem="ref" %} element can include text or sub-elements that further specify the link destination: + +{% include mei example="ptrRef/ptrRef-sample351.txt" valid="" %} diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule.md new file mode 100644 index 00000000000..f54883c691e --- /dev/null +++ b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule.md @@ -0,0 +1,42 @@ +--- +sectionid: ptrrefModule +title: "Specifying Link Elements" +version: "v4" +--- + +The {% include link elem="ptr" %} and {% include link elem="ref" %} elements share a set of common attributes that are inherited from the {% include link att="pointing" %} class: + +{% include desc atts="att.pointing/target" %} +{% include desc atts="att.pointing/targettype" %} +{% include desc atts="att.pointing/xlink:actuate" %} +{% include desc atts="att.pointing/xlink:show" %} +{% include desc atts=" att.pointing/xlink:role" %} + +In addition to the attributes in the {% include link att="pointing" %} class, the **@mimetype** attribute from the {% include link att="internetMedia" %} class is also available on {% include link elem="ptr" %} and {% include link elem="ref" %}: + +{% include desc atts="att.internetMedia/mimetype" %} + +The {% include link att="linking" %} class provides another set of common attributes: + +{% include desc atts="att.linking/copyof" %} +{% include desc atts="att.linking/corresp" %} +{% include desc atts="att.linking/follows" %} +{% include desc atts="att.linking/next" %} +{% include desc atts="att.linking/precedes" %} +{% include desc atts="att.linking/prev" %} +{% include desc atts="att.linking/sameas" %} +{% include desc atts="att.linking/synch" %} + +(via att.classed) + +{% include desc atts="att.classed/class" %} + +(via att.responsibility) + +{% include desc atts="att.responsibility/resp" %} + +(via att.metadataPointing) + +{% include desc atts="att.metadataPointing/decls" %} + + From cc9b4bc84c7a934c3953481133669851da365858 Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 11:25:39 +0100 Subject: [PATCH 04/19] fix(chapter 13): move ptrref attributes into separate sections and files --- .../01-ptrrefmodule/01-ptrreftarget.md | 19 ++++++++ .../01-ptrrefmodule/02-ptrreftargettype.md | 10 ++++ .../03-ptrrefxlinkActuateShow.md | 46 +++++++++++++++++++ .../01-ptrrefmodule/04-ptrrefxlinkRole.md | 16 +++++++ .../01-ptrrefmodule/05-ptrrefmimetype.md | 19 ++++++++ 5 files changed, 110 insertions(+) create mode 100644 _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/01-ptrreftarget.md create mode 100644 _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/02-ptrreftargettype.md create mode 100644 _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefxlinkActuateShow.md create mode 100644 _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkRole.md create mode 100644 _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefmimetype.md diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/01-ptrreftarget.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/01-ptrreftarget.md new file mode 100644 index 00000000000..11bc33edffd --- /dev/null +++ b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/01-ptrreftarget.md @@ -0,0 +1,19 @@ +--- +sectionid: ptrRefTarget +title: "Define the link element's target (XPointer mechanism)" +version: "v4" +--- + +The **@target** attribute specifies the destination of a pointer or reference using a method standardized by the W3C consortium, known as the XPointer mechanism. The XPointer framework is described at [http://www.w3.org/TR/xptr-framework/](http://www.w3.org/TR/xptr-framework/){:.link_ref}. This mechanism permits a range of complexity, from the very simple (a reference to the value of the target element's **@xml:id** attribute) to the more complex usage of a full URI with embedded XPointers: + +{% include mei example="ptrRef/ptrRef-sample336.txt" valid="" %} +{% include mei example="ptrRef/ptrRef-sample337.txt" valid="" %} +{% include mei example="ptrRef/ptrRef-sample338.txt" valid="" %} +{% include mei example="ptrRef/ptrRef-sample339.txt" valid="" %} +{% include mei example="ptrRef/ptrRef-sample340.txt" valid="" %} + +A **@target** attribute is not required in order to mark the textual content as a cross-reference, as demonstrated in the example below; however, without this attribute the reference will not be resolvable. + +{% include mei example="ptrRef/ptrRef-sample352.txt" valid="" %} + + diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/02-ptrreftargettype.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/02-ptrreftargettype.md new file mode 100644 index 00000000000..762f2896dcf --- /dev/null +++ b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/02-ptrreftargettype.md @@ -0,0 +1,10 @@ +--- +sectionid: ptrRefTargettype +title: "Define the type of a link element's target" +version: "v4" +--- + +The **@targettype** attribute allows the target resource to be characterized using any convenient classification scheme or typology. This is often useful when the target requires special processing, e.g., for display purposes. The pointers in the examples below may be formatted differently, e.g., the bibliographic citation may result in special typography while the pointer to the audio file may be used to embed an audio player: + +{% include mei example="ptrRef/ptrRef-sample341.txt" valid="" %} +{% include mei example="ptrRef/ptrRef-sample342.txt" valid="" %} diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefxlinkActuateShow.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefxlinkActuateShow.md new file mode 100644 index 00000000000..c90b8ec8b83 --- /dev/null +++ b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefxlinkActuateShow.md @@ -0,0 +1,46 @@ +--- +sectionid: ptrRefXlinkActuateShow +title: "Determine the link element's behaviour" +version: "v4" +--- + +The **@xlink:actuate** and **@xlink:show** attributes are used in conjunction to determine the link's behavior. The attribute **@xlink:actuate** defines whether the resolution of a link occurs automatically or must be requested by the user. + +The following values are allowed for the **@xlink:actuate** attribute: + +{:.gloss} +**'onLoad'**: load the target resource immediately + +{:.gloss} +**'onRequest'**: load the target resource upon user request, e.g., after a mouse click + +{:.gloss} +**'other'**: traversal behavior is unconstrained; application should look for other markup to determine appropriate behavior + +{:.gloss} +**'none'**: traversal behavior is unconstrained; no other markup is provided to determine appropriate behavior + +The value "none" may be used to indicate that the link is un-traversable; it may or may not render the link invisible to the user. When the value of **@xlink:actuate** is "other", an application must base a determination of appropriate behavior on factors other than the value of **@xlink:actuate**. + +The **@show** attribute defines how a remote resource is to be rendered. The following values are permitted: + +{:.gloss} +**'new'**: target of the link appears in a new window + +{:.gloss} +**'replace'**: target of the link replaces the current resource + +{:.gloss} +**'embed'**: the content of the target appears at the point of the link + +{:.gloss} +**'other'**: traversal behavior is unconstrained; application should look for other markup to determine appropriate behavior + +{:.gloss} +**'none'**: traversal behavior is unconstrained; no other markup is provided to determine appropriate behavior + +When the value of **@xlink:show** is "other", an application must base a determination of appropriate behavior on factors other than the value of **@xlink:show**. The value "none" may be used to indicate a link that is not displayed or is not displayable. + +The following example illustrates a pointer that results in the automatic creation of a new window with the content of the target loaded in it: + +{% include mei example="ptrRef/ptrRef-sample343.txt" valid="" %} diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkRole.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkRole.md new file mode 100644 index 00000000000..c617fdd62e6 --- /dev/null +++ b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkRole.md @@ -0,0 +1,16 @@ +--- +sectionid: ptrRefXlinkRole +title: "Determine the link element's role" +version: "v4" +--- + +The **@xlink:title** and **@xlink:role** attributes describe the meaning of resources within the context of a link. The **@xlink:title** attribute is used to label or describe a link or resource in a human-readable fashion. The value here is highly dependent on the kind of processing being done. It may be used, for example, to make link titles available to applications used by visually impaired users, or to create a table of links, or to present help text that appears when a user's mouse hovers over the link. + +{% include mei example="ptrRef/ptrRef-sample344.txt" valid="" %} + +The attribute **@ xlink:role** serves a similar function to that of **@xlink:title**. Whereas the value of **@xlink:title** may be any string, the value of **@xlink:role** must be an absolute URI reference as defined in IETF RFC 3986, available at [http://tools.ietf.org/html/rfc3986](http://tools.ietf.org/html/rfc3986){:.link_ref}. The URI reference identifies a resource that describes the intended property. When no value is supplied, no particular role value is to be inferred. + +{% include mei example="ptrRef/ptrRef-sample345.txt" valid="" %} +{% include mei example="ptrRef/ptrRef-sample346.txt" valid="" %} + +In the preceding example, the value of the **@xlink:role** attribute may be used to re-write the value of **@xlink:title**, depending on the target resource role. diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefmimetype.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefmimetype.md new file mode 100644 index 00000000000..a10522280f3 --- /dev/null +++ b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefmimetype.md @@ -0,0 +1,19 @@ +--- +sectionid: ptrRefMimetype +title: "Define the mimetype of a link element's target" +version: "v4" +--- + +The function of the **@mimetype** attribute is similar to that of **@targettype** in that they both allow classification of the destination. Unlike **@targettype**, however, **@mimetype** explicitly defines the destination type using a standard taxonomy. Its value should be a valid MIME (Multimedia Internet Mail Extension) type defined by the Internet Engineering Task Force in RFC 2046, available at [http://www.ietf.org/rfc/rfc2046.txt](http://www.ietf.org/rfc/rfc2046.txt){:.link_ref}. The following are all valid mimetype values: + +{% include mei example="ptrRef/ptrRef-sample347.txt" valid="feasible" %} + + +The **@mimetype** attribute is particularly useful for documenting the nature of the destination when the value of **@target** does not provide a filename extension or when the destination is a non-standard file type: + +{% include mei example="ptrRef/ptrRef-sample348.txt" valid="feasible" %} + +As shown above, the {% include link elem="ptr" %} element can be used to ‘point to’ a digital image. However, when the intention is to *display* a digital image as part of the rendering of an MEI file, the {% include link elem="graphic" %} element provides a convenient and recommended alternative: + +{% include mei example="ptrRef/ptrRef-sample350.txt" valid="" %} + From 5f3f3a00f864cee7dd51d1df6897e4b75c1b88a4 Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 11:30:55 +0100 Subject: [PATCH 05/19] fix(chapter 13): remove xlink:title attribute from section and examples Also these changes make the content of the samples more readable by adding some line breaks. --- .../02-ptrref/01-ptrrefmodule/04-ptrrefxlinkRole.md | 8 ++------ _includes/v4/examples/ptrref/ptrref-sample344.txt | 1 + _includes/v4/examples/ptrref/ptrref-sample345.txt | 7 ++++++- _includes/v4/examples/ptrref/ptrref-sample346.txt | 7 ++++++- 4 files changed, 15 insertions(+), 8 deletions(-) diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkRole.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkRole.md index c617fdd62e6..5076f9bb330 100644 --- a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkRole.md +++ b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkRole.md @@ -4,13 +4,9 @@ title: "Determine the link element's role" version: "v4" --- -The **@xlink:title** and **@xlink:role** attributes describe the meaning of resources within the context of a link. The **@xlink:title** attribute is used to label or describe a link or resource in a human-readable fashion. The value here is highly dependent on the kind of processing being done. It may be used, for example, to make link titles available to applications used by visually impaired users, or to create a table of links, or to present help text that appears when a user's mouse hovers over the link. - -{% include mei example="ptrRef/ptrRef-sample344.txt" valid="" %} - -The attribute **@ xlink:role** serves a similar function to that of **@xlink:title**. Whereas the value of **@xlink:title** may be any string, the value of **@xlink:role** must be an absolute URI reference as defined in IETF RFC 3986, available at [http://tools.ietf.org/html/rfc3986](http://tools.ietf.org/html/rfc3986){:.link_ref}. The URI reference identifies a resource that describes the intended property. When no value is supplied, no particular role value is to be inferred. +The **@xlink:role** attribute describes the meaning of resources within the context of a link. It is used to label or describe a link or resource in a human- and machine-readable fashion. The value of **@xlink:role** must be an absolute URI (Uniform Resource Identifier) reference as defined by the Internet Engineering Task Force (IETF) in RFC 3986, available at [http://tools.ietf.org/html/rfc3986](http://tools.ietf.org/html/rfc3986){:.link_ref}. The URI reference identifies a resource that describes the intended property. When no value is supplied, no particular role value is to be inferred. {% include mei example="ptrRef/ptrRef-sample345.txt" valid="" %} {% include mei example="ptrRef/ptrRef-sample346.txt" valid="" %} -In the preceding example, the value of the **@xlink:role** attribute may be used to re-write the value of **@xlink:title**, depending on the target resource role. +In the preceding examples, the value of the **@xlink:role** attribute may be used to specify the value of the link target's role. diff --git a/_includes/v4/examples/ptrref/ptrref-sample344.txt b/_includes/v4/examples/ptrref/ptrref-sample344.txt index 5f1f3f3c4ce..f6e232d019d 100644 --- a/_includes/v4/examples/ptrref/ptrref-sample344.txt +++ b/_includes/v4/examples/ptrref/ptrref-sample344.txt @@ -1 +1,2 @@ + diff --git a/_includes/v4/examples/ptrref/ptrref-sample345.txt b/_includes/v4/examples/ptrref/ptrref-sample345.txt index db01376c62a..5461a532983 100644 --- a/_includes/v4/examples/ptrref/ptrref-sample345.txt +++ b/_includes/v4/examples/ptrref/ptrref-sample345.txt @@ -1 +1,6 @@ - + diff --git a/_includes/v4/examples/ptrref/ptrref-sample346.txt b/_includes/v4/examples/ptrref/ptrref-sample346.txt index f402ce45bbf..c25641de021 100644 --- a/_includes/v4/examples/ptrref/ptrref-sample346.txt +++ b/_includes/v4/examples/ptrref/ptrref-sample346.txt @@ -1 +1,6 @@ - + From e3912669b10e9602703c09e1c483eec04916689d Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 11:32:04 +0100 Subject: [PATCH 06/19] fix(chapter 13): small changes (typo, linebreak) to subsection 3 and 5 --- .../02-ptrref/01-ptrrefmodule/03-ptrrefxlinkActuateShow.md | 6 ++++-- .../02-ptrref/01-ptrrefmodule/05-ptrrefmimetype.md | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefxlinkActuateShow.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefxlinkActuateShow.md index c90b8ec8b83..8efbd7b92af 100644 --- a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefxlinkActuateShow.md +++ b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefxlinkActuateShow.md @@ -4,7 +4,9 @@ title: "Determine the link element's behaviour" version: "v4" --- -The **@xlink:actuate** and **@xlink:show** attributes are used in conjunction to determine the link's behavior. The attribute **@xlink:actuate** defines whether the resolution of a link occurs automatically or must be requested by the user. +The **@xlink:actuate** and **@xlink:show** attributes are used in conjunction to determine the link's behavior. + + The **@xlink:actuate** attribute defines whether the resolution of a link occurs automatically or must be requested by the user. The following values are allowed for the **@xlink:actuate** attribute: @@ -22,7 +24,7 @@ The following values are allowed for the **@xlink:actuate** attribute: The value "none" may be used to indicate that the link is un-traversable; it may or may not render the link invisible to the user. When the value of **@xlink:actuate** is "other", an application must base a determination of appropriate behavior on factors other than the value of **@xlink:actuate**. -The **@show** attribute defines how a remote resource is to be rendered. The following values are permitted: +The **@xlink:show** attribute defines how a remote resource is to be rendered. The following values are permitted: {:.gloss} **'new'**: target of the link appears in a new window diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefmimetype.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefmimetype.md index a10522280f3..ff2c240c6c4 100644 --- a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefmimetype.md +++ b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefmimetype.md @@ -4,7 +4,7 @@ title: "Define the mimetype of a link element's target" version: "v4" --- -The function of the **@mimetype** attribute is similar to that of **@targettype** in that they both allow classification of the destination. Unlike **@targettype**, however, **@mimetype** explicitly defines the destination type using a standard taxonomy. Its value should be a valid MIME (Multimedia Internet Mail Extension) type defined by the Internet Engineering Task Force in RFC 2046, available at [http://www.ietf.org/rfc/rfc2046.txt](http://www.ietf.org/rfc/rfc2046.txt){:.link_ref}. The following are all valid mimetype values: +The function of the **@mimetype** attribute is similar to that of **@targettype** in that they both allow classification of the destination. Unlike **@targettype**, however, **@mimetype** explicitly defines the destination type using a standard taxonomy. Its value should be a valid MIME (Multimedia Internet Mail Extension) type as defined by the Internet Engineering Task Force (IETF) in RFC 2046, available at [http://www.ietf.org/rfc/rfc2046.txt](http://www.ietf.org/rfc/rfc2046.txt){:.link_ref}. The following are all valid mimetype values: {% include mei example="ptrRef/ptrRef-sample347.txt" valid="feasible" %} From 0274886a68c1cc89bb2e27f6af8d98fa2fea99ee Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 11:33:05 +0100 Subject: [PATCH 07/19] fix(chapter 13): move linkAlign section --- .../13-linkingdata/{02-linkalign.md => 03-linkalign.md} | 0 .../{02-linkalign => 03-linkalign}/01-linkalignoverview.md | 0 .../01-linkalignoverview/01-linkalignelements.md | 0 .../{02-linkalign => 03-linkalign}/02-linkalignexamples.md | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename _guidelines-v4/13-linkingdata/{02-linkalign.md => 03-linkalign.md} (100%) rename _guidelines-v4/13-linkingdata/{02-linkalign => 03-linkalign}/01-linkalignoverview.md (100%) rename _guidelines-v4/13-linkingdata/{02-linkalign => 03-linkalign}/01-linkalignoverview/01-linkalignelements.md (100%) rename _guidelines-v4/13-linkingdata/{02-linkalign => 03-linkalign}/02-linkalignexamples.md (100%) diff --git a/_guidelines-v4/13-linkingdata/02-linkalign.md b/_guidelines-v4/13-linkingdata/03-linkalign.md similarity index 100% rename from _guidelines-v4/13-linkingdata/02-linkalign.md rename to _guidelines-v4/13-linkingdata/03-linkalign.md diff --git a/_guidelines-v4/13-linkingdata/02-linkalign/01-linkalignoverview.md b/_guidelines-v4/13-linkingdata/03-linkalign/01-linkalignoverview.md similarity index 100% rename from _guidelines-v4/13-linkingdata/02-linkalign/01-linkalignoverview.md rename to _guidelines-v4/13-linkingdata/03-linkalign/01-linkalignoverview.md diff --git a/_guidelines-v4/13-linkingdata/02-linkalign/01-linkalignoverview/01-linkalignelements.md b/_guidelines-v4/13-linkingdata/03-linkalign/01-linkalignoverview/01-linkalignelements.md similarity index 100% rename from _guidelines-v4/13-linkingdata/02-linkalign/01-linkalignoverview/01-linkalignelements.md rename to _guidelines-v4/13-linkingdata/03-linkalign/01-linkalignoverview/01-linkalignelements.md diff --git a/_guidelines-v4/13-linkingdata/02-linkalign/02-linkalignexamples.md b/_guidelines-v4/13-linkingdata/03-linkalign/02-linkalignexamples.md similarity index 100% rename from _guidelines-v4/13-linkingdata/02-linkalign/02-linkalignexamples.md rename to _guidelines-v4/13-linkingdata/03-linkalign/02-linkalignexamples.md From 69dfaf1a55c6d068d50d36701235cbaa4abed862 Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 11:57:12 +0100 Subject: [PATCH 08/19] fix(chapter 13): change position of mimetype section (5 --> 3) --- .../{05-ptrrefmimetype.md => 03-ptrrefmimetype.md} | 0 ...{03-ptrrefxlinkActuateShow.md => 04-ptrrefxlinkActuateShow.md} | 0 .../{04-ptrrefxlinkRole.md => 05-ptrrefxlinkRole.md} | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/{05-ptrrefmimetype.md => 03-ptrrefmimetype.md} (100%) rename _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/{03-ptrrefxlinkActuateShow.md => 04-ptrrefxlinkActuateShow.md} (100%) rename _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/{04-ptrrefxlinkRole.md => 05-ptrrefxlinkRole.md} (100%) diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefmimetype.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefmimetype.md similarity index 100% rename from _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefmimetype.md rename to _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefmimetype.md diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefxlinkActuateShow.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkActuateShow.md similarity index 100% rename from _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefxlinkActuateShow.md rename to _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkActuateShow.md diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkRole.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefxlinkRole.md similarity index 100% rename from _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkRole.md rename to _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefxlinkRole.md From 0eb6bfdd91e3464b97dbb4739218f7aba985f34a Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 11:58:30 +0100 Subject: [PATCH 09/19] fix(chapter 13): adjust example for mimetype --- .../02-ptrref/01-ptrrefmodule/03-ptrrefmimetype.md | 6 +++--- _includes/v4/examples/ptrref/ptrref-sample350.txt | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefmimetype.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefmimetype.md index ff2c240c6c4..8ec40dc6332 100644 --- a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefmimetype.md +++ b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefmimetype.md @@ -8,12 +8,12 @@ The function of the **@mimetype** attribute is similar to that of **@targettype* {% include mei example="ptrRef/ptrRef-sample347.txt" valid="feasible" %} +As shown above, the {% include link elem="ptr" %} element can be used to ‘point to’ a digital image (`target="my.png"`). However, when the intention is to *display* a digital image as part of the rendering of an MEI file, the {% include link elem="graphic" %} element provides a convenient and recommended alternative: + +{% include mei example="ptrRef/ptrRef-sample350.txt" valid="" %} The **@mimetype** attribute is particularly useful for documenting the nature of the destination when the value of **@target** does not provide a filename extension or when the destination is a non-standard file type: {% include mei example="ptrRef/ptrRef-sample348.txt" valid="feasible" %} -As shown above, the {% include link elem="ptr" %} element can be used to ‘point to’ a digital image. However, when the intention is to *display* a digital image as part of the rendering of an MEI file, the {% include link elem="graphic" %} element provides a convenient and recommended alternative: - -{% include mei example="ptrRef/ptrRef-sample350.txt" valid="" %} diff --git a/_includes/v4/examples/ptrref/ptrref-sample350.txt b/_includes/v4/examples/ptrref/ptrref-sample350.txt index 9dbe3224ea4..329f2334264 100644 --- a/_includes/v4/examples/ptrref/ptrref-sample350.txt +++ b/_includes/v4/examples/ptrref/ptrref-sample350.txt @@ -1 +1 @@ - + From c7b57280e9d925fb2a0085b11509dfe3d2976a5a Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 11:58:58 +0100 Subject: [PATCH 10/19] fix(chapter 13): make long example for xlink:show more readable --- _includes/v4/examples/ptrref/ptrref-sample343.txt | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/_includes/v4/examples/ptrref/ptrref-sample343.txt b/_includes/v4/examples/ptrref/ptrref-sample343.txt index e2b9bfa33eb..a65948dc79f 100644 --- a/_includes/v4/examples/ptrref/ptrref-sample343.txt +++ b/_includes/v4/examples/ptrref/ptrref-sample343.txt @@ -1 +1,8 @@ - + From dbc26698ab6444c915a399a75fceb739f338992c Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 11:59:45 +0100 Subject: [PATCH 11/19] fix(chapter 13): adjust glosses of xlink:... values to latest specs --- .../04-ptrrefxlinkActuateShow.md | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkActuateShow.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkActuateShow.md index 8efbd7b92af..32cdfabcf97 100644 --- a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkActuateShow.md +++ b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkActuateShow.md @@ -11,18 +11,19 @@ The **@xlink:actuate** and **@xlink:show** attributes are used in conjunction to The following values are allowed for the **@xlink:actuate** attribute: {:.gloss} -**'onLoad'**: load the target resource immediately +**'onLoad'**: load the target resource(s) immediately {:.gloss} -**'onRequest'**: load the target resource upon user request, e.g., after a mouse click +**'onRequest'**: load the target resource(s) upon user request, e.g., after a mouse click {:.gloss} -**'other'**: traversal behavior is unconstrained; application should look for other markup to determine appropriate behavior +**'none'**: do not permit loading of the target resource(s); no other markup is provided to determine appropriate behavior {:.gloss} -**'none'**: traversal behavior is unconstrained; no other markup is provided to determine appropriate behavior +**'other'**: behavior other than permitted by the other values of this attribute; application should look for other markup to determine appropriate behavior -The value "none" may be used to indicate that the link is un-traversable; it may or may not render the link invisible to the user. When the value of **@xlink:actuate** is "other", an application must base a determination of appropriate behavior on factors other than the value of **@xlink:actuate**. + +The value "none" may be used to indicate that the link is un-traversable and no other markup is provided to determine appropriate behavior; it may or may not render the link invisible to the user. When the value of **@xlink:actuate** is "other", an application must base a determination of appropriate behavior on factors other than the value of **@xlink:actuate**. The **@xlink:show** attribute defines how a remote resource is to be rendered. The following values are permitted: @@ -30,18 +31,19 @@ The **@xlink:show** attribute defines how a remote resource is to be rendered. T **'new'**: target of the link appears in a new window {:.gloss} -**'replace'**: target of the link replaces the current resource +**'replace'**: target of the link replaces the current resource in the same window {:.gloss} **'embed'**: the content of the target appears at the point of the link {:.gloss} -**'other'**: traversal behavior is unconstrained; application should look for other markup to determine appropriate behavior +**'none'**: do not permit traversal to the target resource(s); no other markup is provided to determine appropriate behavior {:.gloss} -**'none'**: traversal behavior is unconstrained; no other markup is provided to determine appropriate behavior +**'other'**: behavior other than permitted by the other values of this attribute; application should look for other markup to determine appropriate behavior + -When the value of **@xlink:show** is "other", an application must base a determination of appropriate behavior on factors other than the value of **@xlink:show**. The value "none" may be used to indicate a link that is not displayed or is not displayable. +The value "none" may be used to indicate a link that is not displayed or is not displayable and no other markup is provided to determine appropriate behavior. When the value of **@xlink:show** is "other", an application must base a determination of appropriate behavior on factors other than the value of **@xlink:show**. The following example illustrates a pointer that results in the automatic creation of a new window with the content of the target loaded in it: From 55f2bfc0d695df0f595abb219046b65a18ec0e3f Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 12:28:32 +0100 Subject: [PATCH 12/19] fix(chapter 13): give hint to locations of explanations of available attributes --- .../02-ptrref/01-ptrrefmodule.md | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule.md index f54883c691e..12406361a46 100644 --- a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule.md +++ b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule.md @@ -4,7 +4,7 @@ title: "Specifying Link Elements" version: "v4" --- -The {% include link elem="ptr" %} and {% include link elem="ref" %} elements share a set of common attributes that are inherited from the {% include link att="pointing" %} class: +The {% include link elem="ptr" %} and {% include link elem="ref" %} elements share a set of common attributes that are inherited from the {% include link att="pointing" %} class (a more detailed explanation is provided below): {% include desc atts="att.pointing/target" %} {% include desc atts="att.pointing/targettype" %} @@ -12,11 +12,11 @@ The {% include link elem="ptr" %} and {% include link elem="ref" %} elements sha {% include desc atts="att.pointing/xlink:show" %} {% include desc atts=" att.pointing/xlink:role" %} -In addition to the attributes in the {% include link att="pointing" %} class, the **@mimetype** attribute from the {% include link att="internetMedia" %} class is also available on {% include link elem="ptr" %} and {% include link elem="ref" %}: +In addition to the attributes in the {% include link att="pointing" %} class, the **@mimetype** attribute from the {% include link att="internetMedia" %} class is also available on {% include link elem="ptr" %} and {% include link elem="ref" %} (a more detailed explanation is provided below): {% include desc atts="att.internetMedia/mimetype" %} -The {% include link att="linking" %} class provides another set of common attributes: +The {% include link att="linking" %} class provides another set of common attributes (a more detailed explanation is provided in {% include link id="analysisharm" %}: {% include link id="analysisDescribingRelationships" %}): {% include desc atts="att.linking/copyof" %} {% include desc atts="att.linking/corresp" %} @@ -27,16 +27,18 @@ The {% include link att="linking" %} class provides another set of common attrib {% include desc atts="att.linking/sameas" %} {% include desc atts="att.linking/synch" %} -(via att.classed) +Additionally, the following attributes are also available on {% include link elem="ptr" %} and {% include link elem="ref" %}: + +Via the {% include link att="metadataPointing" %} class: + +{% include desc atts="att.metadataPointing/decls" %} + +Via the {% include link att="classed" %} class: {% include desc atts="att.classed/class" %} -(via att.responsibility) +Via the {% include link att="responsibility" %} class: {% include desc atts="att.responsibility/resp" %} -(via att.metadataPointing) - -{% include desc atts="att.metadataPointing/decls" %} - From 09b1e53e10c68e8d2fe58b63b5f2bafa5c3d84bf Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 13:03:48 +0100 Subject: [PATCH 13/19] fix(chapter 13): deprecate the linkAlign module and remove subsections --- _guidelines-v4/13-linkingdata/03-linkalign.md | 9 --------- .../03-linkalign/01-linkalignoverview.md | 7 ------- .../01-linkalignoverview/01-linkalignelements.md | 8 -------- .../03-linkalign/02-linkalignexamples.md | 13 ------------- _guidelines-v4/13-linkingdata/04-linkalign.md | 9 +++++++++ 5 files changed, 9 insertions(+), 37 deletions(-) delete mode 100644 _guidelines-v4/13-linkingdata/03-linkalign.md delete mode 100644 _guidelines-v4/13-linkingdata/03-linkalign/01-linkalignoverview.md delete mode 100644 _guidelines-v4/13-linkingdata/03-linkalign/01-linkalignoverview/01-linkalignelements.md delete mode 100644 _guidelines-v4/13-linkingdata/03-linkalign/02-linkalignexamples.md create mode 100644 _guidelines-v4/13-linkingdata/04-linkalign.md diff --git a/_guidelines-v4/13-linkingdata/03-linkalign.md b/_guidelines-v4/13-linkingdata/03-linkalign.md deleted file mode 100644 index 386211ccf95..00000000000 --- a/_guidelines-v4/13-linkingdata/03-linkalign.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: sidebar -sidebar: s1 -version: "v4" -title: "Linking and Alignment" -sectionid: "linkAlign" ---- - -The linkAlign module makes it possible to align recorded media (audio, video) with elements in the musical domain. This allows for synchronization between the encoded notation and one or many media. diff --git a/_guidelines-v4/13-linkingdata/03-linkalign/01-linkalignoverview.md b/_guidelines-v4/13-linkingdata/03-linkalign/01-linkalignoverview.md deleted file mode 100644 index db6f1c0a337..00000000000 --- a/_guidelines-v4/13-linkingdata/03-linkalign/01-linkalignoverview.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sectionid: linkalignOverview -title: "Overview of the Linkalign Module" -version: "v4" ---- - -The module described in this chapter makes available the following components: diff --git a/_guidelines-v4/13-linkingdata/03-linkalign/01-linkalignoverview/01-linkalignelements.md b/_guidelines-v4/13-linkingdata/03-linkalign/01-linkalignoverview/01-linkalignelements.md deleted file mode 100644 index 9170e3d6a61..00000000000 --- a/_guidelines-v4/13-linkingdata/03-linkalign/01-linkalignoverview/01-linkalignelements.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -sectionid: linkalignElements -title: "Elements" -version: "v4" ---- - -{% include desc elem="when" %} - diff --git a/_guidelines-v4/13-linkingdata/03-linkalign/02-linkalignexamples.md b/_guidelines-v4/13-linkingdata/03-linkalign/02-linkalignexamples.md deleted file mode 100644 index 5bbc42c5a3e..00000000000 --- a/_guidelines-v4/13-linkingdata/03-linkalign/02-linkalignexamples.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -sectionid: linkalignExamples -title: "Linking and Alignment Examples" -version: "v4" ---- - -The {% include link elem="when" %} element specifies timestamped locations on the referenced media file. These may be defined using either an absolute time stamp (specified in ISO 24-hour time format, HH:MM:SS.ss), or using a combination of the **@interval**, **@inttype**, and **@since** attributes. - -{% include mei example="linkAlign/linkAlign-sample381.xml" valid="" %} - -Musical elements can reference specific time points using the **@when** attribute. This is available on most musical elements, e.g., {% include link elem="note" %}, {% include link elem="rest" %}, {% include link elem="measure" %}, etc. - -{% include mei example="linkAlign/linkAlign-sample382.xml" valid="" %} diff --git a/_guidelines-v4/13-linkingdata/04-linkalign.md b/_guidelines-v4/13-linkingdata/04-linkalign.md new file mode 100644 index 00000000000..65069d07990 --- /dev/null +++ b/_guidelines-v4/13-linkingdata/04-linkalign.md @@ -0,0 +1,9 @@ +--- +layout: sidebar +sidebar: s1 +version: "v4" +title: "Linking and Alignment" +sectionid: "linkAlign" +--- + +The linkAlign module has been deprecated in MEI v3. From 91ee04a4339e0c6fa3374ef84b3618d2beb6d018 Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 13:04:29 +0100 Subject: [PATCH 14/19] fix(chapter 13): add starting structure and placeholder files for LOD section --- _guidelines-v4/13-linkingdata/03-lod.md | 9 +++++++++ _guidelines-v4/13-linkingdata/03-lod/01-lodoverview.md | 9 +++++++++ _guidelines-v4/13-linkingdata/03-lod/02-lodexamples.md | 9 +++++++++ 3 files changed, 27 insertions(+) create mode 100644 _guidelines-v4/13-linkingdata/03-lod.md create mode 100644 _guidelines-v4/13-linkingdata/03-lod/01-lodoverview.md create mode 100644 _guidelines-v4/13-linkingdata/03-lod/02-lodexamples.md diff --git a/_guidelines-v4/13-linkingdata/03-lod.md b/_guidelines-v4/13-linkingdata/03-lod.md new file mode 100644 index 00000000000..9c0afe6eb18 --- /dev/null +++ b/_guidelines-v4/13-linkingdata/03-lod.md @@ -0,0 +1,9 @@ +--- +layout: sidebar +sidebar: s1 +version: "v4" +title: "Linking into MEI" +sectionid: "linkIntoMei" +--- + +This section describes techniques and approaches to link into an MEI document from external sources, e. g. in the context of Linked (Open) Data approaches. diff --git a/_guidelines-v4/13-linkingdata/03-lod/01-lodoverview.md b/_guidelines-v4/13-linkingdata/03-lod/01-lodoverview.md new file mode 100644 index 00000000000..a0b65a24c65 --- /dev/null +++ b/_guidelines-v4/13-linkingdata/03-lod/01-lodoverview.md @@ -0,0 +1,9 @@ +--- +sectionid: lodOverview +title: "Overview" +version: "v4" +--- + +Placeholder for an introductory overview to MEI + LOD techniques and approaches. + + diff --git a/_guidelines-v4/13-linkingdata/03-lod/02-lodexamples.md b/_guidelines-v4/13-linkingdata/03-lod/02-lodexamples.md new file mode 100644 index 00000000000..c0a507d609c --- /dev/null +++ b/_guidelines-v4/13-linkingdata/03-lod/02-lodexamples.md @@ -0,0 +1,9 @@ +--- +sectionid: lodExamples +title: "Examples" +version: "v4" +--- + +Placeholder for examples for MEI + LOD techniques and approaches. + + From 10b09a21592a370038495801eda14546a996305d Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 14:15:05 +0100 Subject: [PATCH 15/19] fix(chapter 13): move pointers & references under subheader Linking from MEI --- _guidelines-v4/13-linkingdata/02-linkfrommei.md | 9 +++++++++ .../{02-ptrref.md => 02-ptrref/01-ptrref.md} | 2 +- .../02-ptrref/{01-ptrrefmodule.md => 02-ptrrefmodule.md} | 0 .../01-ptrreftarget.md | 0 .../02-ptrreftargettype.md | 0 .../03-ptrrefmimetype.md | 0 .../04-ptrrefxlinkactuateshow.md} | 0 .../05-ptrrefxlinkrole.md} | 0 .../13-linkingdata/{03-lod.md => 03-linkintomei.md} | 0 .../{03-lod => 03-linkintomei}/01-lodoverview.md | 0 .../{03-lod => 03-linkintomei}/02-lodexamples.md | 0 11 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 _guidelines-v4/13-linkingdata/02-linkfrommei.md rename _guidelines-v4/13-linkingdata/{02-ptrref.md => 02-ptrref/01-ptrref.md} (96%) rename _guidelines-v4/13-linkingdata/02-ptrref/{01-ptrrefmodule.md => 02-ptrrefmodule.md} (100%) rename _guidelines-v4/13-linkingdata/02-ptrref/{01-ptrrefmodule => 02-ptrrefmodule}/01-ptrreftarget.md (100%) rename _guidelines-v4/13-linkingdata/02-ptrref/{01-ptrrefmodule => 02-ptrrefmodule}/02-ptrreftargettype.md (100%) rename _guidelines-v4/13-linkingdata/02-ptrref/{01-ptrrefmodule => 02-ptrrefmodule}/03-ptrrefmimetype.md (100%) rename _guidelines-v4/13-linkingdata/02-ptrref/{01-ptrrefmodule/04-ptrrefxlinkActuateShow.md => 02-ptrrefmodule/04-ptrrefxlinkactuateshow.md} (100%) rename _guidelines-v4/13-linkingdata/02-ptrref/{01-ptrrefmodule/05-ptrrefxlinkRole.md => 02-ptrrefmodule/05-ptrrefxlinkrole.md} (100%) rename _guidelines-v4/13-linkingdata/{03-lod.md => 03-linkintomei.md} (100%) rename _guidelines-v4/13-linkingdata/{03-lod => 03-linkintomei}/01-lodoverview.md (100%) rename _guidelines-v4/13-linkingdata/{03-lod => 03-linkintomei}/02-lodexamples.md (100%) diff --git a/_guidelines-v4/13-linkingdata/02-linkfrommei.md b/_guidelines-v4/13-linkingdata/02-linkfrommei.md new file mode 100644 index 00000000000..1231bfeb365 --- /dev/null +++ b/_guidelines-v4/13-linkingdata/02-linkfrommei.md @@ -0,0 +1,9 @@ +--- +layout: sidebar +sidebar: s1 +version: "v4" +title: "Linking from MEI" +sectionid: "linkFromMei" +--- + +This section describes techniques and approaches to establish references within a single MEI document, or to link out from one MEI document to another or to other external sources. diff --git a/_guidelines-v4/13-linkingdata/02-ptrref.md b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrref.md similarity index 96% rename from _guidelines-v4/13-linkingdata/02-ptrref.md rename to _guidelines-v4/13-linkingdata/02-ptrref/01-ptrref.md index 8dd0ac989d7..49d85756545 100644 --- a/_guidelines-v4/13-linkingdata/02-ptrref.md +++ b/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrref.md @@ -6,7 +6,7 @@ title: "Pointers and References" sectionid: "ptrRef" --- -The link elements discussed in this section are the {% include link elem="ptr" %} and the {% include link elem="ref" %} elements which are declared in the MEI.ptrref module. +The link elements discussed in this section are the {% include link elem="ptr" %} and the {% include link elem="ref" %} elements which are declared in the `MEI.ptrref` module. {% include desc elem="ptr" %} {% include desc elem="ref" %} diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule.md b/_guidelines-v4/13-linkingdata/02-ptrref/02-ptrrefmodule.md similarity index 100% rename from _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule.md rename to _guidelines-v4/13-linkingdata/02-ptrref/02-ptrrefmodule.md diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/01-ptrreftarget.md b/_guidelines-v4/13-linkingdata/02-ptrref/02-ptrrefmodule/01-ptrreftarget.md similarity index 100% rename from _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/01-ptrreftarget.md rename to _guidelines-v4/13-linkingdata/02-ptrref/02-ptrrefmodule/01-ptrreftarget.md diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/02-ptrreftargettype.md b/_guidelines-v4/13-linkingdata/02-ptrref/02-ptrrefmodule/02-ptrreftargettype.md similarity index 100% rename from _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/02-ptrreftargettype.md rename to _guidelines-v4/13-linkingdata/02-ptrref/02-ptrrefmodule/02-ptrreftargettype.md diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefmimetype.md b/_guidelines-v4/13-linkingdata/02-ptrref/02-ptrrefmodule/03-ptrrefmimetype.md similarity index 100% rename from _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/03-ptrrefmimetype.md rename to _guidelines-v4/13-linkingdata/02-ptrref/02-ptrrefmodule/03-ptrrefmimetype.md diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkActuateShow.md b/_guidelines-v4/13-linkingdata/02-ptrref/02-ptrrefmodule/04-ptrrefxlinkactuateshow.md similarity index 100% rename from _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/04-ptrrefxlinkActuateShow.md rename to _guidelines-v4/13-linkingdata/02-ptrref/02-ptrrefmodule/04-ptrrefxlinkactuateshow.md diff --git a/_guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefxlinkRole.md b/_guidelines-v4/13-linkingdata/02-ptrref/02-ptrrefmodule/05-ptrrefxlinkrole.md similarity index 100% rename from _guidelines-v4/13-linkingdata/02-ptrref/01-ptrrefmodule/05-ptrrefxlinkRole.md rename to _guidelines-v4/13-linkingdata/02-ptrref/02-ptrrefmodule/05-ptrrefxlinkrole.md diff --git a/_guidelines-v4/13-linkingdata/03-lod.md b/_guidelines-v4/13-linkingdata/03-linkintomei.md similarity index 100% rename from _guidelines-v4/13-linkingdata/03-lod.md rename to _guidelines-v4/13-linkingdata/03-linkintomei.md diff --git a/_guidelines-v4/13-linkingdata/03-lod/01-lodoverview.md b/_guidelines-v4/13-linkingdata/03-linkintomei/01-lodoverview.md similarity index 100% rename from _guidelines-v4/13-linkingdata/03-lod/01-lodoverview.md rename to _guidelines-v4/13-linkingdata/03-linkintomei/01-lodoverview.md diff --git a/_guidelines-v4/13-linkingdata/03-lod/02-lodexamples.md b/_guidelines-v4/13-linkingdata/03-linkintomei/02-lodexamples.md similarity index 100% rename from _guidelines-v4/13-linkingdata/03-lod/02-lodexamples.md rename to _guidelines-v4/13-linkingdata/03-linkintomei/02-lodexamples.md From 2c1624c1280b70bb1d3d05ba2b24f2cea4fd409b Mon Sep 17 00:00:00 2001 From: "Stefan@AWG" Date: Fri, 28 Feb 2020 14:17:48 +0100 Subject: [PATCH 16/19] fix(chapter 13): fix wording --- _guidelines-v4/13-linkingdata.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_guidelines-v4/13-linkingdata.md b/_guidelines-v4/13-linkingdata.md index 0c83051f1d4..bdd0d313036 100644 --- a/_guidelines-v4/13-linkingdata.md +++ b/_guidelines-v4/13-linkingdata.md @@ -8,4 +8,4 @@ sectionid: "linkingdata" {% include version-warning %} -This chapter describes the use of elements in MEI for linking and referencing. This includes the elements, models, and attributes that are part of the MEI.ptrref module. This module contains declarations, techniques and approaches to establish references within a single MEI document, or to link out from one MEI document to another or to another external source. This chapter also addresses possibilities to link into an MEI document from external sources which makes MEI highly interoperable and serviceable in the context of Linked (Open) Data approaches. +This chapter describes the use of elements in MEI for linking and referencing. This includes the elements, models, and attributes that are part of the `MEI.ptrref` module. This module contains declarations, techniques and approaches to establish references within a single MEI document, or to link out from one MEI document to another or to other external sources. This chapter also addresses possibilities to link into an MEI document from external sources which makes MEI highly interoperable and serviceable in the context of Linked (Open) Data approaches. From 459baaf0a32b63fff42de917773afb302e2a772a Mon Sep 17 00:00:00 2001 From: Johannes Kepper Date: Thu, 26 Mar 2020 16:20:52 +0100 Subject: [PATCH 17/19] prefer empty elements to be self-closing --- _includes/v4/examples/ptrref/ptrref-sample350.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/v4/examples/ptrref/ptrref-sample350.txt b/_includes/v4/examples/ptrref/ptrref-sample350.txt index 329f2334264..2ba68e58318 100644 --- a/_includes/v4/examples/ptrref/ptrref-sample350.txt +++ b/_includes/v4/examples/ptrref/ptrref-sample350.txt @@ -1 +1 @@ - + From d0d96d86ff18806213ae74e91290ac9b142b49b1 Mon Sep 17 00:00:00 2001 From: "Stefan@Lap" Date: Fri, 22 May 2020 18:32:32 +0200 Subject: [PATCH 18/19] remove section 13.3 (Link Into MEI) for now --- .../13-linkingdata/{04-linkalign.md => 03-linkalign.md} | 0 _guidelines-v4/13-linkingdata/03-linkintomei.md | 9 --------- .../13-linkingdata/03-linkintomei/01-lodoverview.md | 9 --------- .../13-linkingdata/03-linkintomei/02-lodexamples.md | 9 --------- 4 files changed, 27 deletions(-) rename _guidelines-v4/13-linkingdata/{04-linkalign.md => 03-linkalign.md} (100%) delete mode 100644 _guidelines-v4/13-linkingdata/03-linkintomei.md delete mode 100644 _guidelines-v4/13-linkingdata/03-linkintomei/01-lodoverview.md delete mode 100644 _guidelines-v4/13-linkingdata/03-linkintomei/02-lodexamples.md diff --git a/_guidelines-v4/13-linkingdata/04-linkalign.md b/_guidelines-v4/13-linkingdata/03-linkalign.md similarity index 100% rename from _guidelines-v4/13-linkingdata/04-linkalign.md rename to _guidelines-v4/13-linkingdata/03-linkalign.md diff --git a/_guidelines-v4/13-linkingdata/03-linkintomei.md b/_guidelines-v4/13-linkingdata/03-linkintomei.md deleted file mode 100644 index 9c0afe6eb18..00000000000 --- a/_guidelines-v4/13-linkingdata/03-linkintomei.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: sidebar -sidebar: s1 -version: "v4" -title: "Linking into MEI" -sectionid: "linkIntoMei" ---- - -This section describes techniques and approaches to link into an MEI document from external sources, e. g. in the context of Linked (Open) Data approaches. diff --git a/_guidelines-v4/13-linkingdata/03-linkintomei/01-lodoverview.md b/_guidelines-v4/13-linkingdata/03-linkintomei/01-lodoverview.md deleted file mode 100644 index a0b65a24c65..00000000000 --- a/_guidelines-v4/13-linkingdata/03-linkintomei/01-lodoverview.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -sectionid: lodOverview -title: "Overview" -version: "v4" ---- - -Placeholder for an introductory overview to MEI + LOD techniques and approaches. - - diff --git a/_guidelines-v4/13-linkingdata/03-linkintomei/02-lodexamples.md b/_guidelines-v4/13-linkingdata/03-linkintomei/02-lodexamples.md deleted file mode 100644 index c0a507d609c..00000000000 --- a/_guidelines-v4/13-linkingdata/03-linkintomei/02-lodexamples.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -sectionid: lodExamples -title: "Examples" -version: "v4" ---- - -Placeholder for examples for MEI + LOD techniques and approaches. - - From 4afe6a2ae8862869ecc3c35855e3c3cc8445f43c Mon Sep 17 00:00:00 2001 From: "Stefan@Lap" Date: Fri, 22 May 2020 18:32:54 +0200 Subject: [PATCH 19/19] remove version warning --- _guidelines-v4/13-linkingdata.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/_guidelines-v4/13-linkingdata.md b/_guidelines-v4/13-linkingdata.md index bdd0d313036..391eb5257ee 100644 --- a/_guidelines-v4/13-linkingdata.md +++ b/_guidelines-v4/13-linkingdata.md @@ -6,6 +6,4 @@ title: "Linking Data" sectionid: "linkingdata" --- -{% include version-warning %} - This chapter describes the use of elements in MEI for linking and referencing. This includes the elements, models, and attributes that are part of the `MEI.ptrref` module. This module contains declarations, techniques and approaches to establish references within a single MEI document, or to link out from one MEI document to another or to other external sources. This chapter also addresses possibilities to link into an MEI document from external sources which makes MEI highly interoperable and serviceable in the context of Linked (Open) Data approaches.