Documentation update

- syntax reference playing with the format
This commit is contained in:
SebastianMC 2022-10-07 15:24:30 +02:00
parent e912c63a97
commit 35d76447c0
4 changed files with 178 additions and 1 deletions

41
docs/svg/syntax-2.svg Normal file
View File

@ -0,0 +1,41 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg xmlns:xl="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:dc="http://purl.org/dc/elements/1.1/" viewBox="80.5 4.5 280.5 82.5" width="280.5" height="82.5">
<defs/>
<metadata> Produced by OmniGraffle 7.20\n2022-10-07 13:22:34 +0000</metadata>
<g id="syntax-2-1" fill="none" stroke-dasharray="none" stroke="none" fill-opacity="1" stroke-opacity="1">
<title>syntax-2</title>
<g id="syntax-2-1_Layer_1">
<title>Layer 1</title>
<g id="Graphic_154">
<path d="M 91 6 L 350.5 6 C 355.47056 6 359.5 10.029437 359.5 15 L 359.5 76.5 C 359.5 81.47056 355.47056 85.5 350.5 85.5 L 91 85.5 C 86.02944 85.5 82 81.47056 82 76.5 L 82 15 C 82 10.029437 86.02944 6 91 6 Z" fill="white"/>
<path d="M 91 6 L 350.5 6 C 355.47056 6 359.5 10.029437 359.5 15 L 359.5 76.5 C 359.5 81.47056 355.47056 85.5 350.5 85.5 L 91 85.5 C 86.02944 85.5 82 81.47056 82 76.5 L 82 15 C 82 10.029437 86.02944 6 91 6 Z" stroke="#919191" stroke-linecap="round" stroke-linejoin="round" stroke-dasharray="6.0,6.0" stroke-width="3"/>
</g>
<g id="Graphic_159">
<rect x="290" y="31.48163" width="49" height="29.390747" fill="#e9e9e9"/>
</g>
<g id="Graphic_74">
<text transform="translate(91 22.455002)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="5.608" y="13">a section</tspan>
</text>
</g>
<g id="Graphic_160">
<text transform="translate(206 37.981003)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">sorting-spec: \&lt; a-z</tspan>
</text>
</g>
<g id="Line_171">
<path d="M 191 35.177 C 176.29412 35.177 192.47059 46.177 178.5 46.177" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/>
</g>
<g id="Line_172">
<path d="M 191 57.177 C 176.29412 57.177 192.47059 46.177 178.5 46.177" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/>
</g>
<g id="Graphic_178">
<text transform="translate(91 49.423004)" fill="black">
<tspan font-family="Helvetica Neue" font-size="10" fill="black" x="15.29" y="10">simplest </tspan>
<tspan font-family="Helvetica Neue" font-size="10" fill="black" x="15.015" y="22.28">example</tspan>
</text>
</g>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 2.4 KiB

46
docs/svg/syntax-3.svg Normal file
View File

