update documentation

This commit is contained in:
Leon van Kammen 2023-04-06 18:37:18 +02:00
parent f646740ab8
commit cf28d036da
2 changed files with 5 additions and 3 deletions

View file

@ -4,7 +4,7 @@
> version 1.0.0 > version 1.0.0
date: 2023-04-06T18:31:24+0200<br> date: 2023-04-06T18:37:15+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
@ -23,7 +23,8 @@ date: 2023-04-06T18:31:24+0200<br>
| Explanation | | | 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. roundrobin of values (in case provided arguments exceeds `n` of `x` for #1) when triggered by browser URI (clicking `href` e.g.)|
| `https://x.co/1.gltf||xyz://x.co/1.gltf` | multi-protocol/fallback urls |
| `.mygroup` | query-alias for `class:mygroup` | | `.mygroup` | query-alias for `class:mygroup` |
> Focus: hasslefree 3D vector-data (`,`), multi-protocol/fallback-linking & dynamic values (`|`), and CSS-piggybacking (`.mygroup`) > Focus: hasslefree 3D vector-data (`,`), multi-protocol/fallback-linking & dynamic values (`|`), and CSS-piggybacking (`.mygroup`)

View file

@ -27,7 +27,8 @@ import xrfragment.Parser;
* | Explanation | | * | 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. roundrobin of values (in case provided arguments exceeds `n` of `x` for #1) when triggered by browser URI (clicking `href` e.g.)|
* | `https://x.co/1.gltf||xyz://x.co/1.gltf` | multi-protocol/fallback urls |
* | `.mygroup` | query-alias for `class:mygroup` | * | `.mygroup` | query-alias for `class:mygroup` |
* *
* > Focus: hasslefree 3D vector-data (`,`), multi-protocol/fallback-linking & dynamic values (`|`), and CSS-piggybacking (`.mygroup`) * > Focus: hasslefree 3D vector-data (`,`), multi-protocol/fallback-linking & dynamic values (`|`), and CSS-piggybacking (`.mygroup`)