diff --git a/docs/IDE/Call Stack.md b/docs/IDE/Call Stack.md new file mode 100644 index 0000000..77cb48f --- /dev/null +++ b/docs/IDE/Call Stack.md @@ -0,0 +1,10 @@ +--- +title: Call Stack +parent: IDE +# nav_order: 2 +permalink: /tB/IDE/Project/Call Stack +--- + +# Call Stack + +![Call Stack](Images/CallStack.png "Call Stack") diff --git a/docs/IDE/Debug Console.md b/docs/IDE/Debug Console.md new file mode 100644 index 0000000..484aece --- /dev/null +++ b/docs/IDE/Debug Console.md @@ -0,0 +1,21 @@ +--- +title: Debug Console +parent: IDE +# nav_order: 2 +permalink: /tB/IDE/Project/Debug Console +--- + +# Debug Console + +![Debug Console](Images/DebugConsole.png "Debug Console") + +## ![](Images/DebugConsole_AutoScroll.png) Auto Scroll + +## ![](Images/DebugConsole_Clear.png) Clear Debug Console + +## ![](Images/DebugConsole_Options.png) Options + +- Invert Output Direction +- Show Timestamps + +## ![](Images/DebugConsole_Input.png) Input diff --git a/docs/IDE/Diagnostics.md b/docs/IDE/Diagnostics.md new file mode 100644 index 0000000..17001d7 --- /dev/null +++ b/docs/IDE/Diagnostics.md @@ -0,0 +1,23 @@ +--- +title: Diagnostics +parent: IDE +# nav_order: 2 +permalink: /tB/IDE/Project/Diagnostics +--- + +# Diagnostics + +![Diagnostics](Images/Diagnostics.png) + +![Diagnostics](Images/Diagnostics_Toggles.png) + +![Diagnostics](Images/Diagnostics_Totals.png) + + + +## Categories + +- 🟥 Error +- 🟨 Warning +- 🟩 Hints +- 🟦 Info diff --git a/docs/IDE/Editor.md b/docs/IDE/Editor.md new file mode 100644 index 0000000..4e70858 --- /dev/null +++ b/docs/IDE/Editor.md @@ -0,0 +1,58 @@ +--- +title: Editor +parent: IDE +# nav_order: 2 +permalink: /tB/IDE/Project/Editor +--- + +# Editor + +![Editor](Images/Editor.png "Editor") + +## Options + +- Show Code Folding + - never + - *when hovering* + - always + +- Render Whitespace + - all + - *none* + - boundary + - selection + - trailing + +- Font Size + - 8px + - ... + - *13px* + - ... + - 30px +- Show Navigation Bar + - above + - below + - none +- ✔ Show Indent Guides +- ✔ Show Line Numbers +- Code Hints Always Visible +- Sticky Scroll +- ✔ Show MiniMap +- Show Advanced Info On Hover +- Show Single Row Of Tabs +- ✔ Auto Prettify Code +- ✔ Show CodeLens Run Procedure + +## Tabs List + +When a file is open in the _Editor_ it will be listed in the _Tabs List_ and you can jump between them here. + +![Editor Tabs List (Example)](Images/Editor_TabsList_Example.png "Editor Tabs List (Example)") + +_Recently Closed_. + +![Editor Tabs List Recently Closed](Images/Editor_TabsList_RecentlyClosed.png "Editor Tabs List Recently Closed") + +_Recently Closed - List_ + +![Editor Tabs List Recently Closed Examples](Images/Editor_TabsList_RecentlyClosed_Example.png "Editor Tabs List Recently Closed Examples") diff --git a/docs/IDE/Images/Add.png b/docs/IDE/Images/Add.png new file mode 100644 index 0000000..4f44f70 Binary files /dev/null and b/docs/IDE/Images/Add.png differ diff --git a/docs/IDE/Images/CallStack.png b/docs/IDE/Images/CallStack.png new file mode 100644 index 0000000..1a6957a Binary files /dev/null and b/docs/IDE/Images/CallStack.png differ diff --git a/docs/IDE/Images/Components_Message.png b/docs/IDE/Images/Components_Message.png new file mode 100644 index 0000000..ecf6b74 Binary files /dev/null and b/docs/IDE/Images/Components_Message.png differ diff --git a/docs/IDE/Images/DebugConsole.png b/docs/IDE/Images/DebugConsole.png new file mode 100644 index 0000000..7c80d71 Binary files /dev/null and b/docs/IDE/Images/DebugConsole.png differ diff --git a/docs/IDE/Images/DebugConsole_AutoScroll.png b/docs/IDE/Images/DebugConsole_AutoScroll.png new file mode 100644 index 0000000..a53f2eb Binary files /dev/null and b/docs/IDE/Images/DebugConsole_AutoScroll.png differ diff --git a/docs/IDE/Images/DebugConsole_Clear.png b/docs/IDE/Images/DebugConsole_Clear.png new file mode 100644 index 0000000..acac543 Binary files /dev/null and b/docs/IDE/Images/DebugConsole_Clear.png differ diff --git a/docs/IDE/Images/DebugConsole_Input.png b/docs/IDE/Images/DebugConsole_Input.png new file mode 100644 index 0000000..a870f75 Binary files /dev/null and b/docs/IDE/Images/DebugConsole_Input.png differ diff --git a/docs/IDE/Images/DebugConsole_Options.png b/docs/IDE/Images/DebugConsole_Options.png new file mode 100644 index 0000000..ae1f1c8 Binary files /dev/null and b/docs/IDE/Images/DebugConsole_Options.png differ diff --git a/docs/IDE/Images/Diagnostics.png b/docs/IDE/Images/Diagnostics.png new file mode 100644 index 0000000..c1e4ee1 Binary files /dev/null and b/docs/IDE/Images/Diagnostics.png differ diff --git a/docs/IDE/Images/Diagnostics_Toggles.png b/docs/IDE/Images/Diagnostics_Toggles.png new file mode 100644 index 0000000..437e98d Binary files /dev/null and b/docs/IDE/Images/Diagnostics_Toggles.png differ diff --git a/docs/IDE/Images/Diagnostics_Totals.png b/docs/IDE/Images/Diagnostics_Totals.png new file mode 100644 index 0000000..7a349c1 Binary files /dev/null and b/docs/IDE/Images/Diagnostics_Totals.png differ diff --git a/docs/IDE/Images/Editor.png b/docs/IDE/Images/Editor.png new file mode 100644 index 0000000..cba20f9 Binary files /dev/null and b/docs/IDE/Images/Editor.png differ diff --git a/docs/IDE/Images/Editor_TabsList.png b/docs/IDE/Images/Editor_TabsList.png new file mode 100644 index 0000000..d4dede9 Binary files /dev/null and b/docs/IDE/Images/Editor_TabsList.png differ diff --git a/docs/IDE/Images/Editor_TabsList_Example.png b/docs/IDE/Images/Editor_TabsList_Example.png new file mode 100644 index 0000000..c5d247e Binary files /dev/null and b/docs/IDE/Images/Editor_TabsList_Example.png differ diff --git a/docs/IDE/Images/Editor_TabsList_RecentlyClosed.png b/docs/IDE/Images/Editor_TabsList_RecentlyClosed.png new file mode 100644 index 0000000..d5ac32e Binary files /dev/null and b/docs/IDE/Images/Editor_TabsList_RecentlyClosed.png differ diff --git a/docs/IDE/Images/Editor_TabsList_RecentlyClosed_Example.png b/docs/IDE/Images/Editor_TabsList_RecentlyClosed_Example.png new file mode 100644 index 0000000..93f1bea Binary files /dev/null and b/docs/IDE/Images/Editor_TabsList_RecentlyClosed_Example.png differ diff --git a/docs/IDE/Images/File-Green.png b/docs/IDE/Images/File-Green.png new file mode 100644 index 0000000..7d7bff2 Binary files /dev/null and b/docs/IDE/Images/File-Green.png differ diff --git a/docs/IDE/Images/Folder.png b/docs/IDE/Images/Folder.png new file mode 100644 index 0000000..f26c79c Binary files /dev/null and b/docs/IDE/Images/Folder.png differ diff --git a/docs/IDE/Images/IDE.png b/docs/IDE/Images/IDE.png new file mode 100644 index 0000000..d9d2066 Binary files /dev/null and b/docs/IDE/Images/IDE.png differ diff --git a/docs/IDE/Images/Licence_CommunityEdition.png b/docs/IDE/Images/Licence_CommunityEdition.png new file mode 100644 index 0000000..7b1a6ce Binary files /dev/null and b/docs/IDE/Images/Licence_CommunityEdition.png differ diff --git a/docs/IDE/Images/Links.png b/docs/IDE/Images/Links.png new file mode 100644 index 0000000..f569583 Binary files /dev/null and b/docs/IDE/Images/Links.png differ diff --git a/docs/IDE/Images/New_Project.png b/docs/IDE/Images/New_Project.png new file mode 100644 index 0000000..6ec80a8 Binary files /dev/null and b/docs/IDE/Images/New_Project.png differ diff --git a/docs/IDE/Images/New_Project_Recent_1.png b/docs/IDE/Images/New_Project_Recent_1.png new file mode 100644 index 0000000..60cf355 Binary files /dev/null and b/docs/IDE/Images/New_Project_Recent_1.png differ diff --git a/docs/IDE/Images/New_Project_Recent_2.png b/docs/IDE/Images/New_Project_Recent_2.png new file mode 100644 index 0000000..58e08cc Binary files /dev/null and b/docs/IDE/Images/New_Project_Recent_2.png differ diff --git a/docs/IDE/Images/New_Project_Samples.png b/docs/IDE/Images/New_Project_Samples.png new file mode 100644 index 0000000..48341fe Binary files /dev/null and b/docs/IDE/Images/New_Project_Samples.png differ diff --git a/docs/IDE/Images/Options.png b/docs/IDE/Images/Options.png new file mode 100644 index 0000000..05749c3 Binary files /dev/null and b/docs/IDE/Images/Options.png differ diff --git a/docs/IDE/Images/ProjectExplorer.png b/docs/IDE/Images/ProjectExplorer.png new file mode 100644 index 0000000..fe09430 Binary files /dev/null and b/docs/IDE/Images/ProjectExplorer.png differ diff --git a/docs/IDE/Images/ProjectExplorer_Header.png b/docs/IDE/Images/ProjectExplorer_Header.png new file mode 100644 index 0000000..6267f09 Binary files /dev/null and b/docs/IDE/Images/ProjectExplorer_Header.png differ diff --git a/docs/IDE/Images/ProjectExplorer_Sample.png b/docs/IDE/Images/ProjectExplorer_Sample.png new file mode 100644 index 0000000..705947e Binary files /dev/null and b/docs/IDE/Images/ProjectExplorer_Sample.png differ diff --git a/docs/IDE/Images/Properties.png b/docs/IDE/Images/Properties.png new file mode 100644 index 0000000..79db176 Binary files /dev/null and b/docs/IDE/Images/Properties.png differ diff --git a/docs/IDE/Images/RightClick-Add-CustomControlsForm-Popup.png b/docs/IDE/Images/RightClick-Add-CustomControlsForm-Popup.png new file mode 100644 index 0000000..e404ae2 Binary files /dev/null and b/docs/IDE/Images/RightClick-Add-CustomControlsForm-Popup.png differ diff --git a/docs/IDE/Images/RightClick-Add.png b/docs/IDE/Images/RightClick-Add.png new file mode 100644 index 0000000..bf76331 Binary files /dev/null and b/docs/IDE/Images/RightClick-Add.png differ diff --git a/docs/IDE/Images/Services_Limited.png b/docs/IDE/Images/Services_Limited.png new file mode 100644 index 0000000..c9bbebd Binary files /dev/null and b/docs/IDE/Images/Services_Limited.png differ diff --git a/docs/IDE/Images/Services_Operational.png b/docs/IDE/Images/Services_Operational.png new file mode 100644 index 0000000..1e12788 Binary files /dev/null and b/docs/IDE/Images/Services_Operational.png differ diff --git a/docs/IDE/Images/Services_Operational_Tooltip.png b/docs/IDE/Images/Services_Operational_Tooltip.png new file mode 100644 index 0000000..5cccec8 Binary files /dev/null and b/docs/IDE/Images/Services_Operational_Tooltip.png differ diff --git a/docs/IDE/Images/Services_Unavailable.png b/docs/IDE/Images/Services_Unavailable.png new file mode 100644 index 0000000..fcb407a Binary files /dev/null and b/docs/IDE/Images/Services_Unavailable.png differ diff --git a/docs/IDE/Images/Services_Unavailable_Tooltip.png b/docs/IDE/Images/Services_Unavailable_Tooltip.png new file mode 100644 index 0000000..d2aa17a Binary files /dev/null and b/docs/IDE/Images/Services_Unavailable_Tooltip.png differ diff --git a/docs/IDE/Images/Settings.png b/docs/IDE/Images/Settings.png new file mode 100644 index 0000000..5da71b8 Binary files /dev/null and b/docs/IDE/Images/Settings.png differ diff --git a/docs/IDE/Images/Splash_Screen.png b/docs/IDE/Images/Splash_Screen.png new file mode 100644 index 0000000..d752ae9 Binary files /dev/null and b/docs/IDE/Images/Splash_Screen.png differ diff --git a/docs/IDE/Images/StatusBar.png b/docs/IDE/Images/StatusBar.png new file mode 100644 index 0000000..e279d48 Binary files /dev/null and b/docs/IDE/Images/StatusBar.png differ diff --git a/docs/IDE/Images/Toggle.png b/docs/IDE/Images/Toggle.png new file mode 100644 index 0000000..cfdc467 Binary files /dev/null and b/docs/IDE/Images/Toggle.png differ diff --git a/docs/IDE/Images/Toolbar_1.png b/docs/IDE/Images/Toolbar_1.png new file mode 100644 index 0000000..3189639 Binary files /dev/null and b/docs/IDE/Images/Toolbar_1.png differ diff --git a/docs/IDE/Images/Toolbar_2.png b/docs/IDE/Images/Toolbar_2.png new file mode 100644 index 0000000..3a39a95 Binary files /dev/null and b/docs/IDE/Images/Toolbar_2.png differ diff --git a/docs/IDE/Images/Toolbar_3.png b/docs/IDE/Images/Toolbar_3.png new file mode 100644 index 0000000..633a8f8 Binary files /dev/null and b/docs/IDE/Images/Toolbar_3.png differ diff --git a/docs/IDE/Images/Toolbar_4.png b/docs/IDE/Images/Toolbar_4.png new file mode 100644 index 0000000..efc664e Binary files /dev/null and b/docs/IDE/Images/Toolbar_4.png differ diff --git a/docs/IDE/Images/Toolbox_MoreComponents.png b/docs/IDE/Images/Toolbox_MoreComponents.png new file mode 100644 index 0000000..0c3a577 Binary files /dev/null and b/docs/IDE/Images/Toolbox_MoreComponents.png differ diff --git a/docs/IDE/Images/Toolbox_Report.png b/docs/IDE/Images/Toolbox_Report.png new file mode 100644 index 0000000..b93e389 Binary files /dev/null and b/docs/IDE/Images/Toolbox_Report.png differ diff --git a/docs/IDE/Images/UserControl.png b/docs/IDE/Images/UserControl.png new file mode 100644 index 0000000..4e27b55 Binary files /dev/null and b/docs/IDE/Images/UserControl.png differ diff --git a/docs/IDE/Images/Variables.png b/docs/IDE/Images/Variables.png new file mode 100644 index 0000000..496f999 Binary files /dev/null and b/docs/IDE/Images/Variables.png differ diff --git a/docs/IDE/Images/tB-Blue.png b/docs/IDE/Images/tB-Blue.png new file mode 100644 index 0000000..433a534 Binary files /dev/null and b/docs/IDE/Images/tB-Blue.png differ diff --git a/docs/IDE/Images/tB-Green.png b/docs/IDE/Images/tB-Green.png new file mode 100644 index 0000000..63cb7c3 Binary files /dev/null and b/docs/IDE/Images/tB-Green.png differ diff --git a/docs/IDE/Images/tB-Orange.png b/docs/IDE/Images/tB-Orange.png new file mode 100644 index 0000000..65b4d4d Binary files /dev/null and b/docs/IDE/Images/tB-Orange.png differ diff --git a/docs/IDE/Images/tB-Red.png b/docs/IDE/Images/tB-Red.png new file mode 100644 index 0000000..60026d6 Binary files /dev/null and b/docs/IDE/Images/tB-Red.png differ diff --git a/docs/IDE/Images/tbForm.png b/docs/IDE/Images/tbForm.png new file mode 100644 index 0000000..e23759a Binary files /dev/null and b/docs/IDE/Images/tbForm.png differ diff --git a/docs/IDE/Images/tbReport.png b/docs/IDE/Images/tbReport.png new file mode 100644 index 0000000..4bcb357 Binary files /dev/null and b/docs/IDE/Images/tbReport.png differ diff --git a/docs/IDE/Menu/File.md b/docs/IDE/Menu/File.md new file mode 100644 index 0000000..6761468 --- /dev/null +++ b/docs/IDE/Menu/File.md @@ -0,0 +1,30 @@ +--- +title: File +parent: Menu +# nav_order: +permalink: /tB/IDE/Project/Menu/File +--- + +# Help Menu + +![File (Menu)](Images/Menu_File.png "File (Menu)") + +- New Project... CTRL + N +- Open Project... CTRL + O +- Open Recent... +- Close Project +--- +- Save Project CTRL + S +- Save Project As... +--- +- Export Project... +- Save Current Document +--- +- Build +- Clean +--- +- Exit ALT + F4 + +> [!NOTE] +> +> TODO: Add each Menu item. diff --git a/docs/IDE/Menu/Help.md b/docs/IDE/Menu/Help.md new file mode 100644 index 0000000..ee0ad96 --- /dev/null +++ b/docs/IDE/Menu/Help.md @@ -0,0 +1,50 @@ +--- +title: Help +parent: Menu +# nav_order: +permalink: /tB/IDE/Project/Menu/Help +--- + +# Help Menu + +![Help Menu](Images/Menu_Help.png "Help Menu") + +- About twinBASIC... +- Licence Agreement... +- Automatic IDE Error Reporting... +--- +- Help & Support (Discord Server)... +- Help & Support (GitHub repository)... +- Twitter (News Feed)... +--- +- Purchase A Licence... +- Enter Licence Key... +- Buy us a Coffee! (Ko-Fi)... +--- +- Compiler services TRACE mode: Disabled + +> [!NOTE] +> +> TODO: Add each Help Menu item. + +## About twinBASIC... + +![About | Help Menu](Images/Menu_Help_About.png "About | Help Menu") + +## Licence Agreement... + +## Automatic IDE Error Reporting... + +## Help & Support (Discord Server)... + +## Help & Support (GitHub repository)... + +## Twitter (News Feed)... + +## Purchase A Licence... + +## Enter Licence Key... + +## Buy us a Coffee! (Ko-Fi)... + +## Compiler services TRACE mode: Disabled diff --git a/docs/IDE/Menu/Images/Menu.png b/docs/IDE/Menu/Images/Menu.png new file mode 100644 index 0000000..8e43d66 Binary files /dev/null and b/docs/IDE/Menu/Images/Menu.png differ diff --git a/docs/IDE/Menu/Images/Menu_File.png b/docs/IDE/Menu/Images/Menu_File.png new file mode 100644 index 0000000..ab8e170 Binary files /dev/null and b/docs/IDE/Menu/Images/Menu_File.png differ diff --git a/docs/IDE/Menu/Images/Menu_Help.png b/docs/IDE/Menu/Images/Menu_Help.png new file mode 100644 index 0000000..9f74fa9 Binary files /dev/null and b/docs/IDE/Menu/Images/Menu_Help.png differ diff --git a/docs/IDE/Menu/Images/Menu_Help_About.png b/docs/IDE/Menu/Images/Menu_Help_About.png new file mode 100644 index 0000000..9f00ce2 Binary files /dev/null and b/docs/IDE/Menu/Images/Menu_Help_About.png differ diff --git a/docs/IDE/Menu/index.md b/docs/IDE/Menu/index.md new file mode 100644 index 0000000..835f0c0 --- /dev/null +++ b/docs/IDE/Menu/index.md @@ -0,0 +1,26 @@ +--- +title: Menu +parent: IDE +# nav_order: 1 +permalink: /tB/IDE/Project/Menu +--- + +# Menu + +![Menu](Images/Menu.png "Menu") + +- [File](/tB/IDE/Project/Menu/File) +- Edit +- View +- Project +- Format +- Debug +- Run +- Tools +- Add-Ins +- Window +- [Help](/tB/IDE/Project/Menu/Help) + +> [!NOTE] +> +> TODO: Add each Menu item. diff --git a/docs/IDE/New Project.md b/docs/IDE/New Project.md new file mode 100644 index 0000000..3a10f29 --- /dev/null +++ b/docs/IDE/New Project.md @@ -0,0 +1,70 @@ +--- +title: Project +parent: IDE +# nav_order: 2 +permalink: /tB/IDE/Project/New +--- + +# New Project + +![New / Open Project](Images/New_Project.png "New / Open Project") + +![File (Menu)](Menu/Images/Menu_File.png "File (Menu)") + +Shortcut: CTRL + N + +## Options + +- Standard Exe +- ActiveX Control +- ActiveX DLL +- Standard DLL +- Standard EXE (Console App) +- Standard EXE (plus VBCCR v1.8) +- Import from VBP... +- Import from folder... + +Browse \| Open \| Cancel + +# Samples + +![Samples](Images/New_Project_Samples.png "Samples") + +0. Reports (Experimental) +1. WebView2 Examples +2. GetIPAddress +3. MyCodeLibrary +4. MyVBEAddin (NEW with ToolWindow) +5. MyCOMAddin +6. CustomControls +7. Package +8. FilePropertyViewer (CustomControls) +9. ActiveX Control WebView2 + Monaco +10. twinBASIC IDE Addin +11. twinBASIC IDE Addin (Chart) +12. twinBASIC IDE Addin (Monaco) +13. twinBASIC IDE Addin (ListView) +14. twinBASIC IDE Addin (VirutalListView) +15. twinBASIC IDE Addin (Global Search) +16. twinBASIC IDE Addin (TODO Widgets demo) +17. Static Library Example (SQLITE3) +18. Static Library Example (libdeflate) +19. MDI Forms +20. TreeView + ListView + ImageList +21. Windows Service Simple Example +22. Windows Service Complex Example (inc Event Logging and IPC) +23. OOP Inheritance Example (Animals) + +# Recent + +If you haven't opened any projects, or removed all then this tab will be blank. + +![Recent](Images/New_Project_Recent_1.png "Recent") + +A list of recent projects will be displayed, resizing depending on how many are in the list. + +![Recent](Images/New_Project_Recent_2.png "Recent") + +_Removed paths_ + +Click on the X to remove from the list. diff --git a/docs/IDE/Project Explorer.md b/docs/IDE/Project Explorer.md new file mode 100644 index 0000000..6b51ddc --- /dev/null +++ b/docs/IDE/Project Explorer.md @@ -0,0 +1,214 @@ +--- +title: Project Explorer +parent: IDE +# nav_order: 2 +permalink: /tB/IDE/Project/Explorer +--- + +# Project Explorer + +![Project Explorer](Images/ProjectExplorer.png "Project Explorer") +![Project Explorer Sample](Images/ProjectExplorer_Sample.png "Project Explorer Sample") + +![Folder](Images/Folder.png "Folder") ImportedTypeLibraries +![Folder](Images/Folder.png "Folder") Miscellaneous +![Folder](Images/Folder.png "Folder") Packages + + + + + +![Folder](Images/Folder.png "Folder") References +![Folder](Images/Folder.png "Folder") Resources +![Folder](Images/Folder.png "Folder") Sources + +When a Project is open contextual icons will appear. + +![Project Explorer Header](Images/ProjectExplorer_Header.png "Project Explorer Header") + +## ![](Images/Settings.png) Project Settings + +- [Info](Settings) + +## ![](Images/Toggle.png) Toggle file view (CTRL + R) + + +## ![](Images/Add.png) Add... + +Same as Right-Click + +> [!NOTE] +> +> TODO: Add each Menu item. + +## Right-Click - Add + +![Right-Click Add](Images/RightClick-Add.png "Right-Click Add") + +- ![Folder](Images/Folder.png "Folder") Add Folder +- ![](Images/tB-Green.png) Add Windows Form +- ![](Images/tB-Green.png) Add Windows MDI Form +- ![](Images/tB-Green.png) Add Windows UserControl +- ![](Images/tB-Green.png) Add Windows PropertyPage +- ![](Images/tB-Green.png) Add Windows Report + +--- + +- ![](Images/tB-Green.png) Add CustomControls Form + +--- + +- ![Module](Images/tB-Red.png "Module") Add Module (.TWIN supporting Unicode) +- ![Class](Images/tB-Red.png "Class") Add Class (.TWIN supporting Unicode) + +--- + +- ![Module](Images/tB-Blue.png "Module (BAS)") Add Module (.BAS) +- ![Class](Images/tB-Orange.png "Class (CLS)") Add Class (.CLS) + +--- + +- ![File](Images/File-Green.png "File") Add Other File + +--- + +- ![File](Images/File-Green.png "File") Import + +--- + +- Add Resource: Visual Styles Manifest +- Add Resource: String Table +- Add Resource: MESSAGETABLE + +## ![](Images/Folder.png) Folder +{: #folder } + +## ![](Images/tB-Green.png) Windows Form +{: #windows-form } + +[tbForm](Editor/Form) + +## ![](Images/tB-Green.png) Windows MDI Form +{: #windows-mdi-form } + +## ![](Images/UserControl.png) Windows UserControl +{: #windows-usercontrol } + +## ![](Images/tB-Green.png) Windows PropertyPage +{: #windows-propertypage } + +## ![](Images/tB-Green.png) Windows Report +{: #windows-report } + +[tbReport](Editor/Report) + +## ![](Images/tB-Green.png) CustomControls Forms +{: #customcontrols-forms } + +![Add CustomControls Form Popup](Images/RightClick-Add-CustomControlsForm-Popup.png "Add CustomControls Form Popup") + +## ![](Images/tB-Red.png) Module +{: #module } + +## ![](Images/tB-Red.png) Class +{: #class } + +## ![](Images/File-Green.png) Other File +{: #other-file } + +## ![](Images/File-Green.png) Import +{: #import } + +## Resource: Visual Styles Manifest + +See ![Folder](Images/Folder.png "Folder") `/.../Resources/MANIFEST/#1.xml` + +```xml + + + + Application description here + + + + + + +``` + +## Resource: String Table + +See ![Folder](Images/Folder.png "Folder") `/.../Resources/STRING/Strings.json` + +```json +[ + { + "id": 101, + "name": "MyLocalizedString1", + "LCID_0000": "This is my NEUTRAL text for MyLocalizedString1", + "LCID_0409": "This is my USA text for MyLocalizedString1", + "LCID_0407": "This is my GERMAN text for MyLocalizedString1", + "LCID_0809": "This is my UK text for MyLocalizedString1" + }, + { + "id": 102, + "name": "MyLocalizedString2", + "LCID_0000": "This is my NEUTRAL text for MyLocalizedString2", + "LCID_0409": "This is my USA text for MyLocalizedString2", + "LCID_0407": "This is my GERMAN text for MyLocalizedString2", + "LCID_0809": "This is my UK text for MyLocalizedString2" + } +] +``` + +## Resource: MESSAGETABLE + +See ![Folder](Images/Folder.png "Folder") `/.../Resources/MESSAGETABLE/Strings.json` + +```json +{ + "events": + [ + { + "id": -1073610751, + "name": "service_started", + "LCID_0000": "%1 service started" + }, + { + "id": -1073610750, + "name": "service_startup_failed", + "LCID_0000": "%1 service startup failed" + }, + { + "id": -1073610749, + "name": "service_ended", + "LCID_0000": "%1 service ended" + }, + { + "id": -1073610748, + "name": "service_stopping", + "LCID_0000": "%1 service stopping" + } + ], + "categories": + [ + { + "id": 1, + "name": "status_changed", + "LCID_0000": "Status Changed" + } + ] +} +``` diff --git a/docs/IDE/Project Settings.md b/docs/IDE/Project Settings.md index 4000c12..f29f4c3 100644 --- a/docs/IDE/Project Settings.md +++ b/docs/IDE/Project Settings.md @@ -1,6 +1,7 @@ --- title: Project Settings parent: IDE +# nav_order: 1 permalink: /tB/IDE/Project/Settings --- diff --git a/docs/IDE/Properties.md b/docs/IDE/Properties.md new file mode 100644 index 0000000..15d1004 --- /dev/null +++ b/docs/IDE/Properties.md @@ -0,0 +1,10 @@ +--- +title: Properties +parent: IDE +# nav_order: 2 +permalink: /tB/IDE/Project/Properties +--- + +# Properties + +![Properties](Images/Properties.png "Properties") diff --git a/docs/IDE/Splash Screen.md b/docs/IDE/Splash Screen.md new file mode 100644 index 0000000..09d336d --- /dev/null +++ b/docs/IDE/Splash Screen.md @@ -0,0 +1,10 @@ +--- +title: Splash Screen +parent: IDE +# nav_order: 2 +permalink: /tB/IDE/Project/Splash +--- + +# Splash Screen + +![Splash Screen](Images/Splash_Screen.png "Splash Screen") diff --git a/docs/IDE/Status Bar.md b/docs/IDE/Status Bar.md new file mode 100644 index 0000000..da29149 --- /dev/null +++ b/docs/IDE/Status Bar.md @@ -0,0 +1,53 @@ +--- +title: Status Bar +parent: IDE +# nav_order: 2 +permalink: /tB/IDE/Project/Status Bar +--- + +# Status Bar + +![Status Bar](Images/StatusBar.png "Status Bar") + +## Services + +![Services Unavailable](Images/Services_Unavailable.png "Services Unavailable") + +![Services](Images/Services_Unavailable_Tooltip.png "Services Unavailable Tooltip") + +![Services Limited](Images/Services_Limited.png "Services Limited") + +![Services Operational](Images/Services_Operational.png "Services Operational") + +![Services](Images/Services_Operational_Tooltip.png "Services Operational Tooltip") + +COMPILER: Disconnected / OPERATIONAL + +FS: Disconnected / OPERATIONAL + +LSP: Disconnected / OPERATIONAL + +- [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) + +DEBUGGER: Disconnected / OPERATIONAL + +## Licence + +- [Pre Order](https://twinbasic.com/preorder.html) + +![Licence - Community Edition](Images/Licence_CommunityEdition.png "Licence - Community Edition") + +- Community Edition +- Professional Edition +- Ultimate Edition + +## Links + +![Links](Images/Links.png "Links") + +- https://ko-fi.com/twinbasic +- https://discord.com/invite/UaW9GgKKuE +- http://x.com/waynephillipsea +- https://github.com/twinbasic/twinbasic + +## Status diff --git a/docs/IDE/Toolbar.md b/docs/IDE/Toolbar.md new file mode 100644 index 0000000..8fdf646 --- /dev/null +++ b/docs/IDE/Toolbar.md @@ -0,0 +1,48 @@ +--- +title: Toolbar +parent: IDE +# nav_order: 3 +permalink: /tB/IDE/Project/Toolbar +--- + +# Toolbar + +![Toolbar](Images/Toolbar_1.png "Toolbar") +![Toolbar](Images/Toolbar_2.png "Toolbar") +![Toolbar](Images/Toolbar_3.png "Toolbar") +![Toolbar](Images/Toolbar_4.png "Toolbar") + +- Save All Changes (CTRL + S) +- Find In Project... (CTRL + SHIFT + F) (CTRL + ⇧ + F) +- Switch Between Form And Code +- Undo +- Redo +- Start / Continue (F5) +- Break Into Code (CTRL + BREAK) +- Stop +- Step Over (SHIFT + F8 / F10) +- Step Into (F8 / F10) +- Step Out (CTRL + SHIFT + F8 / SHIFT + F11) +- Choose a build configuration +- Restart the compiler +- Clean (Deregister & delete build) +- Build +- Comment Selection (CTRL + K) +- Uncomment Selection (CTRL + SHIFT + K) +- Indent Block (CTRL + [) +- Outdent Block (CTRL + ]) +- Align controls to the LEFT (ALT + ARROWLEFT) +- Align controls to the TOP (ALT + ARROWUP) +- Align controls to the RIGHT (ALT + ARROWRIGHT) +- Align controls to the DOWN (ALT + ARROWDOWN) +- Resize controls to the WIDEST (CTRL + SHIFT + ARROWRIGHT) +- Resize controls to the TALLEST (CTRL + SHIFT + ARROWDOWN) +- Resize controls to the NARROWEST (CTRL + SHIFT + ARROWLEFT) +- Resize controls to the SHORTEST (CTRL + SHIFT + ARROWUP) +- Toggle the grid indicators ON/OFF +- Bring the selected control to the FRONT of the z-order +- Send the selected control to the BACK of the z-order +- Form designer zoom ratio +- Launch the form in isolation to test the functionality +- Change IDE Theme +- Global Search diff --git a/docs/IDE/Toolbox.md b/docs/IDE/Toolbox.md new file mode 100644 index 0000000..4364e08 --- /dev/null +++ b/docs/IDE/Toolbox.md @@ -0,0 +1,20 @@ +--- +title: Toolbox +parent: IDE +# nav_order: 4 +permalink: /tB/IDE/Project/Toolbox +--- + +# Toolbox + +See [Controls](../../Controls) + + + +![+ More Components](Images/Toolbox_MoreComponents.png "+ More Components") + +![Components Message](Images/Components_Message.png "Components Message") + +The "GoTo COM References" button takes you to **Project Settings** and filters by "project.references". + +See [Project Settings](Settings) for more info. diff --git a/docs/IDE/Variables.md b/docs/IDE/Variables.md new file mode 100644 index 0000000..6c53509 --- /dev/null +++ b/docs/IDE/Variables.md @@ -0,0 +1,10 @@ +--- +title: Variables +parent: IDE +# nav_order: 2 +permalink: /tB/IDE/Project/Variables +--- + +# Variables + +![Variables](Images/Variables.png "Variables") diff --git a/docs/IDE/_Images/Call Stack.af b/docs/IDE/_Images/Call Stack.af new file mode 100644 index 0000000..6215a63 Binary files /dev/null and b/docs/IDE/_Images/Call Stack.af differ diff --git a/docs/IDE/_Images/Debug Console Auto Scroll.af b/docs/IDE/_Images/Debug Console Auto Scroll.af new file mode 100644 index 0000000..d7a32bf Binary files /dev/null and b/docs/IDE/_Images/Debug Console Auto Scroll.af differ diff --git a/docs/IDE/_Images/Debug Console Clear.af b/docs/IDE/_Images/Debug Console Clear.af new file mode 100644 index 0000000..c3dcb07 Binary files /dev/null and b/docs/IDE/_Images/Debug Console Clear.af differ diff --git a/docs/IDE/_Images/Debug Console Input.af b/docs/IDE/_Images/Debug Console Input.af new file mode 100644 index 0000000..51615c7 Binary files /dev/null and b/docs/IDE/_Images/Debug Console Input.af differ diff --git a/docs/IDE/_Images/Debug Console Options.af b/docs/IDE/_Images/Debug Console Options.af new file mode 100644 index 0000000..d4a5e80 Binary files /dev/null and b/docs/IDE/_Images/Debug Console Options.af differ diff --git a/docs/IDE/_Images/Debug Console.af b/docs/IDE/_Images/Debug Console.af new file mode 100644 index 0000000..c7aec8b Binary files /dev/null and b/docs/IDE/_Images/Debug Console.af differ diff --git a/docs/IDE/_Images/Diagnostics Toggles.af b/docs/IDE/_Images/Diagnostics Toggles.af new file mode 100644 index 0000000..b14e657 Binary files /dev/null and b/docs/IDE/_Images/Diagnostics Toggles.af differ diff --git a/docs/IDE/_Images/Diagnostics Totals.af b/docs/IDE/_Images/Diagnostics Totals.af new file mode 100644 index 0000000..065d146 Binary files /dev/null and b/docs/IDE/_Images/Diagnostics Totals.af differ diff --git a/docs/IDE/_Images/Diagnostics.af b/docs/IDE/_Images/Diagnostics.af new file mode 100644 index 0000000..5b6a182 Binary files /dev/null and b/docs/IDE/_Images/Diagnostics.af differ diff --git a/docs/IDE/_Images/Editor.af b/docs/IDE/_Images/Editor.af new file mode 100644 index 0000000..162ee8e Binary files /dev/null and b/docs/IDE/_Images/Editor.af differ diff --git a/docs/IDE/index.md b/docs/IDE/index.md index ca70698..3f1720a 100644 --- a/docs/IDE/index.md +++ b/docs/IDE/index.md @@ -1,7 +1,9 @@ --- title: IDE +# nav_order: 10 permalink: /tB/IDE --- # The twinBASIC IDE +![IDE](Images/IDE.png "IDE") diff --git a/docs/IDE/tbForm.md b/docs/IDE/tbForm.md new file mode 100644 index 0000000..ba9ee6d --- /dev/null +++ b/docs/IDE/tbForm.md @@ -0,0 +1,12 @@ +--- +title: tbForm +parent: IDE +# nav_order: 2 +permalink: /tB/IDE/Project/Editor/Form +--- + +# .tbForm + +![tbForm](Images/tbForm.png "tbForm") + +See [Toolbox](../Toolbox) for [Controls](../../../Controls) available to use. diff --git a/docs/IDE/tbReport.md b/docs/IDE/tbReport.md new file mode 100644 index 0000000..5e30a40 --- /dev/null +++ b/docs/IDE/tbReport.md @@ -0,0 +1,30 @@ +--- +title: tbReport +parent: IDE +# nav_order: 2 +permalink: /tB/IDE/Project/Editor/Report +--- + +# .tbReport + +Contains + +- Report Header +- Page Header +- Report Detail +- Page Footer +- Report Footer + +![tbReport](Images/tbReport.png "tbReport") + +Only certain [Controls](../../../Controls) are available to a Report. + +- Pointer +- Label +- Shape +- Line +- Image +- CheckMark +- QRCode + +![Toolbox Report](Images/Toolbox_Report.png "Toolbox Report") diff --git a/docs/Reference/Controls.md b/docs/Reference/Controls.md new file mode 100644 index 0000000..553ce9b --- /dev/null +++ b/docs/Reference/Controls.md @@ -0,0 +1,11 @@ +--- +title: Controls +parent: Reference Section +permalink: /tB/Controls +--- + +# Controls + +> [!WARNING] +> Work in Progress +