Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Difference From trunk To v0.10.0
|
2023-01-25
| ||
| 21:42 | Remove support for ZJSON encoding ... (Leaf check-in: 81e47aabc3 user: t73fde tags: trunk) | |
| 21:10 | Increase version to 0.11.0-dev to begin next development cycle ... (check-in: 65f364a414 user: t73fde tags: trunk) | |
|
2023-01-24
| ||
| 21:47 | Version 0.10.0 ... (check-in: b6301cf091 user: stern tags: trunk, release, v0.10.0) | |
| 20:03 | Update to Zettelstore client v0.10.0 ... (check-in: 65115c3a16 user: stern tags: trunk) | |
Changes to VERSION.
|
| | | 1 | 0.10.0 |
Changes to cmd/register.go.
1 | //----------------------------------------------------------------------------- | | | 1 2 3 4 5 6 7 8 9 | //----------------------------------------------------------------------------- // Copyright (c) 2020-2022 Detlef Stern // // This file is part of Zettelstore. // // Zettelstore is licensed under the latest version of the EUPL (European Union // Public License). Please see file LICENSE.txt for your rights and obligations // under this license. //----------------------------------------------------------------------------- |
| ︙ | ︙ | |||
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | _ "zettelstore.de/z/box/dirbox" // Allow to use directory box. _ "zettelstore.de/z/box/filebox" // Allow to use file box. _ "zettelstore.de/z/box/membox" // Allow to use in-memory box. _ "zettelstore.de/z/encoder/htmlenc" // Allow to use HTML encoder. _ "zettelstore.de/z/encoder/mdenc" // Allow to use markdown encoder. _ "zettelstore.de/z/encoder/sexprenc" // Allow to use sexpr encoder. _ "zettelstore.de/z/encoder/textenc" // Allow to use text encoder. _ "zettelstore.de/z/encoder/zmkenc" // Allow to use zmk encoder. _ "zettelstore.de/z/kernel/impl" // Allow kernel implementation to create itself _ "zettelstore.de/z/parser/blob" // Allow to use BLOB parser. _ "zettelstore.de/z/parser/draw" // Allow to use draw parser. _ "zettelstore.de/z/parser/markdown" // Allow to use markdown parser. _ "zettelstore.de/z/parser/none" // Allow to use none parser. _ "zettelstore.de/z/parser/plain" // Allow to use plain parser. _ "zettelstore.de/z/parser/zettelmark" // Allow to use zettelmark parser. ) | > | 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 | _ "zettelstore.de/z/box/dirbox" // Allow to use directory box. _ "zettelstore.de/z/box/filebox" // Allow to use file box. _ "zettelstore.de/z/box/membox" // Allow to use in-memory box. _ "zettelstore.de/z/encoder/htmlenc" // Allow to use HTML encoder. _ "zettelstore.de/z/encoder/mdenc" // Allow to use markdown encoder. _ "zettelstore.de/z/encoder/sexprenc" // Allow to use sexpr encoder. _ "zettelstore.de/z/encoder/textenc" // Allow to use text encoder. _ "zettelstore.de/z/encoder/zjsonenc" // Allow to use ZJSON encoder. _ "zettelstore.de/z/encoder/zmkenc" // Allow to use zmk encoder. _ "zettelstore.de/z/kernel/impl" // Allow kernel implementation to create itself _ "zettelstore.de/z/parser/blob" // Allow to use BLOB parser. _ "zettelstore.de/z/parser/draw" // Allow to use draw parser. _ "zettelstore.de/z/parser/markdown" // Allow to use markdown parser. _ "zettelstore.de/z/parser/none" // Allow to use none parser. _ "zettelstore.de/z/parser/plain" // Allow to use plain parser. _ "zettelstore.de/z/parser/zettelmark" // Allow to use zettelmark parser. ) |
Changes to docs/manual/00001004051200.zettel.
1 2 3 4 5 6 | id: 00001004051200 title: The ''file'' sub-command role: manual tags: #command #configuration #manual #zettelstore syntax: zmk created: 20210126175322 | | > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 | id: 00001004051200 title: The ''file'' sub-command role: manual tags: #command #configuration #manual #zettelstore syntax: zmk created: 20210126175322 modified: 20230109105434 Reads zettel data from a file (or from standard input / stdin) and renders it to standard output / stdout. This allows Zettelstore to render files manually. ``` zettelstore file [-t FORMAT] [file-1 [file-2]] ``` ; ''-t FORMAT'' : Specifies the output format. Supported values are: [[''html''|00001012920510]] (default), [[''md''|00001012920513]], [[''sexpr''|00001012920516]], [[''text''|00001012920519]], [[''zjson''|00001012920503]] (deprecated in v0.11), and [[''zmk''|00001012920522]]. ; ''file-1'' : Specifies the file name, where at least metadata is read. If ''file-2'' is not given, the zettel content is also read from here. ; ''file-2'' : File name where the zettel content is stored. If neither ''file-1'' nor ''file-2'' are given, metadata and zettel content are read from standard input / stdin. |
Changes to docs/manual/00001012920500.zettel.
1 2 3 4 5 6 | id: 00001012920500 title: Encodings available via the [[API|00001012000000]] role: manual tags: #api #manual #reference #zettelstore syntax: zmk created: 20210126175322 | | > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | id: 00001012920500 title: Encodings available via the [[API|00001012000000]] role: manual tags: #api #manual #reference #zettelstore syntax: zmk created: 20210126175322 modified: 20230109104839 A zettel representation can be encoded in various formats for further processing. * [[html|00001012920510]] * [[md|00001012920513]] * [[sexpr|00001012920516]] * [[text|00001012920519]] * [[zjson|00001012920503]] (will be deprecated in v0.11) * [[zmk|00001012920522]] |
Added docs/manual/00001012920503.zettel.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
id: 00001012920503
title: ZJSON Encoding
role: manual
tags: #api #manual #reference #zettelstore
syntax: zmk
created: 20210126175322
modified: 20230109104722
**Note**: ZJSON encoding will be deprecated in v0.11
---
A zettel representation that allows to process the syntactic structure of a zettel.
It is a JSON-based encoding format, but different to the structures returned by using the plain [[endpoint|00001012920000]] ''/z/{ID}''.
For an example, take a look at the ZJSON encoding of this page, which is available via the ""Info"" sub-page of this zettel:
* [[//z/00001012920503?enc=zjson&part=zettel]],
* [[//z/00001012920503?enc=zjson&part=meta]],
* [[//z/00001012920503?enc=zjson&part=content]].
If transferred via HTTP, the content type will be ''application/json''.
A full zettel encoding results in a JSON object with two keys: ''"meta"'' and ''"content"''.
Both values are the same as if you have requested just the appropriate [[part|00001012920800]].
=== Encoding of metadata
Metadata encoding results in a JSON object, where each metadata key is mapped to the same JSON object name.
The associated value is itself a JSON object with two names.
The first name ``""`` references the [[metadata key type|00001006030000]].
Depending on the key type, the other name denotes the value of the metadata element.
The meaning of these names is [[well defined|00001012920582]], as well as the [[mapping of key types to used object names|00001012920584]].
=== Encoding of zettel content
The content encoding results in a JSON array of objects, where each objects represents a Zettelmarkup element.
Every [!zettelmarkup|Zettelmarkup] element is encoded as a JSON object.
These objects always contain the empty name ''""'' with a string value describing the type of Zettelmarkup element.
Depending on the type, other one letter names denotes the details of the element.
The meaning of these names is [[well defined|00001012920588]].
|
Changes to docs/manual/00001012920516.zettel.
1 2 3 4 5 6 | id: 00001012920516 title: Sexpr Encoding role: manual tags: #api #manual #reference #zettelstore syntax: zmk created: 20220422181104 | | > | > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | id: 00001012920516 title: Sexpr Encoding role: manual tags: #api #manual #reference #zettelstore syntax: zmk created: 20220422181104 modified: 20230109104812 A zettel representation that is a [[s-expression|https://en.wikipedia.org/wiki/S-expression]] (also known as symbolic expression). It is an alternative to the [[ZJSON encoding|00001012920503]][^ZJSON will be deprecated in v0.11]. Both encodings are (relatively) easy to parse and contain all relevant information of a zettel, metadata and content. For example, take a look at the Sexpr encoding of this page, which is available via the ""Info"" sub-page of this zettel: * [[//z/00001012920516?enc=sexpr&part=zettel]], * [[//z/00001012920516?enc=sexpr&part=meta]], * [[//z/00001012920516?enc=sexpr&part=content]]. If transferred via HTTP, the content type will be ''text/plain''. |
| ︙ | ︙ |
Added docs/manual/00001012920582.zettel.
> > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | id: 00001012920582 title: ZJSON Encoding: List of Valid Metadata Value Objects Names role: manual tags: #api #manual #reference #zettelstore syntax: zmk modified: 20230109104713 **Note**: ZJSON encoding will be deprecated in v0.11 --- Every Metadata value element is mapped to a JSON object with some well defined names / keys. |=Name | JSON Value | Meaning | ''"\"'' | string | The type of the Zettelmarkup element. | ''"i"'' | array | A sequence of [[inline-structured|00001007040000]] elements. | ''"s"'' | string | The first / major string value of an element. | ''"y"'' | array | A set of string values. |
Added docs/manual/00001012920584.zettel.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 | id: 00001012920584 title: ZJSON Encoding: Mapping of Metadata Key Types to Object Names role: manual tags: #api #manual #reference #zettelstore syntax: zmk modified: 20230109104703 **Note**: ZJSON encoding will be deprecated in v0.11 --- Every [[Metadata key|00001006030000]] is mapped to an [[object name|00001012920582]] where its value is encoded. |=Type | JSON Object Name | Remark | [[Credential|00001006031000]] | ''"s"'' | A string with the decrypted credential. | [[EString|00001006031500]] | ''"s"'' | A possibly empty string. | [[Identifier|00001006032000]] | ''"s"'' | A string containing a [[zettel identifier|00001006050000]]. | [[IdentifierSet|00001006032500]] | ''"y"'' | An array of strings containing [[zettel identifier|00001006050000]]. | [[Number|00001006033000]] | ''"s"'' | A string containing a numeric value. | [[String|00001006033500]] | ''"s"'' | A non-empty string. | [[TagSet|00001006034000]] | ''"y"'' | An array of string containing zettel tags. | [[Timestamp|00001006034500]] | ''"s"'' | A string containing a timestamp in the format YYYYMMDDHHmmSS. | [[URL|00001006035000]] | ''"s"'' | A string containing an URL. | [[Word|00001006035500]] | ''"s"'' | A string containing a word (no space characters) | [[WordSet|00001006036000]] | ''"y"'' | An array of strings containing words. | [[Zettelmarkup|00001006036500]] | ''"i"'' | A sequence of [[inline-structured|00001007040000]] elements. Please note, that metadata is weakly typed. Every metadata key expects a certain type. But the user is free to enter something different. For example, even if the metadata type is ""number"", its value could still be ""abc"". However, the mapping itself is always valid. |
Added docs/manual/00001012920588.zettel.
> > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | id: 00001012920588 title: ZJSON Encoding: List of Valid Zettelmarkup Element Objects Names role: manual tags: #api #manual #reference #zettelstore syntax: zmk modified: 20230109104648 **Note**: ZJSON encoding will be deprecated in v0.11 --- Every [[Zettelmarkup|00001007000000]] element is mapped to a JSON object with some well defined names / keys. |=Name | JSON Value | Meaning | ''"\"'' | string | The type of the Zettelmarkup element. | ''"a"'' | object | Additional attributes of the element. | ''"b"'' | array | A sequence of [[block-structured|00001007030000]] elements. | ''"c"'' | array | A sequence of a sequence of (sub-) list elements or [[inline-structured|00001007040000]] elements. Used for nested lists. | ''"d"'' | array | A sequence of description list elements, where each element is an object of a definition term and a list of descriptions. | ''"e"'' | array | A sequence of descriptions: a JSON array of simple description, which is itself a JSON array of block structured elements. | ''"i"'' | array | A sequence of [[inline-structured|00001007040000]] elements. | ''"j"'' | object | An objects describing a BLOB element. | ''"n"'' | number | A numeric value, e.g. for specifying the [[heading|00001007030300]] level. | ''"o"'' | string | A base64 encoded binary value. Used in some BLOB elements. | ''"p"'' | array | A sequence of two elements: a sequence of [[table|00001007031000]] header value, followed by a sequence of sequence of table row values. | ''"q"'' | string | A second string value, if ''""s""'' is already used. | ''"s"'' | string | The first / major string value of an element. | ''"v"'' | string | A third string value, if ''""q""'' is already used. |
Changes to encoder/encoder_blob_test.go.
| ︙ | ︙ | |||
36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a, 0x00, 0x00, 0x00, 0x0d, 0x49, 0x48, 0x44, 0x52,
0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x08, 0x00, 0x00, 0x00, 0x00, 0x3a, 0x7e, 0x9b,
0x55, 0x00, 0x00, 0x00, 0x0a, 0x49, 0x44, 0x41, 0x54, 0x78, 0x9c, 0x63, 0x62, 0x00, 0x00, 0x00,
0x06, 0x00, 0x03, 0x36, 0x37, 0x7c, 0xa8, 0x00, 0x00, 0x00, 0x00, 0x49, 0x45, 0x4e, 0x44, 0xae,
0x42, 0x60, 0x82,
},
expect: expectMap{
encoderHTML: `<p><img alt="PNG" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAACklEQVR4nGNiAAAABgADNjd8qAAAAABJRU5ErkJggg=="></p>`,
encoderSexpr: `((BLOB ((TEXT "PNG")) "png" "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAACklEQVR4nGNiAAAABgADNjd8qAAAAABJRU5ErkJggg=="))`,
encoderText: "",
encoderZmk: `%% Unable to display BLOB with description 'PNG' and syntax 'png'.`,
},
},
}
| > | 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a, 0x00, 0x00, 0x00, 0x0d, 0x49, 0x48, 0x44, 0x52,
0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x08, 0x00, 0x00, 0x00, 0x00, 0x3a, 0x7e, 0x9b,
0x55, 0x00, 0x00, 0x00, 0x0a, 0x49, 0x44, 0x41, 0x54, 0x78, 0x9c, 0x63, 0x62, 0x00, 0x00, 0x00,
0x06, 0x00, 0x03, 0x36, 0x37, 0x7c, 0xa8, 0x00, 0x00, 0x00, 0x00, 0x49, 0x45, 0x4e, 0x44, 0xae,
0x42, 0x60, 0x82,
},
expect: expectMap{
encoderZJSON: `[{"":"BLOB","q":[{"":"Text","s":"PNG"}],"s":"png","o":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAACklEQVR4nGNiAAAABgADNjd8qAAAAABJRU5ErkJggg=="}]`,
encoderHTML: `<p><img alt="PNG" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAACklEQVR4nGNiAAAABgADNjd8qAAAAABJRU5ErkJggg=="></p>`,
encoderSexpr: `((BLOB ((TEXT "PNG")) "png" "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAACklEQVR4nGNiAAAABgADNjd8qAAAAABJRU5ErkJggg=="))`,
encoderText: "",
encoderZmk: `%% Unable to display BLOB with description 'PNG' and syntax 'png'.`,
},
},
}
|
| ︙ | ︙ |
Changes to encoder/encoder_block_test.go.
1 | //----------------------------------------------------------------------------- | | > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 |
//-----------------------------------------------------------------------------
// Copyright (c) 2021-2022 Detlef Stern
//
// This file is part of Zettelstore.
//
// Zettelstore is licensed under the latest version of the EUPL (European Union
// Public License). Please see file LICENSE.txt for your rights and obligations
// under this license.
//-----------------------------------------------------------------------------
package encoder_test
var tcsBlock = []zmkTestCase{
{
descr: "Empty Zettelmarkup should produce near nothing",
zmk: "",
expect: expectMap{
encoderZJSON: `[]`,
encoderHTML: "",
encoderMD: "",
encoderSexpr: `()`,
encoderText: "",
encoderZmk: useZmk,
},
},
{
descr: "Simple text: Hello, world",
zmk: "Hello, world",
expect: expectMap{
encoderZJSON: `[{"":"Para","i":[{"":"Text","s":"Hello,"},{"":"Space"},{"":"Text","s":"world"}]}]`,
encoderHTML: "<p>Hello, world</p>",
encoderMD: "Hello, world",
encoderSexpr: `((PARA (TEXT "Hello,") (SPACE) (TEXT "world")))`,
encoderText: "Hello, world",
encoderZmk: useZmk,
},
},
{
descr: "Simple block comment",
zmk: "%%%\nNo\nrender\n%%%",
expect: expectMap{
encoderZJSON: `[{"":"CommentBlock","s":"No\nrender"}]`,
encoderHTML: ``,
encoderMD: "",
encoderSexpr: `((VERBATIM-COMMENT () "No\nrender"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Rendered block comment",
zmk: "%%%{-}\nRender\n%%%",
expect: expectMap{
encoderZJSON: `[{"":"CommentBlock","a":{"-":""},"s":"Render"}]`,
encoderHTML: "<!--\nRender\n-->",
encoderMD: "",
encoderSexpr: `((VERBATIM-COMMENT (("-" "")) "Render"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Simple Heading",
zmk: `=== Top`,
expect: expectMap{
encoderZJSON: `[{"":"Heading","n":1,"s":"top","i":[{"":"Text","s":"Top"}]}]`,
encoderHTML: "<h2 id=\"top\">Top</h2>",
encoderMD: "# Top",
encoderSexpr: `((HEADING 1 () "top" "top" (TEXT "Top")))`,
encoderText: `Top`,
encoderZmk: useZmk,
},
},
{
descr: "Simple List",
zmk: "* A\n* B\n* C",
expect: expectMap{
encoderZJSON: `[{"":"Bullet","c":[[{"":"Para","i":[{"":"Text","s":"A"}]}],[{"":"Para","i":[{"":"Text","s":"B"}]}],[{"":"Para","i":[{"":"Text","s":"C"}]}]]}]`,
encoderHTML: "<ul><li>A</li><li>B</li><li>C</li></ul>",
encoderMD: "* A\n* B\n* C",
encoderSexpr: `((UNORDERED ((TEXT "A")) ((TEXT "B")) ((TEXT "C"))))`,
encoderText: "A\nB\nC",
encoderZmk: useZmk,
},
},
{
descr: "Nested List",
zmk: "* T1\n** T2\n* T3\n** T4\n** T5\n* T6",
expect: expectMap{
encoderZJSON: `[{"":"Bullet","c":[[{"":"Para","i":[{"":"Text","s":"T1"}]},{"":"Bullet","c":[[{"":"Para","i":[{"":"Text","s":"T2"}]}]]}],[{"":"Para","i":[{"":"Text","s":"T3"}]},{"":"Bullet","c":[[{"":"Para","i":[{"":"Text","s":"T4"}]}],[{"":"Para","i":[{"":"Text","s":"T5"}]}]]}],[{"":"Para","i":[{"":"Text","s":"T6"}]}]]}]`,
encoderHTML: `<ul><li><p>T1</p><ul><li>T2</li></ul></li><li><p>T3</p><ul><li>T4</li><li>T5</li></ul></li><li><p>T6</p></li></ul>`,
encoderMD: "* T1\n * T2\n* T3\n * T4\n * T5\n* T6",
encoderSexpr: `((UNORDERED ((PARA (TEXT "T1")) (UNORDERED ((TEXT "T2")))) ((PARA (TEXT "T3")) (UNORDERED ((TEXT "T4")) ((TEXT "T5")))) ((PARA (TEXT "T6")))))`,
encoderText: "T1\nT2\nT3\nT4\nT5\nT6",
encoderZmk: useZmk,
},
},
{
descr: "Sequence of two lists",
zmk: "* Item1.1\n* Item1.2\n* Item1.3\n\n* Item2.1\n* Item2.2",
expect: expectMap{
encoderZJSON: `[{"":"Bullet","c":[[{"":"Para","i":[{"":"Text","s":"Item1.1"}]}],[{"":"Para","i":[{"":"Text","s":"Item1.2"}]}],[{"":"Para","i":[{"":"Text","s":"Item1.3"}]}],[{"":"Para","i":[{"":"Text","s":"Item2.1"}]}],[{"":"Para","i":[{"":"Text","s":"Item2.2"}]}]]}]`,
encoderHTML: "<ul><li>Item1.1</li><li>Item1.2</li><li>Item1.3</li><li>Item2.1</li><li>Item2.2</li></ul>",
encoderMD: "* Item1.1\n* Item1.2\n* Item1.3\n* Item2.1\n* Item2.2",
encoderSexpr: `((UNORDERED ((TEXT "Item1.1")) ((TEXT "Item1.2")) ((TEXT "Item1.3")) ((TEXT "Item2.1")) ((TEXT "Item2.2"))))`,
encoderText: "Item1.1\nItem1.2\nItem1.3\nItem2.1\nItem2.2",
encoderZmk: "* Item1.1\n* Item1.2\n* Item1.3\n* Item2.1\n* Item2.2",
},
},
{
descr: "Simple horizontal rule",
zmk: `---`,
expect: expectMap{
encoderZJSON: `[{"":"Thematic"}]`,
encoderHTML: "<hr>",
encoderMD: "---",
encoderSexpr: `((THEMATIC ()))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "No list after paragraph",
zmk: "Text\n*abc",
expect: expectMap{
encoderZJSON: `[{"":"Para","i":[{"":"Text","s":"Text"},{"":"Soft"},{"":"Text","s":"*abc"}]}]`,
encoderHTML: "<p>Text *abc</p>",
encoderMD: "Text\n*abc",
encoderSexpr: `((PARA (TEXT "Text") (SOFT) (TEXT "*abc")))`,
encoderText: `Text *abc`,
encoderZmk: useZmk,
},
},
{
descr: "A list after paragraph",
zmk: "Text\n# abc",
expect: expectMap{
encoderZJSON: `[{"":"Para","i":[{"":"Text","s":"Text"}]},{"":"Ordered","c":[[{"":"Para","i":[{"":"Text","s":"abc"}]}]]}]`,
encoderHTML: "<p>Text</p><ol><li>abc</li></ol>",
encoderMD: "Text\n\n1. abc",
encoderSexpr: `((PARA (TEXT "Text")) (ORDERED ((TEXT "abc"))))`,
encoderText: "Text\nabc",
encoderZmk: useZmk,
},
},
{
descr: "Simple List Quote",
zmk: "> ToBeOrNotToBe",
expect: expectMap{
encoderZJSON: `[{"":"Quotation","c":[[{"":"Para","i":[{"":"Text","s":"ToBeOrNotToBe"}]}]]}]`,
encoderHTML: "<blockquote><p>ToBeOrNotToBe</p></blockquote>",
encoderMD: "> ToBeOrNotToBe",
encoderSexpr: `((QUOTATION ((TEXT "ToBeOrNotToBe"))))`,
encoderText: "ToBeOrNotToBe",
encoderZmk: useZmk,
},
},
{
descr: "Simple Quote Block",
zmk: "<<<\nToBeOrNotToBe\n<<< Romeo",
expect: expectMap{
encoderZJSON: `[{"":"Excerpt","b":[{"":"Para","i":[{"":"Text","s":"ToBeOrNotToBe"}]}],"i":[{"":"Text","s":"Romeo"}]}]`,
encoderHTML: "<blockquote><p>ToBeOrNotToBe</p><cite>Romeo</cite></blockquote>",
encoderMD: "> ToBeOrNotToBe",
encoderSexpr: `((REGION-QUOTE () ((PARA (TEXT "ToBeOrNotToBe"))) ((TEXT "Romeo"))))`,
encoderText: "ToBeOrNotToBe\nRomeo",
encoderZmk: useZmk,
},
},
{
descr: "Quote Block with multiple paragraphs",
zmk: "<<<\nToBeOr\n\nNotToBe\n<<< Romeo",
expect: expectMap{
encoderZJSON: `[{"":"Excerpt","b":[{"":"Para","i":[{"":"Text","s":"ToBeOr"}]},{"":"Para","i":[{"":"Text","s":"NotToBe"}]}],"i":[{"":"Text","s":"Romeo"}]}]`,
encoderHTML: "<blockquote><p>ToBeOr</p><p>NotToBe</p><cite>Romeo</cite></blockquote>",
encoderMD: "> ToBeOr\n\n> NotToBe",
encoderSexpr: `((REGION-QUOTE () ((PARA (TEXT "ToBeOr")) (PARA (TEXT "NotToBe"))) ((TEXT "Romeo"))))`,
encoderText: "ToBeOr\nNotToBe\nRomeo",
encoderZmk: useZmk,
},
},
{
descr: "Verse block",
zmk: `"""
A line
another line
Back
Paragraph
Spacy Para
""" Author`,
expect: expectMap{
encoderZJSON: "[{\"\":\"Poem\",\"b\":[{\"\":\"Para\",\"i\":[{\"\":\"Text\",\"s\":\"A\"},{\"\":\"Space\",\"s\":\"\u00a0\"},{\"\":\"Text\",\"s\":\"line\"},{\"\":\"Hard\"},{\"\":\"Space\",\"s\":\"\u00a0\u00a0\"},{\"\":\"Text\",\"s\":\"another\"},{\"\":\"Space\",\"s\":\"\u00a0\"},{\"\":\"Text\",\"s\":\"line\"},{\"\":\"Hard\"},{\"\":\"Text\",\"s\":\"Back\"}]},{\"\":\"Para\",\"i\":[{\"\":\"Text\",\"s\":\"Paragraph\"}]},{\"\":\"Para\",\"i\":[{\"\":\"Space\",\"s\":\"\u00a0\u00a0\u00a0\u00a0\"},{\"\":\"Text\",\"s\":\"Spacy\"},{\"\":\"Space\",\"s\":\"\u00a0\u00a0\"},{\"\":\"Text\",\"s\":\"Para\"}]}],\"i\":[{\"\":\"Text\",\"s\":\"Author\"}]}]",
encoderHTML: "<div><p>A\u00a0line<br>\u00a0\u00a0another\u00a0line<br>Back</p><p>Paragraph</p><p>\u00a0\u00a0\u00a0\u00a0Spacy\u00a0\u00a0Para</p><cite>Author</cite></div>",
encoderMD: "",
encoderSexpr: "((REGION-VERSE () ((PARA (TEXT \"A\") (SPACE \"\u00a0\") (TEXT \"line\") (HARD) (SPACE \"\u00a0\u00a0\") (TEXT \"another\") (SPACE \"\u00a0\") (TEXT \"line\") (HARD) (TEXT \"Back\")) (PARA (TEXT \"Paragraph\")) (PARA (SPACE \"\u00a0\u00a0\u00a0\u00a0\") (TEXT \"Spacy\") (SPACE \"\u00a0\u00a0\") (TEXT \"Para\"))) ((TEXT \"Author\"))))",
encoderText: "A line\n another line\nBack\nParagraph\n Spacy Para\nAuthor",
encoderZmk: "\"\"\"\nA\u00a0line\\\n\u00a0\u00a0another\u00a0line\\\nBack\nParagraph\n\u00a0\u00a0\u00a0\u00a0Spacy\u00a0\u00a0Para\n\"\"\" Author",
},
},
{
descr: "Span Block",
zmk: `:::
A simple
span
and much more
:::`,
expect: expectMap{
encoderZJSON: `[{"":"Block","b":[{"":"Para","i":[{"":"Text","s":"A"},{"":"Space"},{"":"Text","s":"simple"},{"":"Soft"},{"":"Space"},{"":"Text","s":"span"},{"":"Soft"},{"":"Text","s":"and"},{"":"Space"},{"":"Text","s":"much"},{"":"Space"},{"":"Text","s":"more"}]}]}]`,
encoderHTML: "<div><p>A simple span and much more</p></div>",
encoderMD: "",
encoderSexpr: `((REGION-BLOCK () ((PARA (TEXT "A") (SPACE) (TEXT "simple") (SOFT) (SPACE) (TEXT "span") (SOFT) (TEXT "and") (SPACE) (TEXT "much") (SPACE) (TEXT "more"))) ()))`,
encoderText: `A simple span and much more`,
encoderZmk: useZmk,
},
},
{
descr: "Simple Verbatim Code",
zmk: "```\nHello\nWorld\n```",
expect: expectMap{
encoderZJSON: `[{"":"CodeBlock","s":"Hello\nWorld"}]`,
encoderHTML: "<pre><code>Hello\nWorld</code></pre>",
encoderMD: " Hello\n World",
encoderSexpr: `((VERBATIM-CODE () "Hello\nWorld"))`,
encoderText: "Hello\nWorld",
encoderZmk: useZmk,
},
},
{
descr: "Simple Verbatim Code with visible spaces",
zmk: "```{-}\nHello World\n```",
expect: expectMap{
encoderZJSON: `[{"":"CodeBlock","a":{"-":""},"s":"Hello World"}]`,
encoderHTML: "<pre><code>Hello\u2423World</code></pre>",
encoderMD: " Hello World",
encoderSexpr: `((VERBATIM-CODE (("-" "")) "Hello World"))`,
encoderText: "Hello World",
encoderZmk: useZmk,
},
},
{
descr: "Simple Verbatim Eval",
zmk: "~~~\nHello\nWorld\n~~~",
expect: expectMap{
encoderZJSON: `[{"":"EvalBlock","s":"Hello\nWorld"}]`,
encoderHTML: "<pre><code class=\"zs-eval\">Hello\nWorld</code></pre>",
encoderMD: "",
encoderSexpr: `((VERBATIM-EVAL () "Hello\nWorld"))`,
encoderText: "Hello\nWorld",
encoderZmk: useZmk,
},
},
{
descr: "Simple Verbatim Math",
zmk: "$$$\nHello\n\\LaTeX\n$$$",
expect: expectMap{
encoderZJSON: `[{"":"MathBlock","s":"Hello\n\\LaTeX"}]`,
encoderHTML: "<pre><code class=\"zs-math\">Hello\n\\LaTeX</code></pre>",
encoderMD: "",
encoderSexpr: `((VERBATIM-MATH () "Hello\n\\LaTeX"))`,
encoderText: "Hello\n\\LaTeX",
encoderZmk: useZmk,
},
},
{
descr: "Simple Description List",
zmk: "; Zettel\n: Paper\n: Note\n; Zettelkasten\n: Slip box",
expect: expectMap{
encoderZJSON: `[{"":"Description","d":[{"i":[{"":"Text","s":"Zettel"}],"e":[[{"":"Para","i":[{"":"Text","s":"Paper"}]}],[{"":"Para","i":[{"":"Text","s":"Note"}]}]]},{"i":[{"":"Text","s":"Zettelkasten"}],"e":[[{"":"Para","i":[{"":"Text","s":"Slip"},{"":"Space"},{"":"Text","s":"box"}]}]]}]}]`,
encoderHTML: "<dl><dt>Zettel</dt><dd>Paper</dd><dd>Note</dd><dt>Zettelkasten</dt><dd>Slip box</dd></dl>",
encoderMD: "",
encoderSexpr: `((DESCRIPTION ((TEXT "Zettel")) (((TEXT "Paper")) ((TEXT "Note"))) ((TEXT "Zettelkasten")) (((TEXT "Slip") (SPACE) (TEXT "box")))))`,
encoderText: "Zettel\nPaper\nNote\nZettelkasten\nSlip box",
encoderZmk: useZmk,
},
},
{
descr: "Simple Table",
zmk: "|c1|c2|c3\n|d1||d3",
expect: expectMap{
encoderZJSON: `[{"":"Table","p":[[],[[{"i":[{"":"Text","s":"c1"}]},{"i":[{"":"Text","s":"c2"}]},{"i":[{"":"Text","s":"c3"}]}],[{"i":[{"":"Text","s":"d1"}]},{"i":[]},{"i":[{"":"Text","s":"d3"}]}]]]}]`,
encoderHTML: `<table><tbody><tr><td>c1</td><td>c2</td><td>c3</td></tr><tr><td>d1</td><td></td><td>d3</td></tr></tbody></table>`,
encoderMD: "",
encoderSexpr: `((TABLE () ((CELL (TEXT "c1")) (CELL (TEXT "c2")) (CELL (TEXT "c3"))) ((CELL (TEXT "d1")) (CELL) (CELL (TEXT "d3")))))`,
encoderText: "c1 c2 c3\nd1 d3",
encoderZmk: useZmk,
},
},
{
descr: "Table with alignment and comment",
zmk: `|h1>|=h2|h3:|
|%--+---+---+
|<c1|c2|:c3|
|f1|f2|=f3`,
expect: expectMap{
encoderZJSON: `[{"":"Table","p":[[{"s":">","i":[{"":"Text","s":"h1"}]},{"i":[{"":"Text","s":"h2"}]},{"s":":","i":[{"":"Text","s":"h3"}]}],[[{"s":"<","i":[{"":"Text","s":"c1"}]},{"i":[{"":"Text","s":"c2"}]},{"s":":","i":[{"":"Text","s":"c3"}]}],[{"s":">","i":[{"":"Text","s":"f1"}]},{"i":[{"":"Text","s":"f2"}]},{"s":":","i":[{"":"Text","s":"=f3"}]}]]]}]`,
encoderHTML: `<table><thead><tr><td class="right">h1</td><td>h2</td><td class="center">h3</td></tr></thead><tbody><tr><td class="left">c1</td><td>c2</td><td class="center">c3</td></tr><tr><td class="right">f1</td><td>f2</td><td class="center">=f3</td></tr></tbody></table>`,
encoderMD: "",
encoderSexpr: `((TABLE ((CELL-RIGHT (TEXT "h1")) (CELL (TEXT "h2")) (CELL-CENTER (TEXT "h3"))) ((CELL-LEFT (TEXT "c1")) (CELL (TEXT "c2")) (CELL-CENTER (TEXT "c3"))) ((CELL-RIGHT (TEXT "f1")) (CELL (TEXT "f2")) (CELL-CENTER (TEXT "=f3")))))`,
encoderText: "h1 h2 h3\nc1 c2 c3\nf1 f2 =f3",
encoderZmk: `|=h1>|=h2|=h3:
|<c1|c2|c3
|f1|f2|=f3`,
},
},
{
descr: "Simple Endnotes",
zmk: `Text[^Footnote]`,
expect: expectMap{
encoderZJSON: `[{"":"Para","i":[{"":"Text","s":"Text"},{"":"Footnote","i":[{"":"Text","s":"Footnote"}]}]}]`,
encoderHTML: `<p>Text<sup id="fnref:1"><a class="zs-noteref" href="#fn:1" role="doc-noteref">1</a></sup></p><ol class="zs-endnotes"><li class="zs-endnote" id="fn:1" role="doc-endnote" value="1">Footnote <a class="zs-endnote-backref" href="#fnref:1" role="doc-backlink">↩︎</a></li></ol>`,
encoderMD: "Text",
encoderSexpr: `((PARA (TEXT "Text") (FOOTNOTE () (TEXT "Footnote"))))`,
encoderText: "Text Footnote",
encoderZmk: useZmk,
},
},
{
descr: "Transclusion",
zmk: `{{{http://example.com/image}}}{width="100px"}`,
expect: expectMap{
encoderZJSON: `[{"":"Transclude","a":{"width":"100px"},"q":"external","s":"http://example.com/image"}]`,
encoderHTML: `<p><img class="external" src="http://example.com/image" width="100px"></p>`,
encoderMD: "",
encoderSexpr: `((TRANSCLUDE (("width" "100px")) (EXTERNAL "http://example.com/image")))`,
encoderText: "",
encoderZmk: useZmk,
},
},
{
descr: "A paragraph with a inline comment only should be empty in HTML",
zmk: `%% Comment`,
expect: expectMap{
encoderZJSON: `[{"":"Para","i":[{"":"Comment","s":"Comment"}]}]`,
encoderHTML: ``,
encoderSexpr: `((PARA (LITERAL-COMMENT () "Comment")))`,
encoderText: "",
encoderZmk: useZmk,
},
},
{
descr: "",
zmk: ``,
expect: expectMap{
encoderZJSON: `[]`,
encoderHTML: ``,
encoderSexpr: `()`,
encoderText: "",
encoderZmk: useZmk,
},
},
}
// func TestEncoderBlock(t *testing.T) {
// executeTestCases(t, tcsBlock)
// }
|
Changes to encoder/encoder_inline_test.go.
| ︙ | ︙ | |||
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
package encoder_test
var tcsInline = []zmkTestCase{
{
descr: "Empty Zettelmarkup should produce near nothing (inline)",
zmk: "",
expect: expectMap{
encoderHTML: "",
encoderMD: "",
encoderSexpr: `()`,
encoderText: "",
encoderZmk: useZmk,
},
},
{
descr: "Simple text: Hello, world (inline)",
zmk: `Hello, world`,
expect: expectMap{
encoderHTML: "Hello, world",
encoderMD: "Hello, world",
encoderSexpr: `((TEXT "Hello,") (SPACE) (TEXT "world"))`,
encoderText: "Hello, world",
encoderZmk: useZmk,
},
},
{
descr: "Emphasized formatting",
zmk: "__emph__",
expect: expectMap{
encoderHTML: "<em>emph</em>",
encoderMD: "*emph*",
encoderSexpr: `((FORMAT-EMPH () (TEXT "emph")))`,
encoderText: "emph",
encoderZmk: useZmk,
},
},
{
descr: "Strong formatting",
zmk: "**strong**",
expect: expectMap{
encoderHTML: "<strong>strong</strong>",
encoderMD: "__strong__",
encoderSexpr: `((FORMAT-STRONG () (TEXT "strong")))`,
encoderText: "strong",
encoderZmk: useZmk,
},
},
{
descr: "Insert formatting",
zmk: ">>insert>>",
expect: expectMap{
encoderHTML: "<ins>insert</ins>",
encoderMD: "insert",
encoderSexpr: `((FORMAT-INSERT () (TEXT "insert")))`,
encoderText: "insert",
encoderZmk: useZmk,
},
},
{
descr: "Delete formatting",
zmk: "~~delete~~",
expect: expectMap{
encoderHTML: "<del>delete</del>",
encoderMD: "delete",
encoderSexpr: `((FORMAT-DELETE () (TEXT "delete")))`,
encoderText: "delete",
encoderZmk: useZmk,
},
},
{
descr: "Update formatting",
zmk: "~~old~~>>new>>",
expect: expectMap{
encoderHTML: "<del>old</del><ins>new</ins>",
encoderMD: "oldnew",
encoderSexpr: `((FORMAT-DELETE () (TEXT "old")) (FORMAT-INSERT () (TEXT "new")))`,
encoderText: "oldnew",
encoderZmk: useZmk,
},
},
{
descr: "Superscript formatting",
zmk: "^^superscript^^",
expect: expectMap{
encoderHTML: `<sup>superscript</sup>`,
encoderMD: "superscript",
encoderSexpr: `((FORMAT-SUPER () (TEXT "superscript")))`,
encoderText: `superscript`,
encoderZmk: useZmk,
},
},
{
descr: "Subscript formatting",
zmk: ",,subscript,,",
expect: expectMap{
encoderHTML: `<sub>subscript</sub>`,
encoderMD: "subscript",
encoderSexpr: `((FORMAT-SUB () (TEXT "subscript")))`,
encoderText: `subscript`,
encoderZmk: useZmk,
},
},
{
descr: "Quotes formatting",
zmk: `""quotes""`,
expect: expectMap{
encoderHTML: "<q>quotes</q>",
encoderMD: "<q>quotes</q>",
encoderSexpr: `((FORMAT-QUOTE () (TEXT "quotes")))`,
encoderText: `quotes`,
encoderZmk: useZmk,
},
},
{
descr: "Quotes formatting (german)",
zmk: `""quotes""{lang=de}`,
expect: expectMap{
encoderHTML: `<span lang="de"><q>quotes</q></span>`,
encoderMD: "<q>quotes</q>",
encoderSexpr: `((FORMAT-QUOTE (("lang" "de")) (TEXT "quotes")))`,
encoderText: `quotes`,
encoderZmk: `""quotes""{lang="de"}`,
},
},
{
descr: "Span formatting",
zmk: `::span::`,
expect: expectMap{
encoderHTML: `<span>span</span>`,
encoderMD: "span",
encoderSexpr: `((FORMAT-SPAN () (TEXT "span")))`,
encoderText: `span`,
encoderZmk: useZmk,
},
},
{
descr: "Code formatting",
zmk: "``code``",
expect: expectMap{
encoderHTML: `<code>code</code>`,
encoderMD: "`code`",
encoderSexpr: `((LITERAL-CODE () "code"))`,
encoderText: `code`,
encoderZmk: useZmk,
},
},
{
descr: "Code formatting with visible space",
zmk: "``x y``{-}",
expect: expectMap{
encoderHTML: "<code>x\u2423y</code>",
encoderMD: "`x y`",
encoderSexpr: `((LITERAL-CODE (("-" "")) "x y"))`,
encoderText: `x y`,
encoderZmk: useZmk,
},
},
{
descr: "HTML in Code formatting",
zmk: "``<script `` abc",
expect: expectMap{
encoderHTML: "<code><script </code> abc",
encoderMD: "`<script ` abc",
encoderSexpr: `((LITERAL-CODE () "<script ") (SPACE) (TEXT "abc"))`,
encoderText: `<script abc`,
encoderZmk: useZmk,
},
},
{
descr: "Input formatting",
zmk: `''input''`,
expect: expectMap{
encoderHTML: `<kbd>input</kbd>`,
encoderMD: "input",
encoderSexpr: `((LITERAL-INPUT () "input"))`,
encoderText: `input`,
encoderZmk: useZmk,
},
},
{
descr: "Output formatting",
zmk: `==output==`,
expect: expectMap{
encoderHTML: `<samp>output</samp>`,
encoderMD: "output",
encoderSexpr: `((LITERAL-OUTPUT () "output"))`,
encoderText: `output`,
encoderZmk: useZmk,
},
},
{
descr: "Math formatting",
zmk: `$$\TeX$$`,
expect: expectMap{
encoderHTML: `<code class="zs-math">\TeX</code>`,
encoderMD: "\\TeX",
encoderSexpr: `((LITERAL-MATH () "\\TeX"))`,
encoderText: `\TeX`,
encoderZmk: useZmk,
},
},
{
descr: "Nested Span Quote formatting",
zmk: `::""abc""::{lang=fr}`,
expect: expectMap{
encoderHTML: `<span lang="fr"><q>abc</q></span>`,
encoderMD: "<q>abc</q>",
encoderSexpr: `((FORMAT-SPAN (("lang" "fr")) (FORMAT-QUOTE () (TEXT "abc"))))`,
encoderText: `abc`,
encoderZmk: `::""abc""::{lang="fr"}`,
},
},
{
descr: "Simple Citation",
zmk: `[@Stern18]`,
expect: expectMap{
encoderHTML: `<span>Stern18</span>`, // TODO
encoderMD: "",
encoderSexpr: `((CITE () "Stern18"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "No comment",
zmk: `% comment`,
expect: expectMap{
encoderHTML: `% comment`,
encoderMD: "% comment",
encoderSexpr: `((TEXT "%") (SPACE) (TEXT "comment"))`,
encoderText: `% comment`,
encoderZmk: useZmk,
},
},
{
descr: "Line comment (nogen HTML)",
zmk: `%% line comment`,
expect: expectMap{
encoderHTML: ``,
encoderMD: "",
encoderSexpr: `((LITERAL-COMMENT () "line comment"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Line comment",
zmk: `%%{-} line comment`,
expect: expectMap{
encoderHTML: `<!-- line comment -->`,
encoderMD: "",
encoderSexpr: `((LITERAL-COMMENT (("-" "")) "line comment"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Comment after text",
zmk: `Text %%{-} comment`,
expect: expectMap{
encoderHTML: `Text<!-- comment -->`,
encoderMD: "Text",
encoderSexpr: `((TEXT "Text") (LITERAL-COMMENT (("-" "")) "comment"))`,
encoderText: `Text`,
encoderZmk: useZmk,
},
},
{
descr: "Comment after text and with -->",
zmk: `Text %%{-} comment --> end`,
expect: expectMap{
encoderHTML: `Text<!-- comment --> end -->`,
encoderMD: "Text",
encoderSexpr: `((TEXT "Text") (LITERAL-COMMENT (("-" "")) "comment --> end"))`,
encoderText: `Text`,
encoderZmk: useZmk,
},
},
{
descr: "Simple footnote",
zmk: `[^footnote]`,
expect: expectMap{
encoderHTML: `<sup id="fnref:1"><a class="zs-noteref" href="#fn:1" role="doc-noteref">1</a></sup>`,
encoderMD: "",
encoderSexpr: `((FOOTNOTE () (TEXT "footnote")))`,
encoderText: `footnote`,
encoderZmk: useZmk,
},
},
{
descr: "Simple mark",
zmk: `[!mark]`,
expect: expectMap{
encoderHTML: `<a id="mark"></a>`,
encoderMD: "",
encoderSexpr: `((MARK "mark" "mark" "mark"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Mark with text",
zmk: `[!mark|with text]`,
expect: expectMap{
encoderHTML: `<a id="mark">with text</a>`,
encoderMD: "with text",
encoderSexpr: `((MARK "mark" "mark" "mark" (TEXT "with") (SPACE) (TEXT "text")))`,
encoderText: `with text`,
encoderZmk: useZmk,
},
},
{
descr: "Dummy Link",
zmk: `[[abc]]`,
expect: expectMap{
encoderHTML: `<a class="external" href="abc">abc</a>`,
encoderMD: "[abc](abc)",
encoderSexpr: `((LINK-EXTERNAL () "abc"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Simple URL",
zmk: `[[https://zettelstore.de]]`,
expect: expectMap{
encoderHTML: `<a class="external" href="https://zettelstore.de">https://zettelstore.de</a>`,
encoderMD: "<https://zettelstore.de>",
encoderSexpr: `((LINK-EXTERNAL () "https://zettelstore.de"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "URL with Text",
zmk: `[[Home|https://zettelstore.de]]`,
expect: expectMap{
encoderHTML: `<a class="external" href="https://zettelstore.de">Home</a>`,
encoderMD: "[Home](https://zettelstore.de)",
encoderSexpr: `((LINK-EXTERNAL () "https://zettelstore.de" (TEXT "Home")))`,
encoderText: `Home`,
encoderZmk: useZmk,
},
},
{
descr: "Simple Zettel ID",
zmk: `[[00000000000100]]`,
expect: expectMap{
encoderHTML: `<a href="00000000000100">00000000000100</a>`,
encoderMD: "[00000000000100](00000000000100)",
encoderSexpr: `((LINK-ZETTEL () "00000000000100"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Zettel ID with Text",
zmk: `[[Config|00000000000100]]`,
expect: expectMap{
encoderHTML: `<a href="00000000000100">Config</a>`,
encoderMD: "[Config](00000000000100)",
encoderSexpr: `((LINK-ZETTEL () "00000000000100" (TEXT "Config")))`,
encoderText: `Config`,
encoderZmk: useZmk,
},
},
{
descr: "Simple Zettel ID with fragment",
zmk: `[[00000000000100#frag]]`,
expect: expectMap{
encoderHTML: `<a href="00000000000100#frag">00000000000100#frag</a>`,
encoderMD: "[00000000000100#frag](00000000000100#frag)",
encoderSexpr: `((LINK-ZETTEL () "00000000000100#frag"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Zettel ID with Text and fragment",
zmk: `[[Config|00000000000100#frag]]`,
expect: expectMap{
encoderHTML: `<a href="00000000000100#frag">Config</a>`,
encoderMD: "[Config](00000000000100#frag)",
encoderSexpr: `((LINK-ZETTEL () "00000000000100#frag" (TEXT "Config")))`,
encoderText: `Config`,
encoderZmk: useZmk,
},
},
{
descr: "Fragment link to self",
zmk: `[[#frag]]`,
expect: expectMap{
encoderHTML: `<a href="#frag">#frag</a>`,
encoderMD: "[#frag](#frag)",
encoderSexpr: `((LINK-SELF () "#frag"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Hosted link",
zmk: `[[H|/hosted]]`,
expect: expectMap{
encoderHTML: `<a href="/hosted">H</a>`,
encoderMD: "[H](/hosted)",
encoderSexpr: `((LINK-HOSTED () "/hosted" (TEXT "H")))`,
encoderText: `H`,
encoderZmk: useZmk,
},
},
{
descr: "Based link",
zmk: `[[B|/based]]`,
expect: expectMap{
encoderHTML: `<a href="/based">B</a>`,
encoderMD: "[B](/based)",
encoderSexpr: `((LINK-HOSTED () "/based" (TEXT "B")))`,
encoderText: `B`,
encoderZmk: useZmk,
},
},
{
descr: "Relative link",
zmk: `[[R|../relative]]`,
expect: expectMap{
encoderHTML: `<a href="../relative">R</a>`,
encoderMD: "[R](../relative)",
encoderSexpr: `((LINK-HOSTED () "../relative" (TEXT "R")))`,
encoderText: `R`,
encoderZmk: useZmk,
},
},
{
descr: "Query link w/o text",
zmk: `[[query:title:syntax]]`,
expect: expectMap{
encoderHTML: `<a href="?q=title%3Asyntax">title:syntax</a>`,
encoderMD: "",
encoderSexpr: `((LINK-QUERY () "title:syntax"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Query link with text",
zmk: `[[Q|query:title:syntax]]`,
expect: expectMap{
encoderHTML: `<a href="?q=title%3Asyntax">Q</a>`,
encoderMD: "Q",
encoderSexpr: `((LINK-QUERY () "title:syntax" (TEXT "Q")))`,
encoderText: `Q`,
encoderZmk: useZmk,
},
},
{
descr: "Dummy Embed",
zmk: `{{abc}}`,
expect: expectMap{
encoderHTML: `<img alt="alternate description missing" src="abc">`,
encoderMD: "",
encoderSexpr: `((EMBED () (EXTERNAL "abc") ""))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Inline HTML Zettel",
zmk: `@@<hr>@@{="html"}`,
expect: expectMap{
encoderHTML: ``,
encoderMD: "",
encoderSexpr: `()`,
encoderText: ``,
encoderZmk: ``,
},
},
{
descr: "Inline Text Zettel",
zmk: `@@<hr>@@{="text"}`,
expect: expectMap{
encoderHTML: ``,
encoderMD: "<hr>",
encoderSexpr: `((LITERAL-ZETTEL (("" "text")) "<hr>"))`,
encoderText: `<hr>`,
encoderZmk: useZmk,
},
},
{
descr: "",
zmk: ``,
expect: expectMap{
encoderHTML: ``,
encoderMD: "",
encoderSexpr: `()`,
encoderText: ``,
encoderZmk: useZmk,
},
},
}
| > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 |
package encoder_test
var tcsInline = []zmkTestCase{
{
descr: "Empty Zettelmarkup should produce near nothing (inline)",
zmk: "",
expect: expectMap{
encoderZJSON: `[]`,
encoderHTML: "",
encoderMD: "",
encoderSexpr: `()`,
encoderText: "",
encoderZmk: useZmk,
},
},
{
descr: "Simple text: Hello, world (inline)",
zmk: `Hello, world`,
expect: expectMap{
encoderZJSON: `[{"":"Text","s":"Hello,"},{"":"Space"},{"":"Text","s":"world"}]`,
encoderHTML: "Hello, world",
encoderMD: "Hello, world",
encoderSexpr: `((TEXT "Hello,") (SPACE) (TEXT "world"))`,
encoderText: "Hello, world",
encoderZmk: useZmk,
},
},
{
descr: "Emphasized formatting",
zmk: "__emph__",
expect: expectMap{
encoderZJSON: `[{"":"Emph","i":[{"":"Text","s":"emph"}]}]`,
encoderHTML: "<em>emph</em>",
encoderMD: "*emph*",
encoderSexpr: `((FORMAT-EMPH () (TEXT "emph")))`,
encoderText: "emph",
encoderZmk: useZmk,
},
},
{
descr: "Strong formatting",
zmk: "**strong**",
expect: expectMap{
encoderZJSON: `[{"":"Strong","i":[{"":"Text","s":"strong"}]}]`,
encoderHTML: "<strong>strong</strong>",
encoderMD: "__strong__",
encoderSexpr: `((FORMAT-STRONG () (TEXT "strong")))`,
encoderText: "strong",
encoderZmk: useZmk,
},
},
{
descr: "Insert formatting",
zmk: ">>insert>>",
expect: expectMap{
encoderZJSON: `[{"":"Insert","i":[{"":"Text","s":"insert"}]}]`,
encoderHTML: "<ins>insert</ins>",
encoderMD: "insert",
encoderSexpr: `((FORMAT-INSERT () (TEXT "insert")))`,
encoderText: "insert",
encoderZmk: useZmk,
},
},
{
descr: "Delete formatting",
zmk: "~~delete~~",
expect: expectMap{
encoderZJSON: `[{"":"Delete","i":[{"":"Text","s":"delete"}]}]`,
encoderHTML: "<del>delete</del>",
encoderMD: "delete",
encoderSexpr: `((FORMAT-DELETE () (TEXT "delete")))`,
encoderText: "delete",
encoderZmk: useZmk,
},
},
{
descr: "Update formatting",
zmk: "~~old~~>>new>>",
expect: expectMap{
encoderZJSON: `[{"":"Delete","i":[{"":"Text","s":"old"}]},{"":"Insert","i":[{"":"Text","s":"new"}]}]`,
encoderHTML: "<del>old</del><ins>new</ins>",
encoderMD: "oldnew",
encoderSexpr: `((FORMAT-DELETE () (TEXT "old")) (FORMAT-INSERT () (TEXT "new")))`,
encoderText: "oldnew",
encoderZmk: useZmk,
},
},
{
descr: "Superscript formatting",
zmk: "^^superscript^^",
expect: expectMap{
encoderZJSON: `[{"":"Super","i":[{"":"Text","s":"superscript"}]}]`,
encoderHTML: `<sup>superscript</sup>`,
encoderMD: "superscript",
encoderSexpr: `((FORMAT-SUPER () (TEXT "superscript")))`,
encoderText: `superscript`,
encoderZmk: useZmk,
},
},
{
descr: "Subscript formatting",
zmk: ",,subscript,,",
expect: expectMap{
encoderZJSON: `[{"":"Sub","i":[{"":"Text","s":"subscript"}]}]`,
encoderHTML: `<sub>subscript</sub>`,
encoderMD: "subscript",
encoderSexpr: `((FORMAT-SUB () (TEXT "subscript")))`,
encoderText: `subscript`,
encoderZmk: useZmk,
},
},
{
descr: "Quotes formatting",
zmk: `""quotes""`,
expect: expectMap{
encoderZJSON: `[{"":"Quote","i":[{"":"Text","s":"quotes"}]}]`,
encoderHTML: "<q>quotes</q>",
encoderMD: "<q>quotes</q>",
encoderSexpr: `((FORMAT-QUOTE () (TEXT "quotes")))`,
encoderText: `quotes`,
encoderZmk: useZmk,
},
},
{
descr: "Quotes formatting (german)",
zmk: `""quotes""{lang=de}`,
expect: expectMap{
encoderZJSON: `[{"":"Quote","a":{"lang":"de"},"i":[{"":"Text","s":"quotes"}]}]`,
encoderHTML: `<span lang="de"><q>quotes</q></span>`,
encoderMD: "<q>quotes</q>",
encoderSexpr: `((FORMAT-QUOTE (("lang" "de")) (TEXT "quotes")))`,
encoderText: `quotes`,
encoderZmk: `""quotes""{lang="de"}`,
},
},
{
descr: "Span formatting",
zmk: `::span::`,
expect: expectMap{
encoderZJSON: `[{"":"Span","i":[{"":"Text","s":"span"}]}]`,
encoderHTML: `<span>span</span>`,
encoderMD: "span",
encoderSexpr: `((FORMAT-SPAN () (TEXT "span")))`,
encoderText: `span`,
encoderZmk: useZmk,
},
},
{
descr: "Code formatting",
zmk: "``code``",
expect: expectMap{
encoderZJSON: `[{"":"Code","s":"code"}]`,
encoderHTML: `<code>code</code>`,
encoderMD: "`code`",
encoderSexpr: `((LITERAL-CODE () "code"))`,
encoderText: `code`,
encoderZmk: useZmk,
},
},
{
descr: "Code formatting with visible space",
zmk: "``x y``{-}",
expect: expectMap{
encoderZJSON: `[{"":"Code","a":{"-":""},"s":"x y"}]`,
encoderHTML: "<code>x\u2423y</code>",
encoderMD: "`x y`",
encoderSexpr: `((LITERAL-CODE (("-" "")) "x y"))`,
encoderText: `x y`,
encoderZmk: useZmk,
},
},
{
descr: "HTML in Code formatting",
zmk: "``<script `` abc",
expect: expectMap{
encoderZJSON: `[{"":"Code","s":"<script "},{"":"Space"},{"":"Text","s":"abc"}]`,
encoderHTML: "<code><script </code> abc",
encoderMD: "`<script ` abc",
encoderSexpr: `((LITERAL-CODE () "<script ") (SPACE) (TEXT "abc"))`,
encoderText: `<script abc`,
encoderZmk: useZmk,
},
},
{
descr: "Input formatting",
zmk: `''input''`,
expect: expectMap{
encoderZJSON: `[{"":"Input","s":"input"}]`,
encoderHTML: `<kbd>input</kbd>`,
encoderMD: "input",
encoderSexpr: `((LITERAL-INPUT () "input"))`,
encoderText: `input`,
encoderZmk: useZmk,
},
},
{
descr: "Output formatting",
zmk: `==output==`,
expect: expectMap{
encoderZJSON: `[{"":"Output","s":"output"}]`,
encoderHTML: `<samp>output</samp>`,
encoderMD: "output",
encoderSexpr: `((LITERAL-OUTPUT () "output"))`,
encoderText: `output`,
encoderZmk: useZmk,
},
},
{
descr: "Math formatting",
zmk: `$$\TeX$$`,
expect: expectMap{
encoderZJSON: `[{"":"Math","s":"\\TeX"}]`,
encoderHTML: `<code class="zs-math">\TeX</code>`,
encoderMD: "\\TeX",
encoderSexpr: `((LITERAL-MATH () "\\TeX"))`,
encoderText: `\TeX`,
encoderZmk: useZmk,
},
},
{
descr: "Nested Span Quote formatting",
zmk: `::""abc""::{lang=fr}`,
expect: expectMap{
encoderZJSON: `[{"":"Span","a":{"lang":"fr"},"i":[{"":"Quote","i":[{"":"Text","s":"abc"}]}]}]`,
encoderHTML: `<span lang="fr"><q>abc</q></span>`,
encoderMD: "<q>abc</q>",
encoderSexpr: `((FORMAT-SPAN (("lang" "fr")) (FORMAT-QUOTE () (TEXT "abc"))))`,
encoderText: `abc`,
encoderZmk: `::""abc""::{lang="fr"}`,
},
},
{
descr: "Simple Citation",
zmk: `[@Stern18]`,
expect: expectMap{
encoderZJSON: `[{"":"Cite","s":"Stern18"}]`,
encoderHTML: `<span>Stern18</span>`, // TODO
encoderMD: "",
encoderSexpr: `((CITE () "Stern18"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "No comment",
zmk: `% comment`,
expect: expectMap{
encoderZJSON: `[{"":"Text","s":"%"},{"":"Space"},{"":"Text","s":"comment"}]`,
encoderHTML: `% comment`,
encoderMD: "% comment",
encoderSexpr: `((TEXT "%") (SPACE) (TEXT "comment"))`,
encoderText: `% comment`,
encoderZmk: useZmk,
},
},
{
descr: "Line comment (nogen HTML)",
zmk: `%% line comment`,
expect: expectMap{
encoderZJSON: `[{"":"Comment","s":"line comment"}]`,
encoderHTML: ``,
encoderMD: "",
encoderSexpr: `((LITERAL-COMMENT () "line comment"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Line comment",
zmk: `%%{-} line comment`,
expect: expectMap{
encoderZJSON: `[{"":"Comment","a":{"-":""},"s":"line comment"}]`,
encoderHTML: `<!-- line comment -->`,
encoderMD: "",
encoderSexpr: `((LITERAL-COMMENT (("-" "")) "line comment"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Comment after text",
zmk: `Text %%{-} comment`,
expect: expectMap{
encoderZJSON: `[{"":"Text","s":"Text"},{"":"Comment","a":{"-":""},"s":"comment"}]`,
encoderHTML: `Text<!-- comment -->`,
encoderMD: "Text",
encoderSexpr: `((TEXT "Text") (LITERAL-COMMENT (("-" "")) "comment"))`,
encoderText: `Text`,
encoderZmk: useZmk,
},
},
{
descr: "Comment after text and with -->",
zmk: `Text %%{-} comment --> end`,
expect: expectMap{
encoderZJSON: `[{"":"Text","s":"Text"},{"":"Comment","a":{"-":""},"s":"comment --> end"}]`,
encoderHTML: `Text<!-- comment --> end -->`,
encoderMD: "Text",
encoderSexpr: `((TEXT "Text") (LITERAL-COMMENT (("-" "")) "comment --> end"))`,
encoderText: `Text`,
encoderZmk: useZmk,
},
},
{
descr: "Simple footnote",
zmk: `[^footnote]`,
expect: expectMap{
encoderZJSON: `[{"":"Footnote","i":[{"":"Text","s":"footnote"}]}]`,
encoderHTML: `<sup id="fnref:1"><a class="zs-noteref" href="#fn:1" role="doc-noteref">1</a></sup>`,
encoderMD: "",
encoderSexpr: `((FOOTNOTE () (TEXT "footnote")))`,
encoderText: `footnote`,
encoderZmk: useZmk,
},
},
{
descr: "Simple mark",
zmk: `[!mark]`,
expect: expectMap{
encoderZJSON: `[{"":"Mark","s":"mark","q":"mark"}]`,
encoderHTML: `<a id="mark"></a>`,
encoderMD: "",
encoderSexpr: `((MARK "mark" "mark" "mark"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Mark with text",
zmk: `[!mark|with text]`,
expect: expectMap{
encoderZJSON: `[{"":"Mark","s":"mark","q":"mark","i":[{"":"Text","s":"with"},{"":"Space"},{"":"Text","s":"text"}]}]`,
encoderHTML: `<a id="mark">with text</a>`,
encoderMD: "with text",
encoderSexpr: `((MARK "mark" "mark" "mark" (TEXT "with") (SPACE) (TEXT "text")))`,
encoderText: `with text`,
encoderZmk: useZmk,
},
},
{
descr: "Dummy Link",
zmk: `[[abc]]`,
expect: expectMap{
encoderZJSON: `[{"":"Link","q":"external","s":"abc"}]`,
encoderHTML: `<a class="external" href="abc">abc</a>`,
encoderMD: "[abc](abc)",
encoderSexpr: `((LINK-EXTERNAL () "abc"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Simple URL",
zmk: `[[https://zettelstore.de]]`,
expect: expectMap{
encoderZJSON: `[{"":"Link","q":"external","s":"https://zettelstore.de"}]`,
encoderHTML: `<a class="external" href="https://zettelstore.de">https://zettelstore.de</a>`,
encoderMD: "<https://zettelstore.de>",
encoderSexpr: `((LINK-EXTERNAL () "https://zettelstore.de"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "URL with Text",
zmk: `[[Home|https://zettelstore.de]]`,
expect: expectMap{
encoderZJSON: `[{"":"Link","q":"external","s":"https://zettelstore.de","i":[{"":"Text","s":"Home"}]}]`,
encoderHTML: `<a class="external" href="https://zettelstore.de">Home</a>`,
encoderMD: "[Home](https://zettelstore.de)",
encoderSexpr: `((LINK-EXTERNAL () "https://zettelstore.de" (TEXT "Home")))`,
encoderText: `Home`,
encoderZmk: useZmk,
},
},
{
descr: "Simple Zettel ID",
zmk: `[[00000000000100]]`,
expect: expectMap{
encoderZJSON: `[{"":"Link","q":"zettel","s":"00000000000100"}]`,
encoderHTML: `<a href="00000000000100">00000000000100</a>`,
encoderMD: "[00000000000100](00000000000100)",
encoderSexpr: `((LINK-ZETTEL () "00000000000100"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Zettel ID with Text",
zmk: `[[Config|00000000000100]]`,
expect: expectMap{
encoderZJSON: `[{"":"Link","q":"zettel","s":"00000000000100","i":[{"":"Text","s":"Config"}]}]`,
encoderHTML: `<a href="00000000000100">Config</a>`,
encoderMD: "[Config](00000000000100)",
encoderSexpr: `((LINK-ZETTEL () "00000000000100" (TEXT "Config")))`,
encoderText: `Config`,
encoderZmk: useZmk,
},
},
{
descr: "Simple Zettel ID with fragment",
zmk: `[[00000000000100#frag]]`,
expect: expectMap{
encoderZJSON: `[{"":"Link","q":"zettel","s":"00000000000100#frag"}]`,
encoderHTML: `<a href="00000000000100#frag">00000000000100#frag</a>`,
encoderMD: "[00000000000100#frag](00000000000100#frag)",
encoderSexpr: `((LINK-ZETTEL () "00000000000100#frag"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Zettel ID with Text and fragment",
zmk: `[[Config|00000000000100#frag]]`,
expect: expectMap{
encoderZJSON: `[{"":"Link","q":"zettel","s":"00000000000100#frag","i":[{"":"Text","s":"Config"}]}]`,
encoderHTML: `<a href="00000000000100#frag">Config</a>`,
encoderMD: "[Config](00000000000100#frag)",
encoderSexpr: `((LINK-ZETTEL () "00000000000100#frag" (TEXT "Config")))`,
encoderText: `Config`,
encoderZmk: useZmk,
},
},
{
descr: "Fragment link to self",
zmk: `[[#frag]]`,
expect: expectMap{
encoderZJSON: `[{"":"Link","q":"self","s":"#frag"}]`,
encoderHTML: `<a href="#frag">#frag</a>`,
encoderMD: "[#frag](#frag)",
encoderSexpr: `((LINK-SELF () "#frag"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Hosted link",
zmk: `[[H|/hosted]]`,
expect: expectMap{
encoderZJSON: `[{"":"Link","q":"local","s":"/hosted","i":[{"":"Text","s":"H"}]}]`,
encoderHTML: `<a href="/hosted">H</a>`,
encoderMD: "[H](/hosted)",
encoderSexpr: `((LINK-HOSTED () "/hosted" (TEXT "H")))`,
encoderText: `H`,
encoderZmk: useZmk,
},
},
{
descr: "Based link",
zmk: `[[B|/based]]`,
expect: expectMap{
encoderZJSON: `[{"":"Link","q":"local","s":"/based","i":[{"":"Text","s":"B"}]}]`,
encoderHTML: `<a href="/based">B</a>`,
encoderMD: "[B](/based)",
encoderSexpr: `((LINK-HOSTED () "/based" (TEXT "B")))`,
encoderText: `B`,
encoderZmk: useZmk,
},
},
{
descr: "Relative link",
zmk: `[[R|../relative]]`,
expect: expectMap{
encoderZJSON: `[{"":"Link","q":"local","s":"../relative","i":[{"":"Text","s":"R"}]}]`,
encoderHTML: `<a href="../relative">R</a>`,
encoderMD: "[R](../relative)",
encoderSexpr: `((LINK-HOSTED () "../relative" (TEXT "R")))`,
encoderText: `R`,
encoderZmk: useZmk,
},
},
{
descr: "Query link w/o text",
zmk: `[[query:title:syntax]]`,
expect: expectMap{
encoderZJSON: `[{"":"Link","q":"query","s":"title:syntax"}]`,
encoderHTML: `<a href="?q=title%3Asyntax">title:syntax</a>`,
encoderMD: "",
encoderSexpr: `((LINK-QUERY () "title:syntax"))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Query link with text",
zmk: `[[Q|query:title:syntax]]`,
expect: expectMap{
encoderZJSON: `[{"":"Link","q":"query","s":"title:syntax","i":[{"":"Text","s":"Q"}]}]`,
encoderHTML: `<a href="?q=title%3Asyntax">Q</a>`,
encoderMD: "Q",
encoderSexpr: `((LINK-QUERY () "title:syntax" (TEXT "Q")))`,
encoderText: `Q`,
encoderZmk: useZmk,
},
},
{
descr: "Dummy Embed",
zmk: `{{abc}}`,
expect: expectMap{
encoderZJSON: `[{"":"Embed","s":"abc"}]`,
encoderHTML: `<img alt="alternate description missing" src="abc">`,
encoderMD: "",
encoderSexpr: `((EMBED () (EXTERNAL "abc") ""))`,
encoderText: ``,
encoderZmk: useZmk,
},
},
{
descr: "Inline HTML Zettel",
zmk: `@@<hr>@@{="html"}`,
expect: expectMap{
encoderZJSON: `[]`,
encoderHTML: ``,
encoderMD: "",
encoderSexpr: `()`,
encoderText: ``,
encoderZmk: ``,
},
},
{
descr: "Inline Text Zettel",
zmk: `@@<hr>@@{="text"}`,
expect: expectMap{
encoderZJSON: `[{"":"Zettel","a":{"":"text"},"s":"<hr>"}]`,
encoderHTML: ``,
encoderMD: "<hr>",
encoderSexpr: `((LITERAL-ZETTEL (("" "text")) "<hr>"))`,
encoderText: `<hr>`,
encoderZmk: useZmk,
},
},
{
descr: "",
zmk: ``,
expect: expectMap{
encoderZJSON: `[]`,
encoderHTML: ``,
encoderMD: "",
encoderSexpr: `()`,
encoderText: ``,
encoderZmk: useZmk,
},
},
}
|
Changes to encoder/encoder_test.go.
1 | //----------------------------------------------------------------------------- | | | 1 2 3 4 5 6 7 8 9 | //----------------------------------------------------------------------------- // Copyright (c) 2021-2022 Detlef Stern // // This file is part of Zettelstore. // // Zettelstore is licensed under the latest version of the EUPL (European Union // Public License). Please see file LICENSE.txt for your rights and obligations // under this license. //----------------------------------------------------------------------------- |
| ︙ | ︙ | |||
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
"zettelstore.de/z/input"
"zettelstore.de/z/parser"
_ "zettelstore.de/z/encoder/htmlenc" // Allow to use HTML encoder.
_ "zettelstore.de/z/encoder/mdenc" // Allow to use markdown encoder.
_ "zettelstore.de/z/encoder/sexprenc" // Allow to use sexpr encoder.
_ "zettelstore.de/z/encoder/textenc" // Allow to use text encoder.
_ "zettelstore.de/z/encoder/zmkenc" // Allow to use zmk encoder.
"zettelstore.de/z/parser/cleaner"
_ "zettelstore.de/z/parser/zettelmark" // Allow to use zettelmark parser.
)
type zmkTestCase struct {
descr string
zmk string
inline bool
expect expectMap
}
type expectMap map[api.EncodingEnum]string
const useZmk = "\000"
const (
encoderHTML = api.EncoderHTML
encoderMD = api.EncoderMD
encoderSexpr = api.EncoderSexpr
encoderText = api.EncoderText
encoderZmk = api.EncoderZmk
)
| > > | 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
"zettelstore.de/z/input"
"zettelstore.de/z/parser"
_ "zettelstore.de/z/encoder/htmlenc" // Allow to use HTML encoder.
_ "zettelstore.de/z/encoder/mdenc" // Allow to use markdown encoder.
_ "zettelstore.de/z/encoder/sexprenc" // Allow to use sexpr encoder.
_ "zettelstore.de/z/encoder/textenc" // Allow to use text encoder.
_ "zettelstore.de/z/encoder/zjsonenc" // Allow to use ZJSON encoder.
_ "zettelstore.de/z/encoder/zmkenc" // Allow to use zmk encoder.
"zettelstore.de/z/parser/cleaner"
_ "zettelstore.de/z/parser/zettelmark" // Allow to use zettelmark parser.
)
type zmkTestCase struct {
descr string
zmk string
inline bool
expect expectMap
}
type expectMap map[api.EncodingEnum]string
const useZmk = "\000"
const (
encoderZJSON = api.EncoderZJSON
encoderHTML = api.EncoderHTML
encoderMD = api.EncoderMD
encoderSexpr = api.EncoderSexpr
encoderText = api.EncoderText
encoderZmk = api.EncoderZmk
)
|
| ︙ | ︙ |
Added encoder/zjsonenc/zjsonenc.go.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 |
//-----------------------------------------------------------------------------
// Copyright (c) 2020-2023 Detlef Stern
//
// This file is part of Zettelstore.
//
// Zettelstore is licensed under the latest version of the EUPL (European Union
// Public License). Please see file LICENSE.txt for your rights and obligations
// under this license.
//-----------------------------------------------------------------------------
// Package zjsonenc encodes the abstract syntax tree into JSON.
//
// Deprecated in v0.11
package zjsonenc
import (
"fmt"
"io"
"strconv"
"zettelstore.de/c/api"
"zettelstore.de/c/attrs"
"zettelstore.de/c/zjson"
"zettelstore.de/z/ast"
"zettelstore.de/z/domain/meta"
"zettelstore.de/z/encoder"
"zettelstore.de/z/strfun"
)
func init() {
encoder.Register(api.EncoderZJSON, func() encoder.Encoder { return Create() })
}
// Create a ZJSON encoder
func Create() *Encoder { return &myJE }
type Encoder struct{}
var myJE Encoder
// WriteZettel writes the encoded zettel to the writer.
func (*Encoder) WriteZettel(w io.Writer, zn *ast.ZettelNode, evalMeta encoder.EvalMetaFunc) (int, error) {
v := newDetailVisitor(w)
v.b.WriteString(`{"meta":`)
v.writeMeta(zn.InhMeta, evalMeta)
v.b.WriteString(`,"content":`)
ast.Walk(v, &zn.Ast)
v.b.WriteByte('}')
length, err := v.b.Flush()
return length, err
}
// WriteMeta encodes meta data as JSON.
func (*Encoder) WriteMeta(w io.Writer, m *meta.Meta, evalMeta encoder.EvalMetaFunc) (int, error) {
v := newDetailVisitor(w)
v.writeMeta(m, evalMeta)
length, err := v.b.Flush()
return length, err
}
func (je *Encoder) WriteContent(w io.Writer, zn *ast.ZettelNode) (int, error) {
return je.WriteBlocks(w, &zn.Ast)
}
// WriteBlocks writes a block slice to the writer
func (*Encoder) WriteBlocks(w io.Writer, bs *ast.BlockSlice) (int, error) {
v := newDetailVisitor(w)
ast.Walk(v, bs)
length, err := v.b.Flush()
return length, err
}
// WriteInlines writes an inline slice to the writer
func (*Encoder) WriteInlines(w io.Writer, is *ast.InlineSlice) (int, error) {
v := newDetailVisitor(w)
ast.Walk(v, is)
length, err := v.b.Flush()
return length, err
}
// visitor writes the abstract syntax tree to an io.Writer.
type visitor struct {
b encoder.EncWriter
inVerse bool // Visiting a verse block: save spaces in ZJSON object
}
func newDetailVisitor(w io.Writer) *visitor { return &visitor{b: encoder.NewEncWriter(w)} }
func (v *visitor) Visit(node ast.Node) ast.Visitor {
switch n := node.(type) {
case *ast.BlockSlice:
v.visitBlockSlice(n)
return nil
case *ast.InlineSlice:
v.walkInlineSlice(n)
return nil
case *ast.ParaNode:
v.writeNodeStart(zjson.TypeParagraph)
v.writeContentStart(zjson.NameInline)
ast.Walk(v, &n.Inlines)
case *ast.VerbatimNode:
v.visitVerbatim(n)
case *ast.RegionNode:
v.visitRegion(n)
case *ast.HeadingNode:
v.visitHeading(n)
case *ast.HRuleNode:
v.writeNodeStart(zjson.TypeBreakThematic)
v.visitAttributes(n.Attrs)
case *ast.NestedListNode:
v.visitNestedList(n)
case *ast.DescriptionListNode:
v.visitDescriptionList(n)
case *ast.TableNode:
v.visitTable(n)
case *ast.TranscludeNode:
v.writeNodeStart(zjson.TypeTransclude)
v.visitAttributes(n.Attrs)
v.writeContentStart(zjson.NameString2)
writeEscaped(&v.b, mapRefState[n.Ref.State])
v.writeContentStart(zjson.NameString)
writeEscaped(&v.b, n.Ref.String())
case *ast.BLOBNode:
v.visitBLOB(n)
case *ast.TextNode:
v.writeNodeStart(zjson.TypeText)
v.writeContentStart(zjson.NameString)
writeEscaped(&v.b, n.Text)
case *ast.SpaceNode:
v.writeNodeStart(zjson.TypeSpace)
if v.inVerse {
v.writeContentStart(zjson.NameString)
writeEscaped(&v.b, n.Lexeme)
}
case *ast.BreakNode:
if n.Hard {
v.writeNodeStart(zjson.TypeBreakHard)
} else {
v.writeNodeStart(zjson.TypeBreakSoft)
}
case *ast.LinkNode:
v.visitLink(n)
case *ast.EmbedRefNode:
v.visitEmbedRef(n)
case *ast.EmbedBLOBNode:
v.visitEmbedBLOB(n)
case *ast.CiteNode:
v.writeNodeStart(zjson.TypeCitation)
v.visitAttributes(n.Attrs)
v.writeContentStart(zjson.NameString)
writeEscaped(&v.b, n.Key)
if len(n.Inlines) > 0 {
v.writeContentStart(zjson.NameInline)
ast.Walk(v, &n.Inlines)
}
case *ast.FootnoteNode:
v.writeNodeStart(zjson.TypeFootnote)
v.visitAttributes(n.Attrs)
v.writeContentStart(zjson.NameInline)
ast.Walk(v, &n.Inlines)
case *ast.MarkNode:
v.visitMark(n)
case *ast.FormatNode:
v.writeNodeStart(mapFormatKind[n.Kind])
v.visitAttributes(n.Attrs)
v.writeContentStart(zjson.NameInline)
ast.Walk(v, &n.Inlines)
case *ast.LiteralNode:
kind, ok := mapLiteralKind[n.Kind]
if !ok {
panic(fmt.Sprintf("Unknown literal kind %v", n.Kind))
}
v.writeNodeStart(kind)
v.visitAttributes(n.Attrs)
v.writeContentStart(zjson.NameString)
writeEscaped(&v.b, string(n.Content))
default:
return v
}
v.b.WriteByte('}')
return nil
}
var mapVerbatimKind = map[ast.VerbatimKind]string{
ast.VerbatimZettel: zjson.TypeVerbatimZettel,
ast.VerbatimProg: zjson.TypeVerbatimCode,
ast.VerbatimEval: zjson.TypeVerbatimEval,
ast.VerbatimMath: zjson.TypeVerbatimMath,
ast.VerbatimComment: zjson.TypeVerbatimComment,
ast.VerbatimHTML: zjson.TypeVerbatimHTML,
}
func (v *visitor) visitVerbatim(vn *ast.VerbatimNode) {
kind, ok := mapVerbatimKind[vn.Kind]
if !ok {
panic(fmt.Sprintf("Unknown verbatim kind %v", vn.Kind))
}
v.writeNodeStart(kind)
v.visitAttributes(vn.Attrs)
v.writeContentStart(zjson.NameString)
writeEscaped(&v.b, string(vn.Content))
}
var mapRegionKind = map[ast.RegionKind]string{
ast.RegionSpan: zjson.TypeBlock,
ast.RegionQuote: zjson.TypeExcerpt,
ast.RegionVerse: zjson.TypePoem,
}
func (v *visitor) visitRegion(rn *ast.RegionNode) {
kind, ok := mapRegionKind[rn.Kind]
if !ok {
panic(fmt.Sprintf("Unknown region kind %v", rn.Kind))
}
saveInVerse := v.inVerse
if rn.Kind == ast.RegionVerse {
v.inVerse = true
}
v.writeNodeStart(kind)
v.visitAttributes(rn.Attrs)
v.writeContentStart(zjson.NameBlock)
ast.Walk(v, &rn.Blocks)
if len(rn.Inlines) > 0 {
v.writeContentStart(zjson.NameInline)
ast.Walk(v, &rn.Inlines)
}
v.inVerse = saveInVerse
}
func (v *visitor) visitHeading(hn *ast.HeadingNode) {
v.writeNodeStart(zjson.TypeHeading)
v.visitAttributes(hn.Attrs)
v.writeContentStart(zjson.NameNumeric)
v.b.WriteString(strconv.Itoa(hn.Level))
if fragment := hn.Fragment; fragment != "" {
v.writeContentStart(zjson.NameString)
v.b.WriteStrings(`"`, fragment, `"`)
}
v.writeContentStart(zjson.NameInline)
ast.Walk(v, &hn.Inlines)
}
var mapNestedListKind = map[ast.NestedListKind]string{
ast.NestedListOrdered: zjson.TypeListOrdered,
ast.NestedListUnordered: zjson.TypeListBullet,
ast.NestedListQuote: zjson.TypeListQuotation,
}
func (v *visitor) visitNestedList(ln *ast.NestedListNode) {
v.writeNodeStart(mapNestedListKind[ln.Kind])
v.writeContentStart(zjson.NameList)
for i, item := range ln.Items {
v.writeComma(i)
v.b.WriteByte('[')
for j, in := range item {
v.writeComma(j)
ast.Walk(v, in)
}
v.b.WriteByte(']')
}
v.b.WriteByte(']')
}
func (v *visitor) visitDescriptionList(dn *ast.DescriptionListNode) {
v.writeNodeStart(zjson.TypeDescrList)
v.writeContentStart(zjson.NameDescrList)
for i, def := range dn.Descriptions {
v.writeComma(i)
v.b.WriteStrings(`{"`, zjson.NameInline, `":`)
ast.Walk(v, &def.Term)
if len(def.Descriptions) > 0 {
v.writeContentStart(zjson.NameDescription)
for j, b := range def.Descriptions {
v.writeComma(j)
v.b.WriteByte('[')
for k, dn := range b {
v.writeComma(k)
ast.Walk(v, dn)
}
v.b.WriteByte(']')
}
v.b.WriteByte(']')
}
v.b.WriteByte('}')
}
v.b.WriteByte(']')
}
func (v *visitor) visitTable(tn *ast.TableNode) {
v.writeNodeStart(zjson.TypeTable)
v.writeContentStart(zjson.NameTable)
// Table header
v.b.WriteByte('[')
for i, cell := range tn.Header {
v.writeComma(i)
v.writeCell(cell)
}
v.b.WriteString("],")
// Table rows
v.b.WriteByte('[')
for i, row := range tn.Rows {
v.writeComma(i)
v.b.WriteByte('[')
for j, cell := range row {
v.writeComma(j)
v.writeCell(cell)
}
v.b.WriteByte(']')
}
v.b.WriteString("]]")
}
var alignmentCode = map[ast.Alignment]string{
ast.AlignDefault: "",
ast.AlignLeft: "<",
ast.AlignCenter: ":",
ast.AlignRight: ">",
}
func (v *visitor) writeCell(cell *ast.TableCell) {
if aCode := alignmentCode[cell.Align]; aCode != "" {
v.b.WriteStrings(`{"`, zjson.NameString, `":"`, aCode, `","`, zjson.NameInline, `":`)
} else {
v.b.WriteStrings(`{"`, zjson.NameInline, `":`)
}
ast.Walk(v, &cell.Inlines)
v.b.WriteByte('}')
}
func (v *visitor) visitBLOB(bn *ast.BLOBNode) {
v.writeNodeStart(zjson.TypeBLOB)
if len(bn.Description) > 0 {
v.writeContentStart(zjson.NameString2)
ast.Walk(v, &bn.Description)
}
v.writeContentStart(zjson.NameString)
writeEscaped(&v.b, bn.Syntax)
if bn.Syntax == meta.SyntaxSVG {
v.writeContentStart(zjson.NameString3)
writeEscaped(&v.b, string(bn.Blob))
} else {
v.writeContentStart(zjson.NameBinary)
v.b.WriteBase64(bn.Blob)
v.b.WriteByte('"')
}
}
var mapRefState = map[ast.RefState]string{
ast.RefStateInvalid: zjson.RefStateInvalid,
ast.RefStateZettel: zjson.RefStateZettel,
ast.RefStateSelf: zjson.RefStateSelf,
ast.RefStateFound: zjson.RefStateFound,
ast.RefStateBroken: zjson.RefStateBroken,
ast.RefStateHosted: zjson.RefStateHosted,
ast.RefStateBased: zjson.RefStateBased,
ast.RefStateQuery: zjson.RefStateQuery,
ast.RefStateExternal: zjson.RefStateExternal,
}
func (v *visitor) visitLink(ln *ast.LinkNode) {
v.writeNodeStart(zjson.TypeLink)
v.visitAttributes(ln.Attrs)
v.writeContentStart(zjson.NameString2)
writeEscaped(&v.b, mapRefState[ln.Ref.State])
v.writeContentStart(zjson.NameString)
if ln.Ref.State == ast.RefStateQuery {
writeEscaped(&v.b, ln.Ref.Value)
} else {
writeEscaped(&v.b, ln.Ref.String())
}
if len(ln.Inlines) > 0 {
v.writeContentStart(zjson.NameInline)
ast.Walk(v, &ln.Inlines)
}
}
func (v *visitor) visitEmbedRef(en *ast.EmbedRefNode) {
v.writeNodeStart(zjson.TypeEmbed)
v.visitAttributes(en.Attrs)
v.writeContentStart(zjson.NameString)
writeEscaped(&v.b, en.Ref.String())
if len(en.Inlines) > 0 {
v.writeContentStart(zjson.NameInline)
ast.Walk(v, &en.Inlines)
}
if en.Syntax != "" {
v.writeContentStart(zjson.NameString2)
writeEscaped(&v.b, en.Syntax)
}
}
func (v *visitor) visitEmbedBLOB(en *ast.EmbedBLOBNode) {
v.writeNodeStart(zjson.TypeEmbedBLOB)
v.visitAttributes(en.Attrs)
v.writeContentStart(zjson.NameString)
writeEscaped(&v.b, en.Syntax)
if en.Syntax == meta.SyntaxSVG {
v.writeContentStart(zjson.NameString3)
writeEscaped(&v.b, string(en.Blob))
} else {
v.writeContentStart(zjson.NameBinary)
v.b.WriteBase64(en.Blob)
v.b.WriteByte('"')
}
if len(en.Inlines) > 0 {
v.writeContentStart(zjson.NameInline)
ast.Walk(v, &en.Inlines)
}
}
func (v *visitor) visitMark(mn *ast.MarkNode) {
v.writeNodeStart(zjson.TypeMark)
if text := mn.Mark; text != "" {
v.writeContentStart(zjson.NameString)
writeEscaped(&v.b, text)
}
if fragment := mn.Fragment; fragment != "" {
v.writeContentStart(zjson.NameString2)
v.b.WriteByte('"')
v.b.WriteString(fragment)
v.b.WriteByte('"')
}
if len(mn.Inlines) > 0 {
v.writeContentStart(zjson.NameInline)
ast.Walk(v, &mn.Inlines)
}
}
var mapFormatKind = map[ast.FormatKind]string{
ast.FormatEmph: zjson.TypeFormatEmph,
ast.FormatStrong: zjson.TypeFormatStrong,
ast.FormatDelete: zjson.TypeFormatDelete,
ast.FormatInsert: zjson.TypeFormatInsert,
ast.FormatSuper: zjson.TypeFormatSuper,
ast.FormatSub: zjson.TypeFormatSub,
ast.FormatQuote: zjson.TypeFormatQuote,
ast.FormatSpan: zjson.TypeFormatSpan,
}
var mapLiteralKind = map[ast.LiteralKind]string{
ast.LiteralZettel: zjson.TypeLiteralZettel,
ast.LiteralProg: zjson.TypeLiteralCode,
ast.LiteralInput: zjson.TypeLiteralInput,
ast.LiteralOutput: zjson.TypeLiteralOutput,
ast.LiteralComment: zjson.TypeLiteralComment,
ast.LiteralHTML: zjson.TypeLiteralHTML,
ast.LiteralMath: zjson.TypeLiteralMath,
}
func (v *visitor) visitBlockSlice(bs *ast.BlockSlice) {
v.b.WriteByte('[')
for i, bn := range *bs {
v.writeComma(i)
ast.Walk(v, bn)
}
v.b.WriteByte(']')
}
func (v *visitor) walkInlineSlice(is *ast.InlineSlice) {
v.b.WriteByte('[')
for i, in := range *is {
v.writeComma(i)
ast.Walk(v, in)
}
v.b.WriteByte(']')
}
// visitAttributes write JSON attributes
func (v *visitor) visitAttributes(a attrs.Attributes) {
if a.IsEmpty() {
return
}
v.writeContentStart(zjson.NameAttribute)
for i, k := range a.Keys() {
if i > 0 {
v.b.WriteString(`","`)
}
strfun.JSONEscape(&v.b, k)
v.b.WriteString(`":"`)
strfun.JSONEscape(&v.b, a[k])
}
v.b.WriteString(`"}`)
}
func (v *visitor) writeNodeStart(t string) {
v.b.WriteStrings(`{"":"`, t, `"`)
}
var valueStart = map[string]string{
zjson.NameBlock: "",
zjson.NameAttribute: `{"`,
zjson.NameList: "[",
zjson.NameDescrList: "[",
zjson.NameDescription: "[",
zjson.NameInline: "",
zjson.NameBLOB: "{",
zjson.NameNumeric: "",
zjson.NameBinary: `"`,
zjson.NameTable: "[",
zjson.NameString2: "",
zjson.NameString: "",
zjson.NameString3: "",
}
func (v *visitor) writeContentStart(jsonName string) {
s, ok := valueStart[jsonName]
if !ok {
panic("Unknown object name " + jsonName)
}
v.b.WriteStrings(`,"`, jsonName, `":`, s)
}
func (v *visitor) writeMeta(m *meta.Meta, evalMeta encoder.EvalMetaFunc) {
v.b.WriteByte('{')
for i, p := range m.ComputedPairs() {
if i > 0 {
v.b.WriteByte(',')
}
v.b.WriteByte('"')
key := p.Key
strfun.JSONEscape(&v.b, key)
t := m.Type(key)
v.b.WriteStrings(`":{"`, zjson.NameType, `":"`, t.Name, `","`)
if t.IsSet {
v.b.WriteStrings(zjson.NameSet, `":`)
v.writeSetValue(p.Value)
} else if t == meta.TypeZettelmarkup {
v.b.WriteStrings(zjson.NameInline, `":`)
is := evalMeta(p.Value)
ast.Walk(v, &is)
} else {
v.b.WriteStrings(zjson.NameString, `":`)
writeEscaped(&v.b, p.Value)
}
v.b.WriteByte('}')
}
v.b.WriteByte('}')
}
func (v *visitor) writeSetValue(value string) {
v.b.WriteByte('[')
for i, val := range meta.ListFromValue(value) {
v.writeComma(i)
writeEscaped(&v.b, val)
}
v.b.WriteByte(']')
}
func (v *visitor) writeComma(pos int) {
if pos > 0 {
v.b.WriteByte(',')
}
}
func writeEscaped(b *encoder.EncWriter, s string) {
b.WriteByte('"')
strfun.JSONEscape(b, s)
b.WriteByte('"')
}
|
Changes to go.mod.
1 2 3 4 5 6 7 8 9 10 11 12 | module zettelstore.de/z go 1.19 require ( codeberg.org/t73fde/sxpf v0.0.0-20220719090054-749a39d0a7a0 github.com/fsnotify/fsnotify v1.6.0 github.com/pascaldekloe/jwt v1.12.0 github.com/yuin/goldmark v1.5.3 golang.org/x/crypto v0.5.0 golang.org/x/term v0.4.0 golang.org/x/text v0.6.0 | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | module zettelstore.de/z go 1.19 require ( codeberg.org/t73fde/sxpf v0.0.0-20220719090054-749a39d0a7a0 github.com/fsnotify/fsnotify v1.6.0 github.com/pascaldekloe/jwt v1.12.0 github.com/yuin/goldmark v1.5.3 golang.org/x/crypto v0.5.0 golang.org/x/term v0.4.0 golang.org/x/text v0.6.0 zettelstore.de/c v0.10.0 ) require golang.org/x/sys v0.4.0 // indirect |
Changes to go.sum.
| ︙ | ︙ | |||
11 12 13 14 15 16 17 | golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.4.0 h1:Zr2JFtRQNX3BCZ8YtxRE9hNJYC8J6I1MVbMg6owUp18= golang.org/x/sys v0.4.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.4.0 h1:O7UWfv5+A2qiuulQk30kVinPoMtoIPeVaKLEgLpVkvg= golang.org/x/term v0.4.0/go.mod h1:9P2UbLfCdcvo3p/nzKvsmas4TnlujnuoV9hGgYzW1lQ= golang.org/x/text v0.6.0 h1:3XmdazWV+ubf7QgHSTWeykHOci5oeekaGJBLkrkaw4k= golang.org/x/text v0.6.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= | | | | 11 12 13 14 15 16 17 18 19 | golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.4.0 h1:Zr2JFtRQNX3BCZ8YtxRE9hNJYC8J6I1MVbMg6owUp18= golang.org/x/sys v0.4.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.4.0 h1:O7UWfv5+A2qiuulQk30kVinPoMtoIPeVaKLEgLpVkvg= golang.org/x/term v0.4.0/go.mod h1:9P2UbLfCdcvo3p/nzKvsmas4TnlujnuoV9hGgYzW1lQ= golang.org/x/text v0.6.0 h1:3XmdazWV+ubf7QgHSTWeykHOci5oeekaGJBLkrkaw4k= golang.org/x/text v0.6.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= zettelstore.de/c v0.10.0 h1:e5VOrH5aEEojNrUfO/721dsiHsp/yuTvNPF6DNsgA3U= zettelstore.de/c v0.10.0/go.mod h1:+SoneUhKQ81A2Id/bC6FdDYYQAHYfVryh7wHFnnklew= |
Changes to tests/client/client_test.go.
1 | //----------------------------------------------------------------------------- | | | 1 2 3 4 5 6 7 8 9 | //----------------------------------------------------------------------------- // Copyright (c) 2021-2022 Detlef Stern // // This file is part of Zettelstore. // // Zettelstore client is licensed under the latest version of the EUPL // (European Union Public License). Please see file LICENSE.txt for your rights // and obligations under this license. //----------------------------------------------------------------------------- |
| ︙ | ︙ | |||
167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
}
func TestGetParsedEvaluatedZettel(t *testing.T) {
t.Parallel()
c := getClient()
c.SetAuth("owner", "owner")
encodings := []api.EncodingEnum{
api.EncoderHTML,
api.EncoderSexpr,
api.EncoderText,
}
for _, enc := range encodings {
content, err := c.GetParsedZettel(context.Background(), api.ZidDefaultHome, enc)
if err != nil {
| > | 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
}
func TestGetParsedEvaluatedZettel(t *testing.T) {
t.Parallel()
c := getClient()
c.SetAuth("owner", "owner")
encodings := []api.EncodingEnum{
api.EncoderZJSON,
api.EncoderHTML,
api.EncoderSexpr,
api.EncoderText,
}
for _, enc := range encodings {
content, err := c.GetParsedZettel(context.Background(), api.ZidDefaultHome, enc)
if err != nil {
|
| ︙ | ︙ |
Changes to tests/markdown_test.go.
1 | //----------------------------------------------------------------------------- | | | 1 2 3 4 5 6 7 8 9 | //----------------------------------------------------------------------------- // Copyright (c) 2020-2022 Detlef Stern // // This file is part of Zettelstore. // // Zettelstore is licensed under the latest version of the EUPL (European Union // Public License). Please see file LICENSE.txt for your rights and obligations // under this license. //----------------------------------------------------------------------------- |
| ︙ | ︙ | |||
22 23 24 25 26 27 28 29 30 31 32 33 34 35 | "zettelstore.de/z/config" "zettelstore.de/z/domain/meta" "zettelstore.de/z/encoder" _ "zettelstore.de/z/encoder/htmlenc" _ "zettelstore.de/z/encoder/mdenc" _ "zettelstore.de/z/encoder/sexprenc" _ "zettelstore.de/z/encoder/textenc" _ "zettelstore.de/z/encoder/zmkenc" "zettelstore.de/z/input" "zettelstore.de/z/parser" _ "zettelstore.de/z/parser/markdown" _ "zettelstore.de/z/parser/zettelmark" ) | > | 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | "zettelstore.de/z/config" "zettelstore.de/z/domain/meta" "zettelstore.de/z/encoder" _ "zettelstore.de/z/encoder/htmlenc" _ "zettelstore.de/z/encoder/mdenc" _ "zettelstore.de/z/encoder/sexprenc" _ "zettelstore.de/z/encoder/textenc" _ "zettelstore.de/z/encoder/zjsonenc" _ "zettelstore.de/z/encoder/zmkenc" "zettelstore.de/z/input" "zettelstore.de/z/parser" _ "zettelstore.de/z/parser/markdown" _ "zettelstore.de/z/parser/zettelmark" ) |
| ︙ | ︙ |
Changes to tests/regression_test.go.
1 | //----------------------------------------------------------------------------- | | | 1 2 3 4 5 6 7 8 9 | //----------------------------------------------------------------------------- // Copyright (c) 2020-2022 Detlef Stern // // This file is part of Zettelstore. // // Zettelstore is licensed under the latest version of the EUPL (European Union // Public License). Please see file LICENSE.txt for your rights and obligations // under this license. //----------------------------------------------------------------------------- |
| ︙ | ︙ | |||
34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
_ "zettelstore.de/z/box/dirbox"
)
var encodings = []api.EncodingEnum{
api.EncoderHTML,
api.EncoderSexpr,
api.EncoderText,
}
func getFileBoxes(wd, kind string) (root string, boxes []box.ManagedBox) {
root = filepath.Clean(filepath.Join(wd, "..", "testdata", kind))
entries, err := os.ReadDir(root)
if err != nil {
panic(err)
| > | 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
_ "zettelstore.de/z/box/dirbox"
)
var encodings = []api.EncodingEnum{
api.EncoderHTML,
api.EncoderSexpr,
api.EncoderText,
api.EncoderZJSON,
}
func getFileBoxes(wd, kind string) (root string, boxes []box.ManagedBox) {
root = filepath.Clean(filepath.Join(wd, "..", "testdata", kind))
entries, err := os.ReadDir(root)
if err != nil {
panic(err)
|
| ︙ | ︙ |
Changes to web/content/content.go.
1 | //----------------------------------------------------------------------------- | | | 1 2 3 4 5 6 7 8 9 | //----------------------------------------------------------------------------- // Copyright (c) 2022 Detlef Stern // // This file is part of Zettelstore. // // Zettelstore is licensed under the latest version of the EUPL (European Union // Public License). Please see file LICENSE.txt for your rights and obligations // under this license. //----------------------------------------------------------------------------- |
| ︙ | ︙ | |||
34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
)
var encoding2mime = map[api.EncodingEnum]string{
api.EncoderHTML: mimeHTML,
api.EncoderMD: mimeMarkdown,
api.EncoderSexpr: PlainText,
api.EncoderText: PlainText,
api.EncoderZmk: PlainText,
}
// MIMEFromEncoding returns the MIME encoding for a given zettel encoding
func MIMEFromEncoding(enc api.EncodingEnum) string {
if m, found := encoding2mime[enc]; found {
return m
| > | 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
)
var encoding2mime = map[api.EncodingEnum]string{
api.EncoderHTML: mimeHTML,
api.EncoderMD: mimeMarkdown,
api.EncoderSexpr: PlainText,
api.EncoderText: PlainText,
api.EncoderZJSON: JSON,
api.EncoderZmk: PlainText,
}
// MIMEFromEncoding returns the MIME encoding for a given zettel encoding
func MIMEFromEncoding(enc api.EncodingEnum) string {
if m, found := encoding2mime[enc]; found {
return m
|
| ︙ | ︙ |
Changes to www/changes.wiki.
1 2 3 4 | <title>Change Log</title> <a name="0_11"></a> <h2>Changes for Version 0.11.0 (pending)</h2> | < < < | 1 2 3 4 5 6 7 8 9 10 11 |
<title>Change Log</title>
<a name="0_11"></a>
<h2>Changes for Version 0.11.0 (pending)</h2>
<a name="0_10"></a>
<h2>Changes for Version 0.10.0 (2023-01-24)</h2>
* Remove support for endpoints <tt>/j, /m, /q, /p, /v</tt>. Their functions
are merged into endpoint <tt>/z</tt>. This was announced in version 0.9.0.
Please use only client library with at least version 0.10.0 too.
(breaking: api)
|
| ︙ | ︙ |