coderofsalvation/xrfragment-haxe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update documentation

Browse source
This commit is contained in:
Leon van Kammen 2023-09-07 18:48:40 +02:00
parent 37e68ef433
commit 275589a691
6 changed files with 1270 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/RFC_XR_Fragments.md
View file

@ -552,6 +552,8 @@ hello world
} }
``` ```
> when an XR browser updates the human text, a quick scan for nonmatching tags (`@book{nonmatchingbook` e.g.) should be performed and prompt the enduser for deleting them.
# HYPER copy/paste # HYPER copy/paste
The previous example, offers something exciting compared to simple copy/paste of 3D objects or text. The previous example, offers something exciting compared to simple copy/paste of 3D objects or text.

374
doc/RFC_XR_Macros.html Normal file
View file

@ -0,0 +1,374 @@
<!DOCTYPE html>
<html>
<head>
<title>XR Macros</title>
<meta name="GENERATOR" content="github.com/mmarkdown/mmark Mmark Markdown Processor - mmark.miek.nl">
<meta charset="utf-8">
</head>
<body>
<!-- for annotated version see: https://raw.githubusercontent.com/ietf-tools/rfcxml-templates-and-schemas/main/draft-rfcxml-general-template-annotated-00.xml -->
<style type="text/css">
body{
font-family: monospace;
max-width: 1000px;
font-size: 15px;
padding: 0% 20%;
line-height: 30px;
color:#555;
background:#F0F0F3
}
h1 { margin-top:40px; }
pre{ line-height:18px; }
a,a:visited,a:active{ color: #70f; }
code{
border: 1px solid #AAA;
border-radius: 3px;
padding: 0px 5px 2px 5px;
}
pre{
line-height: 18px;
overflow: auto;
padding: 12px;
}
pre + code {
background:#DDD;
}
pre>code{
border:none;
border-radius:0px;
padding:0;
}
blockquote{
padding-left: 30px;
margin: 0;
border-left: 5px solid #CCC;
}
th {
border-bottom: 1px solid #000;
text-align: left;
padding-right:45px;
padding-left:7px;
background: #DDD;
}
td {
border-bottom: 1px solid #CCC;
font-size:13px;
}
</style>
<br>
<h1>XR Macros</h1>
<br>
<pre>
stream: IETF
area: Internet
status: informational
author: Leon van Kammen
date: 2023-04-12T00:00:00Z
workgroup: Internet Engineering Task Force
value: draft-XRMACROS-leonvankammen-00
</pre>
<h1 class="special" id="abstract">Abstract</h1>
<p>This draft offers a specification for embedding macros in existing 3D scenes/assets, to offer simple interactions and configure the renderer further.<br>
Together with URI Fragments, it allows for rich immersive experiences without the need of a complicated sandboxed scripting languages.</p>
<blockquote>
<p>Almost every idea in this document is demonstrated at <a href="https://xrfragment.org">https://xrfragment.org</a>, as this spec was created during the <a href="https://xrfragment.org">XR Fragments</a> spec.</p>
</blockquote>
<section data-matter="main">
<h1 id="introduction">Introduction</h1>
<p>How can we add more features to existing text &amp; 3D scenes, without introducing new dataformats?<br>
Historically, there&rsquo;s many attempts to create the ultimate markuplanguage or 3D fileformat.<br>
Their lowest common denominator is: (co)authoring using plain text.<br>
Therefore, XR Macros allows us to enrich/connect existing dataformats, by offering a polyglot notation based on existing notations:<br></p>
<ol>
<li>getting/setting common used 3D properties using querystring- or JSON-notation</li>
<li>querying 3D properties using the lightweight searchengine notation used in <a href="https://xrfragment.org">XR Fragments</a></li>
</ol>
<blockquote>
<p>NOTE: The chapters in this document are ordered from highlevel to lowlevel (technical) as much as possible</p>
</blockquote>
<h1 id="core-principle">Core principle</h1>
<ol>
<li>XR Macros use querystrings, but are HTML-agnostic (though pseudo-XR Fragment browsers <strong>can</strong> be implemented on top of HTML/Javascript).</li>
<li>XR Macros represents setting/getting common used properties found in all popular 3D frameworks/(game)editors/internet browsers.</li>
<li>XR Macros acts as simple eventhandlers for URI Fragments</li>
</ol>
<h1 id="conventions-and-definitions">Conventions and Definitions</h1>
<p>See appendix below in case certain terms are not clear.</p>
<h1 id="list-of-xr-macros">List of XR Macros</h1>
<p>(XR) Macros can be embedded in 3D assets/scenes.<br>
Macros enrich existing spatial content with a lowcode, limited logic-layer, by recursive (economic) use of the querystring syntax (which search engines and <a href="https://xrfragment.org">XR Fragments</a> already uses.<br>
This is done by allowing string/integer variables, and the <code>|</code> symbol to roundrobin variable values.<br>
Macros also act as events, so more serious scripting languages can react to them as well.<br></p>
<h2 id="usecase-click-object">Usecase: click object</h2>
<table>
<thead>
<tr>
<th>custom property</th>
<th>value</th>
<th>trigger when</th>
</tr>
</thead>
<tbody>
<tr>
<td>!clickme</td>
<td>bg=1,1,1&amp;foo=2</td>
<td>object clicked</td>
</tr>
</tbody>
</table>
<h2 id="usecase-conditional-click-object">Usecase: conditional click object</h2>
<table>
<thead>
<tr>
<th>custom property</th>
<th>value</th>
<th>trigger when</th>
</tr>
</thead>
<tbody>
<tr>
<td>#</td>
<td>foo=1</td>
<td>scene</td>
</tr>
<tr>
<td>!clickme</td>
<td>q=foo&gt;2&amp;bg=1,1,1</td>
<td>object clicked and foo &gt; 2</td>
</tr>
</tbody>
</table>
<blockquote>
<p>when a user clicks an object with the custom properties above, it should set the backgroundcolor to <code>1,1,1</code> when <code>foo</code> is greater than <code>2</code> (see previous example)</p>
</blockquote>
<h2 id="usecase-click-object-roundrobin">Usecase: click object (roundrobin)</h2>
<table>
<thead>
<tr>
<th>custom property</th>
<th>value</th>
<th>trigger when</th>
</tr>
</thead>
<tbody>
<tr>
<td>!clickme</td>
<td>day|noon|night</td>
<td>object clicked</td>
</tr>
<tr>
<td>day</td>
<td>bg=1,1,1</td>
<td>roundrobin</td>
</tr>
<tr>
<td>noon</td>
<td>bg=0.5,0.5,0.5</td>
<td>roundrobin</td>
</tr>
<tr>
<td>night</td>
<td>bg=0,0,0&amp;foo=2</td>
<td>roundrobin</td>
</tr>
</tbody>
</table>
<blockquote>
<p>when a user clicks an object with the custom properties above, it should trigger either <code>day</code> <code>noon</code> or <code>night</code> in roundrobin fashion.</p>
</blockquote>
<h2 id="usecase-click-object-uri-fragment-and-scene-load">Usecase: click object, URI fragment and scene load</h2>
<table>
<thead>
<tr>
<th>custom property</th>
<th>value</th>
<th>trigger when</th>
</tr>
</thead>
<tbody>
<tr>
<td>#</td>
<td>random</td>
<td>scene loaded</td>
</tr>
<tr>
<td>#random</td>
<td>random</td>
<td>URL contains #random</td>
</tr>
<tr>
<td>!random</td>
<td>day|noon|night</td>
<td>#random, # or click</td>
</tr>
<tr>
<td>day</td>
<td>bg=1,1,1</td>
<td>roundrobin</td>
</tr>
<tr>
<td>noon</td>
<td>bg=0.5,0.5,0.5</td>
<td>roundrobin</td>
</tr>
<tr>
<td>night</td>
<td>bg=0,0,0&amp;foo=2</td>
<td>roundrobin</td>
</tr>
</tbody>
</table>
<h2 id="usecase-present-context-menu-with-options">Usecase: present context menu with options</h2>
<table>
<thead>
<tr>
<th>custom property</th>
<th>value</th>
<th>trigger when</th>
</tr>
</thead>
<tbody>
<tr>
<td>!random</td>
<td>day</td>
<td>noon</td>
</tr>
<tr>
<td>!day</td>
<td>bg=1,1,1</td>
<td>clicked in contextmenu</td>
</tr>
<tr>
<td>!noon</td>
<td>bg=0.5,0.5,0.5</td>
<td>clicked in contextmenu</td>
</tr>
<tr>
<td>!night</td>
<td>bg=0,0,0&amp;foo=2</td>
<td>clicked in contextmenu</td>
</tr>
</tbody>
</table>
<blockquote>
<p>The XR Browser should offer a contextmenu with these options when more than one <code>!</code>-macro is present on an object.</p>
</blockquote>
<h1 id="security-considerations">Security Considerations</h1>
<h1 id="iana-considerations">IANA Considerations</h1>
<p>This document has no IANA actions.</p>
<h1 id="acknowledgments">Acknowledgments</h1>
<ul>
<li><a href="https://nlnet.nl">NLNET</a></li>
<li><a href="https://futureoftext.org">Future of Text</a></li>
<li><a href="https://visual-meta.info">visual-meta.info</a></li>
</ul>
<h1 id="appendix-definitions">Appendix: Definitions</h1>
<table>
<thead>
<tr>
<th>definition</th>
<th>explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td>scene</td>
<td>a (local/remote) 3D scene or 3D file (index.gltf e.g.)</td>
</tr>
<tr>
<td>3D object</td>
<td>an object inside a scene characterized by vertex-, face- and customproperty data.</td>
</tr>
<tr>
<td>XR fragments</td>
<td>URI Fragment with spatial hints like <code>#pos=0,0,0&amp;t=1,100</code> e.g.</td>
</tr>
<tr>
<td>query</td>
<td>an URI Fragment-operator which queries object(s) from a scene like <code>#q=cube</code></td>
</tr>
<tr>
<td>FPS</td>
<td>frames per second in spatial experiences (games,VR,AR e.g.), should be as high as possible</td>
</tr>
<tr>
<td><code>◻</code></td>
<td>ascii representation of an 3D object/mesh</td>
</tr>
<tr>
<td>(un)obtrusive</td>
<td>obtrusive: wrapping human text/thought in XML/HTML/JSON obfuscates human text into a salad of machine-symbols and words</td>
</tr>
</tbody>
</table>
</section>
</body>
</html>

100
doc/RFC_XR_Macros.md
View file

@ -1,11 +1,11 @@
%%% %%%
Title = "XR Fragments" Title = "XR Macros"
area = "Internet" area = "Internet"
workgroup = "Internet Engineering Task Force" workgroup = "Internet Engineering Task Force"
[seriesInfo] [seriesInfo]
name = "XR-Fragments" name = "XR-Macros"
value = "draft-XRFRAGMENTS-leonvankammen-00" value = "draft-XRMACROS-leonvankammen-00"
stream = "IETF" stream = "IETF"
status = "informational" status = "informational"
@ -75,7 +75,7 @@ fullname="L.R. van Kammen"
</style> </style>
<br> <br>
<h1>XR Fragments</h1> <h1>XR Macros</h1>
<br> <br>
<pre> <pre>
@ -85,7 +85,7 @@ status: informational
author: Leon van Kammen author: Leon van Kammen
date: 2023-04-12T00:00:00Z date: 2023-04-12T00:00:00Z
workgroup: Internet Engineering Task Force workgroup: Internet Engineering Task Force
value: draft-XRFRAGMENTS-leonvankammen-00 value: draft-XRMACROS-leonvankammen-00
</pre> </pre>
@ -93,11 +93,10 @@ value: draft-XRFRAGMENTS-leonvankammen-00
.# Abstract .# Abstract
This draft offers a specification for 4D URLs & navigation, to link 3D scenes and text together with- or without a network-connection.<br> This draft offers a specification for embedding macros in existing 3D scenes/assets, to offer simple interactions and configure the renderer further.<br>
The specification promotes spatial addressibility, sharing, navigation, query-ing and tagging interactive (text)objects across for (XR) Browsers.<br> Together with URI Fragments, it allows for rich immersive experiences without the need of a complicated sandboxed scripting languages.
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.<br>
> Almost every idea in this document is demonstrated at [https://xrfragment.org](https://xrfragment.org) > Almost every idea in this document is demonstrated at [https://xrfragment.org](https://xrfragment.org), as this spec was created during the [XR Fragments](https://xrfragment.org) spec.
{mainmatter} {mainmatter}
@ -109,6 +108,7 @@ Their lowest common denominator is: (co)authoring using plain text.<br>
Therefore, XR Macros allows us to enrich/connect existing dataformats, by offering a polyglot notation based on existing notations:<br> Therefore, XR Macros allows us to enrich/connect existing dataformats, by offering a polyglot notation based on existing notations:<br>
1. getting/setting common used 3D properties using querystring- or JSON-notation 1. getting/setting common used 3D properties using querystring- or JSON-notation
1. querying 3D properties using the lightweight searchengine notation used in [XR Fragments](https://xrfragment.org)
> NOTE: The chapters in this document are ordered from highlevel to lowlevel (technical) as much as possible > NOTE: The chapters in this document are ordered from highlevel to lowlevel (technical) as much as possible
@ -116,6 +116,7 @@ Therefore, XR Macros allows us to enrich/connect existing dataformats, by offeri
1. XR Macros use querystrings, but are HTML-agnostic (though pseudo-XR Fragment browsers **can** be implemented on top of HTML/Javascript). 1. XR Macros use querystrings, but are HTML-agnostic (though pseudo-XR Fragment browsers **can** be implemented on top of HTML/Javascript).
1. XR Macros represents setting/getting common used properties found in all popular 3D frameworks/(game)editors/internet browsers. 1. XR Macros represents setting/getting common used properties found in all popular 3D frameworks/(game)editors/internet browsers.
1. XR Macros acts as simple eventhandlers for URI Fragments
# Conventions and Definitions # Conventions and Definitions
@ -123,39 +124,58 @@ See appendix below in case certain terms are not clear.
# List of XR Macros # List of XR Macros
(XR) Macros can be embedded in 3D assets/scenes.<br></br (XR) Macros can be embedded in 3D assets/scenes.<br>
Macros allow a limited logic-layer, by recursive (economic) use of the querystring syntax (which the XR Fragment parser already uses).<br> Macros enrich existing spatial content with a lowcode, limited logic-layer, by recursive (economic) use of the querystring syntax (which search engines and [XR Fragments](https://xrfragment.org) already uses.<br>
The only addition is the `|` symbol to roundrobin variable values.<br> This is done by allowing string/integer variables, and the `|` symbol to roundrobin variable values.<br>
Macros also act as events, so more serious scripting languages can react to them as well.<br> Macros also act as events, so more serious scripting languages can react to them as well.<br>
| custom property | value | assign (rr) variable ? | execute opcode? | show contextmenu? | ## Usecase: click object
|-----------------|--------------------------|------------------------|-----------------|-------------------------------------------|
| &#33;clickme | day&#124;noon&#124;night | yes | not yet | only when multiple props start with &#33; |
| day | bg=1,1,1 | no | yes | no |
| noon | bg=0.5,0.5,0.5 | yes | yes | no |
| night | bg=0,0,0&foo=2 | yes | yes | no |
--- | custom property | value | trigger when |
|-----------------|--------------------------|------------------------|
| !clickme | bg=1,1,1&foo=2 | object clicked |
| custom property | value | assign (rr) variable ? | execute opcode? | show contextmenu? | ## Usecase: conditional click object
|--------------------|--------------------------|------------------------|-----------------|-----------------------------|
| &#33;turnofflights | night | no | yes | yes because of &#33;clickme |
| &#33;clickme | day&#124;noon&#124;night | yes | not yet | yes because of &#33;clickme |
| day | bg=1,1,1 | no | yes | no |
| noon | bg=0.5,0.5,0.5 | yes | yes | no |
| night | bg=0,0,0&foo=2 | yes | yes | no |
| custom property | value | trigger when |
|-----------------|--------------------------|-----------------------------|
| # | foo=1 | scene |
| !clickme | q=foo>2&bg=1,1,1 | object clicked and foo > 2 |
lazy evaluation: > when a user clicks an object with the custom properties above, it should set the backgroundcolor to `1,1,1` when `foo` is greater than `2` (see previous example)
| custom property | value | copy verbatim to URL? | (rr) variable [assingment]? | ## Usecase: click object (roundrobin)
|-----------------|--------------------------|-----------------------|-----------------------------|
| href | #cyclepreset | yes | no |
| cyclepreset | day&#124;noon&#124;night | no | (yes) yes |
| day | bg=1,1,1 | no | yes [yes] |
| noon | bg=0.5,0.5,0.5 | no | yes [yes] |
| night | bg=0,0,0&foo=2 | no | yes [yes] |
| custom property | value | trigger when |
|-----------------|--------------------------|------------------------|
| !clickme | day&#124;noon&#124;night | object clicked |
| day | bg=1,1,1 | roundrobin |
| noon | bg=0.5,0.5,0.5 | roundrobin |
| night | bg=0,0,0&foo=2 | roundrobin |
> when a user clicks an object with the custom properties above, it should trigger either `day` `noon` or `night` in roundrobin fashion.
## Usecase: click object, URI fragment and scene load
| custom property | value | trigger when |
|-----------------|--------------------------|------------------------|
| # | random | scene loaded |
| #random | random | URL contains #random |
| !random | day&#124;noon&#124;night | #random, # or click |
| day | bg=1,1,1 | roundrobin |
| noon | bg=0.5,0.5,0.5 | roundrobin |
| night | bg=0,0,0&foo=2 | roundrobin |
## Usecase: present context menu with options
| custom property | value | trigger when |
|-----------------|--------------------------|------------------------|
| !random | day|noon|night | clicked in contextmenu |
| !day | bg=1,1,1 | clicked in contextmenu |
| !noon | bg=0.5,0.5,0.5 | clicked in contextmenu |
| !night | bg=0,0,0&foo=2 | clicked in contextmenu |
> The XR Browser should offer a contextmenu with these options when more than one `!`-macro is present on an object.
# Security Considerations # Security Considerations
@ -174,21 +194,11 @@ This document has no IANA actions.
|definition | explanation | |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.) | |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. | |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 fragments | URI Fragment with spatial hints like `#pos=0,0,0&t=1,100` e.g. |
|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` | |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 | 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 | |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 | |`◻` | 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 | |(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 |

336
doc/RFC_XR_Macros.txt Normal file
View file

@ -0,0 +1,336 @@
Internet Engineering Task Force L.R. van Kammen
Internet-Draft 7 September 2023
Intended status: Informational
XR Macros
draft-XRMACROS-leonvankammen-00
Abstract
This draft offers a specification for embedding macros in existing 3D
scenes/assets, to offer simple interactions and configure the
renderer further.
Together with URI Fragments, it allows for rich immersive experiences
without the need of a complicated sandboxed scripting languages.
Almost every idea in this document is demonstrated at
https://xrfragment.org (https://xrfragment.org), as this spec was
created during the XR Fragments (https://xrfragment.org) spec.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 10 March 2024.
Copyright Notice
Copyright (c) 2023 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
van Kammen Expires 10 March 2024 [Page 1]
Internet-Draft XR Macros September 2023
extracted from this document must include Revised BSD License text as
described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Revised BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Core principle . . . . . . . . . . . . . . . . . . . . . . . 2
3. Conventions and Definitions . . . . . . . . . . . . . . . . . 3
4. List of XR Macros . . . . . . . . . . . . . . . . . . . . . . 3
4.1. Usecase: click object . . . . . . . . . . . . . . . . . . 3
4.2. Usecase: conditional click object . . . . . . . . . . . . 3
4.3. Usecase: click object (roundrobin) . . . . . . . . . . . 4
4.4. Usecase: click object, URI fragment and scene load . . . 4
4.5. Usecase: present context menu with options . . . . . . . 4
5. Security Considerations . . . . . . . . . . . . . . . . . . . 5
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5
7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 5
8. Appendix: Definitions . . . . . . . . . . . . . . . . . . . . 5
1. 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.
Their lowest common denominator is: (co)authoring using plain text.
Therefore, XR Macros allows us to enrich/connect existing
dataformats, by offering a polyglot notation based on existing
notations:
1. getting/setting common used 3D properties using querystring- or
JSON-notation
2. querying 3D properties using the lightweight searchengine
notation used in XR Fragments (https://xrfragment.org)
| NOTE: The chapters in this document are ordered from highlevel to
| lowlevel (technical) as much as possible
2. Core principle
1. XR Macros use querystrings, but are HTML-agnostic (though pseudo-
XR Fragment browsers *can* be implemented on top of HTML/
Javascript).
2. XR Macros represents setting/getting common used properties found
in all popular 3D frameworks/(game)editors/internet browsers.
3. XR Macros acts as simple eventhandlers for URI Fragments
van Kammen Expires 10 March 2024 [Page 2]
Internet-Draft XR Macros September 2023
3. Conventions and Definitions
See appendix below in case certain terms are not clear.
4. List of XR Macros
(XR) Macros can be embedded in 3D assets/scenes.
Macros enrich existing spatial content with a lowcode, limited logic-
layer, by recursive (economic) use of the querystring syntax (which
search engines and XR Fragments (https://xrfragment.org) already
uses.
This is done by allowing string/integer variables, and the | symbol
to roundrobin variable values.
Macros also act as events, so more serious scripting languages can
react to them as well.
4.1. Usecase: click object
+=================+================+================+
| custom property | value | trigger when |
+=================+================+================+
| !clickme | bg=1,1,1&foo=2 | object clicked |
+-----------------+----------------+----------------+
Table 1
4.2. Usecase: conditional click object
+=================+==================+============================+
| custom property | value | trigger when |
+=================+==================+============================+
| # | foo=1 | scene |
+-----------------+------------------+----------------------------+
| !clickme | q=foo>2&bg=1,1,1 | object clicked and foo > 2 |
+-----------------+------------------+----------------------------+
Table 2
| when a user clicks an object with the custom properties above, it
| should set the backgroundcolor to 1,1,1 when foo is greater than 2
| (see previous example)
van Kammen Expires 10 March 2024 [Page 3]
Internet-Draft XR Macros September 2023
4.3. Usecase: click object (roundrobin)
+=================+================+================+
| custom property | value | trigger when |
+=================+================+================+
| !clickme | day|noon|night | object clicked |
+-----------------+----------------+----------------+
| day | bg=1,1,1 | roundrobin |
+-----------------+----------------+----------------+
| noon | bg=0.5,0.5,0.5 | roundrobin |
+-----------------+----------------+----------------+
| night | bg=0,0,0&foo=2 | roundrobin |
+-----------------+----------------+----------------+
Table 3
| when a user clicks an object with the custom properties above, it
| should trigger either day noon or night in roundrobin fashion.
4.4. Usecase: click object, URI fragment and scene load
+=================+================+======================+
| custom property | value | trigger when |
+=================+================+======================+
| # | random | scene loaded |
+-----------------+----------------+----------------------+
| #random | random | URL contains #random |
+-----------------+----------------+----------------------+
| !random | day|noon|night | #random, # or click |
+-----------------+----------------+----------------------+
| day | bg=1,1,1 | roundrobin |
+-----------------+----------------+----------------------+
| noon | bg=0.5,0.5,0.5 | roundrobin |
+-----------------+----------------+----------------------+
| night | bg=0,0,0&foo=2 | roundrobin |
+-----------------+----------------+----------------------+
Table 4
4.5. Usecase: present context menu with options
+=================+================+========================+
| custom property | value | trigger when |
+=================+================+========================+
| !random | day | noon |
+-----------------+----------------+------------------------+
| !day | bg=1,1,1 | clicked in contextmenu |
+-----------------+----------------+------------------------+
van Kammen Expires 10 March 2024 [Page 4]
Internet-Draft XR Macros September 2023
| !noon | bg=0.5,0.5,0.5 | clicked in contextmenu |
+-----------------+----------------+------------------------+
| !night | bg=0,0,0&foo=2 | clicked in contextmenu |
+-----------------+----------------+------------------------+
Table 5
| The XR Browser should offer a contextmenu with these options when
| more than one !-macro is present on an object.
5. Security Considerations
6. IANA Considerations
This document has no IANA actions.
7. Acknowledgments
* NLNET (https://nlnet.nl)
* Future of Text (https://futureoftext.org)
* visual-meta.info (https://visual-meta.info)
8. Appendix: Definitions
+===============+===================================================+
| definition | explanation |
+===============+===================================================+
| 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. |
+---------------+---------------------------------------------------+
| XR fragments | URI Fragment with spatial hints like |
| | #pos=0,0,0&t=1,100 e.g. |
+---------------+---------------------------------------------------+
| query | an URI Fragment-operator which queries |
| | object(s) from a scene like #q=cube |
+---------------+---------------------------------------------------+
| FPS | frames per second in spatial experiences |
| | (games,VR,AR e.g.), should be as high as |
| | possible |
+---------------+---------------------------------------------------+
| &#9723; | 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 |
van Kammen Expires 10 March 2024 [Page 5]
Internet-Draft XR Macros September 2023
+---------------+---------------------------------------------------+
Table 6
van Kammen Expires 10 March 2024 [Page 6]

299
doc/RFC_XR_Macros.xml Normal file
View file

@ -0,0 +1,299 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- name="GENERATOR" content="github.com/mmarkdown/mmark Mmark Markdown Processor - mmark.miek.nl" -->
<rfc version="3" ipr="trust200902" docName="draft-XRMACROS-leonvankammen-00" submissionType="IETF" category="info" xml:lang="en" xmlns:xi="http://www.w3.org/2001/XInclude" indexInclude="true" consensus="true">
<front>
<title>XR Macros</title><seriesInfo value="draft-XRMACROS-leonvankammen-00" stream="IETF" status="informational" name="XR-Macros"></seriesInfo>
<author initials="L.R." surname="van Kammen" fullname="L.R. van Kammen"><organization></organization><address><postal><street></street>
</postal></address></author><date/>
<area>Internet</area>
<workgroup>Internet Engineering Task Force</workgroup>
<abstract>
<t>This draft offers a specification for embedding macros in existing 3D scenes/assets, to offer simple interactions and configure the renderer further.<br />
Together with URI Fragments, it allows for rich immersive experiences without the need of a complicated sandboxed scripting languages.</t>
<t>Almost every idea in this document is demonstrated at <eref target="https://xrfragment.org">https://xrfragment.org</eref>, as this spec was created during the <eref target="https://xrfragment.org">XR Fragments</eref> spec.</t>
</abstract>
</front>
<middle>
<section anchor="introduction"><name>Introduction</name>
<t>How can we add more features to existing text &amp; 3D scenes, without introducing new dataformats?<br />
Historically, there's many attempts to create the ultimate markuplanguage or 3D fileformat.<br />
Their lowest common denominator is: (co)authoring using plain text.<br />
Therefore, XR Macros allows us to enrich/connect existing dataformats, by offering a polyglot notation based on existing notations:<br />
</t>
<ol spacing="compact">
<li>getting/setting common used 3D properties using querystring- or JSON-notation</li>
<li>querying 3D properties using the lightweight searchengine notation used in <eref target="https://xrfragment.org">XR Fragments</eref></li>
</ol>
<blockquote><t>NOTE: The chapters in this document are ordered from highlevel to lowlevel (technical) as much as possible</t>
</blockquote></section>
<section anchor="core-principle"><name>Core principle</name>
<ol spacing="compact">
<li>XR Macros use querystrings, but are HTML-agnostic (though pseudo-XR Fragment browsers <strong>can</strong> be implemented on top of HTML/Javascript).</li>
<li>XR Macros represents setting/getting common used properties found in all popular 3D frameworks/(game)editors/internet browsers.</li>
<li>XR Macros acts as simple eventhandlers for URI Fragments</li>
</ol>
</section>
<section anchor="conventions-and-definitions"><name>Conventions and Definitions</name>
<t>See appendix below in case certain terms are not clear.</t>
</section>
<section anchor="list-of-xr-macros"><name>List of XR Macros</name>
<t>(XR) Macros can be embedded in 3D assets/scenes.<br />
Macros enrich existing spatial content with a lowcode, limited logic-layer, by recursive (economic) use of the querystring syntax (which search engines and <eref target="https://xrfragment.org">XR Fragments</eref> already uses.<br />
This is done by allowing string/integer variables, and the <tt>|</tt> symbol to roundrobin variable values.<br />
Macros also act as events, so more serious scripting languages can react to them as well.<br />
</t>
<section anchor="usecase-click-object"><name>Usecase: click object</name>
<table>
<thead>
<tr>
<th>custom property</th>
<th>value</th>
<th>trigger when</th>
</tr>
</thead>
<tbody>
<tr>
<td>!clickme</td>
<td>bg=1,1,1&amp;foo=2</td>
<td>object clicked</td>
</tr>
</tbody>
</table></section>
<section anchor="usecase-conditional-click-object"><name>Usecase: conditional click object</name>
<table>
<thead>
<tr>
<th>custom property</th>
<th>value</th>
<th>trigger when</th>
</tr>
</thead>
<tbody>
<tr>
<td>#</td>
<td>foo=1</td>
<td>scene</td>
</tr>
<tr>
<td>!clickme</td>
<td>q=foo&gt;2&amp;bg=1,1,1</td>
<td>object clicked and foo &gt; 2</td>
</tr>
</tbody>
</table><blockquote><t>when a user clicks an object with the custom properties above, it should set the backgroundcolor to <tt>1,1,1</tt> when <tt>foo</tt> is greater than <tt>2</tt> (see previous example)</t>
</blockquote></section>
<section anchor="usecase-click-object-roundrobin"><name>Usecase: click object (roundrobin)</name>
<table>
<thead>
<tr>
<th>custom property</th>
<th>value</th>
<th>trigger when</th>
</tr>
</thead>
<tbody>
<tr>
<td>!clickme</td>
<td>day|noon|night</td>
<td>object clicked</td>
</tr>
<tr>
<td>day</td>
<td>bg=1,1,1</td>
<td>roundrobin</td>
</tr>
<tr>
<td>noon</td>
<td>bg=0.5,0.5,0.5</td>
<td>roundrobin</td>
</tr>
<tr>
<td>night</td>
<td>bg=0,0,0&amp;foo=2</td>
<td>roundrobin</td>
</tr>
</tbody>
</table><blockquote><t>when a user clicks an object with the custom properties above, it should trigger either <tt>day</tt> <tt>noon</tt> or <tt>night</tt> in roundrobin fashion.</t>
</blockquote></section>
<section anchor="usecase-click-object-uri-fragment-and-scene-load"><name>Usecase: click object, URI fragment and scene load</name>
<table>
<thead>
<tr>
<th>custom property</th>
<th>value</th>
<th>trigger when</th>
</tr>
</thead>
<tbody>
<tr>
<td>#</td>
<td>random</td>
<td>scene loaded</td>
</tr>
<tr>
<td>#random</td>
<td>random</td>
<td>URL contains #random</td>
</tr>
<tr>
<td>!random</td>
<td>day|noon|night</td>
<td>#random, # or click</td>
</tr>
<tr>
<td>day</td>
<td>bg=1,1,1</td>
<td>roundrobin</td>
</tr>
<tr>
<td>noon</td>
<td>bg=0.5,0.5,0.5</td>
<td>roundrobin</td>
</tr>
<tr>
<td>night</td>
<td>bg=0,0,0&amp;foo=2</td>
<td>roundrobin</td>
</tr>
</tbody>
</table></section>
<section anchor="usecase-present-context-menu-with-options"><name>Usecase: present context menu with options</name>
<table>
<thead>
<tr>
<th>custom property</th>
<th>value</th>
<th>trigger when</th>
</tr>
</thead>
<tbody>
<tr>
<td>!random</td>
<td>day</td>
<td>noon</td>
</tr>
<tr>
<td>!day</td>
<td>bg=1,1,1</td>
<td>clicked in contextmenu</td>
</tr>
<tr>
<td>!noon</td>
<td>bg=0.5,0.5,0.5</td>
<td>clicked in contextmenu</td>
</tr>
<tr>
<td>!night</td>
<td>bg=0,0,0&amp;foo=2</td>
<td>clicked in contextmenu</td>
</tr>
</tbody>
</table><blockquote><t>The XR Browser should offer a contextmenu with these options when more than one <tt>!</tt>-macro is present on an object.</t>
</blockquote></section>
</section>
<section anchor="security-considerations"><name>Security Considerations</name>
</section>
<section anchor="iana-considerations"><name>IANA Considerations</name>
<t>This document has no IANA actions.</t>
</section>
<section anchor="acknowledgments"><name>Acknowledgments</name>
<ul spacing="compact">
<li><eref target="https://nlnet.nl">NLNET</eref></li>
<li><eref target="https://futureoftext.org">Future of Text</eref></li>
<li><eref target="https://visual-meta.info">visual-meta.info</eref></li>
</ul>
</section>
<section anchor="appendix-definitions"><name>Appendix: Definitions</name>
<table>
<thead>
<tr>
<th>definition</th>
<th>explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td>scene</td>
<td>a (local/remote) 3D scene or 3D file (index.gltf e.g.)</td>
</tr>
<tr>
<td>3D object</td>
<td>an object inside a scene characterized by vertex-, face- and customproperty data.</td>
</tr>
<tr>
<td>XR fragments</td>
<td>URI Fragment with spatial hints like <tt>#pos=0,0,0&amp;t=1,100</tt> e.g.</td>
</tr>
<tr>
<td>query</td>
<td>an URI Fragment-operator which queries object(s) from a scene like <tt>#q=cube</tt></td>
</tr>
<tr>
<td>FPS</td>
<td>frames per second in spatial experiences (games,VR,AR e.g.), should be as high as possible</td>
</tr>
<tr>
<td><tt>◻</tt></td>
<td>ascii representation of an 3D object/mesh</td>
</tr>
<tr>
<td>(un)obtrusive</td>
<td>obtrusive: wrapping human text/thought in XML/HTML/JSON obfuscates human text into a salad of machine-symbols and words</td>
</tr>
</tbody>
</table></section>
</middle>
</rfc>

204
doc/RFC_XR_Text_Fragments.md Normal file
View file

@ -0,0 +1,204 @@
%%%
Title = "XR Macros"
area = "Internet"
workgroup = "Internet Engineering Task Force"
[seriesInfo]
name = "XR-Macros"
value = "draft-XRTEXTFRAGMENTS-leonvankammen-00"
stream = "IETF"
status = "informational"
date = 2023-04-12T00:00:00Z
[[author]]
initials="L.R."
surname="van Kammen"
fullname="L.R. van Kammen"
%%%
<!-- for annotated version see: https://raw.githubusercontent.com/ietf-tools/rfcxml-templates-and-schemas/main/draft-rfcxml-general-template-annotated-00.xml -->
<!--{
<style type="text/css">
body{
font-family: monospace;
max-width: 1000px;
font-size: 15px;
padding: 0% 20%;
line-height: 30px;
color:#555;
background:#F0F0F3
}
h1 { margin-top:40px; }
pre{ line-height:18px; }
a,a:visited,a:active{ color: #70f; }
code{
border: 1px solid #AAA;
border-radius: 3px;
padding: 0px 5px 2px 5px;
}
pre{
line-height: 18px;
overflow: auto;
padding: 12px;
}
pre + code {
background:#DDD;
}
pre>code{
border:none;
border-radius:0px;
padding:0;
}
blockquote{
padding-left: 30px;
margin: 0;
border-left: 5px solid #CCC;
}
th {
border-bottom: 1px solid #000;
text-align: left;
padding-right:45px;
padding-left:7px;
background: #DDD;
}
td {
border-bottom: 1px solid #CCC;
font-size:13px;
}
</style>
<br>
<h1>XR Text Fragments</h1>
<br>
<pre>
stream: IETF
area: Internet
status: informational
author: Leon van Kammen
date: 2023-04-12T00:00:00Z
workgroup: Internet Engineering Task Force
value: draft-XRTEXTFRAGMENTS-leonvankammen-00
</pre>
}-->
.# Abstract
This draft offers a specification for embedding macros in existing 3D scenes/assets, to offer simple interactions and configure the renderer further.<br>
Together with URI Fragments, it allows for rich immersive experiences without the need of a complicated sandboxed scripting languages.
> Almost every idea in this document is demonstrated at [https://xrfragment.org](https://xrfragment.org), as this spec was created during the [XR Fragments](https://xrfragment.org) spec.
{mainmatter}
# Introduction
How can we add more features to existing text & 3D scenes, without introducing new dataformats?<br>
Historically, there's many attempts to create the ultimate markuplanguage or 3D fileformat.<br>
Their lowest common denominator is: (co)authoring using plain text.<br>
Therefore, XR Macros allows us to enrich/connect existing dataformats, by offering a polyglot notation based on existing notations:<br>
1. getting/setting common used 3D properties using querystring- or JSON-notation
1. querying 3D properties using the lightweight searchengine notation used in [XR Fragments](https://xrfragment.org)
> NOTE: The chapters in this document are ordered from highlevel to lowlevel (technical) as much as possible
# Core principle
1. XR Macros use querystrings, but are HTML-agnostic (though pseudo-XR Fragment browsers **can** be implemented on top of HTML/Javascript).
1. XR Macros represents setting/getting common used properties found in all popular 3D frameworks/(game)editors/internet browsers.
1. XR Macros acts as simple eventhandlers for URI Fragments
# Conventions and Definitions
See appendix below in case certain terms are not clear.
# List of XR Macros
(XR) Macros can be embedded in 3D assets/scenes.<br>
Macros enrich existing spatial content with a lowcode, limited logic-layer, by recursive (economic) use of the querystring syntax (which search engines and [XR Fragments](https://xrfragment.org) already uses.<br>
This is done by allowing string/integer variables, and the `|` symbol to roundrobin variable values.<br>
Macros also act as events, so more serious scripting languages can react to them as well.<br>
## Usecase: click object
| custom property | value | trigger when |
|-----------------|--------------------------|------------------------|
| !clickme | bg=1,1,1&foo=2 | object clicked |
## Usecase: conditional click object
| custom property | value | trigger when |
|-----------------|--------------------------|-----------------------------|
| # | foo=1 | scene |
| !clickme | q=foo>2&bg=1,1,1 | object clicked and foo > 2 |
> when a user clicks an object with the custom properties above, it should set the backgroundcolor to `1,1,1` when `foo` is greater than `2` (see previous example)
## Usecase: click object (roundrobin)
| custom property | value | trigger when |
|-----------------|--------------------------|------------------------|
| !clickme | day&#124;noon&#124;night | object clicked |
| day | bg=1,1,1 | roundrobin |
| noon | bg=0.5,0.5,0.5 | roundrobin |
| night | bg=0,0,0&foo=2 | roundrobin |
> when a user clicks an object with the custom properties above, it should trigger either `day` `noon` or `night` in roundrobin fashion.
## Usecase: click object, URI fragment and scene load
| custom property | value | trigger when |
|-----------------|--------------------------|------------------------|
| # | random | scene loaded |
| #random | random | URL contains #random |
| !random | day&#124;noon&#124;night | #random, # or click |
| day | bg=1,1,1 | roundrobin |
| noon | bg=0.5,0.5,0.5 | roundrobin |
| night | bg=0,0,0&foo=2 | roundrobin |
## Usecase: present context menu with options
| custom property | value | trigger when |
|-----------------|--------------------------|------------------------|
| !random | day|noon|night | clicked in contextmenu |
| !day | bg=1,1,1 | clicked in contextmenu |
| !noon | bg=0.5,0.5,0.5 | clicked in contextmenu |
| !night | bg=0,0,0&foo=2 | clicked in contextmenu |
> The XR Browser should offer a contextmenu with these options when more than one `!`-macro is present on an object.
# Security Considerations
# IANA Considerations
This document has no IANA actions.
# Acknowledgments
* [NLNET](https://nlnet.nl)
* [Future of Text](https://futureoftext.org)
* [visual-meta.info](https://visual-meta.info)
# Appendix: Definitions
|definition | explanation |
|----------------------|-------------------------------------------------------------------------------------------------------------------------------|
|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. |
|XR fragments | URI Fragment with spatial hints like `#pos=0,0,0&t=1,100` e.g. |
|query | an URI Fragment-operator which queries object(s) from a scene like `#q=cube` |
|FPS | frames per second in spatial experiences (games,VR,AR e.g.), should be as high as possible |
|`◻` | 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 |