Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions WIP.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Status:
- `docs/Reference/VB/todo.md` — backlog tracker for the VB package; see [Backlog discovery](#backlog-discovery).
- `docs/Reference/Statements.md` — alphabetical index of language statements.
- `docs/Reference/Procedures and Functions.md` — alphabetical index of procedures/functions.
- `docs/_includes/VBA-Attribution.md` — the attribution boilerplate include.
- `docs/_includes/footer_custom.html` — overrides the theme's footer slot; renders the copyright line and, when `vba_attribution: true` is set in a page's frontmatter, an additional CC-BY-4.0 attribution line beneath it.

## VBA-Docs source (read-only)

Expand All @@ -48,7 +48,7 @@ The standard control classes have no VBA-Docs equivalent — they're documented

The `STANDARD/` folder is the primary backlog. The `BASE/` folder defines the inheritance chain (e.g. `BaseControlWindowlessNoFocus` → `BaseControlRectDockable` → `BaseControlRect` → `BaseControl`); read those alongside the leaf class to know which `Public` members are actually visible. Members marked `Protected` or hidden behind `[Unimplemented]` should be flagged with a `> [!NOTE]` callout.

Used for: the VB package only. These pages are fully original content — **omit** the `{% include VBA-Attribution.md %}` line.
Used for: the VB package only. These pages are fully original content — **omit** the `vba_attribution: true` frontmatter flag.

## Page template

Expand All @@ -75,6 +75,7 @@ parent: <Statements | Procedures and Functions | <Mod> Module | VB Package>
permalink: /tB/Core/<Symbol>
redirect_from: # only if relocated; e.g. moved from Core/ to a Module/
- /tB/Core/<Symbol>
vba_attribution: true # omit for VB package pages (fully original content)
---
# <Symbol>
{: .no_toc }
Expand All @@ -99,16 +100,14 @@ This example...
### See Also

- [Other](OtherSymbol)

{% include VBA-Attribution.md %}
````

Formatting conventions:

- `**...**` for keywords/literal tokens; `*...*` for placeholders/arguments.
- Code blocks use ` ```tb ` (the twinBASIC lexer registered in `docs/_plugins/twinbasic.rb`).
- Parameter lists use the kramdown `term` + `: definition` indentation pattern (NOT the MS-style markdown table).
- Don't drop the `{% include VBA-Attribution.md %}` line unless the page is fully original content.
- Set `vba_attribution: true` in the frontmatter on any page derived from VBA-Docs; omit it on fully original content (e.g. VB package pages). The flag drives an extra line in the site footer.

### Cross-section linking

Expand Down Expand Up @@ -166,7 +165,7 @@ Always link to the **canonical** location (the page's `permalink:`), not to a `r
- Walk the `Inherits` chain to enumerate the actually-public surface; private/protected helpers don't belong in user-facing docs.
- List members alphabetically within Properties / Methods / Events sections (see `CheckBox.md`).
- Members marked `[Unimplemented]` get a `> [!NOTE]` callout saying so.
- Omit `{% include VBA-Attribution.md %}` — these pages are fully original.
- Omit the `vba_attribution: true` frontmatter flag — these pages are fully original.
5. **Flag tB deviations** with a `> [!NOTE]` callout (see next section).
6. **Update the parent index** (`<Package>/<Mod>/index.md`, `docs/Reference/VB/index.md`, `Reference/Statements.md`, or `Reference/Procedures and Functions.md`) — turn an unlinked bullet into a link with a short blurb. Match the existing style of the page.
7. **Remove the symbol's path from `docs/Reference/VB/todo.md`** `redirect_from:` array (VB controls only — VBA/VBRUN backlogs are closed).
Expand Down
3 changes: 1 addition & 2 deletions docs/Reference/Core/AddressOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: AddressOf
parent: Operators
grand_parent: Reference Section
permalink: /tB/Core/AddressOf
vba_attribution: true
---
# AddressOf operator
{: .no_toc }
Expand Down Expand Up @@ -92,5 +93,3 @@ End Sub
- [Enhanced Pointer Functionality](../../Features/Language/Pointers)
- [API Declarations](../../Features/Advanced/API-Declarations)
- [Operators](../../Reference/Operators)

{% include VBA-Attribution.md %}
3 changes: 1 addition & 2 deletions docs/Reference/Core/And.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: And
parent: Operators
grand_parent: Reference Section
permalink: /tB/Core/And
vba_attribution: true
---
# And operator
{: .no_toc }
Expand Down Expand Up @@ -63,5 +64,3 @@ MyCheck = A And B ' Returns 8 (bitwise comparison).
- [**Or** operator](Or)
- [**Not** operator](Not)
- [Operators](../../Reference/Operators)

{% include VBA-Attribution.md %}
4 changes: 1 addition & 3 deletions docs/Reference/Core/Call.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Call
parent: Statements
permalink: /tB/Core/Call
vba_attribution: true
---

# Call
Expand Down Expand Up @@ -63,6 +64,3 @@ End Sub
- [**Function** statement](Function)
- [**Sub** statement](Sub)



{% include VBA-Attribution.md %}
3 changes: 1 addition & 2 deletions docs/Reference/Core/Close.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Close
parent: Statements
permalink: /tB/Core/Close
vba_attribution: true
---

# Close
Expand Down Expand Up @@ -44,5 +45,3 @@ Close #FileNumber(1), #FileNumber(2), #FileNumber(3) ' Close the 3 open files.

- [Open](Open) statement
- [FreeFile](../Modules/FileSystem) function

{% include VBA-Attribution.md %}
3 changes: 1 addition & 2 deletions docs/Reference/Core/Const.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Const
parent: Statements
permalink: /tB/Core/Const
vba_attribution: true
---

# Const
Expand Down Expand Up @@ -68,5 +69,3 @@ Private Const MyInt As Integer = 5
' Declare multiple constants on same line.
Const MyStr = "Hello", MyDouble As Double = 3.4567
```

{% include VBA-Attribution.md %}
3 changes: 1 addition & 2 deletions docs/Reference/Core/Declare.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Declare
parent: Statements
permalink: /tB/Core/Declare
vba_attribution: true
---

# Declare
Expand Down Expand Up @@ -132,5 +133,3 @@ Declare PtrSafe Function GetActiveWindow Lib "User32" () As LongPtr
' Code is NOT running in 32-bit or 64-bit twinBASIC or VBA7.
#End If
```

{% include VBA-Attribution.md %}
3 changes: 1 addition & 2 deletions docs/Reference/Core/Deftype.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Deftype
parent: Statements
permalink: /tB/Core/Deftype
vba_attribution: true
---
# DefBool, DefByte, DefInt, DefLng, DefLngLng, DefLngPtr, DefCur, DefSng, DefDbl, DefDec, DefDate, DefStr, DefObj, DefVar
{: .no_toc }
Expand Down Expand Up @@ -76,5 +77,3 @@ Dim TaxRate As Double ' explicit declaration overrides the default
- [**Dim** statement](Dim)
- [**Option** statement](Option) (for **Option Explicit**)
- [**Type** statement](Type)

{% include VBA-Attribution.md %}
5 changes: 2 additions & 3 deletions docs/Reference/Core/Dim.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Dim
parent: Statements
permalink: /tB/Core/Dim
vba_attribution: true
---

# Dim
Expand Down Expand Up @@ -92,6 +93,4 @@ Dim BirthDay(1 To 10)As Date

' MyArray is a dynamic array of variants.
Dim MyArray()
```

{% include VBA-Attribution.md %}
```
5 changes: 2 additions & 3 deletions docs/Reference/Core/Do-Loop.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Do...Loop
parent: Statements
permalink: /tB/Core/Do-Loop
vba_attribution: true
---

# Do...Loop
Expand Down Expand Up @@ -135,6 +136,4 @@ End Sub

> [!NOTE]
>
> To stop an endless loop, press ESC or CTRL+BREAK.

{% include VBA-Attribution.md %}
> To stop an endless loop, press ESC or CTRL+BREAK.
5 changes: 2 additions & 3 deletions docs/Reference/Core/End.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: End
parent: Statements
permalink: /tB/Core/End
vba_attribution: true
---

# End
Expand Down Expand Up @@ -57,6 +58,4 @@ Sub Form_Load
End
End If
End Sub
```

{% include VBA-Attribution.md %}
```
5 changes: 2 additions & 3 deletions docs/Reference/Core/Enum.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Enum
parent: Statements
permalink: /tB/Core/Enum
vba_attribution: true
---

# Enum
Expand Down Expand Up @@ -67,6 +68,4 @@ Public Enum InterfaceColors
icGoldenrod = &H20A5DA&
icFirebrick = &H2222B2&
End Enum
```

{% include VBA-Attribution.md %}
```
5 changes: 2 additions & 3 deletions docs/Reference/Core/Erase.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Erase
parent: Statements
permalink: /tB/Core/Erase
vba_attribution: true
---

# Erase
Expand Down Expand Up @@ -44,6 +45,4 @@ Erase StrVarArray ' Each element set to zero-length
Erase StrFixArray ' Each element set to 0.
Erase VarArray ' Each element set to Empty.
Erase DynamicArray ' Free memory used by array.
```

{% include VBA-Attribution.md %}
```
5 changes: 2 additions & 3 deletions docs/Reference/Core/Error.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Error
parent: Statements
permalink: /tB/Core/Error
vba_attribution: true
---

# Error
Expand Down Expand Up @@ -36,6 +37,4 @@ This example uses the **Error** statement to simulate error number 11.
```tb
On Error Resume Next ' Defer error handling.
Error 11 ' Simulate the "Division by zero" error.
```

{% include VBA-Attribution.md %}
```
4 changes: 2 additions & 2 deletions docs/Reference/Core/Exit.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Exit
parent: Statements
permalink: /tB/Core/Exit
vba_attribution: true
---
# Exit
{: .no_toc }
Expand Down Expand Up @@ -48,5 +49,4 @@ Sub ExitStatementDemo()
Next I
Loop
End Sub
```
{% include VBA-Attribution.md %}
```
4 changes: 2 additions & 2 deletions docs/Reference/Core/For-Each-Next.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: For Each...Next
parent: Statements
permalink: /tB/Core/For-Each-Next
vba_attribution: true
---

# For Each...Next
Expand Down Expand Up @@ -60,5 +61,4 @@ For Each MyObject In MyCollection ' Iterate through each element.
Exit For ' Exit loop.
End If
Next
```
{% include VBA-Attribution.md %}
```
5 changes: 2 additions & 3 deletions docs/Reference/Core/For-Next.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: For...Next
parent: Statements
permalink: /tB/Core/For-Next
vba_attribution: true
---

# For...Next
Expand Down Expand Up @@ -85,6 +86,4 @@ For Words = 10 To 1 Step -1 ' Set up 10 repetitions.
Next Chars ' Increment counter
MyString = MyString & " " ' Append a space.
Next Words
```

{% include VBA-Attribution.md %}
```
4 changes: 2 additions & 2 deletions docs/Reference/Core/Function.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Function
parent: Statements
permalink: /tB/Core/Function
vba_attribution: true
---
# Function
{: .no_toc }
Expand Down Expand Up @@ -187,5 +188,4 @@ Function MyFunc(MyStr As String,Optional MyArg1 As _
' Arguments one and three using named-arguments.
RetVal = MyFunc(MyStr:="Hello ", MyArg1:=7)
End Function
```
{% include VBA-Attribution.md %}
```
3 changes: 1 addition & 2 deletions docs/Reference/Core/Get.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Get
parent: Statements
permalink: /tB/Core/Get
vba_attribution: true
---
# Get
{: .no_toc }
Expand Down Expand Up @@ -94,5 +95,3 @@ Close #1 ' Close file.
- [**Close** statement](Close)
- [**Put** statement](Put)
- [**Seek** function](../Modules/FileSystem/Seek)

{% include VBA-Attribution.md %}
3 changes: 1 addition & 2 deletions docs/Reference/Core/GoSub-Return.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: GoSub ... Return
parent: Statements
permalink: /tB/Core/GoSub-Return
vba_attribution: true
---
# GoSub ... Return
{: .no_toc }
Expand Down Expand Up @@ -51,5 +52,3 @@ End Sub
- [**GoTo** statement](GoTo)
- [**On...GoSub** statement](On-GoSub)
- [**Sub** statement](Sub)

{% include VBA-Attribution.md %}
3 changes: 1 addition & 2 deletions docs/Reference/Core/GoTo.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: GoTo
parent: Statements
permalink: /tB/Core/GoTo
vba_attribution: true
---
# GoTo
{: .no_toc }
Expand Down Expand Up @@ -47,5 +48,3 @@ End Sub
- [**GoSub...Return** statement](GoSub-Return)
- [**On Error** statement](On-Error)
- [**Select Case** statement](Select-Case)

{% include VBA-Attribution.md %}
3 changes: 1 addition & 2 deletions docs/Reference/Core/If-Then-Else.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: If...Then...Else
parent: Statements
permalink: /tB/Core/If-Then-Else
vba_attribution: true
---

# If...Then...Else
Expand Down Expand Up @@ -98,5 +99,3 @@ End Sub

- [**Select Case** statement](Select-Case)
- [**#If...Then...Else** directive](Topic-Preprocessor)

{% include VBA-Attribution.md %}
3 changes: 1 addition & 2 deletions docs/Reference/Core/Implements.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Implements
parent: Statements
permalink: /tB/Core/Implements
vba_attribution: true
---
# Implements
{: .no_toc }
Expand Down Expand Up @@ -105,5 +106,3 @@ End Property
- [**Class** statement](Class)
- [Inheritance](../../Features/Language/Inheritance)
- [Interfaces and CoClasses](../../Features/Language/Interfaces-CoClasses)

{% include VBA-Attribution.md %}
Loading