From 5338c8104d4d096e56adc1e75c9c9df7d06706f3 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Tue, 11 Jun 2024 18:17:28 -0500 Subject: [PATCH] Update: Specifications to use 'grave' as the common term for 'backtick' and synchronize files. --- .../standards/controller/documents/actions.txt | 2 +- documents/standards/controller/documents/entry.txt | 2 +- documents/standards/controller/documents/exit.txt | 2 +- .../standards/controller/documents/packet.txt | 2 +- documents/standards/controller/documents/rule.txt | 2 +- .../standards/controller/documents/simulate.txt | 2 +- .../standards/controller/specifications/entry.txt | 2 +- .../standards/controller/specifications/exit.txt | 2 +- .../standards/controller/specifications/packet.txt | 2 +- .../standards/controller/specifications/rule.txt | 2 +- .../standards/controller/specifications/task.txt | 2 +- .../standards/controller/specifications/time.txt | 2 +- documents/standards/fake/documents/fakefile.txt | 2 +- documents/standards/fake/documents/settings.txt | 2 +- .../standards/fake/specifications/defines.txt | 2 +- .../standards/fake/specifications/dependencies.txt | 2 +- .../standards/fake/specifications/fakefile.txt | 2 +- .../standards/fake/specifications/settings.txt | 2 +- .../standards/fll/specifications/fss-0000.txt | 2 +- .../standards/fll/specifications/fss-0001.txt | 2 +- .../standards/fll/specifications/fss-0002.txt | 2 +- .../standards/fll/specifications/fss-0003.txt | 2 +- .../standards/fll/specifications/fss-0004.txt | 2 +- .../standards/fll/specifications/fss-0005.txt | 2 +- .../standards/fll/specifications/fss-0006.txt | 2 +- .../standards/fll/specifications/fss-0007.txt | 2 +- .../standards/fll/specifications/fss-0008.txt | 2 +- .../standards/fll/specifications/fss-0009.txt | 6 +-- .../standards/fll/specifications/fss-000a.txt | 6 +-- .../standards/fll/specifications/fss-000b.txt | 2 +- .../standards/fll/specifications/fss-000c.txt | 2 +- .../standards/fll/specifications/fss-000d.txt | 2 +- .../standards/fll/specifications/fss-000e.txt | 2 +- .../standards/fll/specifications/fss-000f.txt | 58 +++++++++++++++++----- .../standards/fll/specifications/fss-0010.txt | 2 +- documents/standards/fll/specifications/fss.txt | 2 +- .../standards/fll/specifications/iki-0000.txt | 2 +- .../standards/fll/specifications/iki-0001.txt | 2 +- .../standards/fll/specifications/iki-0002.txt | 2 +- documents/standards/fll/specifications/iki.txt | 6 +-- documents/standards/fll/specifications/time.txt | 2 +- fll/specifications.html | 2 +- 42 files changed, 93 insertions(+), 59 deletions(-) diff --git a/documents/standards/controller/documents/actions.txt b/documents/standards/controller/documents/actions.txt index bbe70f5..9cad634 100644 --- a/documents/standards/controller/documents/actions.txt +++ b/documents/standards/controller/documents/actions.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # # This file (assumed to be named actions.txt) can be more easily read using the following iki_read commands: # iki_read actions.txt +Q -w -W code '"' '"' diff --git a/documents/standards/controller/documents/entry.txt b/documents/standards/controller/documents/entry.txt index 394fd95..7a1983f 100644 --- a/documents/standards/controller/documents/entry.txt +++ b/documents/standards/controller/documents/entry.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # # This file (assumed to be named entry.txt) can be more easily read using the following iki_read commands: # iki_read entry.txt +Q -r PID PID -w -WW code '"' '"' diff --git a/documents/standards/controller/documents/exit.txt b/documents/standards/controller/documents/exit.txt index bfa4372..1d287b6 100644 --- a/documents/standards/controller/documents/exit.txt +++ b/documents/standards/controller/documents/exit.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # # This file (assumed to be named exit.txt) can be more easily read using the following iki_read commands: # iki_read exit.txt +Q -w -r PID PID -w -W code '"' '"' diff --git a/documents/standards/controller/documents/packet.txt b/documents/standards/controller/documents/packet.txt index 3a0038d..a78f9fa 100644 --- a/documents/standards/controller/documents/packet.txt +++ b/documents/standards/controller/documents/packet.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # # This file (assumed to be named packet.txt) can be more easily read using the following iki_read commands: # iki_read packet.txt +Q -w -W code '"' '"' diff --git a/documents/standards/controller/documents/rule.txt b/documents/standards/controller/documents/rule.txt index 8d9e1c5..5d9805a 100644 --- a/documents/standards/controller/documents/rule.txt +++ b/documents/standards/controller/documents/rule.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # # This file (assumed to be named rule.txt) can be more easily read using the following iki_read commands: # iki_read rule.txt +Q -r PID PID -w -W code '"' '"' diff --git a/documents/standards/controller/documents/simulate.txt b/documents/standards/controller/documents/simulate.txt index 2dae70d..a7d003d 100644 --- a/documents/standards/controller/documents/simulate.txt +++ b/documents/standards/controller/documents/simulate.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # # This file (assumed to be named simulate.txt) can be more easily read using the following iki_read commands: # iki_read simulate.txt +Q -w -W code '"' '"' diff --git a/documents/standards/controller/specifications/entry.txt b/documents/standards/controller/specifications/entry.txt index 92ceeea..54f9aff 100644 --- a/documents/standards/controller/specifications/entry.txt +++ b/documents/standards/controller/specifications/entry.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # # This file (assumed to be named entry.txt) can be more easily read using the following iki_read commands: # iki_read entry.txt +Q -w -W code '"' '"' diff --git a/documents/standards/controller/specifications/exit.txt b/documents/standards/controller/specifications/exit.txt index 83ab08f..1d2b842 100644 --- a/documents/standards/controller/specifications/exit.txt +++ b/documents/standards/controller/specifications/exit.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # # This file (assumed to be named exit.txt) can be more easily read using the following iki_read commands: # iki_read exit.txt +Q -w -W code '"' '"' diff --git a/documents/standards/controller/specifications/packet.txt b/documents/standards/controller/specifications/packet.txt index b76ee3e..59ee6c1 100644 --- a/documents/standards/controller/specifications/packet.txt +++ b/documents/standards/controller/specifications/packet.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # # This file (assumed to be named packet.txt) can be more easily read using the following iki_read commands: # iki_read packet.txt +Q -w -W code '"' '"' diff --git a/documents/standards/controller/specifications/rule.txt b/documents/standards/controller/specifications/rule.txt index 8ea846e..db45a2e 100644 --- a/documents/standards/controller/specifications/rule.txt +++ b/documents/standards/controller/specifications/rule.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # # This file (assumed to be named rule.txt) can be more easily read using the following iki_read commands: # iki_read rule.txt +Q -w -W code '"' '"' diff --git a/documents/standards/controller/specifications/task.txt b/documents/standards/controller/specifications/task.txt index 8175aa4..5158361 100644 --- a/documents/standards/controller/specifications/task.txt +++ b/documents/standards/controller/specifications/task.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # # This file (assumed to be named task.txt) can be more easily read using the following iki_read commands: # iki_read task.txt +Q -w -W code '"' '"' diff --git a/documents/standards/controller/specifications/time.txt b/documents/standards/controller/specifications/time.txt index 4af3cf9..9170fde 100644 --- a/documents/standards/controller/specifications/time.txt +++ b/documents/standards/controller/specifications/time.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # # This file (assumed to be named time.txt) can be more easily read using the following iki_read commands: # iki_read time.txt +Q -r UTC UTC -w -WW character "'" "'" code '"' '"' diff --git a/documents/standards/fake/documents/fakefile.txt b/documents/standards/fake/documents/fakefile.txt index e9b6fc0..1c261e2 100644 --- a/documents/standards/fake/documents/fakefile.txt +++ b/documents/standards/fake/documents/fakefile.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # version 2024/03/23 # # This file (assumed to be named fakefile.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fake/documents/settings.txt b/documents/standards/fake/documents/settings.txt index 957a7e1..a962b34 100644 --- a/documents/standards/fake/documents/settings.txt +++ b/documents/standards/fake/documents/settings.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # version 2024/03/23 # # This file (assumed to be named settings.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fake/specifications/defines.txt b/documents/standards/fake/specifications/defines.txt index b85fb6b..e2c8412 100644 --- a/documents/standards/fake/specifications/defines.txt +++ b/documents/standards/fake/specifications/defines.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # version 2024/03/23 # # This file (assumed to be named defines.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fake/specifications/dependencies.txt b/documents/standards/fake/specifications/dependencies.txt index 0983e5c..abb9ed7 100644 --- a/documents/standards/fake/specifications/dependencies.txt +++ b/documents/standards/fake/specifications/dependencies.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # version 2024/03/23 # # This file (assumed to be named dependencies.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fake/specifications/fakefile.txt b/documents/standards/fake/specifications/fakefile.txt index dcd3bb4..52f0389 100644 --- a/documents/standards/fake/specifications/fakefile.txt +++ b/documents/standards/fake/specifications/fakefile.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # version 2024/03/23 # # This file (assumed to be named fakefile.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fake/specifications/settings.txt b/documents/standards/fake/specifications/settings.txt index 4121a80..5fd1e63 100644 --- a/documents/standards/fake/specifications/settings.txt +++ b/documents/standards/fake/specifications/settings.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license: open-standard-license-1.0 +# license: open-standard-license-1.0-or-later # version 2024/03/23 # # This file (assumed to be named settings.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-0000.txt b/documents/standards/fll/specifications/fss-0000.txt index a1f2203..86848d7 100644 --- a/documents/standards/fll/specifications/fss-0000.txt +++ b/documents/standards/fll/specifications/fss-0000.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2024/01/15 # # This file (assumed to be named fss-0000.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-0001.txt b/documents/standards/fll/specifications/fss-0001.txt index c779c54..388ffee 100644 --- a/documents/standards/fll/specifications/fss-0001.txt +++ b/documents/standards/fll/specifications/fss-0001.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2024/01/15 # # This file (assumed to be named fss-0001.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-0002.txt b/documents/standards/fll/specifications/fss-0002.txt index 0b0d50c..715f73b 100644 --- a/documents/standards/fll/specifications/fss-0002.txt +++ b/documents/standards/fll/specifications/fss-0002.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2024/01/15 # # This file (assumed to be named fss-0002.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-0003.txt b/documents/standards/fll/specifications/fss-0003.txt index 6a3954c..652d598 100644 --- a/documents/standards/fll/specifications/fss-0003.txt +++ b/documents/standards/fll/specifications/fss-0003.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2024/01/15 # # This file (assumed to be named fss-0003.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-0004.txt b/documents/standards/fll/specifications/fss-0004.txt index cd75c6b..32adee4 100644 --- a/documents/standards/fll/specifications/fss-0004.txt +++ b/documents/standards/fll/specifications/fss-0004.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2023/07/14 # # This file (assumed to be named fss-0004.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-0005.txt b/documents/standards/fll/specifications/fss-0005.txt index 011a99d..deaed3d 100644 --- a/documents/standards/fll/specifications/fss-0005.txt +++ b/documents/standards/fll/specifications/fss-0005.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2023/07/14 # # This file (assumed to be named fss-0005.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-0006.txt b/documents/standards/fll/specifications/fss-0006.txt index ea5dd62..417a4c7 100644 --- a/documents/standards/fll/specifications/fss-0006.txt +++ b/documents/standards/fll/specifications/fss-0006.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2023/07/14 # # This file (assumed to be named fss-0006.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-0007.txt b/documents/standards/fll/specifications/fss-0007.txt index 7fb5d8e..d420bca 100644 --- a/documents/standards/fll/specifications/fss-0007.txt +++ b/documents/standards/fll/specifications/fss-0007.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2023/07/14 # # This file (assumed to be named fss-0007.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-0008.txt b/documents/standards/fll/specifications/fss-0008.txt index 937f9c6..3409cf5 100644 --- a/documents/standards/fll/specifications/fss-0008.txt +++ b/documents/standards/fll/specifications/fss-0008.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2023/07/14 # # This file (assumed to be named fss-0008.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-0009.txt b/documents/standards/fll/specifications/fss-0009.txt index 740bb9a..6dc5d66 100644 --- a/documents/standards/fll/specifications/fss-0009.txt +++ b/documents/standards/fll/specifications/fss-0009.txt @@ -1,7 +1,7 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 -# version 2023/07/14 +# license open-standard-license-1.0-or-later +# version 2024/06/11 # # This file (assumed to be named fss-0009.txt) can be more easily read using the following iki_read commands: # iki_read fss-0009.txt +Q -w -WW character "'" "'" code '"' '"' @@ -17,7 +17,7 @@ Featureless Settings Specification: 0009 - Reverse Mapping: White space separates an Object from the Content. An Object may be preceded by a new line, in which case means that the Object has no Content. If only printing white spaces or non-printable characters precedes a valid Object, then that Object is considered to have no Content. - An Object may be quoted to include white space where a single quote character:"'" (unicode:"U+0027"), a double quote character:'"' (unicode:"U+0022"), or a backtick character:'`' (unicode:"U+0060") are used to quote. + An Object may be quoted to include white space where a single quote character:"'" (unicode:"U+0027"), a double quote character:'"' (unicode:"U+0022"), or a grave (backtick) character:'`' (unicode:"U+0060") are used to quote. An Object is only considered quoted if the first and last character of the Object are the same quote. Any quote characters in a non-quoted Object are treated as part of the Object rather than as a quote. An Object that properly starts with a quote character but is not properly terminated before the new line is reached is considered to be an Object terminating at the end of the line. diff --git a/documents/standards/fll/specifications/fss-000a.txt b/documents/standards/fll/specifications/fss-000a.txt index da6c0e7..1d75354 100644 --- a/documents/standards/fll/specifications/fss-000a.txt +++ b/documents/standards/fll/specifications/fss-000a.txt @@ -1,7 +1,7 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 -# version 2023/07/14 +# license open-standard-license-1.0-or-later +# version 2024/06/11 # # This file (assumed to be named fss-000a.txt) can be more easily read using the following iki_read commands: # iki_read fss-000a.txt +Q -w -WW character "'" "'" code '"' '"' @@ -17,7 +17,7 @@ Featureless Settings Specification: 000A - Extended Reverse Mapping: White space separates an Object from the Content. An Object may be followed by a new line, in which case means that the Object has no Content. If only printing white spaces or non-printable characters follow a valid Object, then that Object is considered to have no Content. - An Object may be quoted to include white space where a single quote character:"'" (unicode:"U+0027"), a double quote character:'"' (unicode:"U+0022"), or a backtick character:'`' (unicode:"U+0060") are used to quote. + An Object may be quoted to include white space where a single quote character:"'" (unicode:"U+0027"), a double quote character:'"' (unicode:"U+0022"), or a grave (backtick) character:'`' (unicode:"U+0060") are used to quote. An Object is only considered quoted if the first and last character of the Object are the same quote. Any quote characters in a non-quoted Object are treated as part of the Object rather than as a quote. An Object that properly starts with a quote character but is not properly terminated before the new line is reached is considered to be an Object terminating at the end of the line. diff --git a/documents/standards/fll/specifications/fss-000b.txt b/documents/standards/fll/specifications/fss-000b.txt index 4de2fef..55a53c1 100644 --- a/documents/standards/fll/specifications/fss-000b.txt +++ b/documents/standards/fll/specifications/fss-000b.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2023/07/14 # # This file (assumed to be named fss-000b.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-000c.txt b/documents/standards/fll/specifications/fss-000c.txt index c2bd010..8180e61 100644 --- a/documents/standards/fll/specifications/fss-000c.txt +++ b/documents/standards/fll/specifications/fss-000c.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2023/07/14 # # This file (assumed to be named fss-000c.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-000d.txt b/documents/standards/fll/specifications/fss-000d.txt index 1924521..899a263 100644 --- a/documents/standards/fll/specifications/fss-000d.txt +++ b/documents/standards/fll/specifications/fss-000d.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2023/07/14 # # This file (assumed to be named fss-000d.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-000e.txt b/documents/standards/fll/specifications/fss-000e.txt index 141f36a..1e56359 100644 --- a/documents/standards/fll/specifications/fss-000e.txt +++ b/documents/standards/fll/specifications/fss-000e.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2024/03/12 # # This file (assumed to be named fss-000e.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss-000f.txt b/documents/standards/fll/specifications/fss-000f.txt index 1451834..de2752c 100644 --- a/documents/standards/fll/specifications/fss-000f.txt +++ b/documents/standards/fll/specifications/fss-000f.txt @@ -1,7 +1,7 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 -# version 2023/11/14 +# license open-standard-license-1.0-or-later +# version 2024/06/05 # # This file (assumed to be named fss-000f.txt) can be more easily read using the following iki_read commands: # iki_read fss-000f.txt +Q -w -WWWW character "'" "'" code '"' '"' italic '"' '"' bold '"' '"' @@ -11,32 +11,43 @@ # Featureless Settings Specification: 000f - Simple Packet: - This is a network packet format that contains code:"FSS-000e (Payload)" within it. + This is a network packet format that often contains code:"FSS-000e (Payload)" within it. + + The bold:"Magic Block" when containing code:"FSS-000e (Payload)" in the bold:"Payload Block" is: code:"11010010100111101111010000111110". + + The bold:"Magic Block" when containing unspecified plain text in the bold:"Payload Block" is: code:"00101110000001001101110001000010". + + The bold:"Magic Block" when containing unspecified binary data in the bold:"Payload Block" is: code:"00010101101001001111000000001000". The bold:"Simple Packet" structure is described in blocks, of which are structured in bytes. - There are only three blocks in this format\: + There are three or four blocks in this format\: 1) Control Block. 2) Size Block. - 3) Payload Block. + 3) Magic Block. + 4) Payload Block. The bold:"Control Block" is the first block in the packet and is considered endianless. There exists only a single byte within the bold:"Control Block" (8-bits). Regardless of the endianness of the packet, leftmost bit is always the endianness bit. The second bit following that endianness bit represents the italic:"string" or italic:"binary" bit. + The third bit following the endiannes bit represents the magic bit. Control Block Structure\: code:" - [ Endianness Bit ] [ String / Binary Bit ] [ Remaining 6 Bits (unused) ] - [ size: 1 bit ] [ size: 1 bit ] [ size: 6 bits ] + [ Endianness Bit ] [ String / Binary Bit ] [ Magic Bit ] [ Remaining 5 Bits (unused) ] + [ size: 1 bit ] [ size: 1 bit ] [ size: 1 bit ] [ size: 5 bits ] " The endianness bit designates whether or not the packet is in big endian or little endian format. A bit value of 0 designates that this packet is in little endian and a value of 1 designates that this packet is in big endian format. All italic:"binary" data within this packet, following the Control Block, must respect this endianness bit (including the bold:"Size Block"). + The magic bit designates whether or not the packet contains the optional bold:"Magic Block". + When the magic bit is not set, then there is no bold:"Magic Block". + The italic:"string" or italic:"binary" bit, a value of 0 designates that the packet is in string format and a value of 1 designates that the packet is in italic:"binary" format. - While the packet might be considered to be in string format, it is technically always in italic:"binary" format due to the bold:"Control Block" and bold:"Size Block". + While the packet might be considered to be in string format, it is technically always in italic:"binary" format due to the bold:"Control Block", the optional bold:"Magic Block", and bold:"Size Block". This means that the italic:"binary" bit designating the packet as either a italic:"string" packet or a italic:"binary" packet is referring to whether or not the bold:"Payload Block" is in italic:"string" or italic:"binary" format. The bold:"Payload Block" itself can contain italic:"binary" data even when in italic:"string" format as per code:"FSS-000e (Payload)". @@ -55,17 +66,34 @@ Featureless Settings Specification: 000f - Simple Packet: The bold:"Size Block" is an unsigned 32-bit integer representing the size of the entire packet in bytes, including the bold:"Control Block" and bold:"Size Block". This size must exactly match the packet to be a valid packet. The size represents number of bytes in the file. - The bold:"Control Block" is 1 byte long and the bold:"Size Block" is 4 bytes long, therefore the maximum available size of the entire bold:"Simple Packet" structure is code:"(2^32)-6". + The bold:"Control Block" is 1 byte long and the bold:"Size Block" is 4 bytes long, therefore the maximum available size of the entire bold:"Simple Packet" structure is code:"(2^32)-5". + The bold:"Magic Block" is 4 bytes long, therefore when the magic bit is set, then the maximum available size of the entire bold:"Simple Packet" structure is code:"(2^32)-9". The reason behind why the size includes both the bold:"Control Block" and the bold:"Size Block" in addition to the bold:"Payload Block" is to avoid the need to perform any calculations for handling the size of the entire packet. The idea here is to optimize the packet for the network hardware transferring the packet. The network device should not need to read the contents of the packet in order to transfer the packet and therefore it only needs the number of the entire packet. Anything that wants to analyze this packet will have to incure the cost of calculating the bold:"Payload Block" size by performing the appropriate subtraction from the size represented in the bold:"Size Block". + Magic Block Structure\: + code:" + [ Size Block ] + [ size: 32 bits ] + " + + The bold:"Magic Block" is an unsigned 32-bit digit used to uniquely identify the packet. + The 32-bits are treated as endianless such that the left to right order of the bits is always the same for both big and little endian systems. + The bold:"Magic Block" is required when the magic bit is set and it must not exist when the magic bit is not set. + + This offers optimization in identifying the packet and its structure. + This is particularly useful for quick identification on the network such as via routers. + This is particularly useful for storing the packet as a file. + This is particularly unhelpful for security and privacy given that it helps quickly identify the packet. + Payload Block Structure\: code:" - [ Payload Block ] - [ size: (2^32)-6 bytes ] + [ Payload Block ] + [ size: (2^32)-5 bytes (or (2^32)-9 bytes if magic bit is set) ] " - The bold:"Payload Block" is not defined by this standard other than that it exists and should be in code:"FSS-000e (Payload)" format. + The bold:"Payload Block" is not defined by this standard other than that it exists and is suggested to be in code:"FSS-000e (Payload)" format. + If the bold:"Magic Block" is present and set to code:"11010010100111101111010000111110", then this is expected to be in code:"FSS-000e (Payload)" format. The code:"FSS-000e (Payload)" may be represented in either italic:"string" format or italic:"binary" format. The code:"FSS-000e (Payload)" may contain multiple italic:"header"(s) but may only contain a single italic:"payload". With this in mind, it is recommended that only a single italic:"header" be supported in the bold:"Payload Block". @@ -78,3 +106,9 @@ Featureless Settings Specification: 000f - Simple Packet: [ Control Block ] [ Size Block ] [ Payload Block ] [ 0b10000000 ] [ 0b00000000 0b00000000 0b00000100 0b11010010 ] [ size: 1229 (1234 - 5) ] " + + Example Packet Structure with Magic Bit\: + code:" + [ Control Block ] [ Size Block ] [ Magic Block ] [ Payload Block ] + [ 0b10100000 ] [ 0b00000000 0b00000000 0b00000100 0b11010010 ] [ 0b11010010 0b10011110 0b11110100 0b00111110 ] [ size: 1225 (1234 - 9) ] + " diff --git a/documents/standards/fll/specifications/fss-0010.txt b/documents/standards/fll/specifications/fss-0010.txt index 963151d..8e52160 100644 --- a/documents/standards/fll/specifications/fss-0010.txt +++ b/documents/standards/fll/specifications/fss-0010.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2023/07/16 # # This file (assumed to be named fss-0010.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/fss.txt b/documents/standards/fll/specifications/fss.txt index 4e661f1..b0ba607 100644 --- a/documents/standards/fll/specifications/fss.txt +++ b/documents/standards/fll/specifications/fss.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2024/01/15 # # This file (assumed to be named fss.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/iki-0000.txt b/documents/standards/fll/specifications/iki-0000.txt index d7edca0..68213c4 100644 --- a/documents/standards/fll/specifications/iki-0000.txt +++ b/documents/standards/fll/specifications/iki-0000.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2023/07/14 # # This file (assumed to be named iki-0000.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/iki-0001.txt b/documents/standards/fll/specifications/iki-0001.txt index 4a8b140..df33095 100644 --- a/documents/standards/fll/specifications/iki-0001.txt +++ b/documents/standards/fll/specifications/iki-0001.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2023/07/14 # # This file (assumed to be named iki-0001.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/iki-0002.txt b/documents/standards/fll/specifications/iki-0002.txt index 43eface..21ed10f 100644 --- a/documents/standards/fll/specifications/iki-0002.txt +++ b/documents/standards/fll/specifications/iki-0002.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2023/07/14 # # This file (assumed to be named iki-0002.txt) can be more easily read using the following iki_read commands: diff --git a/documents/standards/fll/specifications/iki.txt b/documents/standards/fll/specifications/iki.txt index a6c4fea..c496915 100644 --- a/documents/standards/fll/specifications/iki.txt +++ b/documents/standards/fll/specifications/iki.txt @@ -1,7 +1,7 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 -# version 2024/03/29 +# license open-standard-license-1.0-or-later +# version 2024/06/11 # # 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 '"' '"' @@ -30,7 +30,7 @@ IKI Specifications: White space, non-word, and non character:"_" (unicode:"U+005F"), character:"-" (unicode:"U+002D"), character:"+" (unicode:"U+002B")) character punctuations may not exist as part of the variable name. The only Unicode dash-like characters allowed as a "dash" are those intended to connect, such as the Unicode hyphens (unicode:"U+2010" and unicode:"U+2011"). - Any potential IKI data must be escaped to make it treated as non-IKI data by prepending a backslash character:"\\" before the colon character:":" that is before the opening quote (single, double, or backtic). Potential IKI data refers to any valid IKI sequence without considering the closing single quote character:"'" (unicode:"U+0027"), closing double quote character:'"' (unicode:"U+0022"), or closing grave character:'`' (unicode:"U+0060"). + Any potential IKI data must be escaped to make it treated as non-IKI data by prepending a backslash character:"\\" before the colon character:":" that is before the opening quote (single, double, or grave (backtick)). Potential IKI data refers to any valid IKI sequence without considering the closing single quote character:"'" (unicode:"U+0027"), closing double quote character:'"' (unicode:"U+0022"), or closing grave character:'`' (unicode:"U+0060"). Unicode punctuation connector characters are supported just like character:"_", except when they connect outside the current line (such as unicode:"U+FE33" character:"︳"). Unicode invisible punctuations (such as invisible plus: unicode:"U+2064") are not considered a punctuations in this standard (because they a zero-width characters), therefore they are not to be considered a valid character:"_", character:"-", or character:"+" Unicode equivalents. diff --git a/documents/standards/fll/specifications/time.txt b/documents/standards/fll/specifications/time.txt index f0aaa59..3a0ae79 100644 --- a/documents/standards/fll/specifications/time.txt +++ b/documents/standards/fll/specifications/time.txt @@ -1,6 +1,6 @@ # fss-0002 iki-0000 # -# license open-standard-license-1.0 +# license open-standard-license-1.0-or-later # version 2023/12/16 # # This file (assumed to be named time.txt) can be more easily read using the following iki_read commands: diff --git a/fll/specifications.html b/fll/specifications.html index cf88c0a..17a53db 100644 --- a/fll/specifications.html +++ b/fll/specifications.html @@ -405,7 +405,7 @@ Object_2 This is multiple\" Contents and the trailing quote does not need to be The only Unicode dash-like characters allowed as a "dash" are those intended to connect, such as the Unicode hyphens (U+2010 and U+2011).

- Any potential IKI data must be escaped to make it treated as non-IKI data by prepending a backslash \ before the colon : that is before the opening quote (single, double, or backtic). Potential IKI data refers to any valid IKI sequence without considering the closing single quote ' (U+0027), closing double quote " (U+0022), or closing grave ` (U+0060). + Any potential IKI data must be escaped to make it treated as non-IKI data by prepending a backslash \ before the colon : that is before the opening quote (single, double, or grave (backtick)). Potential IKI data refers to any valid IKI sequence without considering the closing single quote ' (U+0027), closing double quote " (U+0022), or closing grave ` (U+0060).

Unicode punctuation connector characters are supported just like _, except when they connect outside the current line (such as U+FE33 ︳). -- 1.8.3.1