Title ⓘ

Index: box/constbox/info.mustache ================================================================== --- box/constbox/info.mustache +++ box/constbox/info.mustache @@ -9,13 +9,11 @@ {{#CanFolge}} · Folge{{/CanFolge}} {{#CanRename}}· Rename{{/CanRename}} {{#CanDelete}}· Delete{{/CanDelete}}

Interpreted Metadata

- -{{#MetaData}} -{{/MetaData}}

{{{Value}}}

+{{#MetaData}}{{/MetaData}}

{{{Value}}}

References

Local

Parts and encodings

{{Header}}	{{Text}}	{{Text}}

Parsed (not evaluated)

{{Header}}	{{Text}}	{{Text}}

","lang":"en","license":"CC BY-SA 4.0"},"content":"The endpoint to work with a specific zettel is ''/j/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000}}.\n\nFor example, ... ``` Pretty-printed, this results in: ``` { "id": "00001012053300", "meta": { - "back": "00001012000000 00001012054400", - "backward": "00001012000000 00001012054400 00001012920000", + "back": "00001012000000 00001012053200 00001012054400", + "backward": "00001012000000 00001012053200 00001012054400 00001012920000", "box-number": "1", - "created": "20211004093206", - "forward": "00001006020000 00001006050000 00001010040100 00001012050200 00001012053400 00001012920000 00001012920800 00001012921200", - "modified": "20221219160211", - "published": "20221219160211", + "forward": "00001010040100 00001012050200 00001012920000 00001012920800", + "modified": "20210726190012", + "published": "20210726190012", "role": "manual", "syntax": "zmk", "tags": "#api #manual #zettelstore", "title": "API: Retrieve metadata and content of an existing zettel" }, "encoding": "", - "content": "The [[endpoint|00001012920000]] to work with metadata and content of a specific zettel is ''/z/{ID}'', where ''{ID}'' (...) + "content": "The [[endpoint|00001012920000]] to work with metadata and content of a specific zettel is ''/j/{ID}'', where ''{ID}'' (...) "rights": 62 } ``` The following keys of the JSON object are used: @@ -83,10 +51,40 @@ ; ''"content"'' : Is a string value that contains the content of the zettel to be created. Typically, text content is not encoded, and binary content is encoded via Base64. ; ''"rights"'' : An integer number that describes the [[access rights|00001012921200]] for the zettel. + +=== Plain zettel +[!plain]Additionally, you can retrieve the plain zettel, without using JSON. +Just change the [[endpoint|00001012920000]] to ''/z/{ID}'' +Optionally, you may provide which parts of the zettel you are requesting. +In this case, add an additional query parameter ''part=PART''. +Valid values for [[''PART''|00001012920800]] are ""zettel"", ""[[meta|00001012053400]]"", and ""content"" (the default value). + +````sh +# curl 'http://127.0.0.1:23123/z/00001012053300' +The [[endpoint|00001012920000]] to work with metadata and content of a specific zettel is ''/j/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]]. + +For example, to retrieve some data about this zettel you are currently viewing, just send a HTTP GET request to the endpoint ''/j/00001012053300''[^If [[authentication is enabled|00001010040100]], you must include the a valid [[access token|00001012050200]] in the ''Authorization'' header]. +If successful, the output is a JSON object: +```sh +... +```` + +````sh +# curl 'http://127.0.0.1:23123/z/00001012053300?part=zettel' +title: API: Retrieve metadata and content of an existing zettel +role: manual +tags: #api #manual #zettelstore +syntax: zmk + +The [[endpoint|00001012920000]] to work with metadata and content of a specific zettel is ''/j/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]]. + +For example, to retrieve some data about this zettel you are currently viewing, just send a HTTP GET request to the endpoint +... +```` === HTTP Status codes ; ''200'' : Retrieval was successful, the body contains an appropriate JSON object / plain zettel data. ; ''204'' Index: docs/manual/00001012053400.zettel ================================================================== --- docs/manual/00001012053400.zettel +++ docs/manual/00001012053400.zettel @@ -2,42 +2,31 @@ title: API: Retrieve metadata of an existing zettel role: manual tags: #api #manual #zettelstore syntax: zmk created: 20210726174524 -modified: 20221219161030 - -The [[endpoint|00001012920000]] to work with metadata of a specific zettel is ''/z/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]][^If [[authentication is enabled|00001010040100]], you must include the a valid [[access token|00001012050200]] in the ''Authorization'' header]. - -To retrieve the plain metadata of a zettel, use the query parameter ''part=meta'' - -````sh -# curl 'http://127.0.0.1:23123/z/00001012053400?part=meta' -title: API: Retrieve metadata of an existing zettel -role: manual -tags: #api #manual #zettelstore -syntax: zmk -```` - -To return a JSON object, use also the query parameter ''enc=json''. - -```sh -# curl 'http://127.0.0.1:23123/z/00001012053400?part=meta&enc=json' -{"meta":{"back":"00001012000000 00001012053300","backward":"00001012000000 00001012053300 00001012920000","box-number":"1","created":"20210726174524","forward":"00001006020000 00001006050000 00001010040100 00001012050200 00001012920000 00001012921200","modified":"20220917175233","published":"20220917175233","role":"manual","syntax":"zmk","tags":"#api #manual #zettelstore","title":"API: Retrieve metadata of an existing zettel"},"rights":62} +modified: 20220917175233 + +The [[endpoint|00001012920000]] to work with metadata of a specific zettel is ''/m/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]]. + +For example, to retrieve some data about this zettel you are currently viewing, just send a HTTP GET request to the endpoint ''/j/00001012053400''[^If [[authentication is enabled|00001010040100]], you must include the a valid [[access token|00001012050200]] in the ''Authorization'' header]. +If successful, the output is a JSON object: +```sh +# curl http://127.0.0.1:23123/m/00001012053400 +{"meta":{"back":"00001012000000 00001012053300","backward":"00001012000000 00001012053300 00001012920000","box-number":"1","forward":"00001010040100 00001012050200 00001012920000 00001012920800","modified":"20211004111240","published":"20211004111240","role":"manual","syntax":"zmk","tags":"#api #manual #zettelstore","title":"API: Retrieve metadata of an existing zettel"},"rights":62} ``` Pretty-printed, this results in: ``` { "meta": { "back": "00001012000000 00001012053300", "backward": "00001012000000 00001012053300 00001012920000", "box-number": "1", - "created": "20210726174524", - "forward": "00001006020000 00001006050000 00001010040100 00001012050200 00001012920000 00001012921200", - "modified": "20220917175233", - "published": "20220917175233", + "forward": "00001010040100 00001012050200 00001012920000 00001012920800", + "modified": "20211004111240", + "published": "20211004111240", "role": "manual", "syntax": "zmk", "tags": "#api #manual #zettelstore", "title": "API: Retrieve metadata of an existing zettel" }, @@ -50,10 +39,20 @@ The name/value pairs of this objects are interpreted as the metadata of the new zettel. Please consider the [[list of supported metadata keys|00001006020000]] (and their value types). ; ''"rights"'' : An integer number that describes the [[access rights|00001012921200]] for the zettel. +[!plain]Additionally, you can retrieve the plain metadata of a zettel, without using JSON. +Just change the [[endpoint|00001012920000]] to ''/z/{ID}?part=meta'' + +````sh +# curl 'http://127.0.0.1:23123/z/00001012053400?part=meta' +title: API: Retrieve metadata of an existing zettel +role: manual +tags: #api #manual #zettelstore +syntax: zmk +```` === HTTP Status codes ; ''200'' : Retrieval was successful, the body contains an appropriate JSON object. ; ''400'' Index: docs/manual/00001012053500.zettel ================================================================== --- docs/manual/00001012053500.zettel +++ docs/manual/00001012053500.zettel @@ -2,51 +2,62 @@ title: API: Retrieve evaluated metadata and content of an existing zettel in various encodings role: manual tags: #api #manual #zettelstore syntax: zmk created: 20210726174524 -modified: 20230109105303 +modified: 20221107183404 -The [[endpoint|00001012920000]] to work with evaluated metadata and content of a specific zettel is ''/z/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]]. +The [[endpoint|00001012920000]] to work with evaluated metadata and content of a specific zettel is ''/v/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]]. -For example, to retrieve some evaluated data about this zettel you are currently viewing in [[Sexpr encoding|00001012920516]], just send a HTTP GET request to the endpoint ''/z/00001012053500''[^If [[authentication is enabled|00001010040100]], you must include the a valid [[access token|00001012050200]] in the ''Authorization'' header] with the query parameter ''enc=sexpr''. +For example, to retrieve some evaluated data about this zettel you are currently viewing, just send a HTTP GET request to the endpoint ''/v/00001012053500''[^If [[authentication is enabled|00001010040100]], you must include the a valid [[access token|00001012050200]] in the ''Authorization'' header]. If successful, the output is a JSON object: ```sh -# curl 'http://127.0.0.1:23123/z/00001012053500?enc=sexpr' -((PARA (TEXT "The") (SPACE) (LINK-ZETTEL () "00001012920000" (TEXT "endpoint")) (SPACE) (TEXT "to") (SPACE) (TEXT "work") (SPACE) (TEXT "with") (SPACE) (TEXT "evaluated") (SPACE) (TEXT "metadata") (SPACE) (TEXT "and") (SPACE) (TEXT "content") (SPACE) (TEXT "of") (SPACE) (TEXT "a") (SPACE) (TEXT "specific") (SPACE) (TEXT "zettel") (SPACE) (TEXT "is") (SPACE) (LITERAL-INPUT () "/z/{ID}") (TEXT ",") (SPACE) (TEXT "where") (SPACE) (LITERAL-INPUT () "{ID}") ... +# curl http://127.0.0.1:23123/v/00001012053500 +{"meta":{"title":[{"t":"Text","s":"API:"},{"t":"Space"},{"t":"Text","s":"Retrieve"},{"t":"Space"},{"t":"Text","s":"evaluated"},{"t":"Space"},{"t":"Text","s":"metadata"},{"t":"Space"},{"t":"Text","s":"and"},{"t":"Space"},{"t":"Text","s":"content"},{"t":"Space"},{"t":"Text","s":"of"},{"t":"Space"},{"t":"Text","s":"an"},{"t":"Space"},{"t":"Text","s":"existing"},{"t":"Space"},{"t":"Text","s":"zettel"},{"t":"Space"},{"t":"Text","s":"in"},{"t":"Space"}, ... ``` -To select another encoding, you must provide the query parameter ''enc=ENCODING''. +To select another encoding, you can provide a query parameter ''enc=ENCODING''. +The default value for [[''ENCODING''|00001012920500]] is ""[[zjson|00001012920503]]"". Others are ""[[html|00001012920510]]"", ""[[text|00001012920519]]"", and some [[more|00001012920500]]. -In addition, you may provide a query parameter ''part=PART'' to select the relevant [[part|00001012920800]] of a zettel. ```sh -# curl 'http://127.0.0.1:23123/z/00001012053500?enc=html&part=zettel' - +# curl 'http://127.0.0.1:23123/v/00001012053500?enc=html' + + API: Retrieve evaluated metadata and content of an existing zettel in various encodings - - + - - + + - - - - - - - - + + + -

API: Retrieve evaluated metadata and content of an existing zettel in various encodings

The endpoint to work with evaluated metadata and content of a specific zettel is /z/{ID}, +

The endpoint to work with evaluated metadata and content of a specific zettel is /v/{ID}, where {ID} is a placeholder for the zettel identifier.

... ``` + +You also can use the query parameter ''part=PART'' to specify which [[parts|00001012920800]] of a zettel must be encoded. +In this case, its default value is ''content''. +```sh +# curl 'http://127.0.0.1:23123/v/00001012053500?enc=html&part=meta' + + + + + + + + + + + +``` === HTTP Status codes ; ''200'' : Retrieval was successful, the body contains an appropriate JSON object. ; ''400'' Index: docs/manual/00001012053600.zettel ================================================================== --- docs/manual/00001012053600.zettel +++ docs/manual/00001012053600.zettel @@ -2,22 +2,22 @@ title: API: Retrieve parsed metadata and content of an existing zettel in various encodings role: manual tags: #api #manual #zettelstore syntax: zmk created: 20210126175322 -modified: 20230109105034 +modified: 20220908163514 -The [[endpoint|00001012920000]] to work with parsed metadata and content of a specific zettel is ''/z/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]]. +The [[endpoint|00001012920000]] to work with parsed metadata and content of a specific zettel is ''/p/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]]. A __parsed__ zettel is basically an [[unevaluated|00001012053500]] zettel: the zettel is read and analyzed, but its content is not __evaluated__. By using this endpoint, you are able to retrieve the structure of a zettel before it is evaluated. -For example, to retrieve some data about this zettel you are currently viewing, just send a HTTP GET request to the endpoint ''/z/00001012053600''[^If [[authentication is enabled|00001010040100]], you must include the a valid [[access token|00001012050200]] in the ''Authorization'' header] with the query parameter ''parseonly'' (and other appropriate query parameter). -For example: +For example, to retrieve some data about this zettel you are currently viewing, just send a HTTP GET request to the endpoint ''/v/00001012053600''[^If [[authentication is enabled|00001010040100]], you must include the a valid [[access token|00001012050200]] in the ''Authorization'' header]. +If successful, the output is a JSON object: ```sh -# curl 'http://127.0.0.1:23123/z/00001012053600?enc=sexpr&parseonly' -((PARA (TEXT "The") (SPACE) (LINK-ZETTEL () "00001012920000" (TEXT "endpoint")) (SPACE) (TEXT "to") (SPACE) (TEXT "work") (SPACE) (TEXT "with") (SPACE) ... +# curl http://127.0.0.1:23123/p/00001012053600 +[{"t":"Para","i":[{"t":"Text","s":"The"},{"t":"Space"},{"t":"Link","q":"zettel","s":"00001012920000","i":[{"t":"Text","s":"endpoint"}]},{"t":"Space"},{"t":"Text","s":"to"},{"t":"Space"},{"t":"Text","s":"work"},{"t":"Space"},{"t":"Text","s":"with"},{"t":"Space"}, ... ``` Similar to [[retrieving an encoded zettel|00001012053500]], you can specify an [[encoding|00001012920500]] and state which [[part|00001012920800]] of a zettel you are interested in. The same default values applies to this endpoint. Index: docs/manual/00001012054200.zettel ================================================================== --- docs/manual/00001012054200.zettel +++ docs/manual/00001012054200.zettel @@ -1,36 +1,33 @@ id: 00001012054200 title: API: Update a zettel role: manual tags: #api #manual #zettelstore syntax: zmk -created: 20210713150005 -modified: 20221219155029 +modified: 20211124180943 Updating metadata and content of a zettel is technically quite similar to [[creating a new zettel|00001012053200]]. In both cases you must provide the data for the new or updated zettel in the body of the HTTP request. One difference is the endpoint. -The [[endpoint|00001012920000]] to update a zettel is ''/z/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]]. -You must send a HTTP PUT request to that endpoint. - -The zettel must be encoded in a [[plain|00001006000000]] format: first comes the [[metadata|00001006010000]] and the following content is separated by an empty line. -This is the same format as used by storing zettel within a [[directory box|00001006010000]]. +The [[endpoint|00001012920000]] to update a zettel is ''/j/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]]. +You must send a HTTP PUT request to that endpoint: ``` -# curl -X POST --data 'title: Updated Note\n\nUpdated content.' http://127.0.0.1:23123/z/00001012054200 -``` - -Alternatively, you can use the JSON encoding by using the query parameter ''enc=json''. - -``` -# curl -X PUT --data '{}' 'http://127.0.0.1:23123/z/00001012054200?enc=json' +# curl -X PUT --data '{}' http://127.0.0.1:23123/j/00001012054200 ``` This will put some empty content and metadata to the zettel you are currently reading. As usual, some metadata will be calculated if it is empty. The body of the HTTP response is empty, if the request was successful. + +[!plain]Alternatively, you can use the [[endpoint|00001012920000]] ''/z/{ID}'' to update a zettel. +In this case, the zettel must be encoded in a [[plain|00001006000000]] format: first comes the [[metadata|00001006010000]] and the following content is separated by an empty line. +This is the same format as used by storing zettel within a [[directory box|00001006010000]]. +``` +# curl -X POST --data $'title: Updated Note\n\nUpdated content.' http://127.0.0.1:23123/z/00001012054200 +``` === HTTP Status codes ; ''204'' : Update was successful, there is no body in the response. ; ''400'' Index: docs/manual/00001012054400.zettel ================================================================== --- docs/manual/00001012054400.zettel +++ docs/manual/00001012054400.zettel @@ -1,30 +1,32 @@ id: 00001012054400 title: API: Rename a zettel role: manual tags: #api #manual #zettelstore syntax: zmk -created: 20210713150005 -modified: 20221219154659 +modified: 20211124181324 Renaming a zettel is effectively just specifying a new identifier for the zettel. Since more than one [[box|00001004011200]] might contain a zettel with the old identifier, the rename operation must success in every relevant box to be overall successful. If the rename operation fails in one box, Zettelstore tries to rollback previous successful operations. As a consequence, you cannot rename a zettel when its identifier is used in a read-only box. This applies to all [[predefined zettel|00001005090000]], for example. -The [[endpoint|00001012920000]] to rename a zettel is ''/z/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]]. +The [[endpoint|00001012920000]] to rename a zettel is ''/j/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]]. You must send a HTTP MOVE request to this endpoint, and you must specify the new zettel identifier as an URL, placed under the HTTP request header key ''Destination''. ``` -# curl -X MOVE -H "Destination: 10000000000001" http://127.0.0.1:23123/z/00001000000000 +# curl -X MOVE -H "Destination: 10000000000001" http://127.0.0.1:23123/j/00001000000000 ``` Only the last 14 characters of the value of ''Destination'' are taken into account and those must form an unused [[zettel identifier|00001006050000]]. If the value contains less than 14 characters that do not form an unused zettel identifier, the response will contain a HTTP status code ''400''. All other characters, besides those 14 digits, are effectively ignored. However, the value should form a valid URL that could be used later to [[read the content|00001012053300]] of the freshly renamed zettel. + +[!plain]Alternatively, you can also use the [[endpoint|00001012920000]] ''/z/{ID}''. +Both endpoints behave identical. === HTTP Status codes ; ''204'' : Rename was successful, there is no body in the response. ; ''400'' Index: docs/manual/00001012054600.zettel ================================================================== --- docs/manual/00001012054600.zettel +++ docs/manual/00001012054600.zettel @@ -1,22 +1,24 @@ id: 00001012054600 title: API: Delete a zettel role: manual tags: #api #manual #zettelstore syntax: zmk -created: 20210713150005 -modified: 20221219154608 +modified: 20211124181041 Deleting a zettel within the Zettelstore is executed on the first [[box|00001004011200]] that contains that zettel. Zettel with the same identifier, but in subsequent boxes remain. If the first box containing the zettel is read-only, deleting that zettel will fail, as well for a Zettelstore in [[read-only mode|00001004010000#read-only-mode]] or if [[authentication is enabled|00001010040100]] and the user has no [[access right|00001010070600]] to do so. -The [[endpoint|00001012920000]] to delete a zettel is ''/z/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]]. +The [[endpoint|00001012920000]] to delete a zettel is ''/j/{ID}'', where ''{ID}'' is a placeholder for the [[zettel identifier|00001006050000]]. You must send a HTTP DELETE request to this endpoint: ``` -# curl -X DELETE http://127.0.0.1:23123/z/00001000000000 +# curl -X DELETE http://127.0.0.1:23123/j/00001000000000 ``` + +[!plain]Alternatively, you can also use the [[endpoint|00001012920000]] ''/z/{ID}''. +Both endpoints behave identical. === HTTP Status codes ; ''204'' : Delete was successful, there is no body in the response. ; ''403'' Index: docs/manual/00001012920000.zettel ================================================================== --- docs/manual/00001012920000.zettel +++ docs/manual/00001012920000.zettel @@ -2,11 +2,11 @@ title: Endpoints used by the API role: manual tags: #api #manual #reference #zettelstore syntax: zmk created: 20210126175322 -modified: 20221219162335 +modified: 20220923101703 All API endpoints conform to the pattern ''[PREFIX]LETTER[/ZETTEL-ID]'', where: ; ''PREFIX'' : is the URL prefix (default: ""/""), configured via the ''url-prefix'' [[startup configuration|00001004010000]], ; ''LETTER'' @@ -17,18 +17,26 @@ The following letters are currently in use: |= Letter:| Without zettel identifier | With [[zettel identifier|00001006050000]] | Mnemonic | ''a'' | POST: [[client authentication|00001012050200]] | | **A**uthenticate | | PUT: [[renew access token|00001012050400]] | +| ''j'' | GET: [[query zettel list|00001012051400]] (alias of ''/q'') | GET: [[retrieve zettel AS JSON|00001012053300]] | **J**SON +| | POST: [[create new zettel|00001012053200]] | PUT: [[update a zettel|00001012054200]] +| | | DELETE: [[delete the zettel|00001012054600]] +| | | MOVE: [[rename the zettel|00001012054400]] +| ''m'' | | GET: [[retrieve metadata|00001012053400]] | **M**etadata | ''o'' | | GET: [[list zettel order|00001012054000]] | **O**rder +| ''p'' | | GET: [[retrieve parsed zettel|00001012053600]]| **P**arsed +| ''q'' | GET: [[query zettel list|00001012051400]] | | **Q**uery | ''u'' | | GET [[unlinked references|00001012053900]] | **U**nlinked +| ''v'' | | GET: [[retrieve evaluated zettel|00001012053500]] | E**v**aluated | ''x'' | GET: [[retrieve administrative data|00001012070500]] | GET: [[list zettel context|00001012053800]] | Conte**x**t | | POST: [[execute command|00001012080100]] -| ''z'' | GET: [[list zettel|00001012051200]] | GET: [[retrieve zettel|00001012053300]] | **Z**ettel -| | POST: [[create new zettel|00001012053200]] | PUT: [[update a zettel|00001012054200]] -| | | DELETE: [[delete zettel|00001012054600]] -| | | MOVE: [[rename zettel|00001012054400]] +| ''z'' | GET: [[list zettel|00001012051200#plain]] | GET: [[retrieve zettel|00001012053300#plain]] | **Z**ettel +| | POST: [[create new zettel|00001012053200#plain]] | PUT: [[update a zettel|00001012054200#plain]] +| | | DELETE: [[delete zettel|00001012054600#plain]] +| | | MOVE: [[rename zettel|00001012054400#plain]] The full URL will contain either the ""http"" oder ""https"" scheme, a host name, and an optional port number. The API examples will assume the ""http"" schema, the local host ""127.0.0.1"", the default port ""23123"", and the default empty ''PREFIX'' ""/"". Therefore, all URLs in the API documentation will begin with ""http://127.0.0.1:23123/"". Index: docs/manual/00001012920500.zettel ================================================================== --- docs/manual/00001012920500.zettel +++ docs/manual/00001012920500.zettel @@ -2,15 +2,15 @@ title: Encodings available via the [[API|00001012000000]] role: manual tags: #api #manual #reference #zettelstore syntax: zmk created: 20210126175322 -modified: 20230109104839 +modified: 20221107182839 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) +* [[zjson|00001012920503]] (default) * [[zmk|00001012920522]] Index: docs/manual/00001012920503.zettel ================================================================== --- docs/manual/00001012920503.zettel +++ docs/manual/00001012920503.zettel @@ -2,22 +2,20 @@ title: ZJSON Encoding role: manual tags: #api #manual #reference #zettelstore syntax: zmk created: 20210126175322 -modified: 20230109104722 +modified: 20220908163450 -**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}''. +It is a JSON-based encoding format, but different to the structures returned by [[endpoint|00001012920000]] ''/j/{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]]. +* [[//v/00001012920503?enc=zjson&part=zettel]], +* [[//v/00001012920503?enc=zjson&part=meta]], +* [[//v/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]]. Index: docs/manual/00001012920516.zettel ================================================================== --- docs/manual/00001012920516.zettel +++ docs/manual/00001012920516.zettel @@ -2,22 +2,22 @@ title: Sexpr Encoding role: manual tags: #api #manual #reference #zettelstore syntax: zmk created: 20220422181104 -modified: 20230109104812 +modified: 20220908163427 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]. +It is an alternative to the [[ZJSON encoding|00001012920503]]. 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]]. +* [[//v/00001012920516?enc=sexpr&part=zettel]], +* [[//v/00001012920516?enc=sexpr&part=meta]], +* [[//v/00001012920516?enc=sexpr&part=content]]. If transferred via HTTP, the content type will be ''text/plain''. === Syntax of s-expressions There are only two types of elements: atoms and lists. Index: docs/manual/00001012920582.zettel ================================================================== --- docs/manual/00001012920582.zettel +++ docs/manual/00001012920582.zettel @@ -1,16 +1,14 @@ id: 00001012920582 title: ZJSON Encoding: List of Valid Metadata Value Objects Names role: manual tags: #api #manual #reference #zettelstore syntax: zmk -modified: 20230109104713 +modified: 20220223184324 -**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. Index: docs/manual/00001012920584.zettel ================================================================== --- docs/manual/00001012920584.zettel +++ docs/manual/00001012920584.zettel @@ -1,14 +1,12 @@ id: 00001012920584 title: ZJSON Encoding: Mapping of Metadata Key Types to Object Names role: manual tags: #api #manual #reference #zettelstore syntax: zmk -modified: 20230109104703 +modified: 20220304114135 -**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. Index: docs/manual/00001012920588.zettel ================================================================== --- docs/manual/00001012920588.zettel +++ docs/manual/00001012920588.zettel @@ -1,14 +1,11 @@ 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 ---- +modified: 20220301102447 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. Index: domain/meta/meta.go ================================================================== --- domain/meta/meta.go +++ domain/meta/meta.go @@ -1,7 +1,7 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2020-2023 Detlef Stern +// 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 @@ -151,11 +151,10 @@ registerKey(api.KeyLicense, TypeEmpty, usageUser, "") registerKey(api.KeyModified, TypeTimestamp, usageComputed, "") registerKey(api.KeyPrecursor, TypeIDSet, usageUser, api.KeyFolge) registerKey(api.KeyPredecessor, TypeID, usageUser, api.KeySuccessors) registerKey(api.KeyPublished, TypeTimestamp, usageProperty, "") - registerKey(api.KeyQuery, TypeEmpty, usageUser, "") registerKey(api.KeyReadOnly, TypeWord, usageUser, "") registerKey(api.KeySummary, TypeZettelmarkup, usageUser, "") registerKey(api.KeyURL, TypeURL, usageUser, "") registerKey(api.KeyUselessFiles, TypeString, usageProperty, "") registerKey(api.KeyUserID, TypeWord, usageUser, "") Index: encoder/encoder.go ================================================================== --- encoder/encoder.go +++ encoder/encoder.go @@ -71,5 +71,13 @@ for enc := range registry { result = append(result, enc) } return result } + +// GetDefaultEncoding returns the encoding that should be used as default. +func GetDefaultEncoding() api.EncodingEnum { + if _, ok := registry[api.EncoderZJSON]; ok { + return api.EncoderZJSON + } + panic("No ZJSON encoding registered") +} Index: encoder/encoder_blob_test.go ================================================================== --- encoder/encoder_blob_test.go +++ encoder/encoder_blob_test.go @@ -1,7 +1,7 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2021-2023 Detlef Stern +// 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 @@ -38,15 +38,15 @@ 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: `

PNG

`, - encoderSexpr: `((BLOB ((TEXT "PNG")) "png" "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAACklEQVR4nGNiAAAABgADNjd8qAAAAABJRU5ErkJggg=="))`, + encoderZJSON: `[{"":"BLOB","q":"PNG","s":"png","o":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAACklEQVR4nGNiAAAABgADNjd8qAAAAABJRU5ErkJggg=="}]`, + encoderHTML: `

PNG

`, + encoderSexpr: `((BLOB "PNG" "png" "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAACklEQVR4nGNiAAAABgADNjd8qAAAAABJRU5ErkJggg=="))`, encoderText: "", - encoderZmk: `%% Unable to display BLOB with description 'PNG' and syntax 'png'.`, + encoderZmk: `%% Unable to display BLOB with title 'PNG' and syntax 'png'.`, }, }, } func TestBlob(t *testing.T) { Index: encoder/encoder_block_test.go ================================================================== --- encoder/encoder_block_test.go +++ encoder/encoder_block_test.go @@ -323,21 +323,10 @@ encoderZJSON: `[{"":"Transclude","a":{"width":"100px"},"q":"external","s":"http://example.com/image"}]`, encoderHTML: `

`, 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: "", Index: encoder/encoder_inline_test.go ================================================================== --- encoder/encoder_inline_test.go +++ encoder/encoder_inline_test.go @@ -1,7 +1,7 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2021-2023 Detlef Stern +// 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 @@ -506,11 +506,11 @@ { descr: "Dummy Embed", zmk: `{{abc}}`, expect: expectMap{ encoderZJSON: `[{"":"Embed","s":"abc"}]`, - encoderHTML: ` alternate description missing

`, + encoderHTML: `

`, encoderMD: "![abc](abc)", encoderSexpr: `((EMBED () (EXTERNAL "abc") ""))`, encoderText: ``, encoderZmk: useZmk, }, Index: encoder/htmlenc/htmlenc.go ================================================================== --- encoder/htmlenc/htmlenc.go +++ encoder/htmlenc/htmlenc.go @@ -1,7 +1,7 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2022-2023 Detlef Stern +// 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 @@ -55,18 +55,18 @@ io.WriteString(w, "\n\n") env := html.NewEncEnvironment(w, 1) if hasTitle { if isTitle := evalMeta(plainTitle); len(isTitle) > 0 { io.WriteString(w, "

") - if err := acceptInlines(env, &isTitle); err != nil { - return 0, err + if l, err := acceptInlines(env, &isTitle); err != nil { + return l, err } io.WriteString(w, "

\n") } } - err := acceptBlocks(env, &zn.Ast) + _, err := acceptBlocks(env, &zn.Ast) if err == nil { // env.WriteEndnotes() io.WriteString(w, "\n") } return 0, err @@ -83,11 +83,11 @@ } // WriteBlocks encodes a block slice. func (*Encoder) WriteBlocks(w io.Writer, bs *ast.BlockSlice) (int, error) { env := html.NewEncEnvironment(w, 1) - err := acceptBlocks(env, bs) + _, err := acceptBlocks(env, bs) if err == nil { env.WriteEndnotes() err = env.GetError() } return 0, err @@ -94,11 +94,11 @@ } // WriteInlines writes an inline slice to the writer func (*Encoder) WriteInlines(w io.Writer, is *ast.InlineSlice) (int, error) { env := html.NewEncEnvironment(w, 1) - return 0, acceptInlines(env, is) + return acceptInlines(env, is) } func acceptMeta(w io.Writer, textEnc encoder.Encoder, m *meta.Meta, evalMeta encoder.EvalMetaFunc) { for _, p := range m.ComputedPairs() { io.WriteString(w, `\n") } } -func acceptBlocks(env *html.EncEnvironment, bs *ast.BlockSlice) error { +func acceptBlocks(env *html.EncEnvironment, bs *ast.BlockSlice) (int, error) { lst := sexprenc.GetSexpr(bs) sxpf.Eval(env, lst) - return env.GetError() + return 0, env.GetError() } -func acceptInlines(env *html.EncEnvironment, is *ast.InlineSlice) error { +func acceptInlines(env *html.EncEnvironment, is *ast.InlineSlice) (int, error) { lst := sexprenc.GetSexpr(is) sxpf.Eval(env, lst) - return env.GetError() + return 0, env.GetError() } Index: encoder/sexprenc/transform.go ================================================================== --- encoder/sexprenc/transform.go +++ encoder/sexprenc/transform.go @@ -1,7 +1,7 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2022-2023 Detlef Stern +// 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 @@ -76,11 +76,11 @@ case *ast.TableNode: return t.getTable(n) case *ast.TranscludeNode: return sxpf.NewPairFromValues(sexpr.SymTransclude, getAttributes(n.Attrs), getReference(n.Ref)) case *ast.BLOBNode: - return t.getBLOB(n) + return getBLOB(n) case *ast.TextNode: return sxpf.NewPairFromValues(sexpr.SymText, sxpf.NewString(n.Text)) case *ast.SpaceNode: if t.inVerse { return sxpf.NewPairFromValues(sexpr.SymSpace, sxpf.NewString(n.Lexeme)) @@ -278,20 +278,20 @@ func (t *transformer) getCell(cell *ast.TableCell) *sxpf.Pair { return sxpf.NewPair(mapGetS(alignmentSymbolS, cell.Align), t.getInlineSlice(cell.Inlines)) } -func (t *transformer) getBLOB(bn *ast.BLOBNode) *sxpf.Pair { +func getBLOB(bn *ast.BLOBNode) *sxpf.Pair { var lastValue sxpf.Value if bn.Syntax == meta.SyntaxSVG { lastValue = sxpf.NewString(string(bn.Blob)) } else { lastValue = getBase64String(bn.Blob) } return sxpf.NewPairFromValues( sexpr.SymBLOB, - t.getInlineSlice(bn.Description), + sxpf.NewString(bn.Title), sxpf.NewString(bn.Syntax), lastValue, ) } Index: encoder/zjsonenc/zjsonenc.go ================================================================== --- encoder/zjsonenc/zjsonenc.go +++ encoder/zjsonenc/zjsonenc.go @@ -1,18 +1,16 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2020-2023 Detlef Stern +// 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. //----------------------------------------------------------------------------- // Package zjsonenc encodes the abstract syntax tree into JSON. -// -// Deprecated in v0.11 package zjsonenc import ( "fmt" "io" @@ -330,13 +328,13 @@ v.b.WriteByte('}') } func (v *visitor) visitBLOB(bn *ast.BLOBNode) { v.writeNodeStart(zjson.TypeBLOB) - if len(bn.Description) > 0 { + if bn.Title != "" { v.writeContentStart(zjson.NameString2) - ast.Walk(v, &bn.Description) + writeEscaped(&v.b, bn.Title) } v.writeContentStart(zjson.NameString) writeEscaped(&v.b, bn.Syntax) if bn.Syntax == meta.SyntaxSVG { v.writeContentStart(zjson.NameString3) Index: encoder/zmkenc/zmkenc.go ================================================================== --- encoder/zmkenc/zmkenc.go +++ encoder/zmkenc/zmkenc.go @@ -1,7 +1,7 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2020-2023 Detlef Stern +// 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 @@ -10,36 +10,31 @@ // Package zmkenc encodes the abstract syntax tree back into Zettelmarkup. package zmkenc import ( - "bytes" "fmt" "io" "zettelstore.de/c/api" "zettelstore.de/c/attrs" "zettelstore.de/z/ast" "zettelstore.de/z/domain/meta" "zettelstore.de/z/encoder" - "zettelstore.de/z/encoder/textenc" "zettelstore.de/z/strfun" ) func init() { - encoder.Register(api.EncoderZmk, func() encoder.Encoder { return Create() }) + encoder.Register(api.EncoderZmk, func() encoder.Encoder { return &myZE }) } -// Create an encoder. -func Create() *Encoder { return &myZE } +type zmkEncoder struct{} -type Encoder struct{} - -var myZE Encoder +var myZE zmkEncoder // WriteZettel writes the encoded zettel to the writer. -func (*Encoder) WriteZettel(w io.Writer, zn *ast.ZettelNode, evalMeta encoder.EvalMetaFunc) (int, error) { +func (*zmkEncoder) WriteZettel(w io.Writer, zn *ast.ZettelNode, evalMeta encoder.EvalMetaFunc) (int, error) { v := newVisitor(w) v.acceptMeta(zn.InhMeta, evalMeta) if zn.InhMeta.YamlSep { v.b.WriteString("---\n") } else { @@ -49,11 +44,11 @@ length, err := v.b.Flush() return length, err } // WriteMeta encodes meta data as zmk. -func (*Encoder) WriteMeta(w io.Writer, m *meta.Meta, evalMeta encoder.EvalMetaFunc) (int, error) { +func (*zmkEncoder) WriteMeta(w io.Writer, m *meta.Meta, evalMeta encoder.EvalMetaFunc) (int, error) { v := newVisitor(w) v.acceptMeta(m, evalMeta) length, err := v.b.Flush() return length, err } @@ -70,41 +65,40 @@ } v.b.WriteByte('\n') } } -func (ze *Encoder) WriteContent(w io.Writer, zn *ast.ZettelNode) (int, error) { +func (ze *zmkEncoder) WriteContent(w io.Writer, zn *ast.ZettelNode) (int, error) { return ze.WriteBlocks(w, &zn.Ast) } // WriteBlocks writes the content of a block slice to the writer. -func (*Encoder) WriteBlocks(w io.Writer, bs *ast.BlockSlice) (int, error) { +func (*zmkEncoder) WriteBlocks(w io.Writer, bs *ast.BlockSlice) (int, error) { v := newVisitor(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) { +func (*zmkEncoder) WriteInlines(w io.Writer, is *ast.InlineSlice) (int, error) { v := newVisitor(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 - textEnc encoder.Encoder prefix []byte inVerse bool inlinePos int } func newVisitor(w io.Writer) *visitor { - return &visitor{b: encoder.NewEncWriter(w), textEnc: textenc.Create()} + return &visitor{b: encoder.NewEncWriter(w)} } func (v *visitor) Visit(node ast.Node) ast.Visitor { switch n := node.(type) { case *ast.BlockSlice: @@ -343,13 +337,12 @@ v.b.WriteStrings("@@@", bn.Syntax, "\n") v.b.Write(bn.Blob) v.b.WriteString("\n@@@\n") return } - var buf bytes.Buffer - v.textEnc.WriteInlines(&buf, &bn.Description) - v.b.WriteStrings("%% Unable to display BLOB with description '", buf.String(), "' and syntax '", bn.Syntax, "'.") + v.b.WriteStrings( + "%% Unable to display BLOB with title '", bn.Title, "' and syntax '", bn.Syntax, "'.") } var escapeSeqs = strfun.NewSet( "\\", "__", "**", "~~", "^^", ",,", ">>", `""`, "::", "''", "``", "++", "==", ) Index: encoding/atom/atom.go ================================================================== --- encoding/atom/atom.go +++ encoding/atom/atom.go @@ -1,7 +1,7 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2022-2023 Detlef Stern +// 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 @@ -11,10 +11,11 @@ // Package atom provides an Atom encoding. package atom import ( "bytes" + "context" "time" "zettelstore.de/c/api" "zettelstore.de/z/config" "zettelstore.de/z/domain/id" @@ -32,11 +33,11 @@ Title string Generator string NewURLBuilderAbs func() *api.URLBuilder } -func (c *Configuration) Setup(cfg config.Config) { +func (c *Configuration) Setup(ctx context.Context, cfg config.Config) { baseURL := kernel.Main.GetConfig(kernel.WebService, kernel.WebBaseURL).(string) c.Title = cfg.GetSiteName() c.Generator = (kernel.Main.GetConfig(kernel.CoreService, kernel.CoreProgname).(string) + " " + Index: evaluator/evaluator.go ================================================================== --- evaluator/evaluator.go +++ evaluator/evaluator.go @@ -1,7 +1,7 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2021-2023 Detlef Stern +// 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 @@ -407,11 +407,11 @@ e.transcludeCount++ return createInlineErrorImage(en) } if syntax := zettel.Meta.GetDefault(api.KeySyntax, ""); parser.IsImageFormat(syntax) { - e.updateImageRefNode(en, zettel.Meta, syntax) + en.Syntax = syntax return en } else if !parser.IsASTParser(syntax) { // Not embeddable. e.transcludeCount++ return createInlineErrorText(ref, "Not", "embeddable (syntax="+syntax+")") @@ -458,23 +458,10 @@ panic(fmt.Sprintf("%v: %q (state %v) -> %v", err, ref.URL.Path, ref.State, ref)) } return zid } -func (e *evaluator) updateImageRefNode(en *ast.EmbedRefNode, m *meta.Meta, syntax string) { - en.Syntax = syntax - if len(en.Inlines) == 0 { - is := parser.ParseDescription(m) - if len(is) > 0 { - ast.Walk(e, &is) - if len(is) > 0 { - en.Inlines = is - } - } - } -} - func (e *evaluator) evalLiteralNode(ln *ast.LiteralNode) ast.InlineNode { if ln.Kind != ast.LiteralZettel { return ln } e.transcludeCount++ @@ -557,14 +544,18 @@ } if len(bs) == 0 { return nil } if bn, ok := bs[0].(*ast.BLOBNode); ok { + var ins ast.InlineSlice + if bn.Title != "" { + ins = ast.CreateInlineSliceFromWords(strings.Fields(bn.Title)...) + } return ast.InlineSlice{&ast.EmbedBLOBNode{ Blob: bn.Blob, Syntax: bn.Syntax, - Inlines: bn.Description, + Inlines: ins, }} } return nil } Index: evaluator/list.go ================================================================== --- evaluator/list.go +++ evaluator/list.go @@ -1,7 +1,7 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2022-2023 Detlef Stern +// 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 @@ -40,11 +40,11 @@ max: -1, title: rtConfig.GetSiteName(), } actions := q.Actions() if len(actions) == 0 { - return ap.createBlockNodeMeta("") + return ap.createBlockNodeMeta() } acts := make([]string, 0, len(actions)) for i, act := range actions { if strings.HasPrefix(act, "N") { @@ -67,32 +67,26 @@ ap.title = strings.Join(actions[i+1:], " ") break } acts = append(acts, act) } - var firstUnknownKey string for _, act := range acts { switch act { case "ATOM": return ap.createBlockNodeAtom(rtConfig) case "RSS": return ap.createBlockNodeRSS(rtConfig) - case "KEYS": - return ap.createBlockNodeMetaKeys() } key := strings.ToLower(act) switch meta.Type(key) { case meta.TypeWord: return ap.createBlockNodeWord(key) case meta.TypeTagSet: return ap.createBlockNodeTagSet(key) } - if firstUnknownKey == "" { - firstUnknownKey = key - } } - return ap.createBlockNodeMeta(firstUnknownKey) + return ap.createBlockNodeMeta() } type actionPara struct { ctx context.Context q *query.Query @@ -139,11 +133,13 @@ para := make(ast.InlineSlice, 0, len(ccs)) ccs.SortByName() for i, cat := range ccs { if i > 0 { - para = append(para, &ast.SpaceNode{Lexeme: " "}) + para = append(para, &ast.SpaceNode{ + Lexeme: " ", + }) } buf.WriteString(cat.Name) para = append(para, &ast.LinkNode{ Attrs: countMap[cat.Count], @@ -158,11 +154,13 @@ Inlines: ast.InlineSlice{&ast.TextNode{Text: strconv.Itoa(cat.Count)}}, }, ) buf.Truncate(bufLen) } - return &ast.ParaNode{Inlines: para} + return &ast.ParaNode{ + Inlines: para, + } } func (ap *actionPara) limitTags(ccs meta.CountedCategories) meta.CountedCategories { if min, max := ap.min, ap.max; min > 0 || max > 0 { if min < 0 { @@ -182,70 +180,16 @@ } } return ccs } -func (ap *actionPara) createBlockNodeMetaKeys() ast.BlockNode { - arr := make(meta.Arrangement, 128) - for _, m := range ap.ml { - for k := range m.Map() { - arr[k] = append(arr[k], m) - } - } - if len(arr) == 0 { - return nil - } - ccs := arr.Counted() - ccs.SortByName() - - var buf bytes.Buffer - bufLen := ap.prepareSimpleQuery(&buf) - items := make([]ast.ItemSlice, 0, len(ccs)) - for _, cat := range ccs { - buf.WriteString(cat.Name) - buf.WriteString(api.ExistOperator) - q1 := buf.String() - buf.Truncate(bufLen) - buf.WriteString(api.ActionSeparator) - buf.WriteString(cat.Name) - q2 := buf.String() - buf.Truncate(bufLen) - - items = append(items, ast.ItemSlice{ast.CreateParaNode( - &ast.LinkNode{ - Attrs: nil, - Ref: ast.ParseReference(q1), - Inlines: ast.InlineSlice{&ast.TextNode{Text: cat.Name}}, - }, - &ast.SpaceNode{Lexeme: " "}, - &ast.TextNode{Text: "(" + strconv.Itoa(cat.Count) + ", "}, - &ast.LinkNode{ - Attrs: nil, - Ref: ast.ParseReference(q2), - Inlines: ast.InlineSlice{&ast.TextNode{Text: "values"}}, - }, - &ast.TextNode{Text: ")"}, - )}) - } - return &ast.NestedListNode{ - Kind: ap.kind, - Items: items, - Attrs: nil, - } -} - -func (ap *actionPara) createBlockNodeMeta(key string) ast.BlockNode { +func (ap *actionPara) createBlockNodeMeta() ast.BlockNode { if len(ap.ml) == 0 { return nil } items := make([]ast.ItemSlice, 0, len(ap.ml)) for _, m := range ap.ml { - if key != "" { - if _, found := m.Get(key); !found { - continue - } - } zid := m.Zid.String() title, found := m.Get(api.KeyTitle) if !found { title = zid } @@ -269,27 +213,22 @@ ccs := meta.CreateArrangement(ap.ml, key).Counted() if len(ccs) == 0 { return nil, 0 } - ap.prepareSimpleQuery(buf) - buf.WriteString(key) - buf.WriteString(api.SearchOperatorHas) - bufLen := buf.Len() - - return ccs, bufLen -} - -func (ap *actionPara) prepareSimpleQuery(buf *bytes.Buffer) int { sea := ap.q.Clone() sea.RemoveActions() buf.WriteString(ast.QueryPrefix) sea.Print(buf) if buf.Len() > len(ast.QueryPrefix) { buf.WriteByte(' ') } - return buf.Len() + buf.WriteString(key) + buf.WriteByte(':') + bufLen := buf.Len() + + return ccs, bufLen } const fontSizes = 6 // Must be the number of CSS classes zs-font-size-* in base.css const fontSizes64 = float64(fontSizes) @@ -359,15 +298,15 @@ } } func (ap *actionPara) createBlockNodeAtom(cfg config.Config) ast.BlockNode { var atomConfig atom.Configuration - atomConfig.Setup(cfg) + atomConfig.Setup(ap.ctx, cfg) atomConfig.Title = ap.title data := atomConfig.Marshal(ap.q, ap.ml) return &ast.VerbatimNode{ Kind: ast.VerbatimProg, Attrs: attrs.Attributes{"lang": "xml"}, Content: data, } } Index: go.mod ================================================================== --- go.mod +++ go.mod @@ -5,12 +5,12 @@ 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 + golang.org/x/crypto v0.4.0 + golang.org/x/term v0.3.0 + golang.org/x/text v0.5.0 + zettelstore.de/c v0.9.0 ) -require golang.org/x/sys v0.4.0 // indirect +require golang.org/x/sys v0.3.0 // indirect Index: go.sum ================================================================== --- go.sum +++ go.sum @@ -4,16 +4,16 @@ github.com/fsnotify/fsnotify v1.6.0/go.mod h1:sl3t1tCWJFWoRz9R8WJCbQihKKwmorjAbSClcnxKAGw= github.com/pascaldekloe/jwt v1.12.0 h1:imQSkPOtAIBAXoKKjL9ZVJuF/rVqJ+ntiLGpLyeqMUQ= github.com/pascaldekloe/jwt v1.12.0/go.mod h1:LiIl7EwaglmH1hWThd/AmydNCnHf/mmfluBlNqHbk8U= github.com/yuin/goldmark v1.5.3 h1:3HUJmBFbQW9fhQOzMgseU134xfi6hU+mjWywx5Ty+/M= github.com/yuin/goldmark v1.5.3/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= -golang.org/x/crypto v0.5.0 h1:U/0M97KRkSFvyD/3FSmdP5W5swImpNgle/EHFhOsQPE= -golang.org/x/crypto v0.5.0/go.mod h1:NK/OQwhpMQP3MwtdjgLlYHnH9ebylxKWv3e0fK+mkQU= +golang.org/x/crypto v0.4.0 h1:UVQgzMY87xqpKNgb+kDsll2Igd33HszWHFLmpaRMq/8= +golang.org/x/crypto v0.4.0/go.mod h1:3quD/ATkf6oY+rnes5c3ExXTbLc8mueNue5/DoinL80= 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= +golang.org/x/sys v0.3.0 h1:w8ZOecv6NaNa/zC8944JTU3vz4u6Lagfk4RPQxv92NQ= +golang.org/x/sys v0.3.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.3.0 h1:qoo4akIqOcDME5bhc/NgxUdovd6BSS2uMsVjB56q1xI= +golang.org/x/term v0.3.0/go.mod h1:q750SLmJuPmVoN1blW3UFBPREJfb1KmY3vwxfr+nFDA= +golang.org/x/text v0.5.0 h1:OLmvp0KP+FVG99Ct/qFiL/Fhk4zp4QQnZ7b2U+5piUM= +golang.org/x/text v0.5.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +zettelstore.de/c v0.9.0 h1:QkPHKQcJBA5qqEUwy370tNqVDWjhTioAzSf2cRvAdn8= +zettelstore.de/c v0.9.0/go.mod h1:+SoneUhKQ81A2Id/bC6FdDYYQAHYfVryh7wHFnnklew= Index: kernel/impl/cfg.go ================================================================== --- kernel/impl/cfg.go +++ kernel/impl/cfg.go @@ -64,10 +64,11 @@ return vis, nil }, true, }, keyExpertMode: {"Expert mode", parseBool, true}, + config.KeyFooterHTML: {"Footer HTML", parseString, true}, config.KeyFooterZettel: {"Footer Zettel", parseInvalidZid, true}, config.KeyHomeZettel: {"Home zettel", parseZid, true}, kernel.ConfigInsecureHTML: { "Insecure HTML", cs.noFrozen(func(val string) (any, error) { @@ -98,10 +99,11 @@ cs.next = interfaceMap{ keyDefaultCopyright: "", keyDefaultLicense: "", keyDefaultVisibility: meta.VisibilityLogin, keyExpertMode: false, + config.KeyFooterHTML: "", config.KeyFooterZettel: id.Invalid, config.KeyHomeZettel: id.DefaultHomeZid, kernel.ConfigInsecureHTML: config.NoHTML, api.KeyLang: api.ValueLangEN, config.KeyMarkerExternal: "➚", Index: parser/blob/blob.go ================================================================== --- parser/blob/blob.go +++ parser/blob/blob.go @@ -1,7 +1,7 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2020-2023 Detlef Stern +// 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 @@ -10,10 +10,11 @@ // Package blob provides a parser of binary data. package blob import ( + "zettelstore.de/c/api" "zettelstore.de/z/ast" "zettelstore.de/z/domain/meta" "zettelstore.de/z/input" "zettelstore.de/z/parser" ) @@ -59,13 +60,14 @@ func parseBlocks(inp *input.Input, m *meta.Meta, syntax string) ast.BlockSlice { if p := parser.Get(syntax); p != nil { syntax = p.Name } + title := m.GetDefault(api.KeyTitle, "") return ast.BlockSlice{&ast.BLOBNode{ - Description: parser.ParseDescription(m), - Syntax: syntax, - Blob: []byte(inp.Src), + Title: title, + Syntax: syntax, + Blob: []byte(inp.Src), }} } func parseInlines(*input.Input, string) ast.InlineSlice { return nil } Index: parser/draw/draw.go ================================================================== --- parser/draw/draw.go +++ parser/draw/draw.go @@ -1,7 +1,7 @@ //----------------------------------------------------------------------------- -// Copyright (c) 2022-2023 Detlef Stern +// 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 @@ -60,13 +60,13 @@ svg := canvasToSVG(canvas, font, int(scaleX), int(scaleY)) if len(svg) == 0 { return ast.BlockSlice{ast.CreateParaNode(noSVGErrMsg()...)} } return ast.BlockSlice{&ast.BLOBNode{ - Description: parser.ParseDescription(m), - Syntax: meta.SyntaxSVG, - Blob: svg, + Title: "", + Syntax: meta.SyntaxSVG, + Blob: svg, }} } func parseInlines(inp *input.Input, _ string) ast.InlineSlice { canvas, err := newCanvas(inp.Src[inp.Pos:]) @@ -107,13 +107,13 @@ svg := canvasToSVG(canvas, font, scaleX, scaleY) if len(svg) == 0 { return ast.CreateParaNode(noSVGErrMsg()...) } return &ast.BLOBNode{ - Description: nil, // TODO: look for attribute "summary" / "title" - Syntax: meta.SyntaxSVG, - Blob: svg, + Title: "", + Syntax: meta.SyntaxSVG, + Blob: svg, } } func getScale(a attrs.Attributes, key string, defVal int) int { if val, found := a.Get(key); found { Index: parser/draw/svg.go ================================================================== --- parser/draw/svg.go +++ parser/draw/svg.go @@ -37,11 +37,11 @@ font = "monospace" } var b bytes.Buffer fmt.Fprintf(&b, - `docs/development (a zettel box) for details. - ## Clone the repository Most of this is covered by the excellent Fossil [documentation](https://fossil-scm.org/home/doc/trunk/www/quickstart.wiki). 1. Create a directory to store your Fossil repositories. Let's assume, you have created $HOME/fossils. Index: www/changes.wiki ================================================================== --- www/changes.wiki +++ www/changes.wiki @@ -1,34 +1,9 @@ Change Log - -

Changes for Version 0.11.0 (pending)

- -

Changes for Version 0.10.1 (2023-01-30)

- * Show button to save a query into a zettel only when the current user has - authorization to do it. - (fix: webui) - -

Changes for Version 0.10.0 (2023-01-24)

- * Remove support for endpoints /j, /m, /q, /p, /v. Their functions - are merged into endpoint /z. This was announced in version 0.9.0. - Please use only client library with at least version 0.10.0 too. - (breaking: api) - * Remove support for runtime configuration key footer-html. Use - footer-zettel instead. Deprecated in version 0.9.0. - (breaking: webui) - * Save a query into a zettel to freeze it. - (major: webui) - * Allow to show all used metadata keys, linked with their occurrences and - their values. - (minor: webui) - * Mark ZJSON encoding as deprecated for v0.11.0. Please use Sexpr encoding - instead. - (deprecated) - * Some smaller bug fixes and improvements, to the software and to the - documentation. +

Changes for Version 0.10.0 (pending)

Changes for Version 0.9.0 (2022-12-12)

* Remove support syntax pikchr. Although it was a nice idea to include it into Zettelstore, the implementation is too brittle (w.r.t. the Index: www/download.wiki ================================================================== --- www/download.wiki +++ www/download.wiki @@ -7,20 +7,20 @@ * However, it is in use by the main developer since March 2020 without any damage. * It may be useful for you. It is useful for me. * Take a look at the [https://zettelstore.de/manual/|manual] to know how to start and use it.

ZIP-ped Executables

-Build: v0.10.1 (2023-01-30). +Build: v0.9.0 (2022-12-12). - * [/uv/zettelstore-0.10.1-linux-amd64.zip|Linux] (amd64) - * [/uv/zettelstore-0.10.1-linux-arm.zip|Linux] (arm6, e.g. Raspberry Pi) - * [/uv/zettelstore-0.10.1-windows-amd64.zip|Windows] (amd64) - * [/uv/zettelstore-0.10.1-darwin-amd64.zip|macOS] (amd64) - * [/uv/zettelstore-0.10.1-darwin-arm64.zip|macOS] (arm64, aka Apple silicon) + * [/uv/zettelstore-0.9.0-linux-amd64.zip|Linux] (amd64) + * [/uv/zettelstore-0.9.0-linux-arm.zip|Linux] (arm6, e.g. Raspberry Pi) + * [/uv/zettelstore-0.9.0-windows-amd64.zip|Windows] (amd64) + * [/uv/zettelstore-0.9.0-darwin-amd64.zip|macOS] (amd64) + * [/uv/zettelstore-0.9.0-darwin-arm64.zip|macOS] (arm64, aka Apple silicon) Unzip the appropriate file, install and execute Zettelstore according to the manual.

Zettel for the manual

As a starter, you can download the zettel for the manual -[/uv/manual-0.10.1.zip|here]. +[/uv/manual-0.9.0.zip|here]. Just unzip the contained files and put them into your zettel folder or configure a file box to read the zettel directly from the ZIP file. Index: www/index.wiki ================================================================== --- www/index.wiki +++ www/index.wiki @@ -23,17 +23,17 @@ packages may be experimental. [https://twitter.com/zettelstore|Stay] tuned …

Latest Release: 0.10.1 (2023-01-30)

Latest Release: 0.9.0 (2022-12-12)

* [./download.wiki|Download] - * [./changes.wiki#0_10|Change summary] - * [/timeline?p=v0.10.1&bt=v0.9.0&y=ci|Check-ins for version 0.10.1], - [/vdiff?to=v0.10.1&from=v0.9.0|content diff] - * [/timeline?df=v0.10.1&y=ci|Check-ins derived from the 0.10.1 release], - [/vdiff?from=v0.10.1&to=trunk|content diff] + * [./changes.wiki#0_9|Change summary] + * [/timeline?p=v0.9.0&bt=v0.8.0&y=ci|Check-ins for version 0.9.0], + [/vdiff?to=v0.9.0&from=v0.8.0|content diff] + * [/timeline?df=v0.9.0&y=ci|Check-ins derived from the 0.9.0 release], + [/vdiff?from=v0.9.0&to=trunk|content diff] * [./plan.wiki|Limitations and planned improvements] * [/timeline?t=release|Timeline of all past releases]

{{Heading}}