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

main: update documentation

Browse source
This commit is contained in:
Leon van Kammen 2024-06-17 13:58:13 +00:00
parent ced5383530
commit 92aef6abbe
4 changed files with 151 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/RFC_XR_Fragments.html
View file

@ -1618,8 +1618,7 @@ Spec:<br><Br></p>
<li>The enduser must be able to enable an accessibility-mode (which persists across application/webpage restarts)</li> <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 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>Accessibility-mode must contain a flexible textlog for the user to read (via screenreader, screen, or TTS e.g.)</li>
<li>the textlog contains <code>aria-descriptions</code>, and its narration (Screenreader e.g.) can be skipped (via cycling href&rsquo;s, see next rule)</li> <li>the textlog contains <code>aria-descriptions</code>, and its narration (Screenreader e.g.) can be skipped (via 2-button navigation)</li>
<li>href&rsquo;s can be cycled via tab (keyboard) or &lsquo;skip&rsquo; command</li>
<li>The <code>back</code> command should navigate back to the previous URL (alias for browser-backbutton)</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>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>A destination is a 3D node containing an <code>href</code> with a <code>pos=</code> XR fragment</li>
@ -1635,6 +1634,17 @@ Spec:<br><Br></p>
<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> <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> </ol>
<h2 id="two-button-navigation">Two-button navigation</h2>
<p>For specific user-profiles, gyroscope/mouse/keyboard/audio/visuals will not be available.<br>
Therefore a 2-button navigation-interface is the bare minimum interface:</p>
<ol>
<li>objects with href metadata can be cycled via a key (tab on a keyboard)</li>
<li>objects with href metadata can be activated via a key (enter on a keyboard)</li>
<li>the TTS reads the href-value (and/or aria-description if available)</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>

38
doc/RFC_XR_Fragments.md
View file

