From 872a110a110b9c264405c2e04329af61d1b61ae8 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Sat, 10 Aug 2024 15:08:57 -0500 Subject: [PATCH] Cleanup: Remove 'file:""' from file paths. There should be some HTML markup, such as `` wrapping these instead of using a literal `file:""` IKI syntax. I clearly forgot to convert the IKI syntax for `file`. I do not remember or I have not yet decided what the `file:""` should be mapped to in HTML. Just get rid of the IKI syntax. I will make further updates once I figure out how I want a file text to be presented. --- documents/standards/controller/documents/time.txt | 2 +- documents/standards/fake/documents/fakefile.txt | 16 ++++++++-------- documents/standards/fake/documents/settings.txt | 8 ++++---- documents/standards/fake/specifications/dependencies.txt | 2 +- documents/standards/fake/specifications/fakefile.txt | 4 ++-- documents/standards/fll/specifications/fss-0004.txt | 2 +- documents/standards/fll/specifications/fss-0005.txt | 2 +- documents/standards/fll/specifications/fss-0006.txt | 2 +- documents/standards/fll/specifications/fss-0007.txt | 2 +- documents/standards/fll/specifications/fss-0008.txt | 2 +- documents/standards/fll/specifications/fss-000b.txt | 2 +- documents/standards/fll/specifications/fss-000c.txt | 2 +- documents/standards/fll/specifications/fss-000d.txt | 2 +- documents/standards/fll/specifications/fss-000f.txt | 2 +- documents/standards/fll/specifications/fss-0010.txt | 2 +- documents/standards/fll/specifications/iki-0000.txt | 2 +- documents/standards/fll/specifications/iki-0001.txt | 2 +- documents/standards/fll/specifications/iki-0002.txt | 2 +- fll/specifications/fss/fss-000c.html | 2 +- 19 files changed, 30 insertions(+), 30 deletions(-) diff --git a/documents/standards/controller/documents/time.txt b/documents/standards/controller/documents/time.txt index e7c040c..d78829b 100644 --- a/documents/standards/controller/documents/time.txt +++ b/documents/standards/controller/documents/time.txt @@ -48,4 +48,4 @@ Time Documentation: Consequentially, 1 day is easily represented in units of bold:"EpochTime" as code:"86.4 KE (KiloEpochTime)". - See the specification file:"time.txt" for more precise technical details. + See the specification time.txt for more precise technical details. diff --git a/documents/standards/fake/documents/fakefile.txt b/documents/standards/fake/documents/fakefile.txt index 1c261e2..0d1eb2a 100644 --- a/documents/standards/fake/documents/fakefile.txt +++ b/documents/standards/fake/documents/fakefile.txt @@ -11,14 +11,14 @@ # Fakefile Documentation: - This describes intent and purposes of the file:"fakefile" file settings. - For specific details on the allowed formatting, see the file:"fakefile.txt" under the specifications folder. + This describes intent and purposes of the fakefile file settings. + For specific details on the allowed formatting, see the fakefile.txt under the specifications folder. All files specified are relative to the project root. The reserved Section Names are defined as follows\: - code:"settings"\: - Any configuration specific to this file:"fakefile" is stored here. + Any configuration specific to this fakefile is stored here. This includes the declaration of define and parameter IKI variable substitution values. If multiple bold:"Objects" of the same name exist and that bold:"Object" only supports a single value, then only the bold:"Content" from the last same named bold:"Object" is used. @@ -58,9 +58,9 @@ Fakefile Documentation: The return code for programs can still be retrieved through using the reserved bold:"IKI" variable code:"return". - code:"import"\: - Load this file:"fakefile". - The code:"settings" section data from the imported file:"fakefile" is treated as if it were appended to the end of the current file:"fakefile" code:"setting" section. - Each section in the imported file:"fakefile" is treated as if it were appended to either the end of a matching section, if found, or appended at the end of the file:"fakefile", if no matches are found. + Load this fakefile. + The code:"settings" section data from the imported fakefile is treated as if it were appended to the end of the current fakefile code:"setting" section. + Each section in the imported fakefile is treated as if it were appended to either the end of a matching section, if found, or appended at the end of the fakefile, if no matches are found. This a non-recursive operation and the imported file itself cannot perform an import. Relative paths are relative to the importing file. Absolute paths that start with code:"./" are relative to the project root rather than the importing file. @@ -93,7 +93,7 @@ Fakefile Documentation: Setting this here only sets the default code:"return" parameter variable value. - code:"main"\: - This is the main entry point when processing the file:"fakefile". + This is the main entry point when processing the fakefile. This is processed top-down until the end of the list is reached. The following operations are available\: @@ -410,7 +410,7 @@ Fakefile Documentation: Identical to owner operation, except this will recursively apply the mode to all files within the given file, if that file is a directory file path. - code:"parameter"\: - This represents a variable defined within the scope of the file:"fakefile". + This represents a variable defined within the scope of the fakefile. This is not exported as an environment variable and is therefore not visible to any executed programs or scripts. This replaces the value of any existing parameter variable with this name. The reserved parameter variable names (see IKI vocabulary context section below) may not be changed by this. diff --git a/documents/standards/fake/documents/settings.txt b/documents/standards/fake/documents/settings.txt index a962b34..64c3e7f 100644 --- a/documents/standards/fake/documents/settings.txt +++ b/documents/standards/fake/documents/settings.txt @@ -13,7 +13,7 @@ Settings Documentation: This describes intent and purposes of the build bold:"settings" file bold:"settings". The bold:"settings" file is designed for very simple compilations that represent a single named program and/or a single named library. - For specific details on the allowed formatting, see the file:"settings.txt" under the specifications folder. + For specific details on the allowed formatting, see the settings.txt under the specifications folder. - code:"build_compiler"\: This represents the name of the compiler program to use, such as code:"gcc". @@ -368,7 +368,7 @@ Settings Documentation: - code:"modes"\: A collection of available build modes. Build modes provide custom variants of the build process where certain bold:"settings" are appended onto others. - See the file:"settings.txt" specification for a list of which setting names this applies to. + See the settings.txt specification for a list of which setting names this applies to. - code:"modes_default"\: The name of the default mode to use when no mode is specified. @@ -474,7 +474,7 @@ Settings Documentation: When this is code:"no" and the code:"build_sources_headers" has header files code:"xxx/a.h yyy/a.h", then one of the code:"a.h" files will be overwritten, depending on order they were supplied. - code:"process_post"\: - The filename (relative to the file:"data/build/" directory) of a script to execute after the code:"build" operation successfully completes. + The filename (relative to the data/build/ directory) of a script to execute after the code:"build" operation successfully completes. A small subset of parameters from the main execution are passed to this script during execution as parameters (using short parameter codes)\: Color context parameters, such as: code:"+l", code:"+n", and code:"+d". Operation mode, such as: code:"build", code:"clean", code:"make", or code:"skeleton". @@ -488,7 +488,7 @@ Settings Documentation: Work Path parameter, such as code:"-w X', whereas code:"X" is any valid argument associated with code:"-w". - code:"process_pre"\: - The filename (relative to the file:"data/build/" directory) of a script to execute before the code:"build" operation is executed. + The filename (relative to the data/build/ directory) of a script to execute before the code:"build" operation is executed. A small subset of parameters from the main execution are passed to this script during execution as parameters (using short parameter codes)\: Color context parameters, such as: code:"+l", code:"+n", and code:"+d". Operation mode, such as: code:"build", code:"clean", code:"make", or code:"skeleton". diff --git a/documents/standards/fake/specifications/dependencies.txt b/documents/standards/fake/specifications/dependencies.txt index abb9ed7..a3aa4ed 100644 --- a/documents/standards/fake/specifications/dependencies.txt +++ b/documents/standards/fake/specifications/dependencies.txt @@ -11,7 +11,7 @@ # Dependencies Specification: - The build settings file:"dependencies" file follows the code:"FSS-0001 (Extended)" format. + The build settings dependencies file follows the code:"FSS-0001 (Extended)" format. Each Object represents a specific project name as it would be linked against. Each Content represents associated information, such as a version number. diff --git a/documents/standards/fake/specifications/fakefile.txt b/documents/standards/fake/specifications/fakefile.txt index 52f0389..9339d31 100644 --- a/documents/standards/fake/specifications/fakefile.txt +++ b/documents/standards/fake/specifications/fakefile.txt @@ -11,9 +11,9 @@ # Fakefile Specification: - The file:"fakefile" file follows the code:"FSS-0005 (Somewhat Basic List)" format with a sub-format of code:"IKI-0002 (Simple Script)". + The fakefile file follows the code:"FSS-0005 (Somewhat Basic List)" format with a sub-format of code:"IKI-0002 (Simple Script)". - A file:"fakefile" is broken up into multiple bold:"Basic Lists", referred to as bold:"Sections", with two special purpose reserved bold:"Sections". + A fakefile is broken up into multiple bold:"Basic Lists", referred to as bold:"Sections", with two special purpose reserved bold:"Sections". The bold:"Sections" are broken up into multiple bold:"Extended Objects" and their respective bold:"Contents", referred to as bold:"Section Operations". Each of these non-reserved Sections acts as a set to perform some set of bold:"Section Operations". diff --git a/documents/standards/fll/specifications/fss-0004.txt b/documents/standards/fll/specifications/fss-0004.txt index 32adee4..5e04dbd 100644 --- a/documents/standards/fll/specifications/fss-0004.txt +++ b/documents/standards/fll/specifications/fss-0004.txt @@ -15,7 +15,7 @@ Featureless Settings Specification: 0004 - Very Basic List: All code:"FSS-0002 (Basic List)" escapes are applied before any code:"FSS-0000 (Basic)" is identified. - See the file:"fss-0000.txt" and file:"fss-0002.txt" specification files for details on the syntax rules. + See the fss-0000.txt and fss-0002.txt specification files for details on the syntax rules. Example\: # fss-0004 diff --git a/documents/standards/fll/specifications/fss-0005.txt b/documents/standards/fll/specifications/fss-0005.txt index deaed3d..760cc9e 100644 --- a/documents/standards/fll/specifications/fss-0005.txt +++ b/documents/standards/fll/specifications/fss-0005.txt @@ -15,7 +15,7 @@ Featureless Settings Specification: 0005 - Somewhat Basic List: All code:"FSS-0002 (Basic List)" escapes are applied before any code:"FSS-0001 (Extended)" is identified. - See the file:"fss-0001.txt" and file:"fss-0002.txt" specification files for details on the syntax rules. + See the fss-0001.txt and fss-0002.txt specification files for details on the syntax rules. Example\: # fss-0005 diff --git a/documents/standards/fll/specifications/fss-0006.txt b/documents/standards/fll/specifications/fss-0006.txt index 417a4c7..fdeceb8 100644 --- a/documents/standards/fll/specifications/fss-0006.txt +++ b/documents/standards/fll/specifications/fss-0006.txt @@ -15,7 +15,7 @@ Featureless Settings Specification: 0006 - Somewhat Extended List: All code:"FSS-0003 (Extended List)" escapes are applied before any code:"FSS-0000 (Basic)" is identified. - See the file:"fss-0000.txt" and file:"fss-0003.txt" specification files for details on the syntax rules. + See the fss-0000.txt and fss-0003.txt specification files for details on the syntax rules. Example\: # fss-0006 diff --git a/documents/standards/fll/specifications/fss-0007.txt b/documents/standards/fll/specifications/fss-0007.txt index d420bca..791a2ee 100644 --- a/documents/standards/fll/specifications/fss-0007.txt +++ b/documents/standards/fll/specifications/fss-0007.txt @@ -15,7 +15,7 @@ Featureless Settings Specification: 0007 - Very Extended List: All code:"FSS-0003 (Extended List)" escapes are applied before any code:"FSS-0001 (Extended)" is identified. - See the file:"fss-0001.txt" and file:"fss-0003.txt" specification files for details on the syntax rules. + See the fss-0001.txt and fss-0003.txt specification files for details on the syntax rules. Example\: # fss-0007 diff --git a/documents/standards/fll/specifications/fss-0008.txt b/documents/standards/fll/specifications/fss-0008.txt index 3409cf5..9c6ea71 100644 --- a/documents/standards/fll/specifications/fss-0008.txt +++ b/documents/standards/fll/specifications/fss-0008.txt @@ -13,7 +13,7 @@ Featureless Settings Specification: 0008 - Embedded List: This is a code:"FSS-0003 (Extended List)" whose Content is then recursively processed as code:"FSS-0003 (Extended List)". - See the file:"fss-0003.txt" specification file for details on the syntax rules. + See the fss-0003.txt specification file for details on the syntax rules. Example\: # fss-0008 diff --git a/documents/standards/fll/specifications/fss-000b.txt b/documents/standards/fll/specifications/fss-000b.txt index 55a53c1..a9ed921 100644 --- a/documents/standards/fll/specifications/fss-000b.txt +++ b/documents/standards/fll/specifications/fss-000b.txt @@ -13,7 +13,7 @@ Featureless Settings Specification: 000B - Simple List: This is similar to code:"FSS-0008 (Embedded List)", except that it is an code:"FSS-0003 (Extended List)" with a (non-recursive) code:"FSS-0002 (Basic List)" inside the Content. - See the file:"fss-0002.txt" and file:"fss-0003.txt" specification files for details on the syntax rules. + See the fss-0002.txt and fss-0003.txt specification files for details on the syntax rules. Example\: # fss-000b diff --git a/documents/standards/fll/specifications/fss-000c.txt b/documents/standards/fll/specifications/fss-000c.txt index 8180e61..954089d 100644 --- a/documents/standards/fll/specifications/fss-000c.txt +++ b/documents/standards/fll/specifications/fss-000c.txt @@ -17,7 +17,7 @@ Featureless Settings Specification: 000C - IKI Text: The IKI syntax may be used in any FSS:"Featureless Settings Specifications". The IKI format may be added to the. - See the file:"iki.txt" specification for details on the IKI specifications. + See the iki.txt specification for details on the IKI specifications. Example\: # fss-000c iki-0000 diff --git a/documents/standards/fll/specifications/fss-000d.txt b/documents/standards/fll/specifications/fss-000d.txt index 899a263..3359dcd 100644 --- a/documents/standards/fll/specifications/fss-000d.txt +++ b/documents/standards/fll/specifications/fss-000d.txt @@ -28,7 +28,7 @@ Featureless Settings Specification: 000D - Basic Rule: Anything implementing this specification may impose its own restrictions on when to determine if the Inner Content is what FSS:"Featureless Settings Specifications" format, based on Object names. - See the file:"fss-0000.txt", file:"fss-0001.txt", and file:"fss-0003.txt" specification files for details on the syntax rules. + See the fss-0000.txt, fss-0001.txt, and fss-0003.txt specification files for details on the syntax rules. Example\: # fss-000d diff --git a/documents/standards/fll/specifications/fss-000f.txt b/documents/standards/fll/specifications/fss-000f.txt index 503f5f0..d5024d3 100644 --- a/documents/standards/fll/specifications/fss-000f.txt +++ b/documents/standards/fll/specifications/fss-000f.txt @@ -99,7 +99,7 @@ Featureless Settings Specification: 000f - Simple Packet: With this in mind, it is recommended that only a single italic:"header" be supported in the bold:"Payload Block". The italic:"payload" bold:"Content" may be in either a italic:"binary" or italic:"string" format regardless of the italic:"binary" bit in the bold:"Simple Packet" bold:"Header Block". - See the file:"fss-000e.txt" specification file for details on the syntax rules for the bold:"Payload Block". + See the fss-000e.txt specification file for details on the syntax rules for the bold:"Payload Block". Example Packet Structure\: code:" diff --git a/documents/standards/fll/specifications/fss-0010.txt b/documents/standards/fll/specifications/fss-0010.txt index 8e52160..7f5ee47 100644 --- a/documents/standards/fll/specifications/fss-0010.txt +++ b/documents/standards/fll/specifications/fss-0010.txt @@ -32,7 +32,7 @@ Featureless Settings Specification: 0010 - Encrypted Simple Packet: The 5 remaining control bits are left undefined. - See the file:"fss-000f.txt" specification file for details regarding the code:"FSS-000f (Simple Packet)" standard. + See the fss-000f.txt specification file for details regarding the code:"FSS-000f (Simple Packet)" standard. Example Packet Structure\: code:" diff --git a/documents/standards/fll/specifications/iki-0000.txt b/documents/standards/fll/specifications/iki-0000.txt index 68213c4..6f147b1 100644 --- a/documents/standards/fll/specifications/iki-0000.txt +++ b/documents/standards/fll/specifications/iki-0000.txt @@ -13,4 +13,4 @@ IKI Specification: 0000 - Unrestricted: This specification provides no restrictions on the vocabulary. - See the file:"iki.txt" specification file for details on the syntax rules. + See the iki.txt specification file for details on the syntax rules. diff --git a/documents/standards/fll/specifications/iki-0001.txt b/documents/standards/fll/specifications/iki-0001.txt index df33095..c1a62d0 100644 --- a/documents/standards/fll/specifications/iki-0001.txt +++ b/documents/standards/fll/specifications/iki-0001.txt @@ -24,4 +24,4 @@ IKI Specification: 0001 - Basic: - urn: Any valid URN:"Uniform Resource Name". - var: All text contained within represents some sort of variable. - See the file:"iki.txt" specification file for details on the syntax rules. + See the iki.txt specification file for details on the syntax rules. diff --git a/documents/standards/fll/specifications/iki-0002.txt b/documents/standards/fll/specifications/iki-0002.txt index 21ed10f..840ea17 100644 --- a/documents/standards/fll/specifications/iki-0002.txt +++ b/documents/standards/fll/specifications/iki-0002.txt @@ -25,4 +25,4 @@ IKI Specification: 0002 - Simple Script: - define: Intended to be used for global properties, much like a C/C++ code:"#define". - parameter: Intended to be used for parameters or variables. - See the file:"iki.txt" specification file for details on the syntax rules. + See the iki.txt specification file for details on the syntax rules. diff --git a/fll/specifications/fss/fss-000c.html b/fll/specifications/fss/fss-000c.html index 607db99..dddbc24 100644 --- a/fll/specifications/fss/fss-000c.html +++ b/fll/specifications/fss/fss-000c.html @@ -92,7 +92,7 @@ The IKI format may be added to the.

- See the file:"iki.txt" specification for details on the IKI specifications. + See the iki.txt specification for details on the IKI specifications.

Example: -- 1.8.3.1