@ -0,0 +1,46 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg xmlns:xl="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:dc="http://purl.org/dc/elements/1.1/" viewBox="75 3.0546265 423 105" width="423" height="105">
<defs/>
<metadata> Produced by OmniGraffle 7.20\n2022-10-07 13:22:34 +0000</metadata>
<g id="syntax-3" fill="none" stroke-dasharray="none" stroke="none" fill-opacity="1" stroke-opacity="1">
<title>syntax-3</title>
<g id="syntax-3_Layer_1">
<title>Layer 1</title>
<g id="Graphic_154">
<path d="M 85.5 4.5546265 L 487.5 4.5546265 C 492.47056 4.5546265 496.5 8.584064 496.5 13.554626 L 496.5 97.55463 C 496.5 102.52519 492.47056 106.55463 487.5 106.55463 L 85.5 106.55463 C 80.52944 106.55463 76.5 102.52519 76.5 97.55463 L 76.5 13.554626 C 76.5 8.584064 80.52944 4.5546265 85.5 4.5546265 Z" fill="white"/>
<path d="M 85.5 4.5546265 L 487.5 4.5546265 C 492.47056 4.5546265 496.5 8.584064 496.5 13.554626 L 496.5 97.55463 C 496.5 102.52519 492.47056 106.55463 487.5 106.55463 L 85.5 106.55463 C 80.52944 106.55463 76.5 102.52519 76.5 97.55463 L 76.5 13.554626 C 76.5 8.584064 80.52944 4.5546265 85.5 4.5546265 Z" stroke="#919191" stroke-linecap="round" stroke-linejoin="round" stroke-dasharray="6.0,6.0" stroke-width="3"/>
</g>
<g id="Graphic_159">
<rect x="197.3795" y="32.109253" width="264.5" height="46.890747" fill="#e9e9e9"/>
</g>
<g id="Graphic_74">
<text transform="translate(91.5 46.278)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="5.608" y="13">a section</tspan>
</text>
</g>
<g id="Graphic_160">
<text transform="translate(206 37.981003)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">target-folder: Reviews/*</tspan>
</text>
</g>
<g id="Line_171">
<path d="M 186.5 32.109253 C 166.5 32.109253 188.5 55.554626 169.5 55.554626" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/>
</g>
<g id="Line_172">
<path d="M 186.5 79 C 166.5 79 188.5 55.554626 169.5 55.554626" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/>
</g>
<g id="Graphic_178">
<text transform="translate(91.5 73.246)" fill="black">
<tspan font-family="Helvetica Neue" font-size="10" fill="black" x="19.37" y="10">typical </tspan>
<tspan font-family="Helvetica Neue" font-size="10" fill="black" x="15.015" y="22.28">example</tspan>
</text>
</g>
<g id="Graphic_179">
<text transform="translate(206 59.804)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">&gt; advanced modified</tspan>
</text>
</g>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 2.8 KiB

87
docs/svg/syntax-4.svg Normal file
View File

@ -0,0 +1,87 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg xmlns:xl="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:dc="http://purl.org/dc/elements/1.1/" viewBox="63.5 12.302002 423 270.198" width="423" height="270.198">
<defs/>
<metadata> Produced by OmniGraffle 7.20\n2022-10-07 13:22:34 +0000</metadata>
<g id="syntax-4" fill="none" stroke-dasharray="none" stroke="none" fill-opacity="1" stroke-opacity="1">
<title>syntax-4</title>
<g id="syntax-4_Layer_1">
<title>Layer 1</title>
<g id="Graphic_154">
<path d="M 74 13.802002 L 476 13.802002 C 480.97056 13.802002 485 17.83144 485 22.802002 L 485 272 C 485 276.97056 480.97056 281 476 281 L 74 281 C 69.02944 281 65 276.97056 65 272 L 65 22.802002 C 65 17.83144 69.02944 13.802002 74 13.802002 Z" fill="white"/>
<path d="M 74 13.802002 L 476 13.802002 C 480.97056 13.802002 485 17.83144 485 22.802002 L 485 272 C 485 276.97056 480.97056 281 476 281 L 74 281 C 69.02944 281 65 276.97056 65 272 L 65 22.802002 C 65 17.83144 69.02944 13.802002 74 13.802002 Z" stroke="#919191" stroke-linecap="round" stroke-linejoin="round" stroke-dasharray="6.0,6.0" stroke-width="3"/>
</g>
<g id="Graphic_159">
<rect x="197.3795" y="32.109253" width="264.5" height="227.89075" fill="#e9e9e9"/>
</g>
<g id="Graphic_74">
<text transform="translate(88 136.554)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="5.608" y="13">a section</tspan>
</text>
</g>
<g id="Graphic_160">
<text transform="translate(206 37.981003)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">target-folder: Meeting minutes</tspan>
</text>
</g>
<g id="Graphic_161">
<text transform="translate(206 57.856)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">target-folder: Archive/...</tspan>
</text>
</g>
<g id="Graphic_162">
<text transform="translate(206 81.856)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">.......... default sorting for the folder(s)</tspan>
</text>
</g>
<g id="Graphic_163">
<text transform="translate(206 103.856)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">.......... group 1 definition</tspan>
</text>
</g>
<g id="Graphic_164">
<text transform="translate(217.79675 125.856)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">.......... sorting within group 1</tspan>
</text>
</g>
<g id="Graphic_165">
<text transform="translate(206 147.856)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">.......... group 2 definition</tspan>
</text>
</g>
<g id="Graphic_166">
<text transform="translate(206 169.856)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">.......... group 3 definition</tspan>
</text>
</g>
<g id="Graphic_167">
<text transform="translate(206 191.856)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">.......... group 4 definition</tspan>
</text>
</g>
<g id="Graphic_168">
<text transform="translate(217.8345 213.856)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">.......... sorting within group 2</tspan>
</text>
</g>
<g id="Graphic_169">
<text transform="translate(206 235.856)" fill="black">
<tspan font-family="Helvetica Neue" font-size="14" fill="black" x="0" y="13">..........</tspan>
</text>
</g>
<g id="Line_171">
<path d="M 184.5 47 C 164.5 47 186.5 145.5 167.5 145.5" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/>
</g>
<g id="Line_172">
<path d="M 184.5 244 C 164.5 244 186.5 145.5 167.5 145.5" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="1"/>
</g>
<g id="Graphic_178">
<text transform="translate(88 157.382)" fill="black">
<tspan font-family="Helvetica Neue" font-size="10" fill="black" x="14.83" y="10">complex </tspan>
<tspan font-family="Helvetica Neue" font-size="10" fill="black" x="15.015" y="22.28">example</tspan>
<tspan font-family="Helvetica Neue" font-size="10" fill="black" x="10.385" y="34.559998">of the idea</tspan>
</text>
</g>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 4.5 KiB

View File

@ -13,7 +13,10 @@ The intention is to make it understandable to non-technical persons.
# The syntax # The syntax
![Visual idea of the syntax](./svg/syntax-1.svg) ![Visual idea of the syntax 1](./svg/syntax-1.svg)
![Visual idea of the syntax 2](./svg/syntax-2.svg)
![Visual idea of the syntax 3](./svg/syntax-3.svg)
![Visual idea of the syntax 4](./svg/syntax-4.svg)
## Sorting specification ## Sorting specification