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
5 changes: 5 additions & 0 deletions WIP.md
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,11 @@ build.bat && check.bat

Requires `build.bat` to have produced an up-to-date `_site/`.

The build itself includes an additional guard: `_plugins/nav-integrity-check.rb` runs during the GENERATE phase and aborts the build if any nav-visible page has a `parent:` (or `parent:` + `grand_parent:`) that does not resolve to exactly one page in the nav tree. It catches two failure modes:

- **Ambiguity** — multiple pages share the title declared in `parent:` and `grand_parent:` is either absent or insufficient to disambiguate. The page would silently appear under every matching parent.
- **Orphan** — no page has the title declared in `parent:`. The page would silently disappear from the navigation sidebar.

## Repository Use

Favor concise one-line git commit messages.
Expand Down
2 changes: 1 addition & 1 deletion docs/Features/Packages/Creating a TWINPACK package.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Creating a TWINPACK Package
parent: Packages
parent: Package Management
grand_parent: Features
nav_order: 1
permalink: /Features/Packages/Creating-TWINPACK
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Importing a Package from TWINSERV
parent: Packages
parent: Package Management
grand_parent: Features
nav_order: 2
permalink: /Features/Packages/Importing-TWINSERV
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Importing a Package from a TWINPACK File
parent: Packages
parent: Package Management
grand_parent: Features
nav_order: 3
permalink: /Features/Packages/Importing-TWINPACK
Expand Down
2 changes: 1 addition & 1 deletion docs/Features/Packages/Linked Packages.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Linked Packages
parent: Packages
parent: Package Management
grand_parent: Features
nav_order: 5
permalink: /Features/Packages/Linked
Expand Down
2 changes: 1 addition & 1 deletion docs/Features/Packages/Updating a package.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Updating a Package
parent: Packages
parent: Package Management
grand_parent: Features
nav_order: 4
permalink: /Features/Packages/Updating
Expand Down
10 changes: 6 additions & 4 deletions docs/Features/Packages/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Packages
title: Package Management
parent: Features
nav_order: 6
permalink: /Features/Packages/
Expand All @@ -8,14 +8,16 @@ redirect_from:
- /Packages/What-Is
---

# Packages
# Package Management

In twinBASIC, a *package* is a collection of components that you can reference from another twinBASIC project. The components can be modules, classes or interfaces.

twinBASIC comes complete with a package manager service called TWINSERV[^1], allowing you to share and distribute TWINPACK packages to other twinBASIC developers.

A twinBASIC package is distributed as a TWINPACK file that contains everything needed by the components in that package. A project that references a TWINPACK package, imports the whole package into the file system of the root project, resulting in no external dependencies.

With TWINPACK packages you group common components together into their own namespace whilst allowing for convenient code reuse without any of the problems often associated with using external DLL libraries.

twinBASIC comes complete with a package manager service called TWINSERV, allowing you to share and distribute TWINPACK packages to other twinBASIC developers.
Please be aware that TWINPACK files currently contain the full source code of your packaged components. It is planned that we will in future allow for creating binary (compiled) TWINPACK files for developers that hold an Ultimate edition licence of twinBASIC.

Please be aware that TWINPACK files currently contain the full sourcecode of your packaged components. It is planned that we will in future allow for creating binary (compiled) TWINPACK files for developers that hold an Ultimate edition licence of twinBASIC.
[^1]: A service of TWINBASIC LLC offered to the user community.
6 changes: 5 additions & 1 deletion docs/Features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,14 @@ Modernized GUI components featuring:
- 64-bit support and DPI awareness
- New controls (QR Code, Multiframe, CheckMark)

### [Packages](Packages/)
### [Package Management](Packages/)

twinBASIC[^1] has a centralized package repository, called TWINSERV. Users can publish both public and private packages. Package browsing, downloading, and publishing is seamlessly integrated into the IDE.

Packages are collections of components that can be referenced from another twinBASIC project. They are distributed as TWINPACK files that contains everything needed by the components in that package.

[^1]: A service of TWINBASIC LLC offered to the user community.

### [Advanced Features](Advanced/)

