From f5f24a46660af12bad375f5428b6a3af9552f26a Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Fri, 29 Mar 2024 16:41:32 -0500 Subject: [PATCH] Cleanup: Incorrect example in IKI specification. The example in the iki.txt specification has several errors. Of particular note is the first code is incorrectly escaped and the terminating single quote discludes the example block. The Objects and Contents example results is entirely incorrect. There is no change to the specification rules itself and I do not technically need to change the version. However, given how long it has been incorrect I have decided to up the version date to make the correct file easier to identify. --- specifications/iki.txt | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/specifications/iki.txt b/specifications/iki.txt index 1bc219d..a6c4fea 100644 --- a/specifications/iki.txt +++ b/specifications/iki.txt @@ -1,7 +1,7 @@ # fss-0002 iki-0000 # # license open-standard-license-1.0 -# version 2024/01/15 +# version 2024/03/29 # # This file (assumed to be named iki.txt) can be more easily read using the following iki_read commands: # iki_read iki.txt +Q -w -WWW character "'" "'" code '"' '"' italic '"' '"' @@ -57,35 +57,37 @@ IKI Specifications: code:"" Example\: - code\:'# fss-000c iki-0000 + code:'# fss-000c iki-0000 This is my sentence, anything can go here but sometimes I want to italic\:"emphasize some text". - Other times I want to render a url such as this example url: url\:'http://www.example.com/url with space/'. + Other times I want to render a url such as this example url: url\:\'http://www.example.com/url with space/\'. There are no comments, except for maybe the FSS\:"Featureless Settings Specification" header (which would not resolve to any IKI syntax anyway). Quotes may be included, such as: code\:"const char *string = \"My \\\"quoted\\\" C string.\";". - The following italic\:"is escaped to not be treated as IKI data".' + The following italic\:"is escaped to not be treated as IKI data". - The conditionally optional open and close brackets allow for putting a variable directly next to another word character like: [context]\:"strong"this[context]\:"strong". + The conditionally optional open and close brackets allow for putting a variable directly next to another word character like: [context]\:"strong"this[context]\:"strong".' Objects (also called vocabulary or variable name) would be\: - 1) FSS - 2) italic - 3) url + 1) italic + 2) url + 3) FSS 4) code - 5) context + 5) italic 6) context + 7) context Contents (also called variable value) would be\: - 1.1) Featureless Settings Specification - 2.1) emphasize some text - 3.1) http://www.example.com/url with space/ + 1.1) emphasize some text + 2.1) http://www.example.com/url with space/ + 3.1) Featureless Settings Specification 4.1) const char *string = "My \"quoted\" C string."; - 5.1) strong + 5.1) is escaped to not be treated as IKI data 6.1) strong + 7.1) strong The following are core specifications (each with a common name associated with the specification number)\: - fss-0000: Unrestricted -- 1.8.3.1