Merge pull request #15 from KubaO/staging

Fix links, add link checker step during build

Author: KubaO

.github/workflows/jekyll-gh-pages.yml

@@ -37,8 +37,14 @@ jobs:
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v5
+      - name: Write secondary config if available
+        run: |
+          echo "${{ vars.JEKYLL_SITE_CONFIG }}" > _site_config.yml
+          echo "SITE_CONFIG=_site_config.yml" >> "$GITHUB_ENV"
+        if: ${{ vars.JEKYLL_SITE_CONFIG != '' }}
+        working-directory: ./docs
       - name: Build with Jekyll
-        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        run: bundle exec jekyll build --config _config.yml,$SITE_CONFIG --baseurl "${{ steps.pages.outputs.base_path }}"
         working-directory: ./docs
         env:
           JEKYLL_ENV: production

docs/CustomControls/Defining a CustomControl.md

@@ -59,7 +59,7 @@ This method is called when your control is detached from a form.  This allows an
 Sub Paint(ByVal Canvas As Canvas)
 ```
 
-This is the most interesting part for a CustomControl.  As such, it gets its own section, see [Painting / drawing to your control](/CustomControls/Painting)
+This is the most interesting part for a CustomControl.  As such, it gets its own section, see [Painting / drawing to your control](Painting)
 
 ***
 ## Minimum set of properties
@@ -78,7 +78,7 @@ Public Visible As Boolean
 
 The form designer and the form engine work with these properties, so it is important to include them in your CustomControl class.
 
-Note that the form designer works with pixel values which are not DPI-scaled.  So the Left/Top/Width/Height properties of your control do not reflect DPI scaling.  For example, if your control has a width of 50 pixels, then at DPI 150%, then the actual drawing width is 75 pixels ( see [Painting / drawing to your control](/CustomControls/Painting)).
+Note that the form designer works with pixel values which are not DPI-scaled.  So the Left/Top/Width/Height properties of your control do not reflect DPI scaling.  For example, if your control has a width of 50 pixels, then at DPI 150%, then the actual drawing width is 75 pixels ( see [Painting / drawing to your control](Painting)).
 
 ***
 ## Must have a serialization constructor
@@ -88,4 +88,4 @@ CustomControls *must* offer a serialization constructor:
 Public Sub New(Serializer As SerializationInfo)
 ```
 
-The passed in Serializer object offers a `Deserialize()` method that you call in order to load the properties that have been set for your control via the form designer.  See [Property Sheet and Object Serialization](/CustomControls/Properties) for further information.
+The passed in Serializer object offers a `Deserialize()` method that you call in order to load the properties that have been set for your control via the form designer.  See [Property Sheet and Object Serialization](Properties) for further information.

docs/Features/Overview.md

@@ -22,7 +22,7 @@ Attributes have two major functions:
 
 * they can act as instructions to compiler to influence how code is generated, or 
 