@ -1065,23 +1065,31 @@ Spec:<br><Br>
1. The enduser must be able to enable an accessibility-mode (which persists across application/webpage restarts) 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 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.) 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 cycling href's, see next rule) 4. the textlog contains `aria-descriptions`, and its narration (Screenreader e.g.) can be skipped (via 2-button navigation)
5. href's can be cycled via tab (keyboard) or 'skip' command 5. The `back` command should navigate back to the previous URL (alias for browser-backbutton)
6. 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. 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 `pos=` XR fragment
8. A destination is a 3D node containing an `href` with a `pos=` XR fragment 8. The `go` command should list all possible destinations
9. 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 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 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 `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 left 13. The `rotate left` command should rotate the camera 0.3 to the right
14. The `rotate left` command should rotate the camera 0.3 to the right 14. 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`
15. 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` 15. 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)
16. 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) 16. The `do` command should list all possible `href` values which don't contain an `pos=` XR Fragment
17. The `do` command should list all possible `href` values which don't contain an `pos=` 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. 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.<br>
Therefore a 2-button navigation-interface is the bare minimum interface:
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)
# 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).<br> 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).<br>

150
doc/RFC_XR_Fragments.txt
View file

@ -116,12 +116,13 @@ Internet-Draft XR Fragments June 2024
21. Additional scene metadata . . . . . . . . . . . . . . . . . . 35 21. Additional scene metadata . . . . . . . . . . . . . . . . . . 35
22. Accessibility interface . . . . . . . . . . . . . . . . . . . 37 22. Accessibility interface . . . . . . . . . . . . . . . . . . . 37
22.1. Two-button navigation . . . . . . . . . . . . . . . . . 37
23. Security Considerations . . . . . . . . . . . . . . . . . . . 38 23. Security Considerations . . . . . . . . . . . . . . . . . . . 38
24. FAQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 24. FAQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
25. authors . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 25. authors . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
26. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 39 26. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 39
27. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 39 27. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 39
28. Appendix: Definitions . . . . . . . . . . . . . . . . . . . . 39 28. Appendix: Definitions . . . . . . . . . . . . . . . . . . . . 40
1. Introduction 1. Introduction
@ -164,7 +165,6 @@ Internet-Draft XR Fragments June 2024
van Kammen Expires 19 December 2024 [Page 3] van Kammen Expires 19 December 2024 [Page 3]
Internet-Draft XR Fragments June 2024 Internet-Draft XR Fragments June 2024
@ -2032,40 +2032,40 @@ Internet-Draft XR Fragments June 2024
3. Accessibility-mode must contain a flexible textlog for the user 3. Accessibility-mode must contain a flexible textlog for the user
to read (via screenreader, screen, or TTS e.g.) to read (via screenreader, screen, or TTS e.g.)
4. the textlog contains aria-descriptions, and its narration 4. the textlog contains aria-descriptions, and its narration
(Screenreader e.g.) can be skipped (via cycling href's, see next (Screenreader e.g.) can be skipped (via 2-button navigation)
rule) 5. The back command should navigate back to the previous URL (alias
5. href's can be cycled via tab (keyboard) or 'skip' command
6. The back command should navigate back to the previous URL (alias
for browser-backbutton) for browser-backbutton)
7. The forward command should navigate back to the next URL (alias 6. The forward command should navigate back to the next URL (alias
for browser-nextbutton) for browser-nextbutton)
8. A destination is a 3D node containing an href with a pos= XR 7. A destination is a 3D node containing an href with a pos= XR
fragment fragment
9. The go command should list all possible destinations 8. The go command should list all possible destinations
10. The go left command should move the camera around 0.3 meters to 9. The go left command should move the camera around 0.3 meters to
the left the left
11. The go right command should move the camera around 0.3 meters to 10. The go right command should move the camera around 0.3 meters to
the right the right
12. The go forward command should move the camera 0.3 meters forward 11. The go forward command should move the camera 0.3 meters forward
(direction of current rotation). (direction of current rotation).
13. 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 left
14. The rotate left command should rotate the camera 0.3 to the 13. The rotate left command should rotate the camera 0.3 to the
right right
15. The (dynamic) go abc command should navigate to #pos=scene2 in 14. 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 case there's a 3D node with name abc and href value #pos=scene2
16. The look command should give an (contextual) 3D-to-text 15. The look command should give an (contextual) 3D-to-text
transcript, by scanning the aria-description values of the transcript, by scanning the aria-description values of the
current pos= value (including its children) current pos= value (including its children)
17. The do command should list all possible href values which don't 16. The do command should list all possible href values which don't
contain an pos= XR Fragment contain an pos= XR Fragment
18. The (dynamic) do abc command should navigate/execute 17. The (dynamic) do abc command should navigate/execute
https://.../... in case a 3D node exist with name abc and href https://.../... in case a 3D node exist with name abc and href
value https://.../... value https://.../...
22.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:
@ -2074,6 +2074,13 @@ van Kammen Expires 19 December 2024 [Page 37]
Internet-Draft XR Fragments June 2024 Internet-Draft XR Fragments June 2024
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)
23. Security Considerations 23. Security Considerations
The only dynamic parts are W3C Media Fragments The only dynamic parts are W3C Media Fragments
@ -2093,6 +2100,36 @@ Internet-Draft XR Fragments June 2024
(for example, an XR Hypermedia browser can decide to support (for example, an XR Hypermedia browser can decide to support
POST/PUT/DELETE requests for embedded HTML thru src values) POST/PUT/DELETE requests for embedded HTML thru src values)
van Kammen Expires 19 December 2024 [Page 38]
Internet-Draft XR Fragments June 2024
*Q:* Why isn't there support for scripting, URI Template Fragments *Q:* Why isn't there support for scripting, URI Template Fragments
are so limited compared to WASM & javascript *A:* This is out of are so limited compared to WASM & javascript *A:* This is out of
scope as it unhyperifies hypermedia, and this is up to XR hypermedia scope as it unhyperifies hypermedia, and this is up to XR hypermedia
@ -2122,14 +2159,6 @@ Internet-Draft XR Fragments June 2024
* 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)
van Kammen Expires 19 December 2024 [Page 38]
Internet-Draft XR Fragments June 2024
26. IANA Considerations 26. IANA Considerations
This document has no IANA actions. This document has no IANA actions.
@ -2149,6 +2178,14 @@ Internet-Draft XR Fragments June 2024
* Brandel Zackernuk * Brandel Zackernuk
* Mark Anderson * Mark Anderson
van Kammen Expires 19 December 2024 [Page 39]
Internet-Draft XR Fragments June 2024
28. Appendix: Definitions 28. Appendix: Definitions
+=================+=============================================+ +=================+=============================================+
@ -2178,14 +2215,6 @@ Internet-Draft XR Fragments June 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 19 December 2024 [Page 39]
Internet-Draft XR Fragments June 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. |
+-----------------+---------------------------------------------+ +-----------------+---------------------------------------------+
@ -2205,6 +2234,14 @@ Internet-Draft XR Fragments June 2024
| placeholder | a 3D object which with src-metadata (which | | placeholder | a 3D object which with src-metadata (which |
| object | will be replaced by the src-data.) | | object | will be replaced by the src-data.) |
+-----------------+---------------------------------------------+ +-----------------+---------------------------------------------+
van Kammen Expires 19 December 2024 [Page 40]
Internet-Draft XR Fragments June 2024
| src | (HTML-piggybacked) metadata of a 3D object | | src | (HTML-piggybacked) metadata of a 3D object |
| | which instances content | | | which instances content |
+-----------------+---------------------------------------------+ +-----------------+---------------------------------------------+
@ -2234,14 +2271,6 @@ Internet-Draft XR Fragments June 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 19 December 2024 [Page 40]
Internet-Draft XR Fragments June 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 |
@ -2262,6 +2291,13 @@ Internet-Draft XR Fragments June 2024
| | XML | | | XML |
+-----------------+---------------------------------------------+ +-----------------+---------------------------------------------+
van Kammen Expires 19 December 2024 [Page 41]
Internet-Draft XR Fragments June 2024
Table 14 Table 14
@ -2293,4 +2329,24 @@ Internet-Draft XR Fragments June 2024
van Kammen Expires 19 December 2024 [Page 41]
van Kammen Expires 19 December 2024 [Page 42]

15
doc/RFC_XR_Fragments.xml
View file

@ -1439,8 +1439,7 @@ Spec:<br />
<li>The enduser must be able to enable an accessibility-mode (which persists across application/webpage restarts)</li> <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 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>Accessibility-mode must contain a flexible textlog for the user to read (via screenreader, screen, or TTS e.g.)</li>
<li>the textlog contains <tt>aria-descriptions</tt>, and its narration (Screenreader e.g.) can be skipped (via cycling href's, see next rule)</li> <li>the textlog contains <tt>aria-descriptions</tt>, and its narration (Screenreader e.g.) can be skipped (via 2-button navigation)</li>
<li>href's can be cycled via tab (keyboard) or 'skip' command</li>
<li>The <tt>back</tt> command should navigate back to the previous URL (alias for browser-backbutton)</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>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>A destination is a 3D node containing an <tt>href</tt> with a <tt>pos=</tt> XR fragment</li>
@ -1455,6 +1454,18 @@ Spec:<br />
<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 <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> <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> </ol>
<section anchor="two-button-navigation"><name>Two-button navigation</name>
<t>For specific user-profiles, gyroscope/mouse/keyboard/audio/visuals will not be available.<br />
Therefore a 2-button navigation-interface is the bare minimum interface:</t>
<ol spacing="compact">
<li>objects with href metadata can be cycled via a key (tab on a keyboard)</li>
<li>objects with href metadata can be activated via a key (enter on a keyboard)</li>
<li>the TTS reads the href-value (and/or aria-description if available)</li>
</ol>
</section>
</section> </section>
<section anchor="security-considerations"><name>Security Considerations</name> <section anchor="security-considerations"><name>Security Considerations</name>