Skip to content

Commit 8510636

Browse files
authored
Merge pull request #14 from KubaO/staging
Add a link checking step to the build. Fix all broken links.
2 parents f813cd0 + 7d29f08 commit 8510636

45 files changed

Lines changed: 538 additions & 188 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ jobs:
4343
env:
4444
JEKYLL_ENV: production
4545
PAGES_REPO_NWO: "${{ github.repository }}"
46+
- name: Run HTML Proofer
47+
run: bundle exec htmlproofer ./_site --disable-external --swap-urls "^${{ steps.pages.outputs.base_path }}/:/"
48+
# --log-level :debug
49+
working-directory: ./docs
4650
- name: Upload artifact
4751
uses: actions/upload-pages-artifact@v3
4852
with:

docs/CustomControls/Defining a CustomControl.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Defining a CustomControl
33
parent: CustomControls
44
nav_order: 2
5-
permalink: /CustomControls/Defining/
5+
permalink: /CustomControls/Defining
66
---
77
# Defining a CustomControl
88
A CustomControl is simply an ordinary twinBASIC class, with a few extra attributes and requirements.
@@ -46,7 +46,7 @@ All CustomControls *must* implement CustomControls.ICustomControl. This interfa
4646
``` vb
4747
Sub Initialize(ByVal Context As CustomControlContext)
4848
```
49-
49+
5050
This method is called when your control is attached to a form. You must store the provided Context object in a class field as it offers a `Repaint()` method for informing the form engine that something in your control has changed and needs to be repainted.
5151

5252
``` vb
@@ -59,7 +59,7 @@ This method is called when your control is detached from a form. This allows an
5959
Sub Paint(ByVal Canvas As Canvas)
6060
```
6161

62-
This is the most interesting part for a CustomControl. As such, it gets its own section, see [Painting / drawing to your control](../Painting/)
62+
This is the most interesting part for a CustomControl. As such, it gets its own section, see [Painting / drawing to your control](/CustomControls/Painting)
6363

6464
***
6565
## Minimum set of properties
@@ -78,7 +78,7 @@ Public Visible As Boolean
7878

7979
The form designer and the form engine work with these properties, so it is important to include them in your CustomControl class.
8080

81-
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/)).
81+
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)).
8282

8383
***
8484
## Must have a serialization constructor
@@ -88,4 +88,4 @@ CustomControls *must* offer a serialization constructor:
8888
Public Sub New(Serializer As SerializationInfo)
8989
```
9090

91-
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.
91+
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.

docs/CustomControls/Introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Introduction
33
parent: CustomControls
44
nav_order: 1
5-
permalink: /CustomControls/Introduction/
5+
permalink: /CustomControls/Introduction
66
---
77

88
### Introduction

docs/CustomControls/Notes about the form designer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Notes About the Form Designer
33
parent: CustomControls
44
nav_order: 5
5-
permalink: /CustomControls/Notes/
5+
permalink: /CustomControls/Form Designer
66
---
77

88
# Notes About the Form Designer

docs/CustomControls/Painting-drawing to your control.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Painting / Drawing to Your Control
33
parent: CustomControls
44
nav_order: 4
5-
permalink: /CustomControls/Painting/
5+
permalink: /CustomControls/Painting
66
---
77

88
# Painting / Drawing to Your Control

docs/CustomControls/Property sheet and object serialization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Property Sheet and Object Serialization
33
parent: CustomControls
44
nav_order: 3
5-
permalink: /CustomControls/Properties/
5+
permalink: /CustomControls/Properties
66
---
77
# Property Sheet and Object Serialization
88
The form designer property sheet will pickup any **_public_** custom properties (fields) that you expose via your CustomControl class. For example, adding a field `Public MyField As Long` will then automatically show up in the control property sheet in the form designer:

docs/CustomControls/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: CustomControls
33
nav_order: 3
4-
permalink: /CustomControls/
4+
permalink: /CustomControls
55
---
66

77
# CustomControls

docs/Features/Control anchoring and docking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Control Anchoring and Docking
33
parent: Features
44
nav_order: 2
5-
permalink: /Features/Anchoring-Docking/
5+
permalink: /Features/Anchoring-Docking
66
---
77

88
# Anchoring

docs/Features/Overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Overview
33
parent: Features
44
nav_order: 1
5-
permalink: /Features/Overview/
5+
permalink: /Features/Overview
66
---
77

88
# Overview
@@ -1191,7 +1191,7 @@ In addition to the above, forms have:
11911191
* Control anchoring: control x/y/cx/cy can made relative, so they're automatically moved/resized with the Form. For example if you put a TextBox in the bottom right, then check the Right and Bottom anchors (in addition to Top and Left), the bottom right will size with the form on resize. This saves a lot of boiler-plate sizing code.
11921192
* Control docking: Controls can be fixed along one of the sides of the Form (or container), or made to fill the whole Form/container. Multiple controls can be combined and mixed/matched in docking positions.
11931193

1194-
For more information on Control Anchoring and Control Docking, see the Wiki entry [Control Anchoring and Docking ‐ Automatic size and position management](../Anchoring-Docking).
1194+
For more information on Control Anchoring and Control Docking, see the Wiki entry [Control Anchoring and Docking ‐ Automatic size and position management](Anchoring-Docking).
11951195

11961196
## Unicode support
11971197
All tB-implemented controls support Unicode, both in the code editor and when displayed.
@@ -1213,7 +1213,7 @@ tB will eventually replace all built in controls that you're used to, for now th
12131213

12141214
### Alternatives for unimplemented controls
12151215

1216-
The best option is Krool's VBCCR and VBFlexGrid projects. These are now available [from the Package Server](Packages---Importing-a-package-from-TWINSERV) in x64-compatible form, and are also DPI aware and support Visual Styles.
1216+
The best option is Krool's VBCCR and VBFlexGrid projects. These are now available [from the Package Server](../Packages/Importing-TWINSERV/) in x64-compatible form, and are also DPI aware and support Visual Styles.
12171217

12181218
Additionally, the original OCX controls provided by Microsoft will work fine; however, they're mostly 32-bit only. The x64 version of `MSComCtl.ocx` doesn't come with Windows and isn't legally redistributable but if you have Office 64bit, it works in tB.
12191219

docs/Features/Windowless vs windowed controls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Windowless Controls vs. Windowed Controls
33
parent: Features
44
nav_order: 3
5-
permalink: /Features/Windowless/
5+
permalink: /Features/Windowless
66
---
77

88
# Windowless Controls vs. Normal (Windowed) Controls

0 commit comments

Comments
 (0)