www.aleph1.co.uk Git - yaffs-website/blob - web/core/core.link_relation_types.yml

   1 # Drupal core's extension relation types.
   2 # See https://tools.ietf.org/html/rfc5988#section-4.2.
   3 add-form:
   4   uri: https://drupal.org/link-relations/add-form
   5   description: A form where a resource of this type can be created.
   6 add-page:
   7   uri: https://drupal.org/link-relations/add-page
   8   description: A page where a resource of this type and related types can be created.
   9 delete-form:
  10   uri: https://drupal.org/link-relations/delete-form
  11   description: A form where a resource of this type can be deleted.
  12 delete-multiple-form:
  13   uri: https://drupal.org/link-relations/delete-multiple-form
  14   description: A form where multiple resources of this type can be deleted.
  15 revision:
  16   uri: https://drupal.org/link-relations/revision
  17   description: A particular version of this resource.
  18 create:
  19   uri: https://drupal.org/link-relations/create
  20   description: A REST resource URL where a resource of this type can be created.
  21 enable:
  22   uri: https://drupal.org/link-relations/enable
  23   description: A REST resource URL where a resource of this type can be enabled.
  24 disable:
  25   uri: https://drupal.org/link-relations/disable
  26   description: A REST resource URL where a resource of this type can be disabled.
  27 edit-permissions-form:
  28   uri: https://drupal.org/link-relations/edit-permissions-form
  29   description: A form where permissions assigned to a resource of this type can be edited.
  30 overview-form:
  31   uri: https://drupal.org/link-relations/overview-form
  32   description: A form where an overview of the collection of resources belonging to a resource of this type can be edited in bulk.
  33 reset-form:
  34   uri: https://drupal.org/link-relations/reset-form
  35   description: A form where an overview of the collection of resources belonging to a resource of this type can be reset.
  36 cancel-form:
  37   uri: https://drupal.org/link-relations/cancel-form
  38   description: A form where a resource of this type can be canceled.
  39 flush-form:
  40   uri: https://drupal.org/link-relations/flush-form
  41   description: A form where a resource of this type can be flushed.
  42 duplicate-form:
  43   uri: https://drupal.org/link-relations/duplicate-form
  44   description: A form where a resource of this type can be duplicated.
  45
  46 # All registered relation types.
  47 # See https://tools.ietf.org/html/rfc5988#section-4.1.
  48 # See https://www.iana.org/assignments/link-relations/link-relations.xhtml.
  49 about:
  50   description: "Refers to a resource that is the subject of the link's context."
  51   reference: '[RFC6903], section 2'
  52 alternate:
  53   description: 'Refers to a substitute for this context'
  54   reference: '[http://www.w3.org/TR/html5/links.html#link-type-alternate]'
  55 appendix:
  56   description: 'Refers to an appendix.'
  57   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
  58 archives:
  59   description: "Refers to a collection of records, documents, or other materials of historical interest."
  60   reference: '[http://www.w3.org/TR/2011/WD-html5-20110113/links.html#rel-archives]'
  61 author:
  62   description: "Refers to the context's author."
  63   reference: '[http://www.w3.org/TR/html5/links.html#link-type-author]'
  64 blocked-by:
  65   description: "Identifies the entity that blocks access to a resource following receipt of a legal demand."
  66   reference: '[RFC7725]'
  67 bookmark:
  68   description: 'Gives a permanent link to use for bookmarking purposes.'
  69   reference: '[http://www.w3.org/TR/html5/links.html#link-type-bookmark]'
  70 canonical:
  71   description: 'Designates the preferred version of a resource (the IRI and its contents).'
  72   reference: '[RFC6596]'
  73 chapter:
  74   description: 'Refers to a chapter in a collection of resources.'
  75   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
  76 collection:
  77   description: 'The target IRI points to a resource which represents the collection resource for the context IRI.'
  78   reference: '[RFC6573]'
  79 contents:
  80   description: 'Refers to a table of contents.'
  81   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
  82 copyright:
  83   description: "Refers to a copyright statement that applies to the link's context."
  84   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
  85 create-form:
  86   description: 'The target IRI points to a resource where a submission form can be obtained.'
  87   reference: '[RFC6861]'
  88 current:
  89   description: "Refers to a resource containing the most recent item(s) in a collection of resources."
  90   reference: '[RFC5005]'
  91 customize-form:
  92   description: "The target URI points to a resource where a submission form for customizing associated resource can be obtained."
  93   reference: '[RFC6861]'
  94 derivedfrom:
  95   description: 'The target IRI points to a resource from which this material was derived.'
  96   reference: '[draft-hoffman-xml2rfc]'
  97 describedby:
  98   description: "Refers to a resource providing information about the link's context."
  99   reference: '[http://www.w3.org/TR/powder-dr/#assoc-linking]'
 100 describes:
 101   description: "The relationship A 'describes' B asserts that resource A provides a description of resource B. There are no constraints on the format or representation of either A or B, neither are there any further constraints on either resource."
 102   reference: '[RFC6892]'
 103   notes: "This link relation type is the inverse of the 'describedby' relation type.  While 'describedby' establishes a relation from the described resource back to the resource that describes it, 'describes' established a relation from the describing resource to the resource it describes.  If B is 'describedby' A, then A 'describes' B."
 104 disclosure:
 105   description: "Refers to a list of patent disclosures made with respect to  material for which 'disclosure' relation is specified."
 106   reference: '[RFC6579]'
 107 dns-prefetch:
 108   description: "Used to indicate an origin that will be used to fetch required  resources for the link context, and that the user agent ought to resolve  as early as possible."
 109   reference: '[https://www.w3.org/TR/resource-hints/]'
 110 duplicate:
 111   description: "Refers to a resource whose available representations are byte-for-byte identical with the corresponding representations of the context IRI."
 112   reference: '[RFC6249]'
 113   notes: "This relation is for static resources.  That is, an HTTP GET request on any duplicate will return the same representation.  It does not make sense for dynamic or POSTable resources and should not be used for them."
 114 edit:
 115   description: "Refers to a resource that can be used to edit the link's context."
 116   reference: '[RFC5023]'
 117 edit-form:
 118   description: "The target IRI points to a resource where a submission form for editing associated resource can be obtained."
 119   reference: '[RFC6861]'
 120 edit-media:
 121   description: "Refers to a resource that can be used to edit media associated with the link's context."
 122   reference: '[RFC5023]'
 123 enclosure:
 124   description: "Identifies a related resource that is potentially large and might require special handling."
 125   reference: '[RFC4287]'
 126 first:
 127   description: "An IRI that refers to the furthest preceding resource in a series of resources."
 128   reference: '[RFC5988]'
 129   notes: "This relation type registration did not indicate a reference.  Originally requested by Mark Nottingham in December 2004."
 130 glossary:
 131   description: 'Refers to a glossary of terms.'
 132   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
 133 help:
 134   description: 'Refers to context-sensitive help.'
 135   reference: '[http://www.w3.org/TR/html5/links.html#link-type-help]'
 136 hosts:
 137   description: "Refers to a resource hosted by the server indicated by the link context."
 138   reference: '[RFC6690]'
 139   notes: "This relation is used in CoRE where links are retrieved as a \"/.well-known/core\" resource representation, and is the default relation type in the CoRE Link Format."
 140 hub:
 141   description: "Refers to a hub that enables registration for notification of updates to the context."
 142   reference: '[http://pubsubhubbub.googlecode.com]'
 143   notes: 'This relation type was requested by Brett Slatkin.'
 144 icon:
 145   description: "Refers to an icon representing the link's context."
 146   reference: '[http://www.w3.org/TR/html5/links.html#link-type-icon]'
 147 index:
 148   description: 'Refers to an index.'
 149   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
 150 item:
 151   description: 'The target IRI points to a resource that is a member of the collection represented by the context IRI.'
 152   reference: '[RFC6573]'
 153 last:
 154   description: "An IRI that refers to the furthest following resource in a series of resources."
 155   reference: '[RFC5988]'
 156   notes: "This relation type registration did not indicate a reference. Originally requested by Mark Nottingham in December 2004."
 157 latest-version:
 158   description: "Points to a resource containing the latest (e.g., current) version of the context."
 159   reference: '[RFC5829]'
 160 license:
 161   description: 'Refers to a license associated with this context.'
 162   reference: '[RFC4946]'
 163   notes: "For implications of use in HTML, see:  http://www.w3.org/TR/html5/links.html#link-type-license"
 164 lrdd:
 165   description: "Refers to further information about the link's context, expressed as a LRDD (\"Link-based Resource Descriptor Document\") resource.  See [RFC6415] for information about processing this relation type in host-meta documents. When used elsewhere, it refers to additional links and other metadata. Multiple instances indicate additional LRDD resources. LRDD resources MUST have an \"application/xrd+xml\" representation, and MAY have others."
 166   reference: '[RFC6415]'
 167 memento:
 168   description: 'The Target IRI points to a Memento, a fixed resource that will not change state anymore.'
 169   reference: '[RFC7089]'
 170   notes: "A Memento for an Original Resource is a resource that encapsulates a prior state of the Original Resource."
 171 monitor:
 172   description: 'Refers to a resource that can be used to monitor changes in an HTTP resource.'
 173   reference: '[RFC5989]'
 174 monitor-group:
 175   description: 'Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.'
 176   reference: '[RFC5989]'
 177 next:
 178   description: "Indicates that the link's context is a part of a series, and that the next in the series is the link target."
 179   reference: '[http://www.w3.org/TR/html5/links.html#link-type-next]'
 180 next-archive:
 181   description: 'Refers to the immediately following archive resource.'
 182   reference: '[RFC5005]'
 183 nofollow:
 184   description: 'Indicates that the context’s original author or publisher does not endorse the link target.'
 185   reference: '[http://www.w3.org/TR/html5/links.html#link-type-nofollow]'
 186 noreferrer:
 187   description: 'Indicates that no referrer information is to be leaked when following the link.'
 188   reference: '[http://www.w3.org/TR/html5/links.html#link-type-noreferrer]'
 189 original:
 190   description: 'The Target IRI points to an Original Resource.'
 191   reference: '[RFC7089]'
 192   notes: "An Original Resource is a resource that exists or used to exist, and for which access to one of its prior states may be required."
 193 payment:
 194   description: 'Indicates a resource where payment is accepted.'
 195   reference: '[RFC5988]'
 196   notes: "This relation type registration did not indicate a reference.  Requested by Joshua Kinberg and Robert Sayre.  It is meant as a general way to facilitate acts of payment, and thus this specification makes no assumptions on the type of payment or transaction protocol.  Examples may include a web page where donations are accepted or where goods and services are available for purchase. rel=\"payment\" is not intended to initiate an automated transaction.  In Atom documents, a link element with a rel=\"payment\" attribute may exist at the feed/channel level and/or the entry/item level.  For example, a rel=\"payment\" link at the feed/channel level may point to a \"tip jar\" URI, whereas an entry/ item containing a book review may include a rel=\"payment\" link that points to the location where the book may be purchased through an online retailer."
 197 pingback:
 198   description: 'Gives the address of the pingback resource for the link context.'
 199   reference: '[http://www.hixie.ch/specs/pingback/pingback]'
 200 preconnect:
 201   description: "Used to indicate an origin that will be used to fetch required  resources for the link context. Initiating an early connection, which  includes the DNS lookup, TCP handshake, and optional TLS negotiation,  allows the user agent to mask the high latency costs of establishing a  connection."
 202   reference: '[https://www.w3.org/TR/resource-hints/]'
 203 predecessor-version:
 204   description: "Points to a resource containing the predecessor version in the version history."
 205   reference: '[RFC5829]'
 206 prefetch:
 207   description: "The prefetch link relation type is used to identify a resource  that might be required by the next navigation from the link context, and  that the user agent ought to fetch, such that the user agent can deliver a  faster response once the resource is requested in the future."
 208   reference: '[http://www.w3.org/TR/resource-hints/]'
 209 preload:
 210   description: "Refers to a resource that should be loaded early in the  processing of the link's context, without blocking rendering."
 211   reference: '[http://www.w3.org/TR/preload/]'
 212   notes: 'Additional target attributes establish the detailed fetch properties of the link.'
 213 prerender:
 214   description: "Used to identify a resource that might be required by the next  navigation from the link context, and that the user agent ought to fetch  and execute, such that the user agent can deliver a faster response once  the resource is requested in the future."
 215   reference: '[https://www.w3.org/TR/resource-hints/]'
 216 prev:
 217   description: "Indicates that the link's context is a part of a series, and that the previous in the series is the link target."
 218   reference: '[http://www.w3.org/TR/html5/links.html#link-type-prev]'
 219 preview:
 220   description: "Refers to a resource that provides a preview of the link's context."
 221   reference: '[RFC6903], section 3'
 222 previous:
 223   description: "Refers to the previous resource in an ordered series of resources.  Synonym for \"prev\"."
 224   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
 225 prev-archive:
 226   description: 'Refers to the immediately preceding archive resource.'
 227   reference: '[RFC5005]'
 228 privacy-policy:
 229   description: "Refers to a privacy policy associated with the link's context."
 230   reference: '[RFC6903], section 4'
 231 profile:
 232   description: "Identifying that a resource representation conforms to a certain profile, without affecting the non-profile semantics of the resource representation."
 233   reference: '[RFC6906]'
 234   notes: "Profile URIs are primarily intended to be used as identifiers, and thus clients SHOULD NOT indiscriminately access profile URIs."
 235 related:
 236   description: 'Identifies a related resource.'
 237   reference: '[RFC4287]'
 238 replies:
 239   description: "Identifies a resource that is a reply to the context of the link."
 240   reference: '[RFC4685]'
 241 search:
 242   description: "Refers to a resource that can be used to search through the link's context and related resources."
 243   reference: '[http://www.opensearch.org/Specifications/OpenSearch/1.1]'
 244 section:
 245   description: 'Refers to a section in a collection of resources.'
 246   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
 247 self:
 248   description: "Conveys an identifier for the link's context."
 249   reference: '[RFC4287]'
 250 set-default:
 251   description: "Indicates a URI that can be used to set a resource as the default."
 252   reference: '[RFC5023]'
 253 service:
 254   description: "Indicates a URI that can be used to retrieve a service document."
 255   reference: '[RFC5023]'
 256   notes: "When used in an Atom document, this relation type specifies Atom Publishing Protocol service documents by default.  Requested by James Snell."
 257 start:
 258   description: "Refers to the first resource in a collection of resources."
 259   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
 260 stylesheet:
 261   description: 'Refers to a stylesheet.'
 262   reference: '[http://www.w3.org/TR/html5/links.html#link-type-stylesheet]'
 263 subsection:
 264   description: "Refers to a resource serving as a subsection in a collection of resources."
 265   reference: '[http://www.w3.org/TR/1999/REC-html401-19991224]'
 266 successor-version:
 267   description: "Points to a resource containing the successor version in the version history."
 268   reference: '[RFC5829]'
 269 tag:
 270   description: "Gives a tag (identified by the given address) that applies to the current document."
 271   reference: '[http://www.w3.org/TR/html5/links.html#link-type-tag]'
 272 terms-of-service:
 273   description: "Refers to the terms of service associated with the link's context."
 274   reference: '[RFC6903], section 5'
 275 timegate:
 276   description: 'The Target IRI points to a TimeGate for an Original Resource.'
 277   reference: '[RFC7089]'
 278   notes: "A TimeGate for an Original Resource is a resource that is capable of datetime negotiation to support access to prior states of the Original Resource."
 279 timemap:
 280   description: 'The Target IRI points to a TimeMap for an Original Resource.'
 281   reference: '[RFC7089]'
 282   notes: "A TimeMap for an Original Resource is a resource from which a list of URIs of Mementos of the Original Resource is available."
 283 type:
 284   description: "Refers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance."
 285   reference: '[RFC6903], section 6'
 286 up:
 287   description: "Refers to a parent document in a hierarchy of documents."
 288   reference: '[RFC5988]'
 289   notes: "This relation type registration did not indicate a reference.  Requested by Noah Slater."
 290 version-history:
 291   description: "Points to a resource containing the version history for the context."
 292   reference: '[RFC5829]'
 293 via:
 294   description: "Identifies a resource that is the source of the information in the link's context."
 295   reference: '[RFC4287]'
 296 webmention:
 297   description: "Identifies a target URI that supports the Webmention protcol. This allows clients that mention a resource in some form of publishing process to contact that endpoint and inform it that this resource has been mentioned."
 298   reference: '[http://www.w3.org/TR/webmention/]'
 299   notes: "This is a similar \"Linkback\" mechanism to the ones of Refback, Trackback, and Pingback. It uses a different protocol, though, and thus should be discoverable through its own link relation type."
 300 working-copy:
 301   description: 'Points to a working copy for this resource.'
 302   reference: '[RFC5829]'
 303 working-copy-of:
 304   description: "Points to the versioned resource from which this working copy was obtained."
 305   reference: '[RFC5829]'