Skip to main content

Velox Help Knowledge Map

This repository holds user-facing Velox documentation, especially the CodeLibrary for scripting classes, constants, functions, types, variables, and scripting guide pages. It also contains a Docusaurus scaffold named Velox, which appears to be a test or future documentation site rather than the main current help system.

Complexity is estimated from documentation volume, coupling to runtime behavior, generation/indexing complexity, and risk of misleading users. When behavior is not proven by repository files alone, it is marked as unclear.

CodeLibrary Index and Navigation​

Purpose:

  • Provides the structured index for the CodeLibrary help content.
  • Connects top-level documentation categories to many Markdown topic files.

Main classes:

  • No runtime classes.
  • Main artifacts are CodeLibrary\_Index.json, CodeLibrary\Classes.md, CodeLibrary\Constants.md, CodeLibrary\Functions.md, CodeLibrary\Types.md, and CodeLibrary\Variables.md.
  • Documented classes include Velox scripting/runtime symbols such as TvxActionMan, TvxFileDef, TvxDBCon, TvxMap, TvxLog, TdaSQLQueryDataView, TNativeXML, TJSONValue, and Indy mail classes.

Dependencies:

  • Velox scripting surface in the velox repository.
  • Markdown rendering/indexing behavior in the product help system.
  • Generated or curated symbol lists.

Important entry points:

  • CodeLibrary\_Index.json
  • CodeLibrary\Classes.md
  • CodeLibrary\Functions.md
  • CodeLibrary\Variables.md

Important configuration:

  • _Index.json appears to drive navigation and topic discovery.
  • Exact generation process is unclear from this repository alone.

Related documentation:

  • architecture.md
  • AGENTS.md
  • ..\velox\KNOWLEDGE_MAP.md

Estimated complexity: High

Scripting Guide​

Purpose:

  • Documents the Velox scripting language, scripting events, map/flow concepts, includes, datasets, operators, statements, comments, testing values, and compilation errors.
  • Helps users write and troubleshoot scripts in Velox.

Main classes:

  • No runtime classes.
  • Main artifacts are Markdown pages under CodeLibrary\ScriptingGuide.
  • Documented concepts include ScriptEvent, BeforeMap, AfterMap_Field, AfterMap_Record, LinkedData, MapFlow, datasets, statements, and compiler errors.

Dependencies:

  • RemObjects Pascal Script integration in velox.
  • Velox mapping and flow execution behavior.
  • Actual compiler diagnostics and runtime event names.

Important entry points:

  • CodeLibrary\ScriptingGuide\Scripting.md
  • CodeLibrary\ScriptingGuide\Events.md
  • CodeLibrary\ScriptingGuide\Functions.md
  • CodeLibrary\ScriptingGuide\Statements.md
  • CodeLibrary\ScriptingGuide\CompilationErrors.md

Important configuration:

  • No application configuration in this subsystem.
  • Accuracy depends on keeping topic text synchronized with the scripting engine.

Related documentation:

  • architecture.md
  • ..\velox\KNOWLEDGE_MAP.md

Estimated complexity: High

Script API Reference Topics​

Purpose:

  • Documents callable functions, constants, types, variables, properties, and methods available to Velox scripts.
  • Provides detailed pages for utility functions, data variables, local variables, helpers, module variables, and class members.

Main classes:

  • No runtime classes.
  • Main documented groups include Functions, Constants, Types, Variables\Config, Variables\Data, Variables\Helpers, Variables\Modules, and class/property/method topic trees.

Dependencies:

  • Delphi source symbols in velox.
  • Generated documentation conventions.
  • CodeLibrary index/navigation.

Important entry points:

  • CodeLibrary\Functions
  • CodeLibrary\Constants
  • CodeLibrary\Types
  • CodeLibrary\Variables
  • CodeLibrary\Classes

Important configuration:

  • Topic folder naming appears to map directly to help navigation.
  • Generation/exclusion behavior is partly suggested by CodeLibrary\_excludecopy.txt, but the full process is unclear.

Related documentation:

  • architecture.md
  • CodeLibrary\_excludecopy.txt
  • ..\velox\KNOWLEDGE_MAP.md

Estimated complexity: High

Root Topic Templates​

Purpose:

  • Provides template-like Markdown files used for generated or parameterized documentation.
  • The %s placeholders suggest these files are used to render source, destination, or variable-specific views.

Main classes:

  • No runtime classes.
  • Main artifacts are SourceDataView.md, DestDataView.md, and M_Variable.md.

Dependencies:

  • Documentation generation or rendering process, which is unclear.
  • Velox module/data-view terminology.

Important entry points:

  • SourceDataView.md
  • DestDataView.md
  • M_Variable.md

Important configuration:

  • Placeholder substitution rules are unclear from this repository alone.

Related documentation:

  • architecture.md

Estimated complexity: Low

Docusaurus Site Scaffold​

Purpose:

  • Contains a Docusaurus documentation website scaffold under Velox.
  • Appears to be a test or future site, since much of the content is Docusaurus starter material.

Main classes:

  • No product runtime classes.
  • React components include Velox\src\pages\index.js, Velox\src\pages\my-react-page.js, and Velox\src\components\HomepageFeatures\index.js.

Dependencies:

  • Node.js and npm.
  • Docusaurus.
  • React.
  • Static assets under Velox\static.

Important entry points:

  • Velox\package.json
  • Velox\docusaurus.config.js
  • Velox\sidebars.js
  • Velox\src\pages\index.js
  • Velox\docs\intro.md

Important configuration:

  • Docusaurus site config in docusaurus.config.js.
  • Sidebar configuration in sidebars.js.
  • Current production relevance is unclear.

Related documentation:

  • architecture.md
  • Velox\README.md

Estimated complexity: Medium

Documentation Build and Sync Scripts​

Purpose:

  • Provides batch files for editing, building, testing, and syncing documentation/install content.
  • Supports the workflow around CodeLibrary and the Docusaurus scaffold.

Main classes:

  • No runtime classes.
  • Main artifacts are batch files and update scripts.

Dependencies:

  • Windows command shell.
  • Local checkout layout.
  • Docusaurus/npm for site-related scripts.
  • Install repository for CodeLibrary package updates.

Important entry points:

  • 1. Velox Edit.bat
  • 2. Velox Build.bat
  • 3. Velox Test.bat
  • CodeLibrary\_UPDATE INSTALL FOLDER.bat

Important configuration:

  • Script assumptions about paths and installed tools are unclear until each batch file is reviewed/executed.

Related documentation:

  • architecture.md
  • AGENTS.md
  • Install PKB documentation is not currently present under velox-kb\VeloxPKB\docs\

Estimated complexity: Low

Source Coordination and Accuracy Rules​

Purpose:

  • Ensures user-facing documentation stays aligned with actual Velox behavior.
  • Provides guardrails around marking unclear behavior rather than inventing details.

Main classes:

  • No runtime classes.
  • Main artifacts are repo instructions and documentation content.

Dependencies:

  • velox source behavior.
  • velox-data schema and contracts.
  • User documentation requirements.

Important entry points:

  • AGENTS.md
  • CodeLibrary
  • architecture.md

Important configuration:

  • User-facing docs belong in this repository.
  • CodeLibrary pages should not contain tables unless explicitly requested by repository instructions.
  • Behavior that cannot be proven from code should be marked unclear.

Related documentation:

  • AGENTS.md
  • architecture.md

Estimated complexity: Medium