From ce2a05ed26395012d90adea9939c14c09d1ec8d3 Mon Sep 17 00:00:00 2001
From: Leon van Kammen
Date: Fri, 6 Nov 2026 15:41:16 +0100
Subject: [PATCH] refactor docs
---
doc/RFC_XR_Fragments.md | 391 +-
doc/RFC_XR_Fragments.md.bak | 614 -
doc/RFC_XR_Fragments.png | Bin 11855 -> 0 bytes
doc/RFC_XR_Fragments.svg | 35994 ----------------------------------
doc/RFC_XR_Fragments.txt | 2256 +--
doc/RFC_XR_Fragments.xml | 1451 --
doc/awkdown | 350 +
doc/generate.sh | 15 +-
doc/html/style.css | 519 +-
doc/html/template.html | 8 +
doc/meta.awk | 33 +
doc/notes/prio.md | 3 -
12 files changed, 1442 insertions(+), 40192 deletions(-)
delete mode 100644 doc/RFC_XR_Fragments.md.bak
delete mode 100644 doc/RFC_XR_Fragments.png
delete mode 100644 doc/RFC_XR_Fragments.svg
delete mode 100644 doc/RFC_XR_Fragments.xml
create mode 100755 doc/awkdown
create mode 100644 doc/html/template.html
create mode 100755 doc/meta.awk
delete mode 100644 doc/notes/prio.md
diff --git a/doc/RFC_XR_Fragments.md b/doc/RFC_XR_Fragments.md
index 50498f9..a82a271 100644
--- a/doc/RFC_XR_Fragments.md
+++ b/doc/RFC_XR_Fragments.md
@@ -1,102 +1,33 @@
-%%%
-Title = "XR Fragments"
-area = "Internet"
-workgroup = "Jens & Leon Internet Engineering Task Force"
+% if( ENVIRON["HTML"] ){
+% print(" ")
+% }
-[seriesInfo]
-name = "XR-Fragments"
-value = "draft-XRFRAGMENTS-leonvankammen-00"
-stream = "IETF"
-status = "informational"
+```
+▄ ▄ ▄▄▄▄▄▄▄ ▄▄▄▄▄▄▄ ▄▄▄▄▄▄▄ ▄▄▄▄▄▄▄ ▄▄▄▄▄▄ ▄▄▄ ▄▄▄ ▄▄▄▄▄▄▄ ▄▄▄▄▄▄▄ ▄ ▄▄▄▄▄▄
+▓ ▓ ▓ ▓ ▓ ▓ ▓ ▓ ▓ ▓ ▄▄▄ ▓ ▓ ▓ ▓ ▓ ▓ ▓ ▓▄▄▄▄▄ ▓▄▄▄▄▄
+▄▀▀▀▀▀▄ ▒ ▒ ▒▀▀▀ ▒ ▒ ▒▀▀▀▀▀▒ ▒ ▒ ▒ ▒ ▒▄▄▄▄▄▒ ▒ ▒ ▒ ▒
+░ ░ ░ ░ ░ ░ ░ ░▄▄▄▄░ ░ ░ ░▄▄▄▄▄▄ ░ ░ ░▄▄▄▄▄ ▄▄▄▄▄░
+```
-date = 2023-04-12T00:00:00Z
+# XR Fragments spec
-[[author]]
-initials="L.R."
-surname="van Kammen"
-fullname="L.R. van Kammen"
-
-%%%
-
-
-
-
-
-.# Abstract
+# Abstract
> Version: 0.5
An open specification for hyperlinking & deeplinking 3D fileformats.
-This draft is a specification for interactive URI-controllable 3D files, enabling [hypermediatic](https://github.com/coderofsalvation/hypermediatic) navigation, to enable a spatial web for hypermedia browsers with- or without a network-connection.
+This is a specification for interactive URI-controllable 3D files, to enable spatial webs for local-first XR hypermedia browsers.
XR Fragments allows us to better use implicit metadata inside 3D scene(files), by mapping it to proven technologies like [URI Fragments](https://en.wikipedia.org/wiki/URI_fragment).
> Almost every idea in this document is demonstrated at [https://xrfragment.org](https://xrfragment.org)
@@ -110,7 +41,7 @@ XR Fragments allows us to better use implicit metadata inside 3D scene(files), b
1. [Introduction](#introduction)
1. [How does it work](#how-does-it-work)
1. [What does it solve](#what-does-it-solve)
-1. [HFL (Hypermediatic Feedback Loop) for XR Browsers](#hfl-hypermediatic-feedback-loop-for-xr-browsers)
+1. [Hypermediatic Feedback Loop for XR Browsers](#hfl-hypermediatic-feedback-loop-for-xr-browsers)
1. [Conventions and Definitions](#conventions-and-definitions)
1. [XR Fragment URL Grammar](#xr-fragment-url-grammar)
1. [Spatial Referencing 3D](#spatial-referencing-3d)
@@ -126,10 +57,6 @@ XR Fragments allows us to better use implicit metadata inside 3D scene(files), b
1. [Level2: href links](#level2-href-links)
1. [Interaction behaviour](#interaction-behaviour)
1. [XR Viewer implementation](#xr-viewer-implementation)
-1. [Level3: Media Fragments](#level3-media-fragments)
- 1. [Animation(s) timeline](#animation-s-timeline)
- 1. [Specify playback loopmode](#specify-playback-loopmode)
- 1. [Controlling embedded content](#controlling-embedded-content)
1. [Level4: prefix operators](#level4-prefix-operators)
1. [Object teleports](#object-teleports)
1. [Object multipliers](#object-multipliers)
@@ -137,6 +64,10 @@ XR Fragments allows us to better use implicit metadata inside 3D scene(files), b
1. [Sharing object or file (#|)](#sharing-object-or-file)
1. [xrf:// URI scheme](#xrf-uri-scheme)
1. [Level5: URI Templates (RFC6570)](#level5-uri-templates-rfc6570)
+1. [Level8: Media Fragments](#level8-media-fragments)
+ 1. [Animation(s) timeline](#animation-s-timeline)
+ 1. [Specify playback loopmode](#specify-playback-loopmode)
+ 1. [Controlling embedded content](#controlling-embedded-content)
1. [Top-level URL processing](#top-level-url-processing)
1. [UX](#ux)
1. [Example: Navigating content href portals](#example-navigating-content-href-portals)
@@ -156,17 +87,18 @@ XR Fragments allows us to better use implicit metadata inside 3D scene(files), b
1. [Appendix: Definitions](#appendix-definitions)
# Introduction
-(!Introduction)
+
How can we add more control to existing text and 3D scenes, without introducing new dataformats?
Historically, there's many attempts to create the ultimate 3D fileformat.
The lowest common denominator is: designers describing/tagging/naming things using **plain text**.
XR Fragments exploits the fact that all 3D models already contain such metadata:
-**XR Fragments allows deeplinking of 3D objects by mapping objectnames to URI fragments**
+** Deeplinking 3D objects by mapping objectnames to URI fragments**
+
+> For a better-readable, better-updated spec see the website https://xrfragment.org
# How does it work
-(!What is XR Fragments )
XR Fragments utilizes URLs:
@@ -182,7 +114,6 @@ XR Fragments utilizes URLs:
It solves:
1. addressibility and [hypermediatic](https://github.com/coderofsalvation/hypermediatic) navigation of 3D scenes/objects: [URI Fragments](https://en.wikipedia.org/wiki/URI_fragment) using src/href spatial metadata
-1. Interlinking text & spatial objects by collapsing space into a Word Graph (XRWG) to show [visible links](#visible-links)
1. unlocking spatial potential of the (originally 2D) hashtag (which jumps to a chapter) for navigating XR documents
1. refraining from introducing scripting-engines for mundane tasks (and preventing its inevitable security-headaches)
1. the gap between text an 3d objects: object-names directly map to hashtags (=fragments), which allows 3D to text transcription.
@@ -195,19 +126,18 @@ To aid adoption, the standard comprises of various (optional) support-levels, wh
> XR Fragments is in a sense, a heuristical 3D format or meta-format, which leverages heuristic rules derived from any 3D scene or well-established 3D file formats, to extract meaningful features from scene hierarchies.
These heuristics, enable features that are both meaningful and consistent across different scene representations, allowing higher interop between fileformats, 3D editors, viewers and game-engines.
-# HFL (Hypermediatic Feedback Loop) for XR Browsers
-(!HFL (Hypermediatic Feedback Loop) for XR Browsers)
+# Hypermediatic feedback Loop in XR Browsers
-`href` metadata traditionally implies **click** AND **navigate**, however XR Fragments adds stateless **click** (`xrf://....`) via the `xrf://` scheme, which does not change the top-level URL-adress (of the browser).
+`href` metadata traditionally implies **click** AND **navigate**, however XR Fragments separates **click** via the `xrf://` scheme, which does not change the top-level URL-adress (of the browser).
This allows for many extra interactions via URLs, which otherwise needs a scripting language.
-These are called **hashbus**-only events/
+These are called **hash**-events in this sepc.
> Being able to use the same URI Fragment DSL for navigation (`href: #foo`) as well as interactions (`href: xrf://#foo`) greatly simplifies implementation, increases HFL, and reduces need for scripting languages.
This opens up the following benefits for traditional & future webbrowsers:
* [hypermediatic](https://github.com/coderofsalvation/hypermediatic) loading/clicking 3D assets (gltf/fbx e.g.) natively (with or without using HTML).
-* potentially allowing 3D assets/nodes to publish XR Fragments to themselves/eachother using the `xrf://` hashbus (`xrf://#person=walk` to trigger `walk`-animation for object `person`)
+* potentially allowing 3D assets/nodes to publish XR Fragments to themselves/eachother using the `xrf://` hash-events (`xrf://#person=walk` to trigger `walk`-animation for object `person`)
* potentially collapsing the 3D scene to an wordgraph (for essential navigation purposes) controllable thru a hash(tag)bus
* completely bypassing the security-trap of loading external scripts (by loading 3D model-files, not HTML-javascriptable resources)
@@ -216,26 +146,17 @@ XR Fragments itself are [hypermediatic](https://github.com/coderofsalvation/hype
| principle | 3D URL | HTML 2D URL |
|-----------------------------|-------------------------------------------------|---------------------------------------|
-| the XRWG | wordgraph (collapses 3D scene to tags) | Ctrl-F (find) |
-| the hashbus | hashtags alter camera/scene/object-projections | hashtags alter document positions |
-| src metadata | renders content and offers sourceportation | renders content |
+| the hash-events | hashtags alter camera/scene/object-projections | hashtags alter document positions |
| href metadata | teleports to other XR document | jumps to other HTML document |
-| href metadata | triggers predefined view | Media fragments |
-| href metadata | triggers camera/scene/object/projections | n/a |
-| href metadata | draws visible connection(s) for XRWG 'tag' | n/a |
-| href metadata | filters certain (in)visible objects | n/a |
| href metadata | href="xrf://#-foo&bar" | href="javascript:hideFooAndShowBar()` |
-| | (this does not update topLevel URI) | (this is non-standard, non-hypermediatic) |
-> An important aspect of HFL is that URI Fragments can be triggered without updating the top-level URI (default href-behaviour) thru their own 'bus' (`xrf://#.....`). This decoupling between navigation and interaction prevents non-standard things like (`href`:`javascript:dosomething()`).
+> An important aspect is that URI Fragments can be triggered without updating the top-level URI (default href-behaviour) thru their own 'bus' (`xrf://#.....`). This decoupling between navigation and interaction prevents non-standard things like (`href`:`javascript:dosomething()`).
# Conventions and Definitions
-(!Conventions and Definitions)
See appendix below in case certain terms are not clear.
## XR Fragment URL Grammar
-(! XR Fragment URL Grammar )
For typical HTTP-like browsers/applications:
@@ -254,12 +175,12 @@ sub-delims = "," / "="
> this is already implemented in all browsers
-Pseudo (non-native) browser-implementations (supporting XR Fragments using HTML+JS e.g.) can use the `?` search-operator to address outbound content.
-In other words, the URL updates to: `https://me.com?https://me.com/other.glb` when navigating to `https://me.com/other.glb` from inside a `https://me.com` WebXR experience e.g.
-That way, if the link gets shared, the XR Fragments implementation at `https://me.com` can load the latter (and still indicates which XR Fragments entrypoint-experience/client was used).
+For in-browser implementations where hash is already used, the following formats can be used:
+
+* [janusweb](https://github.com/jbaicoianu/janusweb): `https://web.janus.org/#janus.url=https%3A%2F%2Ffoo.com%2Fmy3d.gltf%23room1%26prio%3D-5%26t%3D0%2C100`
+* viewer using query for url-input: `https://my.org/myviewer?https%3A%2F%2Ffoo.com%2Fmy3d.gltf%23room1%26prio%3D-5%26t%3D0%2C100`
# Spatial Referencing 3D
-(!Spatial Referencing 3D )
3D files contain an hierarchy of objects.
XR Fragments assumes the following objectname-to-URI-Fragment mapping, in order to deeplink 3D objects:
@@ -286,15 +207,11 @@ XR Fragments assumes the following objectname-to-URI-Fragment mapping, in order
> Every 3D fileformat supports named 3D object, and this name allows URLs (fragments) to reference them (and their children objects).
Clever nested design of 3D scenes allow great ways for re-using content, and/or previewing scenes.
-For example, to render a portal with a preview-version of the scene, create an 3D object with:
+For example, to render a portal with a preview-version of the scene, create an 3D object with extra/metadata:
-* href: `https://scene.fbx`
-
-> It also allows **sourceportation**, which basically means the enduser can teleport to the original XR Document of an `src` embedded object, and see a visible connection to the particular embedded object. Basically an embedded link becoming an outbound link by activating it.
+* href: `https://scene.gltf`
# Level0: Files
-(!Level0: Files )
-(!Level0: Files)
Compatible 3D fileformats: [glTF](https://www.khronos.org/gltf/), [usdz](https://openusd.org/release/spec_usdz.html), [obj](https://en.wikipedia.org/wiki/Wavefront_.obj_file), [collada](https://www.khronos.org/collada), [THREE.json](https://github.com/mrdoob/three.js/wiki/JSON-Object-Scene-format-4), [X3D](https://en.wikipedia.org/wiki/X3D) e.g.
@@ -310,14 +227,12 @@ they can accomodate developers or applications who (for whatever reason) must no
## Timelines
-when a loaded file contains a timeline (animations/subtitles e.g.), then:
+When a loaded file contains a timeline (animations/subtitles e.g.), then:
> All timelines must play (looped) by default (to enable [[XR Movies]])
Unless an object has multiple animations (actions e.g.), then just play the first or with name `default`.
-
-
## via href metadata
```
@@ -377,14 +292,12 @@ $ setfattr -n explainer.vtt -v "subtitles.vtt" explainer.glb
## JSON sidecar-file
-For developers, sidecar-file can allow for defining **explicit** XR Fragments links (>level1), outside of the 3D file.
-This can be done via (objectname/metadata) key/value-pairs in a JSON [sidecar-file](https://en.wikipedia.org/wiki/Sidecar_file):
+> NOTE: the following approach is only recommended for archivist/userupload scenarios where the 3D file itself should not be altered.
-* experience.glb
-* experience.json `<----`
+For developers, a json-sidecar-file can allow for defining explicit XR Fragments metadata (>level1), outside of the 3D file.
+This can be done via (objectname/metadata) key/value-pairs in a JSON sidecar-file:
-
-```json
+```json
{
"aria-description": "description of scene",
"button": {
@@ -394,22 +307,21 @@ This can be done via (objectname/metadata) key/value-pairs in a JSON [sidecar-fi
}
```
-> This will make object `button` clickable, and teleport the user to object `roomB`.
+This will make object button clickable, and teleport the user to object roomB.
+
+> So after loading experience.glb the existence of experience.json is detected, to apply the explicit metadata. The sidecar will define (or override already existing) extras, which can be handy for multi-user platforms (offer 3D scene customization/personalization to users).
-So after loading `experience.glb` the existence of `experience.json` is detected, to apply the explicit metadata.
-The sidecar will define (or **override** already existing) extras, which can be handy for multi-user platforms (offer 3D scene customization/personalization to users).
-
-> In THREE.js-code this would boil down to:
+In THREE.js-code this would boil down to:
```javascript
scene.userData['aria-description'] = "description of scene"
scene.getObjectByName("button").userData.href = "#roomB"
-
- // now the XR Fragments parser can process the XR Fragments userData 'extras' in the scene
```
+> now the XR Fragments parser can process the XR Fragments userData 'extras' in the scene
+
# Level1: URI
-(!Level1: URI)
+
> **XR Fragments allows deeplinking of 3D objects by mapping objectnames to URI fragments**
@@ -446,26 +358,23 @@ Fact: our typical browser URL's are just **a possible implementation** of URI's
Below you can see how this translates back into good-old URLs:
```
- +───────────────────────────────────────────────────────────────────────────────────────────────+
- │ │
- │ the soul of any URL: ://macro /meso ?micro #nano │
- │ │
- │ 2D URL: ://library.com /document ?search #chapter │
- │ xrf:// │
- │ 4D URL: ://park.com /4Dscene.fbx ─> ?other.glb ─> #object ─> hashbus │
- │ │ #filter │ │
- │ │ #tag │ │
- │ │ (hypermediatic) #material │ │
- │ │ ( feedback ) #animation │ │
- │ │ ( loop ) #texture │ │
- │ │ #variable │ │
- │ │ │ │
- │ XRWG <─────────────────────<─────────────+ │
- │ │ │ │
- │ └─ objects ──────────────>─────────────+ │
- │ │
- │ │
- +───────────────────────────────────────────────────────────────────────────────────────────────+
+ +─────────────────────────────────────────────────────────────────────────────────────+
+ │ │
+ │ the soul of any URL: ://macro /meso ?micro #nano │
+ │ │
+ │ 2D URL: ://library.com /document ?search #chapter │
+ │ │
+ │ 4D URL: ://park.com /4Dscene.fbx ─> ?other.glb ─> #object │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ │ │ │
+ │ └─ view change ───────────────+ │
+ │ │
+ │ │
+ +─────────────────────────────────────────────────────────────────────────────────────+
```
@@ -476,7 +385,6 @@ Below you can see how this translates back into good-old URLs:
| fragment | type | example | info |
|-------------------|------------|--------------------|----------------------------------------------------------------------|
| `#......` | vector3 | `#room1` `#room2` `#cam2` | positions/parents camera(rig) (or XR floor) to xyz-coord/object/camera and upvector |
-| [Media Fragments](https://www.w3.org/TR/media-frags/) | [media fragment](#media%20fragments%20and%20datatypes) | `#t=0,2&loop` | play (and loop) 3D animation from 0 seconds till 2 seconds|
## List of **explicit* metadata
@@ -489,7 +397,7 @@ These are the possible 'extras' for 3D nodes and sidecar-files
# Level2: href links
-(!Level2: href links)
+
Explicit href metadata ('extras') in a 3D object (of a 3D file), hint the viewer that the user ''can interact'' with that object :
@@ -513,10 +421,10 @@ The imported/teleported destination can be another object in the same scene-file
| level2 | click external 3D file [href](#via-href-metadata) (`foo.glb` e.g.) | replace the current scene with a new 3D file (`href: other.glb` e.g.) |
| level2 | hover external 3D file [href](#via-href-metadata) | show the preview PNG thumbnail (if any sidecar, see level0) |
| level2 | activate animation | clicking href-value `#foo` will select animation `foo` (if exist) |
-| level2 | click [href](#via-href-metadata) | hashbus: execute without changing the toplevel URL location (`href: xrf://#someObjectName` e.g.) |
-| level3 | click [href](#via-href-metadata) | set the global 3D animation timeline to its Media Fragment value (`#t=2,3` e.g.) |
+| level2 | click [href](#via-href-metadata) | hash-events: execute without changing the toplevel URL location (`href: xrf://#someObjectName` e.g.) |
+| higher levels | non-normative | non-normative |
-> NOTE: hashbus links (`xrf://#foo&bar`) don't change the toplevel URL, which makes it ideal for interactions (in contrast to typical `#roomC` navigation, which benefit back/forward browser-buttons), see hashbus for more info.
+> NOTE: hash-events links (`xrf://#foo&bar`) don't change the toplevel URL, which makes it ideal for interactions (in contrast to typical `#roomC` navigation, which benefit back/forward browser-buttons), see hash-events for more info.
> **default camera (spawn) location**: When a 3D file is loaded, it will position the user/camera at xyz: 0,0,0 OR to the location of (an object called) ''spawn''.
@@ -532,8 +440,58 @@ will load as default:
https://my.org/foo.glb#spawn
```
-# Level3: Media Fragments
-(!Level3: Media Fragments )
+# Level3: XR hints
+
+> How to know whether a 3D file is a full scene or just a prop? When should a 3D file hide its skybox? How does a file know whether its embedded or not? How to hide an object in AR-mode only? How to ''hide'' an object by default, after loading a scene?
+
+**Answer**: somehow tagging the file, or object with **predefined classes** ; universal XR keywords.
+
+Example in JanusWeb JML:
+
+```
+
+
+
+
+```
+
+
+## Predefined hints: XR layers
+
+| **hint/class** | desktop mode | VR mode | AR mode | **usecase** |
+|-|-|-|-|-|
+| `vr` | show | show | hide | render object+children |
+| `ar` | hide | hide | show | render object+children |
+| `embed` | show | show | show | render object+children when loaded in another scene |
+| `portal` | show | show | show | render object+children inside portal |
+| `collection` | hide | hide | hide | object+children are not part of a scene/experience (think importing into inventory, openbrush brushes e.g.). |
+| `hide` | hide | hide | hide | hide object+children |
+
+Any element without any of these class-values is considered visible in all layers. Once class-value(s) are detected it'll work as a layer-mask: `class: 'vr ar'` will be visible in desktop-,VR- and AR-mode.
+
+> **NOTE**: there's is no CSS: class attributes without CSS means **no cascade inheritance**; above class-definitions will apply to the element itself (and its children, which can override by defining their own XR layer class-definitions).
+
+## Predefined hints: XR object interactions
+
+| **hint/class** | **spec** | **document default** | **usecase** |
+|-|-|-|-|
+| `grabbable` | v1 | unset | allow single handtracking-pinch to reposition object, or via buttonhold + controllermove/mousemove |
+| `stretchable` | v1 | unset | allow both handtracking-pinch to stretch object, or via buttonhold + controllermove/mousemove |
+| `collidable` | v1 | unset | hints that `grabbable` and `stretchable` should halt upon collisions |
+
+> **NOTE:** `href: #*foo` implies that object `foo` has `class: 'grabbable'`
+
+## Usecases
+
+* 3D previews: `class: 'vr ar'` prevents rendering (heavy) items when displayed in a portal (or embedded into another scene).
+* extra info: `class: 'portal'` displays onboarding texts/info ONLY when rendered in a portal.
+
+# Level8: Media Fragments
+
> these allow for XR Movies with a controllable timeline using `href` URI's with Media Fragments
@@ -590,7 +548,7 @@ use [[URI Templates]] to control embedded media, for example a simple video-play
```
# Level4: prefix operators
-(!Level4: prefix operators)
+
Prefixing objectnames with the following simple operators allow for **extremely powerful** XR interactions:
@@ -603,7 +561,7 @@ Prefixing objectnames with the following simple operators allow for **extremely
> **Examples:** `#+menu` to show a object, `#-menu` to hide a menu, `#!menu` to teleport a menu, `#*block` to clone a grabbable block, `#|object` to share an object
-## Object teleports (!)
+## Object teleports
Prefixing an object with an exclamation-symbol, will teleport a (local or remote) referenced object from/to its original/usercamera location.
@@ -715,14 +673,14 @@ The `xrf:` scheme will just do 2 & 3 (so the URL-values will not leak into the t
> **compliance with RFC 3986**: unimplemented/unknown URI schemes (`xrf:...` e.g.) will not update the top-level URL
# Level5: URI Templates (RFC6570)
-(!Level5: URI Templates (RFC6570))
+
XR Fragments adopts Level1 URI **Fragment** expansion to provide safe interactivity.
This is non-normative, and the draft spec is available on request.
# Top-level URL processing
-(!Top-level URL processing)
+
> Example URL: `://foo/world.gltf#room1&t=10&cam`
@@ -742,7 +700,7 @@ End-users should always have read/write access to:
# Example: Navigating content href portals
-(!Example: Navigating content href portals)
+
navigation, portals & mutations
@@ -772,18 +730,8 @@ navigation, portals & mutations
[» example 3D asset](https://github.com/coderofsalvation/xrfragment/blob/main/example/assets/href.gltf#L192)
[» discussion](https://github.com/coderofsalvation/xrfragment/issues/1)
-## Walking surfaces
+# Example: Virtual world webrings
-> By default position `0,0,0` of the 3D scene represents the walkable plane, however this is overridden when the following applies:
-
-XR Fragment-compatible viewers can infer this data based scanning the scene for:
-
-1. materialless (nameless & textureless) mesh-objects (without `href` and >0 faces)
-
-> optionally the viewer can offer thumbstick, mouse or joystick teleport-tools for non-roomscale VR/AR setups.
-
-# Example: Virtual world rings
-(!Example: Virtual world rings )
Consider 3D scenes linking to eachother using these `href` values, attached to 3D button-objects:
@@ -800,7 +748,7 @@ Now consider adding a 'webring index'-button to each file, with this href-value:
This would allow displaying the (remote 3D file) webring menu with various href-buttons inside, all centrally curated by the workgroup.
# Additional scene metadata
-(!Additional scene metadata )
+
XR Fragments does not aim to redefine the metadata-space or accessibility-space by introducing its own cataloging-metadata fields.
Instead, it encourages browsers to scan nodes for the following custom properties:
@@ -844,7 +792,7 @@ There's no silver bullet when it comes to metadata, so XR Fragment-implementatio
> These attributes can be scanned and presented during an `href` or `src` eye/mouse-over.
# Accessibility interface
-(!Accessibility interface)
+
The addressibility of XR Fragments allows for unique 3D-to-text transcripts, as well as an textual interface to navigate 3D content.
Spec:
@@ -876,7 +824,7 @@ Therefore a 2-button navigation-interface is the bare minimum interface:
2. objects with href metadata can be activated via a key (enter on a keyboard)
3. the TTS reads the href-value (and/or aria-description if available)
-## XRF microformat
+# XRF Microformat
How can applications discover 3D experiences on a network?
@@ -884,7 +832,7 @@ How can applications discover 3D experiences on a network?
The XRF microformat is an [optional](#Progressive%20enhancement) text heuristics which applications can detect across various usecases.
-#### via HTML webpage
+## via HTML webpage
If the browser/application requests an webpage (`https://nlnet.nl` e.g.) it should check for the [rel-me microformat](https://gmpg.org/xfn/) :
@@ -906,24 +854,56 @@ Another reason is that XR Fragments is filetype-agnostic, so flexibility is expe
> NOTE: in case of multiple 3D files mentioned in `
+
+
+
+
+
+
+
+
```
+
+3D engines (games/apps) can render these like clickable portals, for example JanusXR-style portals:
+
+> NOTE: for more customizability [JML <link>](https://coderofsalvation.github.io/janus-guide/#/build/room?id=link) will allow for positioning/thumbnailed portals:
+
+```xml
+
+
+
+
+
+
+
+
+
+
+```
+
+### Mixing multiple spatial microformats:
+
+```xml
-
```
-#### via WebFinger
+
+## via WebFinger
When John has an account on foo.com, how can other applications request his 3D homepage by simply entering `john@foo.com`?
@@ -972,9 +952,9 @@ When John has an account on foo.com, how can other applications request his 3D h
This way the application will load `https://3d.john.foo.com/model/scene.glb` when the user types `john@foo.com` into the user field.
-#### via Text (URI)
+## via Text (URI)
-Another way for an application to trigger loading a 3D scene is by detecting URI's of 3D scene-files any text:
+As a fallback, for an application to trigger loading a 3D scene is by detecting URI's of 3D scene-files any text:
* `foo.glb` (or any other popular 3D extension)
* `https://foo.com/scene.glb` (or any other popular protocol)
@@ -1002,7 +982,7 @@ If a glTF implementation does not support a particular extension, the (XRF) extr
> **Example 2** If an Extensions uses XR Fragments in URI's (`href: #otherroom` or `href: xrf://-walls` in OMI_LINK e.g.), then perform them according to XR Fragment spec (teleport user). But only once: ignore further overlapping metadata for that usecase.
# Vendor Prefixes
-(!Vendor Prefixes )
+
Vendor-specific metadata in a 3D scenefiles, are similar to vendor-specific [CSS-prefixes](https://en.wikipedia.org/wiki/CSS#Vendor_prefixes) (`-moz-opacity: 0.2` e.g.).
This allows popular 3D engines/frameworks, to initialize specific features when loading a scene/object, in a progressive enhanced way.
@@ -1061,14 +1041,14 @@ String-templatevalues are evaluated as per [URI Templates (RFC6570)](https://www
# Security Considerations
-(!Security Considerations)
+
The only dynamic parts are [W3C Media Fragments](https://www.w3.org/TR/media-frags/) and [URI Templates (RFC6570)](https://www.rfc-editor.org/rfc/rfc6570).
The use of URI Templates is limited to pre-defined variables and Level0 fragments-expansion only, which makes it quite safe.
n fact, it is much safer than relying on a scripting language (javascript) which can change URN too.
# FAQ
-(!FAQ )
+
**Q:** Why is everything HTTP GET-based, what about POST/PUT/DELETE HATEOS
**A:** Because it's out of scope: XR Fragment specifies a read-only way to surf XR documents. These things belong in the application layer (for example, an XR Hypermedia browser can decide to support POST/PUT/DELETE requests for embedded HTML thru `src` values)
@@ -1082,18 +1062,18 @@ Doing advanced scripting & networkrequests under the hood are obviously interest
Non-HTML Hypermedia browsers should make browser extensions the right place, to 'extend' experiences, in contrast to code/javascript inside hypermedia documents (this turned out as a hypermedia antipattern).
# authors
-(!authors)
+
* Leon van Kammen (@lvk@mastodon.online)
* Jens Finkhäuser (@jens@social.finkhaeuser.de)
# IANA Considerations
-(!IANA Considerations)
+
This document has no IANA actions.
# Acknowledgments
-(!Acknowledgments)
+
* [NLNET](https://nlnet.nl)
* [Future of Text](https://futureoftext.org)
@@ -1109,7 +1089,7 @@ This document has no IANA actions.
* Mark Anderson
# Appendix: Definitions
-(!Appendix: Definitions )
+
|definition | explanation |
|----------------------|--------------------------------------------------------------------------------------------------------------------------------------|
@@ -1121,8 +1101,7 @@ This document has no IANA actions.
|URN | something at some domain (`me.com/foo.glb`) |
|metadata | custom properties of text, 3D Scene or Object(nodes), relevant to machines and a human minority (academics/developers) |
|XR fragment | URI Fragment with spatial hints (which match the name of a 3D object-, camera-, animation-object) |
-|the XRWG | wordgraph (collapses 3D scene to tags) |
-|the hashbus | hashtags map to camera/scene-projections |
+|the hash-events | hashtags map to camera/scene-projections |
|spacetime hashtags | positions camera, triggers scene-preset/time |
|teleportation | repositioning the enduser to a different position (or 3D scene/file) |
|sourceportation | teleporting the enduser to the original XR Document of an `src` embedded object. |
diff --git a/doc/RFC_XR_Fragments.md.bak b/doc/RFC_XR_Fragments.md.bak
deleted file mode 100644
index 09e996d..0000000
--- a/doc/RFC_XR_Fragments.md.bak
+++ /dev/null
@@ -1,614 +0,0 @@
-%%%
-Title = "XR Fragments"
-area = "Internet"
-workgroup = "Internet Engineering Task Force"
-
-[seriesInfo]
-name = "XR-Fragments"
-value = "draft-XRFRAGMENTS-leonvankammen-00"
-stream = "IETF"
-status = "informational"
-
-date = 2023-04-12T00:00:00Z
-
-[[author]]
-initials="L.R."
-surname="van Kammen"
-fullname="L.R. van Kammen"
-
-%%%
-
-
-
-
-
-.# Abstract
-
-This draft offers a specification for 4D URLs & navigation, to link 3D scenes and text together with- or without a network-connection.
-The specification promotes spatial addressibility, sharing, navigation, query-ing and tagging interactive (text)objects across for (XR) Browsers.
-XR Fragments allows us to enrich existing dataformats, by recursive use of existing proven technologies like [URI Fragments](https://en.wikipedia.org/wiki/URI_fragment) and BibTags notation.
-
-> Almost every idea in this document is demonstrated at [https://xrfragment.org](https://xrfragment.org)
-
-{mainmatter}
-
-# Introduction
-
-How can we add more features to existing text & 3D scenes, without introducing new dataformats?
-Historically, there's many attempts to create the ultimate markuplanguage or 3D fileformat.
-However, thru the lens of authoring, their lowest common denominator is still: plain text.
-XR Fragments allows us to enrich/connect existing dataformats, by recursive use of existing technologies:
-
-1. addressibility and navigation of 3D scenes/objects: [URI Fragments](https://en.wikipedia.org/wiki/URI_fragment) + src/href spatial metadata
-1. hasslefree tagging across text and spatial objects using [BibTags](https://en.wikipedia.org/wiki/BibTeX) as appendix (see [visual-meta](https://visual-meta.info) e.g.)
-
-> NOTE: The chapters in this document are ordered from highlevel to lowlevel (technical) as much as possible
-
-# Core principle
-
-XR Fragments strives to serve (nontechnical/fuzzy) humans first, and machine(implementations) later, by ensuring hasslefree text-vs-thought feedback loops.
-This also means that the repair-ability of machine-matters should be human friendly too (not too complex).
-
-> "When a car breaks down, the ones **without** turbosupercharger are easier to fix"
-
-Let's always focus on average humans: the 'fuzzy symbolical mind' must be served first, before serving the greater ['categorized typesafe RDF hive mind'](https://en.wikipedia.org/wiki/Borg)).
-
-> Humans first, machines (AI) later.
-
-# Conventions and Definitions
-
-|definition | explanation |
-|----------------------|-------------------------------------------------------------------------------------------------------------------------------|
-|human | a sentient being who thinks fuzzy, absorbs, and shares thought (by plain text, not markuplanguage) |
-|scene | a (local/remote) 3D scene or 3D file (index.gltf e.g.) |
-|3D object | an object inside a scene characterized by vertex-, face- and customproperty data. |
-|metadata | custom properties of text, 3D Scene or Object(nodes), relevant to machines and a human minority (academics/developers) |
-|XR fragment | URI Fragment with spatial hints like `#pos=0,0,0&t=1,100` e.g. |
-|src | (HTML-piggybacked) metadata of a 3D object which instances content |
-|href | (HTML-piggybacked) metadata of a 3D object which links to content |
-|query | an URI Fragment-operator which queries object(s) from a scene like `#q=cube` |
-|visual-meta | [visual-meta](https://visual.meta.info) data appended to text/books/papers which is indirectly visible/editable in XR. |
-|requestless metadata | opposite of networked metadata (RDF/HTML requests can easily fan out into framerate-dropping, hence not used a lot in games). |
-|FPS | frames per second in spatial experiences (games,VR,AR e.g.), should be as high as possible |
-|introspective | inward sensemaking ("I feel this belongs to that") |
-|extrospective | outward sensemaking ("I'm fairly sure John is a person who lives in oklahoma") |
-|`◻` | ascii representation of an 3D object/mesh |
-|(un)obtrusive | obtrusive: wrapping human text/thought in XML/HTML/JSON obfuscates human text into a salad of machine-symbols and words |
-|BibTeX | simple tagging/citing/referencing standard for plaintext |
-|BibTag | a BibTeX tag |
-
-# List of URI Fragments
-
-| fragment | type | example | info |
-|--------------|----------|-------------------|-------------------------------------------------------------------|
-| `#pos` | vector3 | `#pos=0.5,0,0` | positions camera to xyz-coord 0.5,0,0 |
-| `#rot` | vector3 | `#rot=0,90,0` | rotates camera to xyz-coord 0.5,0,0 |
-| `#t` | vector2 | `#t=500,1000` | sets animation-loop range between frame 500 and 1000 |
-| `#......` | string | `#.cubes` `#cube` | object(s) of interest (fragment to object name or class mapping) |
-
-> xyz coordinates are similar to ones found in SVG Media Fragments
-
-# List of metadata for 3D nodes
-
-| key | type | example (JSON) | info |
-|--------------|----------|--------------------|--------------------------------------------------------|
-| `name` | string | `"name": "cube"` | available in all 3D fileformats & scenes |
-| `class` | string | `"class": "cubes"` | available through custom property in 3D fileformats |
-| `href` | string | `"href": "b.gltf"` | available through custom property in 3D fileformats |
-| `src` | string | `"src": "#q=cube"` | available through custom property in 3D fileformats |
-
-Popular compatible 3D fileformats: `.gltf`, `.obj`, `.fbx`, `.usdz`, `.json` (THREEjs), `COLLADA` and so on.
-
-> NOTE: XR Fragments are file-agnostic, which means that the metadata exist in programmatic 3D scene(nodes) too.
-
-# Navigating 3D
-
-Here's an ascii representation of a 3D scene-graph which contains 3D objects `◻` and their metadata:
-
-```
- +--------------------------------------------------------+
- | |
- | index.gltf |
- | │ |
- | ├── ◻ buttonA |
- | │ └ href: #pos=1,0,1&t=100,200 |
- | │ |
- | └── ◻ buttonB |
- | └ href: other.fbx | <-- file-agnostic (can be .gltf .obj etc)
- | |
- +--------------------------------------------------------+
-
-```
-
-An XR Fragment-compatible browser viewing this scene, allows the end-user to interact with the `buttonA` and `buttonB`.
-In case of `buttonA` the end-user will be teleported to another location and time in the **current loaded scene**, but `buttonB` will
- **replace the current scene** with a new one, like `other.fbx`.
-
-# Embedding 3D content
-
-Here's an ascii representation of a 3D scene-graph with 3D objects `◻` which embeds remote & local 3D objects `◻` (without) using queries:
-
-```
- +--------------------------------------------------------+ +-------------------------+
- | | | |
- | index.gltf | | ocean.com/aquarium.fbx |
- | │ | | │ |
- | ├── ◻ canvas | | └── ◻ fishbowl |
- | │ └ src: painting.png | | ├─ ◻ bass |
- | │ | | └─ ◻ tuna |
- | ├── ◻ aquariumcube | | |
- | │ └ src: ://rescue.com/fish.gltf#q=bass%20tuna | +-------------------------+
- | │ |
- | ├── ◻ bedroom |
- | │ └ src: #q=canvas |
- | │ |
- | └── ◻ livingroom |
- | └ src: #q=canvas |
- | |
- +--------------------------------------------------------+
-```
-
-An XR Fragment-compatible browser viewing this scene, lazy-loads and projects `painting.png` onto the (plane) object called `canvas` (which is copy-instanced in the bed and livingroom).
-Also, after lazy-loading `ocean.com/aquarium.gltf`, only the queried objects `bass` and `tuna` will be instanced inside `aquariumcube`.
-Resizing will be happen accordingly to its placeholder object `aquariumcube`, see chapter Scaling.
-
-# XR Fragment queries
-
-Include, exclude, hide/shows objects using space-separated strings:
-
-* `#q=cube`
-* `#q=cube -ball_inside_cube`
-* `#q=* -sky`
-* `#q=-.language .english`
-* `#q=cube&rot=0,90,0`
-* `#q=price:>2 price:<5`
-
-It's simple but powerful syntax which allows css-like class/id-selectors with a searchengine prompt-style feeling:
-
-1. queries are showing/hiding objects **only** when defined as `src` value (prevents sharing of scene-tampered URL's).
-1. queries are highlighting objects when defined in the top-Level (browser) URL (bar).
-1. search words like `cube` and `foo` in `#q=cube foo` are matched against 3D object names or custom metadata-key(values)
-1. search words like `cube` and `foo` in `#q=cube foo` are matched against tags (BibTeX) inside plaintext `src` values like `@cube{redcube, ...` e.g.
-1. `#` equals `#q=*`
-1. words starting with `.` like `.german` match class-metadata of 3D objects like `"class":"german"`
-1. words starting with `.` like `.german` match class-metadata of (BibTeX) tags in XR Text objects like `@german{KarlHeinz, ...` e.g.
-
-> **For example**: `#q=.foo` is a shorthand for `#q=class:foo`, which will select objects with custom property `class`:`foo`. Just a simple `#q=cube` will simply select an object named `cube`.
-
-* see [an example video here](https://coderofsalvation.github.io/xrfragment.media/queries.mp4)
-
-## including/excluding
-
-| operator | info |
-|----------|-------------------------------------------------------------------------------------------------------------------------------|
-| `*` | select all objects (only useful in `src` custom property) |
-| `-` | removes/hides object(s) |
-| `:` | indicates an object-embedded custom property key/value |
-| `.` | alias for `"class" :".foo"` equals `class:foo` |
-| `>` `<` | compare float or int number |
-| `/` | reference to root-scene. Useful in case of (preventing) showing/hiding objects in nested scenes (instanced by `src`) (*) |
-
-> \* = `#q=-/cube` hides object `cube` only in the root-scene (not nested `cube` objects) `#q=-cube` hides both object `cube` in the root-scene AND nested `skybox` objects |
-
-[» example implementation](https://github.com/coderofsalvation/xrfragment/blob/main/src/3rd/js/three/xrf/q.js)
-[» example 3D asset](https://github.com/coderofsalvation/xrfragment/blob/main/example/assets/query.gltf#L192)
-[» discussion](https://github.com/coderofsalvation/xrfragment/issues/3)
-
-## Query Parser
-
-Here's how to write a query parser:
-
-1. create an associative array/object to store query-arguments as objects
-1. detect object id's & properties `foo:1` and `foo` (reference regex: `/^.*:[><=!]?/` )
-1. detect excluders like `-foo`,`-foo:1`,`-.foo`,`-/foo` (reference regex: `/^-/` )
-1. detect root selectors like `/foo` (reference regex: `/^[-]?\//` )
-1. detect class selectors like `.foo` (reference regex: `/^[-]?class$/` )
-1. detect number values like `foo:1` (reference regex: `/^[0-9\.]+$/` )
-1. expand aliases like `.foo` into `class:foo`
-1. for every query token split string on `:`
-1. create an empty array `rules`
-1. then strip key-operator: convert "-foo" into "foo"
-1. add operator and value to rule-array
-1. therefore we we set `id` to `true` or `false` (false=excluder `-`)
-1. and we set `root` to `true` or `false` (true=`/` root selector is present)
-1. we convert key '/foo' into 'foo'
-1. finally we add the key/value to the store like `store.foo = {id:false,root:true}` e.g.
-
-> An example query-parser (which compiles to many languages) can be [found here](https://github.com/coderofsalvation/xrfragment/blob/main/src/xrfragment/Query.hx)
-
-## XR Fragment URI Grammar
-
-```
-reserved = gen-delims / sub-delims
-gen-delims = "#" / "&"
-sub-delims = "," / "="
-```
-
-> Example: `://foo.com/my3d.gltf#pos=1,0,0&prio=-5&t=0,100`
-
-| Demo | Explanation |
-|-------------------------------|---------------------------------|
-| `pos=1,2,3` | vector/coordinate argument e.g. |
-| `pos=1,2,3&rot=0,90,0&q=.foo` | combinators |
-
-
-# Text in XR (tagging,linking to spatial objects)
-
-We still think and speak in simple text, not in HTML or RDF.
-The most advanced human will probably not shout `
+
-van Kammen Expires 28 March 2026 [Page 16]
-
-Internet-Draft XR Fragments September 2025
+Clicking the [href](#via-href-metadata)-value above will:
+1. **reposition the referenced object** (menu) to the usercamera's-coordinates.
+2. **zoom** in case of (non-empty) mesh-object: rescale to 1 m³, and position 1m in front of the camera
+3. toggle behaviour: revert values if 1/2 were already applied
+4. `#+` is always implied (objects are always made visible)
-
#!menu
+This tiny but powerful symbol allows incredible interactive possibilities, by carefully positioning re-usable objects outside of a scene (below the usercamera's floor e.g.).
- Clicking the href (#via-href-metadata)-value above will:
+* href: `#whiteroom&!explainer&!exitmenu`
- 1. *reposition the referenced object* (menu) to the
- usercamera's-coordinates.
- 2. *zoom* in case of (non-empty) mesh-object: rescale to 1 m³, and
- position 1m in front of the camera
- 3. toggle behaviour: revert values if 1/2 were already applied
- 4. #+ is always implied (objects are always made visible)
+> This will teleport the user to `whiteroom` and moves object `explainer` and `exitmenu` in front of the user.
- This tiny but powerful symbol allows incredible interactive
- possibilities, by carefully positioning re-usable objects outside of
- a scene (below the usercamera's floor e.g.).
+* href: `https://my.org/foo.glb#!
- * href: #whiteroom&!explainer&!exitmenu
+Clicking the [href](#via-href-metadata)-value above will:
- | This will teleport the user to whiteroom and moves object
- | explainer and exitmenu in front of the user.
+1. import `foo.glb` from `my.org`'s webserver
+2. show it in front of the user (because `#!` indicates object teleport)
- * href: `https://my.org/foo.glb#! (https://my.org/foo.glb#!)
+* href: `https://foo.glb#roomB&!bar`
- Clicking the href (#via-href-metadata)-value above will:
+Clicking the [href](#via-href-metadata)-value above will:
- 1. import foo.glb from my.org's webserver
- 2. show it in front of the user (because #! indicates object
- teleport)
+1. replace the current scene with `foo.glb`
+2. teleport the user to #roomB inside `foo.glb`
+3. **instance the referenced object** (bar inside foo.glb) in front of the user.
+4. it will update the top-Level URL (because `xrf:` was not used)
+5. hide the **instanced object** when clicked again (toggle visibility)
- * href: https://foo.glb#roomB&!bar
+> **NOTE**: level2 teleportation links, as well as instancing mitigates the 'broken embedded image'-issue of HTML: **always** attaching the href-values to **a 3D (preview) object** (that way broken links will not break the design).
- Clicking the href (#via-href-metadata)-value above will:
+**Example:** clicking a 3D button with title 'menu' and [href](#href)-value `xrf:menu.glb?instance#t=4,5` would instance a 3D menu (`menu.glb`) in front of the user, and loop its animation between from 4-5 seconds (`t=4,5`)
- 1. replace the current scene with foo.glb
- 2. teleport the user to #roomB inside foo.glb
- 3. *instance the referenced object* (bar inside foo.glb) in front of
- the user.
- 4. it will update the top-Level URL (because xrf: was not used)
- 5. hide the *instanced object* when clicked again (toggle
- visibility)
+> **NOTE**: combining instance-operators allows dynamic construction of 3D scenes (`#london&!welcomeMenu&!fadeBox` e.g.)
- | *NOTE*: level2 teleportation links, as well as instancing
- | mitigates the 'broken embedded image'-issue of HTML: *always*
- | attaching the href-values to *a 3D (preview) object* (that way
- | broken links will not break the design).
+## Object multipliers (*)
+The star-prefix will clone a (local or remote) referenced object to the usercamera's location, and make it grabbable.
+Usecases:
+* object-picker (build stuff with objects)
+> **NOTE**: this is basically the [#! operator](#%23%21) which infinitely **clones** the referenced object (instead of repositioning the object).
+## De/selectors (+ and -)
+> How to show/hide/group material- or object- or animations by name?
+Clicking href-values below will show/hide the targeted material- or animation or object-name (incl. children):
-van Kammen Expires 28 March 2026 [Page 17]
-
-Internet-Draft XR Fragments September 2025
+* `#-welcome`
+* `#+welcome`
+* `#-VR*`
+* `https://foo.glb#bar&-welcome`
+Matching logic:
- *Example:* clicking a 3D button with title 'menu' and href (#href)-
- value xrf:menu.glb?instance#t=4,5 would instance a 3D menu (menu.glb)
- in front of the user, and loop its animation between from 4-5 seconds
- (t=4,5)
+* - and + prefix for exact matches (welcome e.g.)
+* \* postfix for match beginning (VR_skybox VR_skyboxmat e.g.)
- | *NOTE*: combining instance-operators allows dynamic construction
- | of 3D scenes (#london&!welcomeMenu&!fadeBox e.g.)
+> NOTE: to hide a skybox when importing/loading a 3D file (force AR) is possible by linking to ``https://my.org/foo.glb#-skybox` or `https://my.org/foo.glb#-skyboxmaterial`
-12.2. Object multipliers (*)
- The star-prefix will clone a (local or remote) referenced object to
- the usercamera's location, and make it grabbable.
- Usecases: * object-picker (build stuff with objects)
- | *NOTE*: this is basically the #! operator (#%23%21) which
- | infinitely *clones* the referenced object (instead of
- | repositioning the object).
+## Sharing object or file (#|)
-12.3. De/selectors (+ and -)
+The pipe-symbol (`|`) sends a (targeted) object to the OS.
+Clicking the href-value below will:
- | How to show/hide/group material- or object- or animations by name?
+1. share the (targeted object in the) file to a another application
- Clicking href-values below will show/hide the targeted material- or
- animation or object-name (incl. children):
+> This URL can be fed straight into [Web Share API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Share_API) or [xdg-open](https://www.freedesktop.org/wiki/Software/xdg-utils/)
- * #-welcome
- * #+welcome
- * #-VR*
- * https://foo.glb#bar&-welcome
+* href: `xrf://#|bar`
- Matching logic:
+> **NOTE**: sharing is limited to (internal objects) via `xrf:` scheme-only
- * - and + prefix for exact matches (welcome e.g.)
- * * postfix for match beginning (VR_skybox VR_skyboxmat e.g.)
+## xrf:// URI scheme
- | NOTE: to hide a skybox when importing/loading a 3D file (force AR)
- | is possible by linking to `https://my.org/foo.glb#-skybox or
- | https://my.org/foo.glb#-skyboxmaterial
+Prefixing the `xrf:` to [href](#href)-values **will prevent** [level2](#📜%20level2:%20explicit%20links) [href](#href)-values from changing the top-Level URL.
-12.4. Sharing object or file (#|)
+> **Usecase**: for non-shareable URLs like `href: xrf:#t=4,5`, to display a stateful msg e.g.).
- The pipe-symbol (|) sends a (targeted) object to the OS. Clicking
- the href-value below will:
+**Reason:** XR Fragments is inspired by HTML's [href-attribute](https://en.wikipedia.org/wiki/Hyperlink), which does various things:
- 1. share the (targeted object in the) file to a another application
+1. it updates the browser-location
+2. it makes something clickable
+3. it jumps to another document / elsewhere in the same document
+4. and more
+The `xrf:` scheme will just do 2 & 3 (so the URL-values will not leak into the top-level URL).
+> **compliance with RFC 3986**: unimplemented/unknown URI schemes (`xrf:...` e.g.) will not update the top-level URL
+# Level5: URI Templates (RFC6570)
+XR Fragments adopts Level1 URI **Fragment** expansion to provide safe interactivity.
+This is non-normative, and the draft spec is available on request.
-van Kammen Expires 28 March 2026 [Page 18]
-
-Internet-Draft XR Fragments September 2025
+# Top-level URL processing
- | This URL can be fed straight into Web Share API
- | (https://developer.mozilla.org/en-US/docs/Web/API/Web_Share_API)
- | or xdg-open (https://www.freedesktop.org/wiki/Software/xdg-utils/)
- * href: xrf://#|bar
+> Example URL: `://foo/world.gltf#room1&t=10&cam`
- | *NOTE*: sharing is limited to (internal objects) via xrf: scheme-
- | only
+The URL-processing-flow for hypermedia browsers goes like this:
-12.5. xrf:// URI scheme
+1. IF scene operators and/or animation operator (`t`) are present in the URL then (re)position the camera (to `room1`) and/or animation-range (`10`) accordingly.
+2. IF no camera-position has been set in step 1 or 2 assume `0,0,0` as camera coordinate (XR: add user-height) ([example](https://github.com/coderofsalvation/xrfragment/blob/main/src/3rd/js/three/navigator.js#L31]]))
+3. IF a camera-object exists with name `cam` assume that user(camera) position
- Prefixing the xrf: to href (#href)-values *will prevent* level2
- (#📜%20level2:%20explicit%20links) href (#href)-values from changing
- the top-Level URL.
+## UX
- | *Usecase*: for non-shareable URLs like href: xrf:#t=4,5, to
- | display a stateful msg e.g.).
+End-users should always have read/write access to:
- *Reason:* XR Fragments is inspired by HTML's href-attribute
- (https://en.wikipedia.org/wiki/Hyperlink), which does various things:
+1. the current (toplevel) URL (an URLbar etc)
+2. URL-history (a back/forward button e.g.)
+3. Clicking/Touching an `href` navigates (and updates the URL) to another scene/file (and coordinate e.g. in case the URL contains XR Fragments).
- 1. it updates the browser-location
- 2. it makes something clickable
- 3. it jumps to another document / elsewhere in the same document
- 4. and more
- The xrf: scheme will just do 2 & 3 (so the URL-values will not leak
- into the top-level URL).
+# Example: Navigating content href portals
- | *compliance with RFC 3986*: unimplemented/unknown URI schemes
- | (xrf:... e.g.) will not update the top-level URL
-13. Level5: URI Templates (RFC6570)
+navigation, portals & mutations
- )
+| fragment | type | example value |
+|----------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------|
+|`href` | string (uri or predefined view) | `#room1` `#room1` `://somefile.gltf#room1` |
- XR Fragments adopts Level1 URI *Fragment* expansion to provide safe
- interactivity.
- This is non-normative, and the draft spec is available on request.
+1. clicking an outbound ''external''- or ''file URI'' fully replaces the current scene and assumes `room2` by default (unless specified)
-14. Top-level URL processing
+2. relocation/reorientation should happen locally for local URI's (`#....`)
- | Example URL: ://foo/world.gltf#room1&t=10&cam
+3. navigation should not happen ''immediately'' when user is more than 5 meter away from the portal/object containing the href (to prevent accidental navigation e.g.)
- The URL-processing-flow for hypermedia browsers goes like this:
+4. URL navigation should always be reflected in the client URL-bar (in case of javascript: see [[here](https://github.com/coderofsalvation/xrfragment/blob/dev/src/3rd/js/three/navigator.js) for an example navigator), and only update the URL-bar after the scene (default fragment `#`) has been loaded.
+5. In immersive XR mode, the navigator back/forward-buttons should be always visible (using a wearable e.g., see [[here](https://github.com/coderofsalvation/xrfragment/blob/dev/example/aframe/sandbox/index.html#L26-L29) for an example wearable)
+6. make sure that the ''back-button'' of the ''browser-history'' always refers to the previous position (see [[here](https://github.com/coderofsalvation/xrfragment/blob/main/src/3rd/js/three/xrf/href.js#L97))
+7. ignore previous rule in special cases, like clicking an `href` using camera-portal collision (the back-button could cause a teleport-loop if the previous position is too close)
+8. href-events should bubble upward the node-tree (from children to ancestors, so that ancestors can also conain an href), however only 1 href can be executed at the same time.
+9. the end-user navigator back/forward buttons should repeat a back/forward action until a `#...` primitive is found (the stateless xrf:// href-values should not be pushed to the url-history)
-van Kammen Expires 28 March 2026 [Page 19]
-
-Internet-Draft XR Fragments September 2025
+[» example implementation](https://github.com/coderofsalvation/xrfragment/blob/main/src/3rd/js/three/xrf/href.js)
+[» example 3D asset](https://github.com/coderofsalvation/xrfragment/blob/main/example/assets/href.gltf#L192)
+[» discussion](https://github.com/coderofsalvation/xrfragment/issues/1)
+# Example: Virtual world webrings
- 1. IF scene operators and/or animation operator (t) are present in
- the URL then (re)position the camera (to room1) and/or animation-
- range (10) accordingly.
- 2. IF no camera-position has been set in step 1 or 2 assume
- 0,0,0 as camera coordinate (XR: add user-height) (example (https:
- //github.com/coderofsalvation/xrfragment/blob/main/src/3rd/js/
- three/navigator.js#L31]]))
- 3. IF a camera-object exists with name cam assume that user(camera)
- position
-14.1. UX
+Consider 3D scenes linking to eachother using these `href` values, attached to 3D button-objects:
- End-users should always have read/write access to:
+* `href: schoolA.edu/projects.gltf#math`
+* `href: schoolB.edu/projects.gltf#math`
+* `href: university.edu/projects.gltf#math`
- 1. the current (toplevel) URL (an URLbar etc)
- 2. URL-history (a back/forward button e.g.)
- 3. Clicking/Touching an href navigates (and updates the URL) to
- another scene/file (and coordinate e.g. in case the URL contains
- XR Fragments).
+This would teleport users to the math-projects of those universities.
+Now consider adding a 'webring index'-button to each file, with this href-value:
-15. Example: Navigating content href portals
- navigation, portals & mutations
+* href: workgroup.edu/webrings.glb#!webringmenu
- +==========+==================+========================+
- | fragment | type | example value |
- +==========+==================+========================+
- | href | string (uri or | #room1 |
- | | predefined view) | #room1 |
- | | | ://somefile.gltf#room1 |
- +----------+------------------+------------------------+
+This would allow displaying the (remote 3D file) webring menu with various href-buttons inside, all centrally curated by the workgroup.
- Table 5
+# Additional scene metadata
- 1. clicking an outbound ''external''- or ''file URI'' fully replaces
- the current scene and assumes room2 by default (unless specified)
- 2. relocation/reorientation should happen locally for local URI's
- (#....)
+XR Fragments does not aim to redefine the metadata-space or accessibility-space by introducing its own cataloging-metadata fields.
+Instead, it encourages browsers to scan nodes for the following custom properties:
- 3. navigation should not happen ''immediately'' when user is more
- than 5 meter away from the portal/object containing the href (to
- prevent accidental navigation e.g.)
+* [SPDX](https://spdx.dev/) license information
+* [ARIA](https://www.w3.org/WAI/standards-guidelines/aria/) attributes (`aria-*: .....`)
+* [datapackage.json](https://datapackage.org) findability, accessibility, interoperability, and reusability of data
+ARIA's `aria-description`-metadata is normative, to aid accessibility and scene transcripts
+> **NOTE**: please always start `aria-description` with a verb to aid transcripts.
+The following metadata are non-normative but encouraged, since they are popular and cheap to parse:
+* [RDF/JSON-LD](https://json-ld.org) like [this example](https://mvmd.org/standards/gltf/) or via glTF's [KHR_xmp_json_ld extension](https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_xmp_json_ld)
+* [Open Graph](https://ogp.me) attributes (`og:*: .....`)
+* [Dublin-Core](https://www.dublincore.org/specifications/dublin-core/application-profile-guidelines/) attributes(`dc:*: .....`)
+* [BibTex](https://bibtex.eu/fields) when known bibtex-keys exist with values enclosed in `{` and `},`
+> Example: object 'tryceratops' with `aria-description: is a huge dinosaurus standing on a #mountain` generates transcript `#tryceratops is a huge dinosaurus standing on a #mountain`, where the hashtags are clickable XR Fragments (activating the visible-links in the XR browser).
+Individual nodes can be enriched with such metadata, but most importantly the scene node:
-van Kammen Expires 28 March 2026 [Page 20]
-
-Internet-Draft XR Fragments September 2025
+| metadata key | example value |
+|--------------------------------------------------------|-------------------------------------------------|
+| `aria-description`, `og:description`, `dc:description` | `An immersive experience about Triceratops` (*) |
+| `SPDX` | `CC0-1.0` |
+| `dc:creator` | `John Doe` |
+| `dc:title`, `og:title` | 'Triceratops` (*) |
+| `og:site_name` | `https://xrfragment.org` |
+| `dc.publisher` | `NLNET` |
+| `dc.date` | `2024-01-01` |
+| `dc.identifier` | `XRFRAGMENT-001` |
+| `journal` (bibTeX) | `{Future Of Text Vol 3},` |
+> \* = these are interchangable (only one needs to be defined)
- 4. URL navigation should always be reflected in the client URL-bar
- (in case of javascript: see [here
- (https://github.com/coderofsalvation/xrfragment/blob/dev/src/3rd/
- js/three/navigator.js) for an example navigator), and only update
- the URL-bar after the scene (default fragment #) has been loaded.
+There's no silver bullet when it comes to metadata, so XR Fragment-implementations should support where the metadata is/goes.
- 5. In immersive XR mode, the navigator back/forward-buttons should
- be always visible (using a wearable e.g., see [here
- (https://github.com/coderofsalvation/xrfragment/blob/dev/example/
- aframe/sandbox/index.html#L26-L29) for an example wearable)
+> These attributes can be scanned and presented during an `href` or `src` eye/mouse-over.
- 6. make sure that the ''back-button'' of the ''browser-history''
- always refers to the previous position (see [here (https://github
- .com/coderofsalvation/xrfragment/blob/main/src/3rd/js/three/xrf/
- href.js#L97))
+# Accessibility interface
- 7. ignore previous rule in special cases, like clicking an href
- using camera-portal collision (the back-button could cause a
- teleport-loop if the previous position is too close)
- 8. href-events should bubble upward the node-tree (from children to
- ancestors, so that ancestors can also conain an href), however
- only 1 href can be executed at the same time.
+The addressibility of XR Fragments allows for unique 3D-to-text transcripts, as well as an textual interface to navigate 3D content.
+Spec:
- 9. the end-user navigator back/forward buttons should repeat a back/
- forward action until a #... primitive is found (the stateless
- xrf:// href-values should not be pushed to the url-history)
+1. The enduser must be able to enable an accessibility-mode (which persists across application/webpage restarts)
+2. Accessibility-mode must contain a text-input for the user to enter text
+3. Accessibility-mode must contain a flexible textlog for the user to read (via screenreader, screen, or TTS e.g.)
+4. the textlog contains `aria-descriptions`, and its narration (Screenreader e.g.) can be skipped (via 2-button navigation)
+5. The `back` command should navigate back to the previous URL (alias for browser-backbutton)
+6. The `forward` command should navigate back to the next URL (alias for browser-nextbutton)
+7. A destination is a 3D node containing an `href` with a `#...` XR fragment (which matches a 3d object name)
+8. The `go` command should list all possible destinations
+9. The `go left` command should move the camera around 0.3 meters to the left
+10. The `go right` command should move the camera around 0.3 meters to the right
+11. The `go forward` command should move the camera 0.3 meters forward (direction of current rotation).
+12. The `rotate left` command should rotate the camera 0.3 to the left
+13. The `rotate left` command should rotate the camera 0.3 to the right
+14. The (dynamic) `go abc` command should navigate to `#scene2` in case there's a 3D node with name `abc` and `href` value `#scene2`
+15. The `look` command should give an (contextual) 3D-to-text transcript, by scanning the `aria-description` values of the current `#...` (3D object) value (including its children)
+16. The `do` command should list all possible `href` values which don't contain an `#...` XR Fragment
+17. The (dynamic) `do abc` command should navigate/execute `https://.../...` in case a 3D node exist with name `abc` and `href` value `https://.../...`
- » example implementation
- (https://github.com/coderofsalvation/xrfragment/blob/main/src/3rd/js/
- three/xrf/href.js)
- » example 3D asset
- (https://github.com/coderofsalvation/xrfragment/blob/main/example/
- assets/href.gltf#L192)
- » discussion (https://github.com/coderofsalvation/xrfragment/
- issues/1)
+## Two-button navigation
-15.1. Walking surfaces
+For specific user-profiles, gyroscope/mouse/keyboard/audio/visuals will not be available.
+Therefore a 2-button navigation-interface is the bare minimum interface:
- | By default position 0,0,0 of the 3D scene represents the walkable
- | plane, however this is overridden when the following applies:
+1. objects with href metadata can be cycled via a key (tab on a keyboard)
+2. objects with href metadata can be activated via a key (enter on a keyboard)
+3. the TTS reads the href-value (and/or aria-description if available)
- XR Fragment-compatible viewers can infer this data based scanning the
- scene for:
+# XRF Microformat
- 1. materialless (nameless & textureless) mesh-objects (without href
- and >0 faces)
+How can applications discover 3D experiences on a network?
+> Answer: **spatial microformats**
+The XRF microformat is an [optional](#Progressive%20enhancement) text heuristics which applications can detect across various usecases.
+## via HTML webpage
-van Kammen Expires 28 March 2026 [Page 21]
-
-Internet-Draft XR Fragments September 2025
+If the browser/application requests an webpage (`https://nlnet.nl` e.g.) it should check for the [rel-me microformat](https://gmpg.org/xfn/) :
+```
+
+```
- | optionally the viewer can offer thumbstick, mouse or joystick
- | teleport-tools for non-roomscale VR/AR setups.
+This way the application loads `https://nlnet.nl/scene.xrf.glb` when the user types `nlnet.nl` into the URLbar.
+Optionally, `type` can be specified for dynamically generated 3D files:
-16. Example: Virtual world rings
+```
+
+```
+
+The `type`-attribute is for fallback-purposes.
+Viewer-supported 3D file-extensions (`.glb` e.g.) will **ALWAYS** take precedence over the (non)presence of the `type` attribute.
+The reason is that platforms (Mastodon 'labels' e.g.) don't allow specifying type-attributes.
+Another reason is that XR Fragments is filetype-agnostic, so flexibility is expected on the viewer-side.
+
+> NOTE: in case of multiple 3D files mentioned in `
+
+
+
+
+
+
+
+
+```
+
+3D engines (games/apps) can render these like clickable portals, for example JanusXR-style portals:
+
+> NOTE: for more customizability [JML <link>](https://coderofsalvation.github.io/janus-guide/#/build/room?id=link) will allow for positioning/thumbnailed portals:
+
+```xml
+
+
+
+
+
+
+
+
+
+
+```
- Consider 3D scenes linking to eachother using these href values,
- attached to 3D button-objects:
+### Mixing multiple spatial microformats:
- * href: schoolA.edu/projects.gltf#math
- * href: schoolB.edu/projects.gltf#math
- * href: university.edu/projects.gltf#math
+```xml
+
+
+
+```
+
+
+## via WebFinger
+
+When John has an account on foo.com, how can other applications request his 3D homepage by simply entering `john@foo.com`?
- This would teleport users to the math-projects of those universities.
- Now consider adding a 'webring index'-button to each file, with this
- href-value:
+> Answer: it can be requested at `https://foo.com/.well-known/webfinger?resource=acct:john@foo.com`, resulting in:
- * href: workgroup.edu/webrings.glb#!webringmenu
-
- This would allow displaying the (remote 3D file) webring menu with
- various href-buttons inside, all centrally curated by the workgroup.
-
-17. Additional scene metadata
-
- XR Fragments does not aim to redefine the metadata-space or
- accessibility-space by introducing its own cataloging-metadata
- fields. Instead, it encourages browsers to scan nodes for the
- following custom properties:
-
- * SPDX (https://spdx.dev/) license information
- * ARIA (https://www.w3.org/WAI/standards-guidelines/aria/)
- attributes (aria-*: .....)
- * datapackage.json (https://datapackage.org) findability,
- accessibility, interoperability, and reusability of data
-
- ARIA's aria-description-metadata is normative, to aid accessibility
- and scene transcripts
-
- | *NOTE*: please always start aria-description with a verb to aid
- | transcripts.
-
- The following metadata are non-normative but encouraged, since they
- are popular and cheap to parse:
-
- * RDF/JSON-LD (https://json-ld.org) like this example
- (https://mvmd.org/standards/gltf/) or via glTF's KHR_xmp_json_ld
- extension
- (https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/
- Khronos/KHR_xmp_json_ld)
-
-
-
-van Kammen Expires 28 March 2026 [Page 22]
-
-Internet-Draft XR Fragments September 2025
-
-
- * Open Graph (https://ogp.me) attributes (og:*: .....)
- * Dublin-Core (https://www.dublincore.org/specifications/dublin-
- core/application-profile-guidelines/) attributes(dc:*: .....)
- * BibTex (https://bibtex.eu/fields) when known bibtex-keys exist
- with values enclosed in { and },
-
- | Example: object 'tryceratops' with aria-description: is a huge
- | dinosaurus standing on a #mountain generates transcript
- | #tryceratops is a huge dinosaurus standing on a #mountain, where
- | the hashtags are clickable XR Fragments (activating the visible-
- | links in the XR browser).
-
- Individual nodes can be enriched with such metadata, but most
- importantly the scene node:
-
- +================================+=========================+
- | metadata key | example value |
- +================================+=========================+
- | aria-description, | An immersive experience |
- | og:description, dc:description | about Triceratops (*) |
- +--------------------------------+-------------------------+
- | SPDX | CC0-1.0 |
- +--------------------------------+-------------------------+
- | dc:creator | John Doe |
- +--------------------------------+-------------------------+
- | dc:title, og:title | 'Triceratops` (*) |
- +--------------------------------+-------------------------+
- | og:site_name | https://xrfragment.org |
- +--------------------------------+-------------------------+
- | dc.publisher | NLNET |
- +--------------------------------+-------------------------+
- | dc.date | 2024-01-01 |
- +--------------------------------+-------------------------+
- | dc.identifier | XRFRAGMENT-001 |
- +--------------------------------+-------------------------+
- | journal (bibTeX) | {Future Of Text Vol 3}, |
- +--------------------------------+-------------------------+
-
- Table 6
-
- | * = these are interchangable (only one needs to be defined)
-
- There's no silver bullet when it comes to metadata, so XR Fragment-
- implementations should support where the metadata is/goes.
-
- | These attributes can be scanned and presented during an href or
- | src eye/mouse-over.
-
-
-
-
-van Kammen Expires 28 March 2026 [Page 23]
-
-Internet-Draft XR Fragments September 2025
-
-
-18. Accessibility interface
-
- The addressibility of XR Fragments allows for unique 3D-to-text
- transcripts, as well as an textual interface to navigate 3D content.
- Spec:
-
-
- 1. The enduser must be able to enable an accessibility-mode (which
- persists across application/webpage restarts)
- 2. Accessibility-mode must contain a text-input for the user to
- enter text
- 3. Accessibility-mode must contain a flexible textlog for the user
- to read (via screenreader, screen, or TTS e.g.)
- 4. the textlog contains aria-descriptions, and its narration
- (Screenreader e.g.) can be skipped (via 2-button navigation)
- 5. The back command should navigate back to the previous URL (alias
- for browser-backbutton)
- 6. The forward command should navigate back to the next URL (alias
- for browser-nextbutton)
- 7. A destination is a 3D node containing an href with a #... XR
- fragment (which matches a 3d object name)
- 8. The go command should list all possible destinations
- 9. The go left command should move the camera around 0.3 meters to
- the left
- 10. The go right command should move the camera around 0.3 meters to
- the right
- 11. The go forward command should move the camera 0.3 meters forward
- (direction of current rotation).
- 12. The rotate left command should rotate the camera 0.3 to the left
- 13. The rotate left command should rotate the camera 0.3 to the
- right
- 14. The (dynamic) go abc command should navigate to #scene2 in case
- there's a 3D node with name abc and href value #scene2
- 15. The look command should give an (contextual) 3D-to-text
- transcript, by scanning the aria-description values of the
- current #... (3D object) value (including its children)
- 16. The do command should list all possible href values which don't
- contain an #... XR Fragment
- 17. The (dynamic) do abc command should navigate/execute
- https://.../... in case a 3D node exist with name abc and href
- value https://.../...
-
-18.1. Two-button navigation
-
- For specific user-profiles, gyroscope/mouse/keyboard/audio/visuals
- will not be available.
- Therefore a 2-button navigation-interface is the bare minimum
- interface:
-
-
-
-van Kammen Expires 28 March 2026 [Page 24]
-
-Internet-Draft XR Fragments September 2025
-
-
- 1. objects with href metadata can be cycled via a key (tab on a
- keyboard)
- 2. objects with href metadata can be activated via a key (enter on a
- keyboard)
- 3. the TTS reads the href-value (and/or aria-description if
- available)
-
-18.2. Overlap with fileformat-specific extensions
-
- Some 3D scene-fileformats have support for extensions. What if the
- functionality of those overlap? For example, GLTF has the OMI_LINK
- extension which might overlap with XR Fragment's href:
-
- | Priority Order and Precedence, otherwise fallback applies
-
- 1.*Extensions Take Precedence*: Since glTF-specific extensions are
- designed with the format’s specific needs and optimizations in mind,
- they should take precedence over extras metadata in cases where both
- contain overlapping functionality. This approach aligns with the
- idea that extensions are more likely to be interpreted uniformly by
- glTF-compatible software.
-
- 2. *Fallback Fall-through Mechanism*: If a glTF implementation does
- not support a particular extension, the (XRF) extras field can
- serve as a fallback. This way, metadata provided in extras can
- still be useful for applications that don't handle certain
- extensions.
-
- | *Example 1* In case of the OMI_LINK glTF extension (href:
- | https://nlnet.nl) and an XR Fragment (href: #otherroom or href:
- | otherplanet.glb), it is clear that https://nlnet.nl should open in
- | a browsertab, whereas the XR Fragment links should teleport the
- | user. If the OMI_LINK contains an XR Fragment (#room1 e.g.) a
- | teleport should be performed only (and other [overlapping]
- | metadata should be ignored).
- |
- | *Example 2* If an Extensions uses XR Fragments in URI's (href:
- | #otherroom or href: xrf://-walls in OMI_LINK e.g.), then perform
- | them according to XR Fragment spec (teleport user). But only
- | once: ignore further overlapping metadata for that usecase.
-
-19. Vendor Prefixes
-
- Vendor-specific metadata in a 3D scenefiles, are similar to vendor-
- specific CSS-prefixes (https://en.wikipedia.org/wiki/
- CSS#Vendor_prefixes) (-moz-opacity: 0.2 e.g.). This allows popular
- 3D engines/frameworks, to initialize specific features when loading a
- scene/object, in a progressive enhanced way.
-
-
-
-van Kammen Expires 28 March 2026 [Page 25]
-
-Internet-Draft XR Fragments September 2025
-
-
- Vendor Prefixes allows embedding 3D engines/framework-specific
- features a 3D file via metadata:
-
- +===========+===================+==============================+
- | what | XR metadata | Lowest common denominator |
- +===========+===================+==============================+
- | CSS | vendor-agnostic | 2D canvas + object |
- | | | referencing/styling |
- +-----------+-------------------+------------------------------+
- | XR | vendor-agnostic | 3D camera + object(file) |
- | Fragments | | load/embed/click/referencing |
- +-----------+-------------------+------------------------------+
- | Vendor | vendor-*specific* | Specialized Entity-Component |
- | prefixs | | implementation |
- +-----------+-------------------+------------------------------+
-
- Table 7
-
- | Why? Because not all XR interactions can/should be solved/
- | standardized by embedding XR Fragments into any 3D file. The
- | lowest common denominator between 3D engines is the 'entity'-part
- | of their entity-component-system (ECS). The 'component'-part can
- | be progressively enhanced via vendor prefixes.
-
- For example, the following metadata can be added to a .glb file, to
- make an object grabbable in AFRAME:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-van Kammen Expires 28 March 2026 [Page 26]
-
-Internet-Draft XR Fragments September 2025
-
-
-+────────────────────────────────────────────────────────────────────────────────────────────────────────+
-│ http://y.io/z.glb | AFRAME app │
-│-----------------------------------------------+--------------------------------------------------------│
+```
+{
+ "subject": "acct:john@foo.com",
+ "aliases": [
+ "https://mastodon.example/social/john",
+ "https://john.foo.com",
+ "https://3d.john.foo.com/model/scene.glb"
+ ],
+ "properties": {
+ "http://schema.org/name": "John Doe",
+ "http://schema.org/description": "Developer, 3D Enthusiast, and Social Explorer"
+ },
+ "links": [
+ {
+ "rel": "http://ostatus.org/schema/1.0/subscribe",
+ "template": "https://mastodon.example/social/john/{uri}"
+ },
+ {
+ "rel": "self",
+ "type": "text/html",
+ "href": "https://john.foo.com"
+ },
+ {
+ "rel": "me",
+ "type": "text/html",
+ "href": "https://john.foo.com"
+ },
+ {
+ "rel": "me",
+ "type": "model/gltf+binary",
+ "href": "https://3d.john.foo.com/model/avatar.vrm"
+ },
+ {
+ "rel": "scene",
+ "type": "model/gltf+binary",
+ "href": "https://3d.john.foo.com/model/scene.xrf.glb"
+ }
+ ]
+}
+```
+
+This way the application will load `https://3d.john.foo.com/model/scene.glb` when the user types `john@foo.com` into the user field.
+
+## via Text (URI)
+
+As a fallback, for an application to trigger loading a 3D scene is by detecting URI's of 3D scene-files any text:
+
+* `foo.glb` (or any other popular 3D extension)
+* `https://foo.com/scene.glb` (or any other popular protocol)
+
+This way, the application can highlight the link whenever it detects the URI (in a text-file or text-section of a 3D model)
+
+## Overlap with fileformat-specific extensions
+
+Some 3D scene-fileformats have support for extensions.
+What if the functionality of those overlap?
+For example, GLTF has the `OMI_LINK` extension which might overlap with XR Fragment's `href`:
+
+> Priority Order and Precedence, otherwise fallback applies
+
+1.**Extensions Take Precedence**: Since glTF-specific extensions are designed with the format’s
+specific needs and optimizations in mind, they should take precedence over extras metadata
+in cases where both contain overlapping functionality.
+This approach aligns with the idea that extensions are more likely to be interpreted uniformly by glTF-compatible software.
+
+2. **Fallback Fall-through Mechanism**:
+If a glTF implementation does not support a particular extension, the (XRF) extras field can serve as a fallback. This way, metadata provided in extras can still be useful for applications that don't handle certain extensions.
+
+> **Example 1** In case of the OMI_LINK glTF extension (`href: https://nlnet.nl`) and an XR Fragment (`href: #otherroom` or `href: otherplanet.glb`), it is clear that `https://nlnet.nl` should open in a browsertab, whereas the XR Fragment links should teleport the user. If the OMI_LINK contains an XR Fragment (`#room1` e.g.) a teleport should be performed only (and other [overlapping] metadata should be ignored).
+
+> **Example 2** If an Extensions uses XR Fragments in URI's (`href: #otherroom` or `href: xrf://-walls` in OMI_LINK e.g.), then perform them according to XR Fragment spec (teleport user). But only once: ignore further overlapping metadata for that usecase.
+
+# Vendor Prefixes
+
+
+Vendor-specific metadata in a 3D scenefiles, are similar to vendor-specific [CSS-prefixes](https://en.wikipedia.org/wiki/CSS#Vendor_prefixes) (`-moz-opacity: 0.2` e.g.).
+This allows popular 3D engines/frameworks, to initialize specific features when loading a scene/object, in a progressive enhanced way.
+
+Vendor Prefixes allows embedding 3D engines/framework-specific features a 3D file via metadata:
+
+| what | XR metadata | Lowest common denominator |
+|------------------|---------------------|-------------------------------------------------------|
+| CSS | vendor-agnostic | 2D canvas + object referencing/styling |
+| XR Fragments | vendor-agnostic | 3D camera + object(file) load/embed/click/referencing |
+| Vendor prefixs | vendor-**specific** | Specialized Entity-Component implementation |
+
+> Why? Because not all XR interactions can/should be solved/standardized by embedding XR Fragments into any 3D file.
+The lowest common denominator between 3D engines is the 'entity'-part of their entity-component-system (ECS). The 'component'-part can be progressively enhanced via vendor prefixes.
+
+For example, the following metadata can be added to a .glb file, to make an object grabbable in AFRAME:
+
+```
++────────────────────────────────────────────────────────────────────────────────────────────────────────+
+│ http://y.io/z.glb | AFRAME app │
+│-----------------------------------------------+--------------------------------------------------------│
│ | │
-│ | after loading the glb, john can be placed into the │
-│ +-[3D mesh]-+ | castle via hands, because the author added metadata to │
-│ | / \ | | john via either: │
-│ | / \ | | │
-│ | / \ | | 1. Blender (custom property-box, no plugins needed) │
-│ | |_____| | | │
-│ +-----│-----+ | 2. javascript-code: │
-│ │ | │
-│ ├─ name: castle | for( var com in this.el.components ){ │
-│ └─ tag: house baroque | this.el.object3D.userData[`-AFRAME-${com}`] = '' │
-│ | } │
-│ [3D mesh-+ | // save to z.glb in AFRAME inspector │
-│ | ├─ name: john | │
-│ | O ├─ age: 23 | │
-│ | /|\ ├─ -aframe-grabbable: '' | > inits 'grabbable' component on object john │
-│ | / \ ├─ -aframe-material.color: '#F0A' | > inits 'material' component on object john │
-│ | ├─ -aframe-text.value: '{name}{age}'| > inits 'text' component (*) with value 'john' │
-│ | ├─ -three-material.fog: false | > changes material settings in THREE.js app │
-│ | ├─ -godot-Label3D.text: '{name}{age}'| > inits 'Label3D' component (*) in Godot │
+│ | after loading the glb, john can be placed into the │
+│ +-[3D mesh]-+ | castle via hands, because the author added metadata to │
+│ | / \ | | john via either: │
+│ | / \ | | │
+│ | / \ | | 1. Blender (custom property-box, no plugins needed) │
+│ | |_____| | | │
+│ +-----│-----+ | 2. javascript-code: │
+│ │ | │
+│ ├─ name: castle | for( var com in this.el.components ){ │
+│ └─ tag: house baroque | this.el.object3D.userData[`-AFRAME-${com}`] = '' │
+│ | } │
+│ [3D mesh-+ | // save to z.glb in AFRAME inspector │
+│ | ├─ name: john | │
+│ | O ├─ age: 23 | │
+│ | /|\ ├─ -aframe-grabbable: '' | > inits 'grabbable' component on object john │
+│ | / \ ├─ -aframe-material.color: '#F0A' | > inits 'material' component on object john │
+│ | ├─ -aframe-text.value: '{name}{age}'| > inits 'text' component (*) with value 'john' │
+│ | ├─ -three-material.fog: false | > changes material settings in THREE.js app │
+│ | ├─ -godot-Label3D.text: '{name}{age}'| > inits 'Label3D' component (*) in Godot │
│ +--------+ | │
│ | │
├─ -GODOT-version: '4.3' | > exporters/authors can report targeted version │
├─ -AFRAME-version: '1.6.0' | and (optionally) hint component-repo│
-├─ -AFRAME-info: 'https://git.benetou.fr/comps' │
+├─ -AFRAME-info: 'https://git.benetou.fr/comps' │
│ | │
-+────────────────────────────────────────────────────────────────────────────────────────────────────────+
++────────────────────────────────────────────────────────────────────────────────────────────────────────+
+```
- * key/value syntax: --.
- [string/boolean/float/int]-value
+* key/value syntax: -``-``.`` `[string/boolean/float/int]`-value
- String-templatevalues are evaluated as per URI Templates (RFC6570)
- (https://www.rfc-editor.org/rfc/rfc6570) Level 1.
+String-templatevalues are evaluated as per [URI Templates (RFC6570)](https://www.rfc-editor.org/rfc/rfc6570) Level 1.
- | This 'separating of mechanism from policy' (unix rule) does
- | *somewhat* break portability of an XR experience, but still
- | prevents (E-waste of) handcoded virtual worlds. It allows for (XR
- | experience) metadata to survive in future 3D engines and scene-
- | fileformats.
+> This 'separating of mechanism from policy' (unix rule) does **somewhat** break portability of an XR experience, but still prevents (E-waste of) handcoded virtual worlds. It allows for (XR experience) metadata to survive in future 3D engines and scene-fileformats.
+# Security Considerations
+The only dynamic parts are [W3C Media Fragments](https://www.w3.org/TR/media-frags/) and [URI Templates (RFC6570)](https://www.rfc-editor.org/rfc/rfc6570).
+The use of URI Templates is limited to pre-defined variables and Level0 fragments-expansion only, which makes it quite safe.
+n fact, it is much safer than relying on a scripting language (javascript) which can change URN too.
+# FAQ
+**Q:** Why is everything HTTP GET-based, what about POST/PUT/DELETE HATEOS
+**A:** Because it's out of scope: XR Fragment specifies a read-only way to surf XR documents. These things belong in the application layer (for example, an XR Hypermedia browser can decide to support POST/PUT/DELETE requests for embedded HTML thru `src` values)
+---
-van Kammen Expires 28 March 2026 [Page 27]
-
-Internet-Draft XR Fragments September 2025
+**Q:** Why isn't there support for scripting, URI Template Fragments are so limited compared to WASM & javascript
+**A:** This is out of scope as it unhyperifies hypermedia, and this is up to XR hypermedia browser-extensions. Historically scripting/Javascript seems to been able to turn webpages from hypermedia documents into its opposite (hyperscripted nonhypermedia documents). In order to prevent this backward-movement (hypermedia tends to liberate people from finnicky scripting) XR Fragment uses [W3C Media Fragments](https://www.w3.org/TR/media-frags/) and [URI Templates (RFC6570)](https://www.rfc-editor.org/rfc/rfc6570), to prevent unhyperifying itself by hardcoupling to a particular markup or scripting language.
+XR Fragments supports filtering objects in a scene only, because in the history of the javascript-powered web, showing/hiding document-entities seems to be one of the most popular basic usecases.
+Doing advanced scripting & networkrequests under the hood are obviously interesting endavours, but this is something which should not be hardcoupled with XR Fragments or hypermedia. This perhaps belongs more to browser extensions.
+Non-HTML Hypermedia browsers should make browser extensions the right place, to 'extend' experiences, in contrast to code/javascript inside hypermedia documents (this turned out as a hypermedia antipattern).
+# authors
-20. Security Considerations
-
- The only dynamic parts are W3C Media Fragments
- (https://www.w3.org/TR/media-frags/) and URI Templates (RFC6570)
- (https://www.rfc-editor.org/rfc/rfc6570).
- The use of URI Templates is limited to pre-defined variables and
- Level0 fragments-expansion only, which makes it quite safe.
- n fact, it is much safer than relying on a scripting language
- (javascript) which can change URN too.
-21. FAQ
+* Leon van Kammen (@lvk@mastodon.online)
+* Jens Finkhäuser (@jens@social.finkhaeuser.de)
- *Q:* Why is everything HTTP GET-based, what about POST/PUT/DELETE
- HATEOS
- *A:* Because it's out of scope: XR Fragment specifies a read-only way
- to surf XR documents. These things belong in the application layer
- (for example, an XR Hypermedia browser can decide to support
- POST/PUT/DELETE requests for embedded HTML thru src values)
+# IANA Considerations
- *Q:* Why isn't there support for scripting, URI Template Fragments
- are so limited compared to WASM & javascript *A:* This is out of
- scope as it unhyperifies hypermedia, and this is up to XR hypermedia
- browser-extensions.
- Historically scripting/Javascript seems to been able to turn webpages
- from hypermedia documents into its opposite (hyperscripted
- nonhypermedia documents).
- In order to prevent this backward-movement (hypermedia tends to
- liberate people from finnicky scripting) XR Fragment uses W3C Media
- Fragments (https://www.w3.org/TR/media-frags/) and URI Templates
- (RFC6570) (https://www.rfc-editor.org/rfc/rfc6570), to prevent
- unhyperifying itself by hardcoupling to a particular markup or
- scripting language.
- XR Fragments supports filtering objects in a scene only, because in
- the history of the javascript-powered web, showing/hiding document-
- entities seems to be one of the most popular basic usecases.
- Doing advanced scripting & networkrequests under the hood are
- obviously interesting endavours, but this is something which should
- not be hardcoupled with XR Fragments or hypermedia.
- This perhaps belongs more to browser extensions.
- Non-HTML Hypermedia browsers should make browser extensions the right
- place, to 'extend' experiences, in contrast to code/javascript inside
- hypermedia documents (this turned out as a hypermedia antipattern).
-
-22. authors
-
- * Leon van Kammen (@lvk@mastodon.online)
- * Jens Finkhäuser (@jens@social.finkhaeuser.de)
-
-
-
-
-van Kammen Expires 28 March 2026 [Page 28]
-
-Internet-Draft XR Fragments September 2025
-
-
-23. IANA Considerations
-
- This document has no IANA actions.
-
-24. Acknowledgments
-
- * NLNET (https://nlnet.nl)
- * Future of Text (https://futureoftext.org)
- * visual-meta.info (https://visual-meta.info)
- * Michiel Leenaars
- * Gerben van der Broeke
- * Mauve
- * Jens Finkhäuser
- * Marc Belmont
- * Tim Gerritsen
- * Frode Hegland
- * Brandel Zackernuk
- * Mark Anderson
-
-25. Appendix: Definitions
-
- +=================+=============================================+
- | definition | explanation |
- +=================+=============================================+
- | human | a sentient being who thinks fuzzy, absorbs, |
- | | and shares thought (by plain text, not |
- | | markuplanguage) |
- +-----------------+---------------------------------------------+
- | scene | a (local/remote) 3D scene or 3D file |
- | | (index.gltf e.g.) |
- +-----------------+---------------------------------------------+
- | 3D object | an object inside a scene characterized by |
- | | vertex-, face- and customproperty data. |
- +-----------------+---------------------------------------------+
- | URI | some resource at something somewhere via |
- | | someprotocol (http://me.com/foo.glb#foo or |
- | | e76f8efec8efce98e6f see interpeer.io |
- | | (https://interpeer.io)) |
- +-----------------+---------------------------------------------+
- | URL | something somewhere via someprotocol |
- | | (http://me.com/foo.glb) |
- +-----------------+---------------------------------------------+
- | URN | something at some domain (me.com/foo.glb) |
- +-----------------+---------------------------------------------+
- | metadata | custom properties of text, 3D Scene or |
- | | Object(nodes), relevant to machines and a |
- | | human minority (academics/developers) |
- +-----------------+---------------------------------------------+
-
-
-
-van Kammen Expires 28 March 2026 [Page 29]
-
-Internet-Draft XR Fragments September 2025
-
-
- | XR fragment | URI Fragment with spatial hints (which |
- | | match the name of a 3D object-, camera-, |
- | | animation-object) |
- +-----------------+---------------------------------------------+
- | the XRWG | wordgraph (collapses 3D scene to tags) |
- +-----------------+---------------------------------------------+
- | the hashbus | hashtags map to camera/scene-projections |
- +-----------------+---------------------------------------------+
- | spacetime | positions camera, triggers scene-preset/ |
- | hashtags | time |
- +-----------------+---------------------------------------------+
- | teleportation | repositioning the enduser to a different |
- | | position (or 3D scene/file) |
- +-----------------+---------------------------------------------+
- | sourceportation | teleporting the enduser to the original XR |
- | | Document of an src embedded object. |
- +-----------------+---------------------------------------------+
- | placeholder | a 3D object which with src-metadata (which |
- | object | will be replaced by the src-data.) |
- +-----------------+---------------------------------------------+
- | src | (HTML-piggybacked) metadata of a 3D object |
- | | which instances content |
- +-----------------+---------------------------------------------+
- | href | (HTML-piggybacked) metadata of a 3D object |
- | | which links to content |
- +-----------------+---------------------------------------------+
- | filter | URI Fragment(s) which show/hide object(s) |
- | | in a scene based on name/tag/property |
- | | (#cube&-price=>3) |
- +-----------------+---------------------------------------------+
- | visual-meta | visual-meta (https://visual.meta.info) data |
- | | appended to text/books/papers which is |
- | | indirectly visible/editable in XR. |
- +-----------------+---------------------------------------------+
- | requestless | metadata which never spawns new requests |
- | metadata | (unlike RDF/HTML, which can cause |
- | | framerate-dropping, hence not used a lot in |
- | | games) |
- +-----------------+---------------------------------------------+
- | FPS | frames per second in spatial experiences |
- | | (games,VR,AR e.g.), should be as high as |
- | | possible |
- +-----------------+---------------------------------------------+
- | introspective | inward sensemaking ("I feel this belongs to |
- | | that") |
- +-----------------+---------------------------------------------+
- | extrospective | outward sensemaking ("I'm fairly sure John |
- | | is a person who lives in oklahoma") |
+This document has no IANA actions.
+# Acknowledgments
-van Kammen Expires 28 March 2026 [Page 30]
-
-Internet-Draft XR Fragments September 2025
+* [NLNET](https://nlnet.nl)
+* [Future of Text](https://futureoftext.org)
+* James Baicoianu [janusweb](https://github.com/jbaicoianu/janusweb)
+* Michiel Leenaars
+* Gerben van der Broeke
+* Mauve
+* Jens Finkhäuser
+* Marc Belmont
+* Tim Gerritsen
+* Frode Hegland
+* Brandel Zackernuk
+* Mark Anderson
- +-----------------+---------------------------------------------+
- | ◻ | ascii representation of an 3D object/mesh |
- +-----------------+---------------------------------------------+
- | (un)obtrusive | obtrusive: wrapping human text/thought in |
- | | XML/HTML/JSON obfuscates human text into a |
- | | salad of machine-symbols and words |
- +-----------------+---------------------------------------------+
- | flat 3D object | a 3D object of which all verticies share a |
- | | plane |
- +-----------------+---------------------------------------------+
- | BibTeX | simple tagging/citing/referencing standard |
- | | for plaintext |
- +-----------------+---------------------------------------------+
- | BibTag | a BibTeX tag |
- +-----------------+---------------------------------------------+
- | (hashtag)bibs | an easy to speak/type/scan tagging SDL (see |
- | | here (https://github.com/coderofsalvation/ |
- | | hashtagbibs) which expands to BibTex/JSON/ |
- | | XML |
- +-----------------+---------------------------------------------+
+# Appendix: Definitions
- Table 8
+|definition | explanation |
+|----------------------|--------------------------------------------------------------------------------------------------------------------------------------|
+|human | a sentient being who thinks fuzzy, absorbs, and shares thought (by plain text, not markuplanguage) |
+|scene | a (local/remote) 3D scene or 3D file (index.gltf e.g.) |
+|3D object | an object inside a scene characterized by vertex-, face- and customproperty data. |
+|URI | some resource at something somewhere via someprotocol (`http://me.com/foo.glb#foo` or `e76f8efec8efce98e6f` [see interpeer.io](https://interpeer.io))|
+|URL | something somewhere via someprotocol (`http://me.com/foo.glb`) |
+|URN | something at some domain (`me.com/foo.glb`) |
+|metadata | custom properties of text, 3D Scene or Object(nodes), relevant to machines and a human minority (academics/developers) |
+|XR fragment | URI Fragment with spatial hints (which match the name of a 3D object-, camera-, animation-object) |
+|the hash-events | hashtags map to camera/scene-projections |
+|spacetime hashtags | positions camera, triggers scene-preset/time |
+|teleportation | repositioning the enduser to a different position (or 3D scene/file) |
+|sourceportation | teleporting the enduser to the original XR Document of an `src` embedded object. |
+|placeholder object | a 3D object which with src-metadata (which will be replaced by the src-data.) |
+|src | (HTML-piggybacked) metadata of a 3D object which instances content |
+|href | (HTML-piggybacked) metadata of a 3D object which links to content |
+|filter | URI Fragment(s) which show/hide object(s) in a scene based on name/tag/property (`#cube&-price=>3`) |
+|requestless metadata | metadata which never spawns new requests (unlike RDF/HTML, which can cause framerate-dropping, hence not used a lot in games) |
+|FPS | frames per second in spatial experiences (games,VR,AR e.g.), should be as high as possible |
+|introspective | inward sensemaking ("I feel this belongs to that") |
+|extrospective | outward sensemaking ("I'm fairly sure John is a person who lives in oklahoma") |
+|`◻` | ascii representation of an 3D object/mesh |
+|(un)obtrusive | obtrusive: wrapping human text/thought in XML/HTML/JSON obfuscates human text into a salad of machine-symbols and words |
+|flat 3D object | a 3D object of which all verticies share a plane |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-van Kammen Expires 28 March 2026 [Page 31]
diff --git a/doc/RFC_XR_Fragments.xml b/doc/RFC_XR_Fragments.xml
deleted file mode 100644
index f09fffe..0000000
--- a/doc/RFC_XR_Fragments.xml
+++ /dev/null
@@ -1,1451 +0,0 @@
-
-
-
-
-
-XR Fragments
-
-
-Internet
-Jens & Leon Internet Engineering Task Force
-
-
-Version: 0.5
-An open specification for hyperlinking & deeplinking 3D fileformats.
-This draft is a specification for interactive URI-controllable 3D files, enabling hypermediatic navigation, to enable a spatial web for hypermedia browsers with- or without a network-connection.
-
-XR Fragments allows us to better use implicit metadata inside 3D scene(files), by mapping it to proven technologies like URI Fragments.
-
-Almost every idea in this document is demonstrated at https://xrfragment.org
-
-
-
-
-
-
-Quick reference
-
-
-
Abstract
-
Index
-
Introduction
-
How does it work
-
What does it solve
-
HFL (Hypermediatic Feedback Loop) for XR Browsers
-
Conventions and Definitions
-
-
-
XR Fragment URL Grammar
-
-
Spatial Referencing 3D
-
Level0: Files
-
-
-
timelines
-
via href metadata
-
via chained extension
-
via subdocuments/xattr
-
JSON sidecar-file
-
-
Level1: URI
-
-
-
List of URI Fragments
-
List of explicit metadata
-
-
Level2: href links
-
-
-
Interaction behaviour
-
XR Viewer implementation
-
-
Level3: Media Fragments
-
-
-
Animation(s) timeline
-
Specify playback loopmode
-
Controlling embedded content
-
-
Level4: prefix operators
-
-
-
Object teleports
-
Object multipliers
-
De/selectors (+ and -)
-
Sharing object or file (#|)
-
xrf:// URI scheme
-
-
Level5: URI Templates (RFC6570)
-
Top-level URL processing
-
-
-
UX
-
-
Example: Navigating content href portals
-
-
-
Walking surfaces
-
-
Example: Virtual world rings
-
Additional scene metadata
-
Accessibility interface
-
-
-
Two-button navigation
-
Overlap with fileformat-specific extensions
-
-
XRF microformat
-
Vendor Prefixes
-
Security Considerations
-
FAQ
-
Authors
-
IANA Considerations
-
Acknowledgments
-
Appendix: Definitions
-
-
-
-Introduction
-How can we add more control to existing text and 3D scenes, without introducing new dataformats?
-
-Historically, there's many attempts to create the ultimate 3D fileformat.
-
-The lowest common denominator is: designers describing/tagging/naming things using plain text.
-
-XR Fragments exploits the fact that all 3D models already contain such metadata:
-XR Fragments allows deeplinking of 3D objects by mapping objectnames to URI fragments
-
-
-How does it work
-XR Fragments utilizes URLs:
-
-
-
for 3D viewers/browser to manipulate the camera or objects (via URI fragments)
-
implicitly: by mapping 3D objectnames (of a 3D scene/file) to URI fragments (3D deeplinking)
-
explicitly: by scanning href metadata inside 3D scene-files to enable interactions
-
externally: progressively enhance a 3D (file) into an experience via sidecarfiles
-
-
Aspect 1 was pioneered and implemented by JanusXR / James Baicoianu via janusweb well before the formal specification was established. As a key architect of these early concepts, James’s work laid the groundwork for the standard we use today. We owe him a great deal of thanks for his early contributions.
-
-
-What does it solve
-It solves:
-
-
-
addressibility and hypermediatic navigation of 3D scenes/objects: URI Fragments using src/href spatial metadata
-
Interlinking text & spatial objects by collapsing space into a Word Graph (XRWG) to show visible links
-
unlocking spatial potential of the (originally 2D) hashtag (which jumps to a chapter) for navigating XR documents
-
refraining from introducing scripting-engines for mundane tasks (and preventing its inevitable security-headaches)
-
the gap between text an 3d objects: object-names directly map to hashtags (=fragments), which allows 3D to text transcription.
-
-
NOTE: The chapters in this document are ordered from highlevel to lowlevel (technical) as much as possible
-
XR Fragments views XR experiences through the lens of 3D deeplinked URI's, rather than thru code(frameworks) or protocol-specific browsers (webbrowser e.g.).
-To aid adoption, the standard comprises of various (optional) support-levels, which incorporate existing standards like W3C Media Fragments and URI Templates (RFC6570) to promote spatial addressibility, sharing, navigation, filtering and databinding objects for (XR) Browsers.
-
-
XR Fragments is in a sense, a <b>heuristical 3D format</b> or meta-format, which leverages heuristic rules derived from any 3D scene or well-established 3D file formats, to extract meaningful features from scene hierarchies.
-
-These heuristics, enable features that are both meaningful and consistent across different scene representations, allowing <b>higher interop</b> between fileformats, 3D editors, viewers and game-engines.
-
-
-HFL (Hypermediatic Feedback Loop) for XR Browsers
- for XR Browsers)
-href metadata traditionally implies click AND navigate, however XR Fragments adds stateless click (xrf://....) via the xrf:// scheme, which does not change the top-level URL-adress (of the browser).
-This allows for many extra interactions via URLs, which otherwise needs a scripting language.
-These are called hashbus-only events/
-
Being able to use the same URI Fragment DSL for navigation (href: #foo) as well as interactions (href: xrf://#foo) greatly simplifies implementation, increases HFL, and reduces need for scripting languages.
-
This opens up the following benefits for traditional & future webbrowsers:
-
-
-
hypermediatic loading/clicking 3D assets (gltf/fbx e.g.) natively (with or without using HTML).
-
potentially allowing 3D assets/nodes to publish XR Fragments to themselves/eachother using the xrf:// hashbus (xrf://#person=walk to trigger walk-animation for object person)
-
potentially collapsing the 3D scene to an wordgraph (for essential navigation purposes) controllable thru a hash(tag)bus
-
completely bypassing the security-trap of loading external scripts (by loading 3D model-files, not HTML-javascriptable resources)
-
-XR Fragments itself are hypermediatic and HTML-agnostic, though pseudo-XR Fragment browsers can be implemented on top of HTML/Javascript.
-
-
-
-
principle
-
3D URL
-
HTML 2D URL
-
-
-
-
-
-
the XRWG
-
wordgraph (collapses 3D scene to tags)
-
Ctrl-F (find)
-
-
-
-
the hashbus
-
hashtags alter camera/scene/object-projections
-
hashtags alter document positions
-
-
-
-
src metadata
-
renders content and offers sourceportation
-
renders content
-
-
-
-
href metadata
-
teleports to other XR document
-
jumps to other HTML document
-
-
-
-
href metadata
-
triggers predefined view
-
Media fragments
-
-
-
-
href metadata
-
triggers camera/scene/object/projections
-
n/a
-
-
-
-
href metadata
-
draws visible connection(s) for XRWG 'tag'
-
n/a
-
-
-
-
href metadata
-
filters certain (in)visible objects
-
n/a
-
-
-
-
href metadata
-
href="xrf://#-foo&bar"
-
href="javascript:hideFooAndShowBar()`
-
-
-
-
-
(this does not update topLevel URI)
-
(this is non-standard, non-hypermediatic)
-
-
-
An important aspect of HFL is that URI Fragments can be triggered without updating the top-level URI (default href-behaviour) thru their own 'bus' (xrf://#.....). This decoupling between navigation and interaction prevents non-standard things like (href:javascript:dosomething()).
-
-
-Conventions and Definitions
-See appendix below in case certain terms are not clear.
-
-XR Fragment URL Grammar
-For typical HTTP-like browsers/applications:
-
-
-
-
Pseudo (non-native) browser-implementations (supporting XR Fragments using HTML+JS e.g.) can use the ? search-operator to address outbound content.
-
-In other words, the URL updates to: https://me.com?https://me.com/other.glb when navigating to https://me.com/other.glb from inside a https://me.com WebXR experience e.g.
-
-That way, if the link gets shared, the XR Fragments implementation at https://me.com can load the latter (and still indicates which XR Fragments entrypoint-experience/client was used).
-
-
-
-Spatial Referencing 3D
-3D files contain an hierarchy of objects.
-
-XR Fragments assumes the following objectname-to-URI-Fragment mapping, in order to deeplink 3D objects:
-
-
-
-
Every 3D fileformat supports named 3D object, and this name allows URLs (fragments) to reference them (and their children objects).
-
Clever nested design of 3D scenes allow great ways for re-using content, and/or previewing scenes.
-
-For example, to render a portal with a preview-version of the scene, create an 3D object with:
-
-
-
href: https://scene.fbx
-
-
It also allows sourceportation, which basically means the enduser can teleport to the original XR Document of an src embedded object, and see a visible connection to the particular embedded object. Basically an embedded link becoming an outbound link by activating it.
-
-
-Level0: Files
-Compatible 3D fileformats: glTF, usdz, obj, collada, THREE.json, X3D e.g.
-
-
-A 3D scene-file can be considered <b>XR Fragment-compatible</b> when it contains metadata:
-1. implicit: there's at least one object with a name (*)
-2. explicit: (optional) object(s) have (level2) href extras.
-
* = last wins in case of non-unique names
-
There are optional auto-loaded side-car files to enable hasslefree XR Movies.
-
-they can accomodate developers or applications who (for whatever reason) must not modify the 3D scene-file (a .glb e.g.).
-
-Timelines
-when a loaded file contains a timeline (animations/subtitles e.g.), then:
-
All timelines must play (looped) by default (to enable [[XR Movies]])
-
Unless an object has multiple animations (actions e.g.), then just play the first or with name default.
-
-
-via href metadata
-
-
-
-heuristics:
-
-
-
if at least one href custom property/extra is found in a 3D scene
-
The viewer should poll for the above mentioned sidecar-file extensions (and present accordingly)
-
-
-
-via chained extension
-
-
-
-
A fallback-mechanism to turn 3D files into XR Movies without editing them.
-
heuristics:
-
-
-
the chained-extension heuristic .xrf. should be present in the filename (scene.xrf.glb e.g.)
-
-
-
-via subdocuments/xattr
-More secure protocols (Nextgraph e.g.) don't allow for simply polling files.
-In such case, subdocuments or extended attributes should be polled:
-
NOTE: in the examples below we use the href-heuristic, but also the .xrf. chained-extension applies here.
-
-
-
-If only extended attributes (xattr) are available, the respective referenced file can be embedded:
-
-
-
-
NOTE: Linux's setfattr/getfattr is xattr on mac, and Set-Content/Get-content on Windows. See pxattr for lowlevel access.
-
-
-JSON sidecar-file
-For developers, sidecar-file can allow for defining explicit XR Fragments links (>level1), outside of the 3D file.
-
-This can be done via (objectname/metadata) key/value-pairs in a JSON sidecar-file:
-
-
-
experience.glb
-
experience.json <----
-
-
-
-
-
This will make object button clickable, and teleport the user to object roomB.
-
So after loading experience.glb the existence of experience.json is detected, to apply the explicit metadata.
-
-The sidecar will define (or override already existing) extras, which can be handy for multi-user platforms (offer 3D scene customization/personalization to users).
-
In THREE.js-code this would boil down to:
-
-
-
-
-
-
-Level1: URI
-
XR Fragments allows deeplinking of 3D objects by mapping objectnames to URI fragments
-
XR Fragments tries to seek to connect the world of text (semantical web / RDF), and the world of pixels.
-
-Instead of forcing authors to combine 3D/2D objects programmatically (publishing thru a game-editor e.g.), XR Fragments integrates all which allows a universal viewing experience.
-
-
-
-
-Fact: our typical browser URL's are just a possible implementation of URI's (for untapped humancentric potential of URI's see interpeer.io or NextGraph )
-
XR Fragments does not look at XR (or the web) thru the lens of HTML or URLs.
-But approaches things from a higherlevel local-first 3D hypermedia browser-perspective.
-
?-linked and #-linked navigation are JUST one possible way to implement XR Fragments: the essential goal is to allow a Hypermediatic FeedbackLoop (HFL) between external and internal 4D navigation.
-
-List of URI Fragments
-
-
-
-
fragment
-
type
-
example
-
info
-
-
-
-
-
-
#......
-
vector3
-
#room1#room2#cam2
-
positions/parents camera(rig) (or XR floor) to xyz-coord/object/camera and upvector
-
-
-
-
Media Fragments
-
media fragment
-
#t=0,2&loop
-
play (and loop) 3D animation from 0 seconds till 2 seconds
-
-
-
-
-List of *explicit metadata
-These are the possible 'extras' for 3D nodes and sidecar-files
-
-
-
-
key
-
type
-
example (JSON)
-
function
-
existing compatibility
-
-
-
-
-
-
href
-
string
-
"href": "b.gltf"
-
XR teleport
-
custom property in 3D fileformats
-
-
-
-
-
-Level2: href links
-Explicit href metadata ('extras') in a 3D object (of a 3D file), hint the viewer that the user ''can interact'' with that object :
-
-Interaction behaviour
-When clicking an ''href''-value, the user(camera) is teleport to the referenced object.
-The imported/teleported destination can be another object in the same scene-file, or a different file.
-
-
-XR Viewer implementation
-
-
-
-
spec
-
action
-
feature
-
-
-
-
-
-
level0+1
-
hover 3D file href
-
show the preview PNG thumbnail (if any).
-
-
-
-
level0+1
-
launch 3D file href
-
replace the current scene with a new 3D file (href: other.glb e.g.)
-
-
-
-
level2
-
click internal 3D file href (#roomB e.g.)
-
teleport the camera to the origin of object(name roomB). See [[teleport camera]].
-
-
-
-
level2
-
click external 3D file href (foo.glb e.g.)
-
replace the current scene with a new 3D file (href: other.glb e.g.)
-
-
-
-
level2
-
hover external 3D file href
-
show the preview PNG thumbnail (if any sidecar, see level0)
-
-
-
-
level2
-
activate animation
-
clicking href-value #foo will select animation foo (if exist)
-
-
-
-
level2
-
click href
-
hashbus: execute without changing the toplevel URL location (href: xrf://#someObjectName e.g.)
-
-
-
-
level3
-
click href
-
set the global 3D animation timeline to its Media Fragment value (#t=2,3 e.g.)
-
-
-
NOTE: hashbus links (xrf://#foo&bar) don't change the toplevel URL, which makes it ideal for interactions (in contrast to typical #roomC navigation, which benefit back/forward browser-buttons), see <a href="#hashbus">hashbus</a> for more info.
-default camera (spawn) location: When a 3D file is loaded, it will position the user/camera at xyz: 0,0,0 OR to the location of (an object called) ''spawn''.
-
Basically:
-
-
-
-will load as default:
-
-
-
-
-
-
-Level3: Media Fragments
-
these allow for XR Movies with a controllable timeline using href URI's with Media Fragments
-
Just like with 2D media-files, W3C mediafragments (#t=1,2) can be used to control a timeline via the #t primitive.
-XR Fragments Level3 makes the 3D timeline, as well as URL-referenced files controllable via Media Fragments like:
-
-
-
level2 hrefs (href: #t=4 e.g. to control 3D timeline)
-
level4: xrf: URI scheme:
-
-
-
href: xrf:foo.wav#t=0 to play a wav
-
href: xrf:news.glb?clone#t=0 to instance and play another experience
-
-
-
-Animation(s) timeline
-controls the animation(s) of the scene (or src resource which contains a timeline)
-
-
-
-
fragment
-
type
-
functionality
-
-
-
-
-
-
<b>#t</b>=start,stop
-
[vector2]
-
start,stop (in seconds
-
-
-
-
-
-
Example Value
-
Explanation
-
-
-
-
-
-
#t=1
-
play (3D) animations from 1 seconds till end (and stop)
-
-
-
-
#t=1,100
-
play (3D) animations from 1 till 100 seconds (and stop)
-
-
-
-
-Specify playback loopmode
-This compensates a missing element from Media Fragments to enable/disable temporal looping. .
-| fragment | type | functionality |
-| <b>#loop</b> | string | enables animation/video/audio loop |
-| <b>#-loop</b> | string | disables animation/video/audio loop |
-
-
-Controlling embedded content
-use [[URI Templates]] to control embedded media, for example a simple video-player:
-
-
-
-
-
-
-Level4: prefix operators
-Prefixing objectnames with the following simple operators allow for extremely powerful XR interactions:
-
-
-
#!
-
#*
-
#+ or #-
-
#|
-
xrf: URI scheme
-
-
Examples:#+menu to show a object, #-menu to hide a menu, #!menu to teleport a menu, #*block to clone a grabbable block, #|object to share an object
-
-Object teleports (!)
-Prefixing an object with an exclamation-symbol, will teleport a (local or remote) referenced object from/to its original/usercamera location.
-
-[img[objecteleport.png]]
-Usecases:
-* show/hide objects/buttons (menu e.g.) in front of user
-* embed remote (object within) 3D file via remote URL
-* instance an interactive object near the user regardless of location
-* instance HUD or semi-transparent-textured-sphere (LUT) around the user
-<div class="border padding" style="border:4px solid #888">
- <span class="big hi1">#!menu</span>
-</div>
-
-
-Clicking the href-value above will:
-
-
-
reposition the referenced object (menu) to the usercamera's-coordinates.
-
zoom in case of (non-empty) mesh-object: rescale to 1 m³, and position 1m in front of the camera
-
toggle behaviour: revert values if 1/2 were already applied
-
#+ is always implied (objects are always made visible)
-
-This tiny but powerful symbol allows incredible interactive possibilities, by carefully positioning re-usable objects outside of a scene (below the usercamera's floor e.g.).
-
-
-
href: #whiteroom&!explainer&!exitmenu
-
-
This will teleport the user to whiteroom and moves object explainer and exitmenu in front of the user.
-
-
-
href: `https://my.org/foo.glb#!
-
-Clicking the href-value above will:
-
-
-
import foo.glb from my.org's webserver
-
show it in front of the user (because #! indicates object teleport)
-
-
-
-
href: https://foo.glb#roomB&!bar
-
-Clicking the href-value above will:
-
-
-
replace the current scene with foo.glb
-
teleport the user to #roomB inside foo.glb
-
instance the referenced object (bar inside foo.glb) in front of the user.
-
it will update the top-Level URL (because xrf: was not used)
-
hide the instanced object when clicked again (toggle visibility)
-
-
NOTE: level2 teleportation links, as well as instancing mitigates the 'broken embedded image'-issue of HTML: always attaching the href-values to a 3D (preview) object (that way broken links will not break the design).
-
Example: clicking a 3D button with title 'menu' and href-value xrf:menu.glb?instance#t=4,5 would instance a 3D menu (menu.glb) in front of the user, and loop its animation between from 4-5 seconds (t=4,5)
-
NOTE: combining instance-operators allows dynamic construction of 3D scenes (#london&!welcomeMenu&!fadeBox e.g.)
-
-
-Object multipliers (*)
-The star-prefix will clone a (local or remote) referenced object to the usercamera's location, and make it grabbable.
-
-Usecases:
-* object-picker (build stuff with objects)
-
NOTE: this is basically the #! operator which infinitely clones the referenced object (instead of repositioning the object).
-
-
-De/selectors (+ and -)
-
How to show/hide/group material- or object- or animations by name?
-
Clicking href-values below will show/hide the targeted material- or animation or object-name (incl. children):
-
-
-
#-welcome
-
#+welcome
-
#-VR*
-
https://foo.glb#bar&-welcome
-
-Matching logic:
-
-
-
- and + prefix for exact matches (welcome e.g.)
-
* postfix for match beginning (VR_skybox VR_skyboxmat e.g.)
-
-
NOTE: to hide a skybox when importing/loading a 3D file (force AR) is possible by linking to `https://my.org/foo.glb#-skybox or https://my.org/foo.glb#-skyboxmaterial
-
-
-Sharing object or file (#|)
-The pipe-symbol (|) sends a (targeted) object to the OS.
-Clicking the href-value below will:
-
-
-
share the (targeted object in the) file to a another application
-
-
This URL can be fed straight into Web Share API or xdg-open
-
-
-
href: xrf://#|bar
-
-
NOTE: sharing is limited to (internal objects) via xrf: scheme-only
-
-
-xrf:// URI scheme
-Prefixing the xrf: to href-values will preventlevel2href-values from changing the top-Level URL.
-
Usecase: for non-shareable URLs like href: xrf:#t=4,5, to display a stateful msg e.g.).
-
Reason: XR Fragments is inspired by HTML's href-attribute, which does various things:
-
-
-
it updates the browser-location
-
it makes something clickable
-
it jumps to another document / elsewhere in the same document
-
and more
-
-The xrf: scheme will just do 2 & 3 (so the URL-values will not leak into the top-level URL).
-
compliance with RFC 3986: unimplemented/unknown URI schemes (xrf:... e.g.) will not update the top-level URL
-
-
-
-Level5: URI Templates (RFC6570)
-)
-XR Fragments adopts Level1 URI Fragment expansion to provide safe interactivity.
-
-This is non-normative, and the draft spec is available on request.
-
-
-Top-level URL processing
-
Example URL: ://foo/world.gltf#room1&t=10&cam
-
The URL-processing-flow for hypermedia browsers goes like this:
-
-
-
IF scene operators and/or animation operator (t) are present in the URL then (re)position the camera (to room1) and/or animation-range (10) accordingly.
-
IF no camera-position has been set in <b>step 1 or 2</b> assume 0,0,0 as camera coordinate (XR: add user-height) (example)
-
IF a camera-object exists with name cam assume that user(camera) position
-
-
-UX
-End-users should always have read/write access to:
-
-
-
the current (toplevel) <b>URL</b> (an URLbar etc)
-
URL-history (a <b>back/forward</b> button e.g.)
-
Clicking/Touching an href navigates (and updates the URL) to another scene/file (and coordinate e.g. in case the URL contains XR Fragments).
clicking an outbound ''external''- or ''file URI'' fully replaces the current scene and assumes room2 by default (unless specified)
-
-
relocation/reorientation should happen locally for local URI's (#....)
-
-
navigation should not happen ''immediately'' when user is more than 5 meter away from the portal/object containing the href (to prevent accidental navigation e.g.)
-
-
URL navigation should always be reflected in the client URL-bar (in case of javascript: see [here for an example navigator), and only update the URL-bar after the scene (default fragment #) has been loaded.
-
-
In immersive XR mode, the navigator back/forward-buttons should be always visible (using a wearable e.g., see [here for an example wearable)
-
-
make sure that the ''back-button'' of the ''browser-history'' always refers to the previous position (see [here)
-
-
ignore previous rule in special cases, like clicking an href using camera-portal collision (the back-button could cause a teleport-loop if the previous position is too close)
-
-
href-events should bubble upward the node-tree (from children to ancestors, so that ancestors can also conain an href), however only 1 href can be executed at the same time.
-
-
the end-user navigator back/forward buttons should repeat a back/forward action until a #... primitive is found (the stateless xrf:// href-values should not be pushed to the url-history)
-
-
-» example implementation
-
-» example 3D asset
-
-» discussion
-
-
-Walking surfaces
-
By default position 0,0,0 of the 3D scene represents the walkable plane, however this is overridden when the following applies:
-
XR Fragment-compatible viewers can infer this data based scanning the scene for:
-
-
-
materialless (nameless & textureless) mesh-objects (without href and >0 faces)
-
-
optionally the viewer can offer thumbstick, mouse or joystick teleport-tools for non-roomscale VR/AR setups.
-
-
-
-Example: Virtual world rings
-Consider 3D scenes linking to eachother using these href values, attached to 3D button-objects:
-
-
-
href: schoolA.edu/projects.gltf#math
-
href: schoolB.edu/projects.gltf#math
-
href: university.edu/projects.gltf#math
-
-This would teleport users to the math-projects of those universities.
-
-Now consider adding a 'webring index'-button to each file, with this href-value:
-
-
-
href: workgroup.edu/webrings.glb#!webringmenu
-
-This would allow displaying the (remote 3D file) webring menu with various href-buttons inside, all centrally curated by the workgroup.
-
-
-Additional scene metadata
-XR Fragments does not aim to redefine the metadata-space or accessibility-space by introducing its own cataloging-metadata fields.
-Instead, it encourages browsers to scan nodes for the following custom properties:
-
-
-
SPDX license information
-
ARIA attributes (aria-*: .....)
-
datapackage.json findability, accessibility, interoperability, and reusability of data
-
-ARIA's aria-description-metadata is normative, to aid accessibility and scene transcripts
-
NOTE: please always start aria-description with a verb to aid transcripts.
-
The following metadata are non-normative but encouraged, since they are popular and cheap to parse:
-
-
-
RDF/JSON-LD like this example or via glTF's KHR_xmp_json_ld extension
-
Open Graph attributes (og:*: .....)
-
Dublin-Core attributes(dc:*: .....)
-
BibTex when known bibtex-keys exist with values enclosed in { and },
-
-
Example: object 'tryceratops' with aria-description: is a huge dinosaurus standing on a #mountain generates transcript #tryceratops is a huge dinosaurus standing on a #mountain, where the hashtags are clickable XR Fragments (activating the visible-links in the XR browser).
-
Individual nodes can be enriched with such metadata, but most importantly the scene node:
-
-
-
-
metadata key
-
example value
-
-
-
-
-
-
aria-description, og:description, dc:description
-
An immersive experience about Triceratops (*)
-
-
-
-
SPDX
-
CC0-1.0
-
-
-
-
dc:creator
-
John Doe
-
-
-
-
dc:title, og:title
-
'Triceratops` (*)
-
-
-
-
og:site_name
-
https://xrfragment.org
-
-
-
-
dc.publisher
-
NLNET
-
-
-
-
dc.date
-
2024-01-01
-
-
-
-
dc.identifier
-
XRFRAGMENT-001
-
-
-
-
journal (bibTeX)
-
{Future Of Text Vol 3},
-
-
-
* = these are interchangable (only one needs to be defined)
-
There's no silver bullet when it comes to metadata, so XR Fragment-implementations should support where the metadata is/goes.
-
These attributes can be scanned and presented during an href or src eye/mouse-over.
-
-
-Accessibility interface
-The addressibility of XR Fragments allows for unique 3D-to-text transcripts, as well as an textual interface to navigate 3D content.
-
-Spec:
-<Br>
-
-
-
The enduser must be able to enable an accessibility-mode (which persists across application/webpage restarts)
-
Accessibility-mode must contain a text-input for the user to enter text
-
Accessibility-mode must contain a flexible textlog for the user to read (via screenreader, screen, or TTS e.g.)
-
the textlog contains aria-descriptions, and its narration (Screenreader e.g.) can be skipped (via 2-button navigation)
-
The back command should navigate back to the previous URL (alias for browser-backbutton)
-
The forward command should navigate back to the next URL (alias for browser-nextbutton)
-
A destination is a 3D node containing an href with a #... XR fragment (which matches a 3d object name)
-
The go command should list all possible destinations
-
The go left command should move the camera around 0.3 meters to the left
-
The go right command should move the camera around 0.3 meters to the right
-
The go forward command should move the camera 0.3 meters forward (direction of current rotation).
-
The rotate left command should rotate the camera 0.3 to the left
-
The rotate left command should rotate the camera 0.3 to the right
-
The (dynamic) go abc command should navigate to #scene2 in case there's a 3D node with name abc and href value #scene2
-
The look command should give an (contextual) 3D-to-text transcript, by scanning the aria-description values of the current #... (3D object) value (including its children)
-
The do command should list all possible href values which don't contain an #... XR Fragment
-
The (dynamic) do abc command should navigate/execute https://.../... in case a 3D node exist with name abc and href value https://.../...
-
-
-Two-button navigation
-For specific user-profiles, gyroscope/mouse/keyboard/audio/visuals will not be available.
-
-Therefore a 2-button navigation-interface is the bare minimum interface:
-
-
-
objects with href metadata can be cycled via a key (tab on a keyboard)
-
objects with href metadata can be activated via a key (enter on a keyboard)
-
the TTS reads the href-value (and/or aria-description if available)
-
-
-
-XRF microformat
-How can applications discover 3D experiences on a network?
-
Answer: spatial microformats
-
The XRF microformat is an optional text heuristics which applications can detect across various usecases.
-
-via HTML webpage
-If the browser/application requests an webpage (https://nlnet.nl e.g.) it should check for the rel-me microformat :
-
-
-]]>
-
-This way the application loads https://nlnet.nl/scene.xrf.glb when the user types nlnet.nl into the URLbar.
-
-Optionally, type can be specified for dynamically generated 3D files:
-
-
-]]>
-
-The type-attribute is for fallback-purposes.
-
-Viewer-supported 3D file-extensions (.glb e.g.) will ALWAYS take precedence over the (non)presence of the type attribute.
-
-The reason is that platforms (Mastodon 'labels' e.g.) don't allow specifying type-attributes.
-
-Another reason is that XR Fragments is filetype-agnostic, so flexibility is expected on the viewer-side.
-
NOTE: in case of multiple 3D files mentioned in <link rel="me", only the first (supported 3D filetype) will be chosen.
-
Example of multiple spatial microformats:
-
-
-
-
-]]>
-
-
-
-via WebFinger
-When John has an account on foo.com, how can other applications request his 3D homepage by simply entering john@foo.com?
-
Answer: it can be requested at https://foo.com/.well-known/webfinger?resource=acct:john@foo.com, resulting in:
-
-
-
-This way the application will load https://3d.john.foo.com/model/scene.glb when the user types john@foo.com into the user field.
-
-
-via Text (URI)
-Another way for an application to trigger loading a 3D scene is by detecting URI's of 3D scene-files any text:
-
-
-
foo.glb (or any other popular 3D extension)
-
https://foo.com/scene.glb (or any other popular protocol)
-
-This way, the application can highlight the link whenever it detects the URI (in a text-file or text-section of a 3D model)
-
-
-
-
-Overlap with fileformat-specific extensions
-Some 3D scene-fileformats have support for extensions.
-What if the functionality of those overlap?
-For example, GLTF has the OMI_LINK extension which might overlap with XR Fragment's href:
-
Priority Order and Precedence, otherwise fallback applies
-
1.Extensions Take Precedence: Since glTF-specific extensions are designed with the format’s
-specific needs and optimizations in mind, they should take precedence over extras metadata
-in cases where both contain overlapping functionality.
-This approach aligns with the idea that extensions are more likely to be interpreted uniformly by glTF-compatible software.
-
-
-
Fallback Fall-through Mechanism:
-If a glTF implementation does not support a particular extension, the (XRF) extras field can serve as a fallback. This way, metadata provided in extras can still be useful for applications that don't handle certain extensions.
-
-
Example 1 In case of the OMI_LINK glTF extension (href: https://nlnet.nl) and an XR Fragment (href: #otherroom or href: otherplanet.glb), it is clear that https://nlnet.nl should open in a browsertab, whereas the XR Fragment links should teleport the user. If the OMI_LINK contains an XR Fragment (#room1 e.g.) a teleport should be performed only (and other [overlapping] metadata should be ignored).
-Example 2 If an Extensions uses XR Fragments in URI's (href: #otherroom or href: xrf://-walls in OMI_LINK e.g.), then perform them according to XR Fragment spec (teleport user). But only once: ignore further overlapping metadata for that usecase.
-
-
-
-Vendor Prefixes
-Vendor-specific metadata in a 3D scenefiles, are similar to vendor-specific CSS-prefixes (-moz-opacity: 0.2 e.g.).
-This allows popular 3D engines/frameworks, to initialize specific features when loading a scene/object, in a progressive enhanced way.
-Vendor Prefixes allows embedding 3D engines/framework-specific features a 3D file via metadata:
-
-
-
-
what
-
XR metadata
-
Lowest common denominator
-
-
-
-
-
-
CSS
-
vendor-agnostic
-
2D canvas + object referencing/styling
-
-
-
-
XR Fragments
-
vendor-agnostic
-
3D camera + object(file) load/embed/click/referencing
-
-
-
-
Vendor prefixs
-
vendor-specific
-
Specialized Entity-Component implementation
-
-
-
Why? Because not all XR interactions can/should be solved/standardized by embedding XR Fragments into any 3D file.
-The lowest common denominator between 3D engines is the 'entity'-part of their entity-component-system (ECS). The 'component'-part can be progressively enhanced via vendor prefixes.
-
For example, the following metadata can be added to a .glb file, to make an object grabbable in AFRAME:
-
- inits 'grabbable' component on object john │
-│ | / \ ├─ -aframe-material.color: '#F0A' | > inits 'material' component on object john │
-│ | ├─ -aframe-text.value: '{name}{age}'| > inits 'text' component (*) with value 'john' │
-│ | ├─ -three-material.fog: false | > changes material settings in THREE.js app │
-│ | ├─ -godot-Label3D.text: '{name}{age}'| > inits 'Label3D' component (*) in Godot │
-│ +--------+ | │
-│ | │
-├─ -GODOT-version: '4.3' | > exporters/authors can report targeted version │
-├─ -AFRAME-version: '1.6.0' | and (optionally) hint component-repo│
-├─ -AFRAME-info: 'https://git.benetou.fr/comps' │
-│ | │
-+────────────────────────────────────────────────────────────────────────────────────────────────────────+
-]]>
-
-
-
-String-templatevalues are evaluated as per URI Templates (RFC6570) Level 1.
-
This 'separating of mechanism from policy' (unix rule) does somewhat break portability of an XR experience, but still prevents (E-waste of) handcoded virtual worlds. It allows for (XR experience) metadata to survive in future 3D engines and scene-fileformats.
-
-
-Security Considerations
-The only dynamic parts are W3C Media Fragments and URI Templates (RFC6570).
-
-The use of URI Templates is limited to pre-defined variables and Level0 fragments-expansion only, which makes it quite safe.
-
-n fact, it is much safer than relying on a scripting language (javascript) which can change URN too.
-
-
-FAQ
-Q: Why is everything HTTP GET-based, what about POST/PUT/DELETE HATEOS
-
-A: Because it's out of scope: XR Fragment specifies a read-only way to surf XR documents. These things belong in the application layer (for example, an XR Hypermedia browser can decide to support POST/PUT/DELETE requests for embedded HTML thru src values)
-Q: Why isn't there support for scripting, URI Template Fragments are so limited compared to WASM & javascript
-A: This is out of scope as it unhyperifies hypermedia, and this is up to XR hypermedia browser-extensions.
- Historically scripting/Javascript seems to been able to turn webpages from hypermedia documents into its opposite (hyperscripted nonhypermedia documents).
-In order to prevent this backward-movement (hypermedia tends to liberate people from finnicky scripting) XR Fragment uses W3C Media Fragments and URI Templates (RFC6570), to prevent unhyperifying itself by hardcoupling to a particular markup or scripting language.
-
-XR Fragments supports filtering objects in a scene only, because in the history of the javascript-powered web, showing/hiding document-entities seems to be one of the most popular basic usecases.
-
-Doing advanced scripting & networkrequests under the hood are obviously interesting endavours, but this is something which should not be hardcoupled with XR Fragments or hypermedia.
-This perhaps belongs more to browser extensions.
-
-Non-HTML Hypermedia browsers should make browser extensions the right place, to 'extend' experiences, in contrast to code/javascript inside hypermedia documents (this turned out as a hypermedia antipattern).
-
-
-authors
-
-
-
Leon van Kammen (@lvk@mastodon.online)
-
Jens Finkhäuser (@jens@social.finkhaeuser.de)
-
-
-
-IANA Considerations
-This document has no IANA actions.
-
-
-Acknowledgments
-
-
-
NLNET
-
Future of Text
-
James Baicoianu janusweb
-
Michiel Leenaars
-
Gerben van der Broeke
-
Mauve
-
Jens Finkhäuser
-
Marc Belmont
-
Tim Gerritsen
-
Frode Hegland
-
Brandel Zackernuk
-
Mark Anderson
-
-
-
-Appendix: Definitions
-
-
-
-
definition
-
explanation
-
-
-
-
-
-
human
-
a sentient being who thinks fuzzy, absorbs, and shares thought (by plain text, not markuplanguage)
-
-
-
-
scene
-
a (local/remote) 3D scene or 3D file (index.gltf e.g.)
-
-
-
-
3D object
-
an object inside a scene characterized by vertex-, face- and customproperty data.
-
-
-
-
URI
-
some resource at something somewhere via someprotocol (http://me.com/foo.glb#foo or e76f8efec8efce98e6fsee interpeer.io)
-
-
-
-
URL
-
something somewhere via someprotocol (http://me.com/foo.glb)
-
-
-
-
URN
-
something at some domain (me.com/foo.glb)
-
-
-
-
metadata
-
custom properties of text, 3D Scene or Object(nodes), relevant to machines and a human minority (academics/developers)
-
-
-
-
XR fragment
-
URI Fragment with spatial hints (which match the name of a 3D object-, camera-, animation-object)
-
-
-
-
the XRWG
-
wordgraph (collapses 3D scene to tags)
-
-
-
-
the hashbus
-
hashtags map to camera/scene-projections
-
-
-
-
spacetime hashtags
-
positions camera, triggers scene-preset/time
-
-
-
-
teleportation
-
repositioning the enduser to a different position (or 3D scene/file)
-
-
-
-
sourceportation
-
teleporting the enduser to the original XR Document of an src embedded object.
-
-
-
-
placeholder object
-
a 3D object which with src-metadata (which will be replaced by the src-data.)
-
-
-
-
src
-
(HTML-piggybacked) metadata of a 3D object which instances content
-
-
-
-
href
-
(HTML-piggybacked) metadata of a 3D object which links to content
-
-
-
-
filter
-
URI Fragment(s) which show/hide object(s) in a scene based on name/tag/property (#cube&-price=>3)
-
-
-
-
requestless metadata
-
metadata which never spawns new requests (unlike RDF/HTML, which can cause framerate-dropping, hence not used a lot in games)
-
-
-
-
FPS
-
frames per second in spatial experiences (games,VR,AR e.g.), should be as high as possible
-
-
-
-
introspective
-
inward sensemaking ("I feel this belongs to that")
-
-
-
-
extrospective
-
outward sensemaking ("I'm fairly sure John is a person who lives in oklahoma")
-
-
-
-
◻
-
ascii representation of an 3D object/mesh
-
-
-
-
(un)obtrusive
-
obtrusive: wrapping human text/thought in XML/HTML/JSON obfuscates human text into a salad of machine-symbols and words