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

update documentation

Browse source
This commit is contained in:
Leon van Kammen 2024-04-25 19:26:22 +00:00
parent 29262e3528
commit f6f0431f3b
4 changed files with 149 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
doc/RF6_XR_Fragments.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB

26
doc/RFC_XR_Fragments.html
View file

@ -1538,7 +1538,7 @@ The following demonstrates a simple video player:</p>
<h1 id="additional-scene-metadata">Additional scene metadata</h1> <h1 id="additional-scene-metadata">Additional scene metadata</h1>
<p>XR Fragments does not aim to redefine the metadata-space by introducing its own cataloging-metadata fields. <p>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:</p> Instead, it encourages browsers to scan nodes for the following custom properties:</p>
<ul> <ul>
@ -1623,6 +1623,30 @@ Instead, it encourages browsers to scan nodes for the following custom propertie
<p>These attributes can be scanned and presented during an <code>href</code> or <code>src</code> eye/mouse-over.</p> <p>These attributes can be scanned and presented during an <code>href</code> or <code>src</code> eye/mouse-over.</p>
</blockquote> </blockquote>
<h1 id="accessibility-interface">Accessibility interface</h1>
<p>The addressibility of XR Fragments allows for unique 3D-to-text transcripts, as well as an textual interface to navigate 3D content.<br>
Spec:<br><Br></p>
<ol>
<li>The enduser must be able to enable an accessibility-mode (which persists across application/webpage restarts)</li>
<li>Accessibility-mode must contain a text-input for the user to enter text</li>
<li>Accessibility-mode must contain a flexible textlog for the user to read (via screenreader, screen, or TTS e.g.)</li>
<li>The <code>back</code> command should navigate back to the previous URL (alias for browser-backbutton)</li>
<li>The <code>forward</code> command should navigate back to the next URL (alias for browser-nextbutton)</li>
<li>A destination is a 3D node containing an <code>href</code> with a <code>pos=</code> XR fragment</li>
<li>The <code>go</code> command should list all possible destinations</li>
<li>The <code>go left</code> command should move the camera around 0.3 meters to the left</li>
<li>The <code>go right</code> command should move the camera around 0.3 meters to the right</li>
<li>The <code>go forward</code> command should move the camera 0.3 meters forward (direction of current rotation).</li>
<li>The <code>rotate left</code> command should rotate the camera 0.3 to the left</li>
<li>The <code>rotate left</code> command should rotate the camera 0.3 to the right</li>
<li>The (dynamic) <code>go abc</code> command should navigate to <code>#pos=scene2</code> in case there&rsquo;s a 3D node with name <code>abc</code> and <code>href</code> value <code>#pos=scene2</code></li>
<li>The <code>look</code> command should give an (contextual) 3D-to-text transcript, by scanning the <code>aria-description</code> values of the current <code>pos=</code> value (including its children)</li>
<li>The <code>do</code> command should list all possible <code>href</code> values which don&rsquo;t contain an <code>pos=</code> XR Fragment</li>
<li>The (dynamic) <code>do abc</code> command should navigate/execute <code>https://.../...</code> in case a 3D node exist with name <code>abc</code> and <code>href</code> value <code>https://.../...</code></li>
</ol>
<h1 id="security-considerations">Security Considerations</h1> <h1 id="security-considerations">Security Considerations</h1>
<p>The only dynamic parts are <a href="https://www.w3.org/TR/media-frags/">W3C Media Fragments</a> and <a href="https://www.rfc-editor.org/rfc/rfc6570">URI Templates (RFC6570)</a>.<br> <p>The only dynamic parts are <a href="https://www.w3.org/TR/media-frags/">W3C Media Fragments</a> and <a href="https://www.rfc-editor.org/rfc/rfc6570">URI Templates (RFC6570)</a>.<br>

138
doc/RFC_XR_Fragments.txt
View file

