I did a quick review of the updates but I may very easily have missed something.
I attempt to run the following commands to generate this:
# fss_basic_list_read specifications/iki.txt +Q -cn "IKI Specifications" | iki_read +Q -w -WWW character '<code class="code">' "</code>" code '<code class="code">' '</code>' italic '<em class="em">' '</em>'
and this:
# fss_basic_list_read specifications/fss.txt +Q -cn "Featureless Settings Specifications" | iki_read +Q -w -rrrrrrrr anti-KISS 'anti-<abbr title="Keep It Simple Stupid">KISS</abbr>' ASCII '<abbr title="American Standard Code for Information Interchange">ASCII</abbr>' BOM '<abbr title="Byte Order Mark">BOM</abbr>' FSS '<abbr title="Featureless Settings Specifications">FSS</abbr>' KISS '<abbr title="Keep It Simple Stupid">KISS</abbr>' UTF-8 '<abbr title="Unicode Transformation Format 8-bit">UTF-8</abbr>' URL '<abbr title="Byte Order Mark">URL</abbr>' XML '<abbr title="Extensible Markup Language">XML</abbr>' -WWW character '<code class="code">' "</code>" code '<code class="code">' '</code>' italic '<em class="em">' '</em>'
This exposed a bug somewhere where "-rrrrrrrr" is too large.
I had to break it up like this:
# fss_basic_list_read specifications/fss.txt +Q -cn "Featureless Settings Specifications" | iki_read +Q -w -rrrr anti-KISS 'anti-<abbr title="Keep It Simple Stupid">KISS</abbr>' ASCII '<abbr title="American Standard Code for Information Interchange">ASCII</abbr>' BOM '<abbr title="Byte Order Mark">BOM</abbr>' FSS '<abbr title="Featureless Settings Specifications">FSS</abbr>' -r KISS '<abbr title="Keep It Simple Stupid">KISS</abbr>' -r UTF-8 '<abbr title="Unicode Transformation Format 8-bit">UTF-8</abbr>' -r URL '<abbr title="Byte Order Mark">URL</abbr>' -r XML '<abbr title="Extensible Markup Language">XML</abbr>' -WWW character '<code class="code">' "</code>" code '<code class="code">' '</code>' italic '<em class="em">' '</em>'
This problem will be addressed later.
I also noticed that the specification that I am updating contains less IKI syntax than what is used on the website.
I may have to do additional clean ups to the source specifications.
This is good enough of an update for now but I suspect that I will have updates later on.
</p>
<ul>
<li>Will consist of numerous different kinds of specification files, depending on the type of information stored.</li>
- <li>As with the practice of "<code class="code">#!/bin/bash</code>", the setting files <em class="em">should</em> have the following: "<code class="code"># fss-????" format, such as "# FSS-0001</code>".</li>
+ <li>As with the practice of <code class="code">#!/bin/bash</code>, the setting files <em class="em">should</em> have the following: <code class="code"># fss-????</code> format, such as "# fss-0001".</li>
<li>Multiple sub-standards may be appended to the <abbr title="Featureless Settings Specifications">FSS</abbr> header, using the same format structure, such as supporting IKI: "# fss-0000 iki-0000" or <abbr title="Hyper Text Markup Language 5">HTML5</abbr>: "# fss-0000 html-0005".</li>
<li>With the <code class="code">?</code> representing the (hexadecimal/base-16) number that represents the particular specification structure.</li>
<li>All settings specifications <em class="em">should</em> avoid any form of noise, relative to the data being stored.</li>
Newline characters are only <code class="code">\n</code> and are never anything else (<code class="code">\r</code> is not considered newline in any manner).
These specifications refer to characters that have printable representation as <em class="em">printable</em>.
These specifications refer to characters that have no printable representation as <em class="em">non-printable</em>.
-
White spaces characters that are printable, such as tabs and spaces, must be considered the same type for the purposes of parsing.
Non-printing white spaces characters (zero-width characters) are ignored, are treated as placeholders for processing with the exception of combining characters.
White spaces that use combining characters result in printable characters and the resulting combination is treated as not white space.
<div class="section-content">
<p class="p">
- The version date of this specification is <code class="code">2024/01/15</code>.
+ The version date of this specification is <code class="code">2024/06/11</code>.
</p>
<p class="p">
IKI is a minimally structured WIKI-like syntax meant to be simpler than WIKI syntax.
Whereas <code class="code">iki-0001</code> and beyond represent a specific IKI vocabulary.
</p>
<p class="p">
- A potential IKI variable name starts on word character or one of <code class="code">_</code> (<code class="code">U+005F</code>), <code class="code">-</code> (<code class="code">U+002D</code>), <code class="code">+</code> (<code class="code">U+002B</code>), <code class="code">[</code> (<code class="code">U+005B</code>)).
- White space, non-word, and non <code class="code">_</code> (<code class="code">U+005F</code>), <code class="code">-</code> (<code class="code">U+002D</code>), <code class="code">+</code> (<code class="code">U+002B</code>)) character punctuations may not exist as part of the variable name.
+ A potential IKI variable name starts on word character or one of <code class="code">_</code> (<code class="code">U+005F</code>), <code class="code">-</code> (<code class="code">U+002D</code>), <code class="code">+</code> (<code class="code">U+002B</code>), <code class="code">[</code> (<code class="code">U+005B</code>).
+ White space, non-word, and non <code class="code">_</code> (<code class="code">U+005F</code>), <code class="code">-</code> (<code class="code">U+002D</code>), <code class="code">+</code> (<code class="code">U+002B</code>) 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 (<code class="code">U+2010</code> and <code class="code">U+2011</code>).
</p>
<p class="p">
- Any potential IKI data must be escaped to make it treated as non-IKI data by prepending a backslash <code class="code">\</code> before the colon <code class="code">:</code> 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 <code class="code">'</code> (<code class="code">U+0027</code>), closing double quote <code class="code">"</code> (<code class="code">U+0022</code>), or closing grave <code class="code">`</code> (<code class="code">U+0060)</code>.
+ Any potential IKI data must be escaped to make it treated as non-IKI data by prepending a backslash <code class="code">\</code> before the colon <code class="code">:</code> 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 <code class="code">'</code> (<code class="code">U+0027</code>), closing double quote <code class="code">"</code> (<code class="code">U+0022</code>), or closing grave <code class="code">`</code> (<code class="code">U+0060</code>).
</p>
<p class="p">
Unicode punctuation connector characters are supported just like <code class="code">_</code>, except when they connect outside the current line (such as <code class="code">U+FE33</code> <code class="code">︳</code>).
<ul>
<li><code class="code">\o</code> = any printable word character, including <code class="code">_</code>, <code class="code">-</code>, <code class="code">+</code> (and Unicode equivalents).</li>
<li><code class="code">\c</code> = any character, including white space and non-printing, and any delimited quote (used as the opening quote) or a any quote (undelimited) not used as the opening quote.</li>
- <li><code class="code">\q</code> = either a single quote <code class="code">'</code> (<code class="code">U+0027</code>), a double quote <code class="code">"</code> (<code class="code">U+0022</code>, or a grave <code class="code">`</code> (<code class="code">U+0060</code>).</li>
+ <li><code class="code">\q</code> = either a single quote <code class="code">'</code> (<code class="code">U+0027</code>), a double quote <code class="code">"</code> (<code class="code">U+0022</code>), or a grave <code class="code">`</code> (<code class="code">U+0060</code>).</li>
<li><code class="code">\x</code> = any character.</li>
<li><code class="code">\W</code> = any non-word character, discluding <code class="code">_</code>, <code class="code">-</code>, <code class="code">+</code> (and Unicode equivalents).</li>
<li><code class="code">\e</code> = an optional escape sequence of any number of backslashes, such as <code class="code">\</code>.</li>
<div class="section-content">
<p class="p">
- The version date of this specification is <code class="code">2024/01/15</code>.
+ The version date of this specification is <code class="code">2024/06/11</code>.
</p>
<p class="p">
This is based off of <code class="code">fss-0000 (Basic)</code>, except the Object is at the end of the line.
<p class="p">
Each Object starts at the end of a line and white space to the left of the Object is not treated as part of the object.
White space separates an Object from the Content.
- An Object may be preceded by a newline, in which case means that the Object has no 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 whitespace where a single quote <code class="code">'</code> (<code class="code">U+0027</code>), a double quote <code class="code">"</code> (<code class="code">U+0022</code>), or a grave <code class="code">`</code> (<code class="code">U+0060</code>) are used to quote.
+ An Object may be quoted to include white space where a single quote <code class="code">'</code> (<code class="code">U+0027</code>), a double quote <code class="code">"</code> (<code class="code">U+0022</code>), or a grave (backtick) <code class="code">`</code> (<code class="code">U+0060</code>) 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.
+ A quoted Objected terminating at the new line in this way preserves the quotes as part of the Object.
</p>
<p class="p">
Content exists on the same line as the Object.
- Content is represented as a single Content column that begins at a newline.
+ Content is represented as a single Content column that begins at a new line.
Content column consists of everything following the first non-white space character at the start of the line until the Object is reached.
- Content column includes trailing white space before newline is reached.
+ Content column includes trailing white space before new line is reached.
Content column does not include any of the white space between the last non-white space character and the start of the Object.
No delimits are supported in the Content.
</p>
Key:
</p>
<ul>
- <li><code class="code">\s</code> = White space, except newline.</li>
- <li><code class="code">\b</code> = Either white space or printable, except newline.</li>
+ <li><code class="code">\s</code> = White space, except new line.</li>
+ <li><code class="code">\b</code> = Either white space or printable, except new line.</li>
<li><code class="code">\q</code> = Non-white space or quoted white space (and non-whitespace) with no white space outside of the quotes.</li>
<li><code class="code">\n</code> = Newline.</li>
<li><code class="code">*</code> = Zero or more occurrences.</li>
</p><pre class="preserve">
# fss-0009
# valid comments are ignored.
-Content from newline. "The Object"
+Content from new line. "The Object"
object set. Second
</pre>
<p class="p">
2) Second
Content would be:
- 1.1) Content from newline.
+ 1.1) Content from new line.
2.1) object set.
</pre>
</div>
<div class="section-content">
<p class="p">
- The version date of this specification is <code class="code">2023/07/14</code>.
+ The version date of this specification is <code class="code">2024/06/11</code>.
</p>
<p class="p">
This is based off of <code class="code">fss-0001 (Extended)</code>, except the Object is at the end of the line.
<p class="p">
Each Object starts at the end of a line and white space to the left of the Object is not treated as an object.
White space separates an Object from the Content.
- An Object may be followed by a newline, in which case means that the Object has no 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 whitespace where a single quote <code class="code">'</code> (<code class="code">U+0027</code>), a double quote <code class="code">"</code> (<code class="code">U+0022</code>), or a grave <code class="code">`</code> (<code class="code">U+0060</code>) are used to quote.
+ An Object may be quoted to include white space where a single quote <code class="code">'</code> (<code class="code">U+0027</code>), a double quote <code class="code">"</code> (<code class="code">U+0022</code>), or a grave (backtick) <code class="code">`</code> (<code class="code">U+0060</code>) 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.
+ A quoted Objected terminating at the new line in this way preserves the quotes as part of the Object.
</p>
<p class="p">
Content exists on the same line as the Object.
Content is represented as multiple Content columns.
Content columns are white space separated parts within the Content is terminated by the start of the Object.
Any number of Content columns may exist in the Content until the Object is reached.
+ Content follows the same quoting rules as an Object.
</p>
<p class="p">
Key:
</p>
<ul>
- <li><code class="code">\s</code> = White space, except newline.</li>
- <li><code class="code">\b</code> = Either white space or printable, except newline.</li>
+ <li><code class="code">\s</code> = White space, except new line.</li>
+ <li><code class="code">\b</code> = Either white space or printable, except new line.</li>
<li><code class="code">\q</code> = Non-white space or quoted white space (and non-whitespace) with no white space outside of the quotes.</li>
<li><code class="code">\n</code> = Newline.</li>
<li><code class="code">*</code> = Zero or more occurrences.</li>
projects / kevux.org-website / commitdiff