-* to annotate Forms, Modules, Classes, Types, Enums, Declares, and [procedures](/tB/Gloss/#procedure) i.e. Subs/Functions/Properties. 
+* to annotate Forms, Modules, Classes, Types, Enums, Declares, and [procedures](../tB/Gloss#procedure) i.e. Subs/Functions/Properties. 
 
 Previously in VBx, these attributes, such as procedure description, hidden, default member, and others, were set via hidden text the IDE's editor didn't show you, configured via the Procedure Attributes dialog or some other places. In tB, these are all visible in the code editor. The legacy ones from VBx are supported for compatibility, but new attributes utilize the following syntax:\
     `[Attribute]` or `[Attribute(value)]`
@@ -1402,15 +1402,15 @@ Code can be grouped as a package, and published to an online server. You can hav
 
 For more information, see the following pages:
 
-[What is a package](/Packages/What-Is)
+[What is a package](../Packages/What-Is)
 
-[Creating a TWINPACK package](/Packages/Creating-TWINPACK)
+[Creating a TWINPACK package](../Packages/Creating-TWINPACK)
 
-[Importing a package from a TWINPACK file](/Packages/Importing-TWINPACK)
+[Importing a package from a TWINPACK file](../Packages/Importing-TWINPACK)
 
-[Importing a package from TWINSERV](/Packages/Importing-TWINSERV)
+[Importing a package from TWINSERV](../Packages/Importing-TWINSERV)
 
-[Updating a package](/Packages/Updating)
+[Updating a package](../Packages/Updating)
 
 ## View Forms and Packages as JSON
 Project forms and packages are stored as JSON format data, and you can view this by right-click in Project Explorer and selecting 'View as JSON'. This is particularly interesting for packages as it exposes the entire code in a much more easily parsed format.

docs/Miscellaneous/FAQs.md

@@ -60,7 +60,7 @@ Yes, see the [twinBASIC Roadmap](https://github.com/twinbasic/twinbasic/issues/3
 
 **Many!** It has 64bit compilation (using VBA7x64 compatible syntax), generics, overloading, multithreading (API-only right now, built in syntax coming soon), inheritance, ability to define interfaces and coclasses in your project using BASIC-style syntax, Unicode support in all controls and the editor (.twin files only), support for modern image formats, numerous enhancements to *Implements*, ability to create standard DLLs and kernel mode drivers, ability to set UDT packing alignment, and dozens of others, all available *right now*, with many more planned in the future.
 
-For a full list of all the new features available right now, see the Wiki article [Overview of features new to twinBASIC](/Features).
+For a full list of all the new features available right now, see the Wiki article [Overview of features new to twinBASIC](Features).
 
 </details>
 

docs/Reference/Attributes.md

@@ -9,7 +9,7 @@ permalink: /tB/Core/Attributes
 Attributes have two major functions: 
 
 - they can act as instructions to compiler to influence how code is generated, or 
-- to annotate Forms, Modules, Classes, Types, Enums, Declares, and [procedures](/tB/Gloss/#procedure) i.e. Subs/Functions/Properties. 
+- to annotate Forms, Modules, Classes, Types, Enums, Declares, and [procedures](../Gloss#procedure) i.e. Subs/Functions/Properties. 
 
 Previously in VBx, these attributes, such as the procedure description, hidden, default member, and others, were set via hidden text the IDE's editor didn't show you, configured via the Procedure Attributes dialog or some other places. In tB, these are all visible in the code editor. The legacy ones from VBx are supported for compatibility, but new attributes utilize the following syntax:   
 `[Attribute]` or `[Attribute(value)]`
@@ -24,7 +24,7 @@ The available attributes are listed below in alphabetic order. Not every attribu
 
 Syntax: **[AppObject]**
 
-Applicable to: [**CoClass**](/tB/Core/CoClass)
+Applicable to: [**CoClass**](CoClass)
 
 Indicates the class is part of the global namespace. You should not include this attribute without a full understanding of the meaning.
 
@@ -34,7 +34,7 @@ Indicates the class is part of the global namespace. You should not include this
 
 Syntax: **ArrayBoundsChecks( True** \| **False)**
 
-Applicable to: [**Class**](/tB/Core/Class), [**Module**](/tB/Core/Module), [procedure](/tB/Gloss/#procedure)
+Applicable to: [**Class**](Class), [**Module**](Module), [procedure](../Gloss#procedure)
 
 Disables array element access bounds checking. Used on performance-critical routines. The default value is **True**.
 
@@ -44,7 +44,7 @@ Disables array element access bounds checking. Used on performance-critical rout
 
 Syntax: **[CoClassCustomConstructor("** fully qualified path to factory method **")]**
 
-Applicable to: [**CoClass**](/tB/Core/CoClass)
+Applicable to: [**CoClass**](CoClass)
 
 Allows custom logic for creating and returning a new instance of the coclass' implementation.
 
@@ -59,15 +59,15 @@ Public CoClass Foo
 End CoClass
 ```
 
-For an overview of coclasses in tB, see [Defining coclasses](/Features/Overview/#defining-coclasses).
+For an overview of coclasses in tB, see [Defining coclasses](../../Features/Overview#defining-coclasses).
 
 ## CoClassId(String)
 
 {: #coclassid }
 
 Syntax: **[CoClassId("**00000000-0000-0000-0000-000000000000**")]**
 
-Applicable to: [**CoClass**](/tB/Core/CoClass)
+Applicable to: [**CoClass**](CoClass)
 
 In addition to interfaces, twinBASIC also allows defining coclasses -- creatable classes that implement one or more defined interfaces. Like interfaces, these too must be in .twin files and not legacy .bas/.cls files, and must appear prior to the `Class` or `Module` statement. The generic form is:
 
@@ -81,51 +81,51 @@ CoClass <name>
 End CoClass
 ```
 
-The methods are [procedures](/tB/Gloss/#procedure).
+The methods are [procedures](../Gloss#procedure).
 
-For an overview of coclasses in tB, see [Defining coclasses](/Features/Overview#defining-coclasses).
+For an overview of coclasses in tB, see [Defining coclasses](../../Features/Overview#defining-coclasses).
 
 ## ComCreatable(Bool)
 
 {: #comcreatable }
 
 Syntax: **[ComCreatable(True** \| **False)]**
 
-Applicable to:  [**CoClass**](/tB/Core/CoClass)
+Applicable to:  [**CoClass**](CoClass)
 
-Indicates that this coclass can be created with the [**New**](/tB/Core/New) keyword. This attribute is is **True** by default. 
+Indicates that this coclass can be created with the [**New**](New) keyword. This attribute is is **True** by default. 
 
 ## ComExtensible(Bool)
 
 {: #comextensible }
 
 Syntax: **[ComExtensible(True** \| **False)]**
 
-Applicable to: [**Interface**](/tB/Core/Interface), [procedure in an Interface](/tB/Gloss/#procedure)
+Applicable to: [**Interface**](Interface), [procedure in an Interface](../Gloss#procedure)
 
 Specifies whether new members added at runtime can be called by name through an interface implementing **IDispatch**. This attribute is set to **False** by default.
 
 ## ComImport
 
 Syntax: **[ComImport]**
 
-Applicable to: [**Interface**](/tB/Core/Interface)
+Applicable to: [**Interface**](Interface)
 
 Specifies that an interface is an import from an external COM library, for instance, the Windows shell.
 
 ## CompileIf(Bool)
 
 Syntax: **[CompileIf(** condition **)]**
 
-Applicable to: [procedure definitions](/tB/Gloss/#procedure)
+Applicable to: [procedure definitions](../Gloss#procedure)
 
 Controls the conditional compilation of a procedure definition. Has no default value.
 
 ## ConstantFoldable
 
 Syntax: **[ConstantFoldable]**
 
-Applicable to: [**Function**](/tB/Core/Function)
+Applicable to: [**Function**](Function)
 
 Specify this attribute for functions where when called with non-variable input, will be computed at compile time, rather than runtime. For example, a function to converted string literals to ANSI. The result would never change, so the resulting ANSI string is stored, rather than recomputing every run. Such functions are also called *pure functions*, because their output only depends on the arguments, and not on the state of the program.
 
@@ -135,15 +135,15 @@ Specify this attribute for functions where when called with non-variable input,
 
 Syntax: **[Debuggable(True** \| **False)]**
 
-Applicable to: [**Module**](/tB/Core/Module), [procedure in a Class or Module](/tB/Gloss/#procedure)
+Applicable to: [**Module**](Module), [procedure in a Class or Module](../Gloss#procedure)
 
 When false, turns of breakpoints and stepping for the method or module. The default value is **True**.
 
 ## DebugOnly
 
 Syntax: **[DebugOnly]**
 
-Applicable to: [procedure definitions](/tB/Gloss/#procedure)
+Applicable to: [procedure definitions](../Gloss#procedure)
 
 Excludes calls to this procedure from the Build. They are only available when running from the IDE, i.e. debugging.
 
@@ -152,7 +152,7 @@ Excludes calls to this procedure from the Build. They are only available when ru
 
 Syntax: **[Description("** arbitrary text **")]**
 
-Applicable to: [**Class**](/tB/Core/Class), [**CoClass**](/tB/Core/CoClass), [**Const**](/tB/Core/Const), [**Declare** (API declaration)](/tB/Core/Declare), [**Interface**](/tB/Core/Interface), [**Module**](/tB/Core/Module), [**Type** (UDT)](/tB/Core/Type)
+Applicable to: [**Class**](Class), [**CoClass**](CoClass), [**Const**](Const), [**Declare** (API declaration)](Declare), [**Interface**](Interface), [**Module**](Module), [**Type** (UDT)](Type)
 
 Provides a description in information popups in the IDE, and is exported as a `helpstring` attribute in the type library (if applicable).
 
@@ -162,15 +162,15 @@ Provides a description in information popups in the IDE, and is exported as a `h
 
 Syntax: **[DispId(** 123 **)]**
 
-Applicable to: [procedure in an Interface](/tB/Gloss/#procedure)
+Applicable to: [procedure in an Interface](../Gloss#procedure)
 
 Defines a dispatch ID associated with the procedure.
 
 ## DllExport
 
 Syntax: **[DllExport]**
 
-Applicable to: [procedures](/tB/Gloss/#procedure) and variables in a module.
+Applicable to: [procedures](../Gloss#procedure) and variables in a module.
 
 It's possible to export a function or variable from standard modules. Example:
 
@@ -185,7 +185,7 @@ Public Const MyExportedSymbol As Long = &H00000001
 
 Syntax: **DllStackCheck( True** \| **False)**
 
-Applicable to: [**Declare** (API declaration)](/tB/Core/Declare)
+Applicable to: [**Declare** (API declaration)](Declare)
 
 Gives minor codegen size reduction on 32-bit API calls on the Intel platform. Has no effect on other platforms.
 
@@ -195,15 +195,15 @@ Gives minor codegen size reduction on 32-bit API calls on the Intel platform. Ha
 
 Syntax: **[EnumId("** 00000000-0000-0000-0000-000000000000 **")]**
 
-Applicable to: [**Enum**](/tB/Core/Enum)
+Applicable to: [**Enum**](Enum)
 
 Specifies a GUID to be associated with an enum in type libraries.
 
 ## Flags
 
 Syntax: **[Flags]**
 
-Applicable to: [**Enum**](/tB/Core/Enum)
+Applicable to: [**Enum**](Enum)
 
 Calculate implicit enum values as a flag set (powers of 2).
 
@@ -218,15 +218,15 @@ Calculate implicit enum values as a flag set (powers of 2).
 
 Syntax: **FloatingPointErrorChecks( True** \| **False)**
 
-Applicable to: [**Class**](/tB/Core/Class), [**Module**](/tB/Core/Module), [procedure](/tB/Gloss/#procedure)
+Applicable to: [**Class**](Class), [**Module**](Module), [procedure](../Gloss#procedure)
 
 Disables floating point error checks. Used on performance-critical routines. The default value is **True**.
 
 ## Hidden
 
 Syntax: **[Hidden]**
 
-Applicable to: [**CoClass**](/tB/Core/CoClass), [**Interface**](/tB/Core/Interface)
+Applicable to: [**CoClass**](CoClass), [**Interface**](Interface)
 
 Hides the interface or coclass from certain Intellisense and other lists.
 
@@ -236,7 +236,7 @@ Hides the interface or coclass from certain Intellisense and other lists.
 
 Syntax: **IntegerOverflowChecks( True** \| **False)**
 
-Applicable to: [**Class**](/tB/Core/Class), [**Module**](/tB/Core/Module), [procedure](/tB/Gloss/#procedure)
+Applicable to: [**Class**](Class), [**Module**](Module), [procedure](../Gloss#procedure)
 
 Disables integer overflow checks. Used on performance-critical routines. The default value is **True**.
 
@@ -246,9 +246,9 @@ Disables integer overflow checks. Used on performance-critical routines. The def
 
 Syntax: **[InterfaceId("**00000000-0000-0000-0000-000000000000**")]**
 
-Applicable to: [**Interface**](/tB/Core/Interface)
+Applicable to: [**Interface**](Interface)
 
-twinBASIC supports defining COM interfaces using BASIC syntax, rather than needing an type library with IDL and C++. These are only supported in .twin files, not in legacy .bas or .cls files. They must appear *before* the [**Class**](/tB/Core/Class) or [**Module**](/tB/Core/Module) statement, and will always have a project-wide scope. the The generic form for is as follows:
+twinBASIC supports defining COM interfaces using BASIC syntax, rather than needing an type library with IDL and C++. These are only supported in .twin files, not in legacy .bas or .cls files. They must appear *before* the [**Class**](Class) or [**Module**](Module) statement, and will always have a project-wide scope. the The generic form for is as follows:
 
 ``` vb
 [InterfaceId ("00000000-0000-0000-0000-000000000000")]
@@ -262,17 +262,17 @@ Interface <name> Extends <base-interface>
 End Interface
 ```
 
-The methods are [procedures](/tB/Gloss/#procedure).
+The methods are [procedures](../Gloss#procedure).
 
-For an overview of interfaces in tB, see [Defining interfaces](/Features/Overview#defining-interfaces).
+For an overview of interfaces in tB, see [Defining interfaces](../../Features/Overview#defining-interfaces).
 
 ## OleAutomation(Bool)
 
 {: #oleautomation }
 
 Syntax:  **[OleAutomation(True** \| **False)]**
 
-Applicable to: [**Interface**](/tB/Core/Interface)
+Applicable to: [**Interface**](Interface)
 
 Controls whether this attribute is applied in the typelibrary. This attribute is set to **True** by default.
 
@@ -282,7 +282,7 @@ Controls whether this attribute is applied in the typelibrary. This attribute is
 
 Syntax: **[PopulateFrom("json", "**internal path to .json**", "** table field **", "** name field **", "** value field **" )]**
 
-Applicable to: [**Enum**](/tB/Core/Enum)
+Applicable to: [**Enum**](Enum)
 
 Populates an **Enum** with values from a json file bundled with the project.
 
@@ -325,7 +325,7 @@ End Enum
 
 Syntax: **[PredeclaredId]**
 
-Applicable to: [**Class**](/tB/Core/Class)
+Applicable to: [**Class**](Class)
 
 When set, a global instance of the class is created when the application starts.
 
@@ -337,7 +337,7 @@ This attribute is equivalent to the `VB_PredeclaredId` attribute in VBx .cls fil
 
 Syntax: **[PreserveSig** [ **(** **True** \| **False** **)** ] **]**
 
-Applicable to: Method in an [Interface](/tB/Core/Interface), [API Declarations](/tB/Core/Declare).
+Applicable to: Method in an [Interface](Interface), [API Declarations](Declare).
 
 Default value: **False** in an Interface, **True** in an API Declare.
 
@@ -360,7 +360,7 @@ Public Declare PtrSafe Function SHGetDesktopFolder Lib "shell32" () As IShellFol
 
 Syntax: **[Restricted]**
 
-Applicable to: [**Interface**](/tB/Core/Interface)
+Applicable to: [**Interface**](Interface)
 
 Restricts the interface methods from being called in most contexts.
 
@@ -372,7 +372,7 @@ This is attribute has the same function as the [**restricted** MIDL attribute][M
 
 Syntax: **[RunAfterBuild]**
 
-Applicable to: [**Function**](/tB/Core/Function), [**Sub**](/tB/Core/Sub)
+Applicable to: [**Function**](Function), [**Sub**](Sub)
 
 Specifies a function that runs after your exe is built. Tthere's `App.LastBuildPath` to know where it is if you're e.g. signing the executable.
 
@@ -382,7 +382,7 @@ Specifies a function that runs after your exe is built. Tthere's `App.LastBuildP
 
 Syntax: **[SetDllDirectory( True** \| **False)]**
 
-Applicable to: [**Declare** (API declaration)](/tB/Core/Declare), [**Module**](/tB/Core/Module)
+Applicable to: [**Declare** (API declaration)](Declare), [**Module**](Module)
 
 Allows an explicitly loaded DLL to load its own dependencies from it's load path. Also has the effect of allowing searching the app path for the DLLs in the base app's declare statements. It can be used per-declare or within a module.
 
@@ -392,15 +392,15 @@ Allows an explicitly loaded DLL to load its own dependencies from it's load path
 
 Syntax: **[TypeHint(** an enum type **)]**
 
-Applicable to: [procedure](/tB/Gloss/#procedure) parameters
+Applicable to: [procedure](../Gloss#procedure) parameters
 
 Allows populating Intellisense with an enum for types other than **Long**.
 
 ## Unimplemented
 
 Syntax: **[Unimplemented]**
 
-Applicable to: [procedure](/tB/Gloss/#procedure) definitions
+Applicable to: [procedure](../Gloss#procedure) definitions
 
 Makes the compiler issue a warning about the procedure being unimplemented wherever it's called. You can upgrade it to an error too.