@ -115,12 +115,13 @@ Internet-Draft XR Fragments April 2024
21. Additional scene metadata . . . . . . . . . . . . . . . . . . 35 21. Additional scene metadata . . . . . . . . . . . . . . . . . . 35
22. Security Considerations . . . . . . . . . . . . . . . . . . . 37 22. Accessibility interface . . . . . . . . . . . . . . . . . . . 37
23. FAQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 23. Security Considerations . . . . . . . . . . . . . . . . . . . 37
24. authors . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 24. FAQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
25. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 38 25. authors . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
26. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 38 26. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 38
27. Appendix: Definitions . . . . . . . . . . . . . . . . . . . . 38 27. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 38
28. Appendix: Definitions . . . . . . . . . . . . . . . . . . . . 39
1. Introduction 1. Introduction
@ -164,7 +165,6 @@ Internet-Draft XR Fragments April 2024
van Kammen Expires 27 October 2024 [Page 3] van Kammen Expires 27 October 2024 [Page 3]
Internet-Draft XR Fragments April 2024 Internet-Draft XR Fragments April 2024
@ -1942,10 +1942,10 @@ Internet-Draft XR Fragments April 2024
21. Additional scene metadata 21. Additional scene metadata
XR Fragments does not aim to redefine the metadata-space by XR Fragments does not aim to redefine the metadata-space or
introducing its own cataloging-metadata fields. Instead, it accessibility-space by introducing its own cataloging-metadata
encourages browsers to scan nodes for the following custom fields. Instead, it encourages browsers to scan nodes for the
properties: following custom properties:
* SPDX (https://spdx.dev/) license information * SPDX (https://spdx.dev/) license information
* ARIA (https://www.w3.org/WAI/standards-guidelines/aria/) * ARIA (https://www.w3.org/WAI/standards-guidelines/aria/)
@ -2018,7 +2018,47 @@ van Kammen Expires 27 October 2024 [Page 36]
Internet-Draft XR Fragments April 2024 Internet-Draft XR Fragments April 2024
22. Security Considerations 22. 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>
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 back command should navigate back to the previous URL (alias
for browser-backbutton)
5. The forward command should navigate back to the next URL (alias
for browser-nextbutton)
6. A destination is a 3D node containing an href with a pos= XR
fragment
7. The go command should list all possible destinations
8. The go left command should move the camera around 0.3 meters to
the left
9. The go right command should move the camera around 0.3 meters to
the right
10. The go forward command should move the camera 0.3 meters forward
(direction of current rotation).
11. The rotate left command should rotate the camera 0.3 to the left
12. The rotate left command should rotate the camera 0.3 to the
right
13. The (dynamic) go abc command should navigate to #pos=scene2 in
case there's a 3D node with name abc and href value #pos=scene2
14. The look command should give an (contextual) 3D-to-text
transcript, by scanning the aria-description values of the
current pos= value (including its children)
15. The do command should list all possible href values which don't
contain an pos= XR Fragment
16. The (dynamic) do abc command should navigate/execute
https://.../... in case a 3D node exist with name abc and href
value https://.../...
23. Security Considerations
The only dynamic parts are W3C Media Fragments The only dynamic parts are W3C Media Fragments
(https://www.w3.org/TR/media-frags/) and URI Templates (RFC6570) (https://www.w3.org/TR/media-frags/) and URI Templates (RFC6570)
@ -2026,9 +2066,17 @@ Internet-Draft XR Fragments April 2024
The use of URI Templates is limited to pre-defined variables and The use of URI Templates is limited to pre-defined variables and
Level0 fragments-expansion only, which makes it quite safe. Level0 fragments-expansion only, which makes it quite safe.
In fact, it is much safer than relying on a scripting language In fact, it is much safer than relying on a scripting language
van Kammen Expires 27 October 2024 [Page 37]
Internet-Draft XR Fragments April 2024
(javascript) which can change URN too. (javascript) which can change URN too.
23. FAQ 24. FAQ
*Q:* Why is everything HTTP GET-based, what about POST/PUT/DELETE *Q:* Why is everything HTTP GET-based, what about POST/PUT/DELETE
HATEOS HATEOS
@ -2061,27 +2109,27 @@ Internet-Draft XR Fragments April 2024
place, to 'extend' experiences, in contrast to code/javascript inside place, to 'extend' experiences, in contrast to code/javascript inside
hypermedia documents (this turned out as a hypermedia antipattern). hypermedia documents (this turned out as a hypermedia antipattern).
24. authors 25. authors
* Leon van Kammen (@lvk@mastodon.online) * Leon van Kammen (@lvk@mastodon.online)
* Jens Finkhäuser (@jens@social.finkhaeuser.de) * Jens Finkhäuser (@jens@social.finkhaeuser.de)
26. IANA Considerations
This document has no IANA actions.
27. Acknowledgments
* NLNET (https://nlnet.nl)
* Future of Text (https://futureoftext.org)
van Kammen Expires 27 October 2024 [Page 37] van Kammen Expires 27 October 2024 [Page 38]
Internet-Draft XR Fragments April 2024 Internet-Draft XR Fragments April 2024
25. IANA Considerations
This document has no IANA actions.
26. Acknowledgments
* NLNET (https://nlnet.nl)
* Future of Text (https://futureoftext.org)
* visual-meta.info (https://visual-meta.info) * visual-meta.info (https://visual-meta.info)
* Michiel Leenaars * Michiel Leenaars
* Gerben van der Broeke * Gerben van der Broeke
@ -2093,7 +2141,7 @@ Internet-Draft XR Fragments April 2024
* Brandel Zackernuk * Brandel Zackernuk
* Mark Anderson * Mark Anderson
27. Appendix: Definitions 28. Appendix: Definitions
+=================+=============================================+ +=================+=============================================+
| definition | explanation | | definition | explanation |
@ -2122,14 +2170,6 @@ Internet-Draft XR Fragments April 2024
| | Object(nodes), relevant to machines and a | | | Object(nodes), relevant to machines and a |
| | human minority (academics/developers) | | | human minority (academics/developers) |
+-----------------+---------------------------------------------+ +-----------------+---------------------------------------------+
van Kammen Expires 27 October 2024 [Page 38]
Internet-Draft XR Fragments April 2024
| XR fragment | URI Fragment with spatial hints like | | XR fragment | URI Fragment with spatial hints like |
| | #pos=0,0,0&t=1,100 e.g. | | | #pos=0,0,0&t=1,100 e.g. |
+-----------------+---------------------------------------------+ +-----------------+---------------------------------------------+
@ -2138,6 +2178,14 @@ Internet-Draft XR Fragments April 2024
| the hashbus | hashtags map to camera/scene-projections | | the hashbus | hashtags map to camera/scene-projections |
+-----------------+---------------------------------------------+ +-----------------+---------------------------------------------+
| spacetime | positions camera, triggers scene-preset/ | | spacetime | positions camera, triggers scene-preset/ |
van Kammen Expires 27 October 2024 [Page 39]
Internet-Draft XR Fragments April 2024
| hashtags | time | | hashtags | time |
+-----------------+---------------------------------------------+ +-----------------+---------------------------------------------+
| teleportation | repositioning the enduser to a different | | teleportation | repositioning the enduser to a different |
@ -2178,14 +2226,6 @@ Internet-Draft XR Fragments April 2024
| extrospective | outward sensemaking ("I'm fairly sure John | | extrospective | outward sensemaking ("I'm fairly sure John |
| | is a person who lives in oklahoma") | | | is a person who lives in oklahoma") |
+-----------------+---------------------------------------------+ +-----------------+---------------------------------------------+
van Kammen Expires 27 October 2024 [Page 39]
Internet-Draft XR Fragments April 2024
| ◻ | ascii representation of an 3D object/mesh | | ◻ | ascii representation of an 3D object/mesh |
+-----------------+---------------------------------------------+ +-----------------+---------------------------------------------+
| (un)obtrusive | obtrusive: wrapping human text/thought in | | (un)obtrusive | obtrusive: wrapping human text/thought in |
@ -2194,6 +2234,14 @@ Internet-Draft XR Fragments April 2024
+-----------------+---------------------------------------------+ +-----------------+---------------------------------------------+
| flat 3D object | a 3D object of which all verticies share a | | flat 3D object | a 3D object of which all verticies share a |
| | plane | | | plane |
van Kammen Expires 27 October 2024 [Page 40]
Internet-Draft XR Fragments April 2024
+-----------------+---------------------------------------------+ +-----------------+---------------------------------------------+
| BibTeX | simple tagging/citing/referencing standard | | BibTeX | simple tagging/citing/referencing standard |
| | for plaintext | | | for plaintext |
@ -2237,4 +2285,12 @@ Internet-Draft XR Fragments April 2024
van Kammen Expires 27 October 2024 [Page 40]
van Kammen Expires 27 October 2024 [Page 41]

28
doc/RFC_XR_Fragments.xml
View file

@ -1369,7 +1369,7 @@ The following demonstrates a simple video player:</t>
</section> </section>
<section anchor="additional-scene-metadata"><name>Additional scene metadata</name> <section anchor="additional-scene-metadata"><name>Additional scene metadata</name>
<t>XR Fragments does not aim to redefine the metadata-space by introducing its own cataloging-metadata fields. <t>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:</t> Instead, it encourages browsers to scan nodes for the following custom properties:</t>
<ul spacing="compact"> <ul spacing="compact">
@ -1441,6 +1441,32 @@ Instead, it encourages browsers to scan nodes for the following custom propertie
<blockquote><t>These attributes can be scanned and presented during an <tt>href</tt> or <tt>src</tt> eye/mouse-over.</t> <blockquote><t>These attributes can be scanned and presented during an <tt>href</tt> or <tt>src</tt> eye/mouse-over.</t>
</blockquote></section> </blockquote></section>
<section anchor="accessibility-interface"><name>Accessibility interface</name>
<t>The addressibility of XR Fragments allows for unique 3D-to-text transcripts, as well as an textual interface to navigate 3D content.<br />
Spec:<br />
&lt;Br&gt;</t>
<ol spacing="compact">
<li>The enduser must be able to enable an accessibility-mode (which persists across application/webpage restarts)</li>
<li>Accessibility-mode must contain a text-input for the user to enter text</li>
<li>Accessibility-mode must contain a flexible textlog for the user to read (via screenreader, screen, or TTS e.g.)</li>
<li>The <tt>back</tt> command should navigate back to the previous URL (alias for browser-backbutton)</li>
<li>The <tt>forward</tt> command should navigate back to the next URL (alias for browser-nextbutton)</li>
<li>A destination is a 3D node containing an <tt>href</tt> with a <tt>pos=</tt> XR fragment</li>
<li>The <tt>go</tt> command should list all possible destinations</li>
<li>The <tt>go left</tt> command should move the camera around 0.3 meters to the left</li>
<li>The <tt>go right</tt> command should move the camera around 0.3 meters to the right</li>
<li>The <tt>go forward</tt> command should move the camera 0.3 meters forward (direction of current rotation).</li>
<li>The <tt>rotate left</tt> command should rotate the camera 0.3 to the left</li>
<li>The <tt>rotate left</tt> command should rotate the camera 0.3 to the right</li>
<li>The (dynamic) <tt>go abc</tt> command should navigate to <tt>#pos=scene2</tt> in case there's a 3D node with name <tt>abc</tt> and <tt>href</tt> value <tt>#pos=scene2</tt></li>
<li>The <tt>look</tt> command should give an (contextual) 3D-to-text transcript, by scanning the <tt>aria-description</tt> values of the current <tt>pos=</tt> value (including its children)</li>
<li>The <tt>do</tt> command should list all possible <tt>href</tt> values which don't contain an <tt>pos=</tt> XR Fragment</li>
<li>The (dynamic) <tt>do abc</tt> command should navigate/execute <tt>https://.../...</tt> in case a 3D node exist with name <tt>abc</tt> and <tt>href</tt> value <tt>https://.../...</tt></li>
</ol>
</section>
<section anchor="security-considerations"><name>Security Considerations</name> <section anchor="security-considerations"><name>Security Considerations</name>
<t>The only dynamic parts are <eref target="https://www.w3.org/TR/media-frags/">W3C Media Fragments</eref> and <eref target="https://www.rfc-editor.org/rfc/rfc6570">URI Templates (RFC6570)</eref>.<br /> <t>The only dynamic parts are <eref target="https://www.w3.org/TR/media-frags/">W3C Media Fragments</eref> and <eref target="https://www.rfc-editor.org/rfc/rfc6570">URI Templates (RFC6570)</eref>.<br />