update documentation

This commit is contained in:
Leon van Kammen 2023-04-06 18:31:07 +02:00
parent 59b76123b5
commit 766dc2e9e4
2 changed files with 7 additions and 3 deletions

View file

@ -4,7 +4,7 @@
> version 1.0.0 > version 1.0.0
date: 2023-04-06T18:30:33+0200<br> date: 2023-04-06T18:31:05+0200<br>
[![Actions Status](https://github.com/coderofsalvation/xrfragment/workflows/test/badge.svg)](https://github.com/coderofsalvation/xrfragment/actions) [![Actions Status](https://github.com/coderofsalvation/xrfragment/workflows/test/badge.svg)](https://github.com/coderofsalvation/xrfragment/actions)
# XRFragment Grammar # XRFragment Grammar
@ -18,7 +18,9 @@ date: 2023-04-06T18:30:33+0200<br>
> Example: `://foo.com/my3d.asset#pos=1,0,0&prio=-5&t=0,100|100,200` > Example: `://foo.com/my3d.asset#pos=1,0,0&prio=-5&t=0,100|100,200`
<br>Explanation:<br> <br>
| Explanation | |
|-|-|
| `x=1,2,3` | vector/coordinate argument e.g. | | `x=1,2,3` | vector/coordinate argument e.g. |
| `x=foo\|bar\|1\,2,3\|1.0` | the `\|` character is used for:<br>1.specifying `n` arguments for xrfragment `x`<br>2. fallback urls (`src=https://x.co/f.gltf\|xyz://f.gltf`)<br>3. roundrobin of values (in case provided arguments exceeds `n` of `x` for #1) when triggered by browser URI (clicking `href` e.g.)| | `x=foo\|bar\|1\,2,3\|1.0` | the `\|` character is used for:<br>1.specifying `n` arguments for xrfragment `x`<br>2. fallback urls (`src=https://x.co/f.gltf\|xyz://f.gltf`)<br>3. roundrobin of values (in case provided arguments exceeds `n` of `x` for #1) when triggered by browser URI (clicking `href` e.g.)|
| `.mygroup` | query-alias for `class:mygroup` | | `.mygroup` | query-alias for `class:mygroup` |

View file

@ -22,7 +22,9 @@ import xrfragment.Parser;
* *
* > Example: `://foo.com/my3d.asset#pos=1,0,0&prio=-5&t=0,100|100,200` * > Example: `://foo.com/my3d.asset#pos=1,0,0&prio=-5&t=0,100|100,200`
* *
* <br>Explanation:<br> * <br>
* | Explanation | |
* |-|-|
* | `x=1,2,3` | vector/coordinate argument e.g. | * | `x=1,2,3` | vector/coordinate argument e.g. |
* | `x=foo\|bar\|1\,2,3\|1.0` | the `\|` character is used for:<br>1.specifying `n` arguments for xrfragment `x`<br>2. fallback urls (`src=https://x.co/f.gltf\|xyz://f.gltf`)<br>3. roundrobin of values (in case provided arguments exceeds `n` of `x` for #1) when triggered by browser URI (clicking `href` e.g.)| * | `x=foo\|bar\|1\,2,3\|1.0` | the `\|` character is used for:<br>1.specifying `n` arguments for xrfragment `x`<br>2. fallback urls (`src=https://x.co/f.gltf\|xyz://f.gltf`)<br>3. roundrobin of values (in case provided arguments exceeds `n` of `x` for #1) when triggered by browser URI (clicking `href` e.g.)|
* | `.mygroup` | query-alias for `class:mygroup` | * | `.mygroup` | query-alias for `class:mygroup` |