Advanced programming capabilities:
Expand Down
145 changes: 109 additions & 36 deletions docs/Miscellaneous/Documentation Development.md

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/Reference/Assert/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Assert Package
parent: Packages
grand_parent: Reference Section
nav_order: 4
permalink: /tB/Packages/Assert/
has_toc: false
Expand Down
1 change: 0 additions & 1 deletion docs/Reference/CEF/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: CEF Package
parent: Packages
grand_parent: Reference Section
nav_order: 6
permalink: /tB/Packages/CEF/
has_toc: false
Expand Down
1 change: 0 additions & 1 deletion docs/Reference/CustomControls/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: CustomControls Package
parent: Packages
grand_parent: Reference Section
nav_order: 5
permalink: /tB/Packages/CustomControls/
has_toc: false
Expand Down
3 changes: 1 addition & 2 deletions docs/Reference/Packages.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Packages
parent: Reference Section
nav_order: 20
nav_order: 8
permalink: /tB/Packages/
has_toc: false
---
Expand Down
1 change: 0 additions & 1 deletion docs/Reference/VB/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: VB Package
parent: Packages
grand_parent: Reference Section
nav_order: 1
permalink: /tB/Packages/VB/
has_toc: false
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbAppWinStyle.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbAppWinStyle
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbAppWinStyle
redirect_from:
- /tB/Core/VbAppWinStyle
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbArchitecture.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbArchitecture
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbArchitecture
redirect_from:
- /tB/Core/VbArchitecture
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbCalendar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbCalendar
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbCalendar
redirect_from:
- /tB/Core/VbCalendar
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbCallType.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbCallType
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbCallType
redirect_from:
- /tB/Core/VbCallType
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbCompareMethod.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbCompareMethod
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbCompareMethod
redirect_from:
- /tB/Core/VbCompareMethod
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbDateTimeFormat.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbDateTimeFormat
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbDateTimeFormat
redirect_from:
- /tB/Core/VbDateTimeFormat
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbDayOfWeek.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbDayOfWeek
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbDayOfWeek
redirect_from:
- /tB/Core/VbDayOfWeek
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbFileAttribute.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbFileAttribute
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbFileAttribute
redirect_from:
- /tB/Core/VbFileAttribute
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbFirstWeekOfYear.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbFirstWeekOfYear
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbFirstWeekOfYear
redirect_from:
- /tB/Core/VbFirstWeekOfYear
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbIMEStatus.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbIMEStatus
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbIMEStatus
redirect_from:
- /tB/Core/VbIMEStatus
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbMsgBoxResult.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbMsgBoxResult
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbMsgBoxResult
redirect_from:
- /tB/Core/VbMsgBoxResult
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbMsgBoxStyle.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbMsgBoxStyle
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbMsgBoxStyle
redirect_from:
- /tB/Core/VbMsgBoxStyle
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbStrConv.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbStrConv
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbStrConv
redirect_from:
- /tB/Core/VbStrConv
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbTriState.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbTriState
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbTriState
redirect_from:
- /tB/Core/VbTriState
Expand Down
1 change: 1 addition & 0 deletions docs/Reference/VBA/Constants/VbVarType.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: VbVarType
parent: Constants Module
grand_parent: VBA Package
permalink: /tB/Modules/Constants/VbVarType
redirect_from:
- /tB/Core/VbVarType
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBA/TbExpressionService/Bind.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Bind
parent: TbExpressionService Module
parent: TbExpressionService
permalink: /tB/Modules/TbExpressionService/Bind
redirect_from:
- /tB/Modules/ExpressionService/Bind
Expand Down
1 change: 0 additions & 1 deletion docs/Reference/VBA/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: VBA Package
parent: Packages
grand_parent: Reference Section
nav_order: 2
permalink: /tB/Packages/VBA
redirect_from:
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/BackColor.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: BackColor
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/BackColor
---
# BackColor
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/DisplayAsDefault.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: DisplayAsDefault
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/DisplayAsDefault
---
# DisplayAsDefault
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/DisplayName.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: DisplayName
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/DisplayName
---
# DisplayName
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/Font.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Font
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/Font
---
# Font
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/ForeColor.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: ForeColor
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/ForeColor
---
# ForeColor
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/LocaleID.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: LocaleID
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/LocaleID
---
# LocaleID
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/MessageReflect.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: MessageReflect
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/MessageReflect
---
# MessageReflect
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/Palette.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Palette
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/Palette
---
# Palette
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/RightToLeft.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: RightToLeft
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/RightToLeft
---
# RightToLeft
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/ScaleUnits.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: ScaleUnits
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/ScaleUnits
---
# ScaleUnits
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/ShowGrabHandles.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: ShowGrabHandles
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/ShowGrabHandles
---
# ShowGrabHandles
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/ShowHatching.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: ShowHatching
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/ShowHatching
---
# ShowHatching
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: SupportsMnemonics
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/SupportsMnemonics
---
# SupportsMnemonics
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/TextAlign.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: TextAlign
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/TextAlign
---
# TextAlign
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/UIDead.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: UIDead
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/UIDead
---
# UIDead
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/VBRUN/AmbientProperties/UserMode.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: UserMode
parent: AmbientProperties Module
parent: AmbientProperties
permalink: /tB/Packages/VBRUN/AmbientProperties/UserMode
---
# UserMode
Expand Down
Loading
Loading