Skip to content

Latest commit

 

History

History
160 lines (125 loc) · 20.1 KB

File metadata and controls

160 lines (125 loc) · 20.1 KB
title Permanent Links
parent Documentation Development
nav_order 1
permalink /Documentation/Development/Permanent-Links

Permanent Links

{: .no_toc }

The stable, or machine-accessible, part of the documentation tree is rooted on the /tB/ prefix. URLs with this prefix --- and the internal links that target them, e.g. docs.twinbasic.com/tB/Modules/Math/Round --- are guaranteed not to move. This is the contract the IDE help system, [Documentation(...)] attribute references, and external links rely on; anything documented below should be treated as essential.

  • TOC goes here {:toc}

/tB/Core/<Statement>

/tB/Modules/<ModuleName>/<Symbol>

Within each VBA module, each procedure, property, or statement has its own stand-alone page, e.g. LenB: /tB/Modules/Strings/Len. The $-suffixed and B/W variants are documented on the same page as the base symbol (so LenB, Len$, etc. all share the Len page).

/tB/Packages/<Package>/...

Each package lives under /tB/Packages/<Package>/. The sub-structure depends on the package: modules, classes, enumerations, and sub-objects each have their own page.

VBRUN -- /tB/Packages/VBRUN/<Module>/

VB -- /tB/Packages/VB/<Class>/

WebView2 -- /tB/Packages/WebView2/...

Assert -- /tB/Packages/Assert/<Module>

CustomControls -- /tB/Packages/CustomControls/...

CEF -- /tB/Packages/CEF/...

WinEventLogLib -- /tB/Packages/WinEventLogLib/<Class>

WinNamedPipesLib -- /tB/Packages/WinNamedPipesLib/<Class>

WinServicesLib -- /tB/Packages/WinServicesLib/...

tbIDE -- /tB/Packages/tbIDE/<Class>

WinNativeCommonCtls -- /tB/Packages/WinNativeCommonCtls/...

/tB/Core/Attributes#<attribute>

Note

All non-alphabetic characters, as well as parameters, are removed from the links. All attribute names are in lowercase in the links. E.g. ArrayBoundsChecks(Bool) is referenced as /tB/Core/Attributes#arrayboundschecks.