Skip to content

Better Xojo Help 0.15.0

Choose a tag to compare

@JYPochez JYPochez released this 29 Jul 10:22
· 1 commit to main since this release

v0.15.0 — first public release

Browse every set of Xojo offline documentation installed on your machine, from one window.

The IDE's help only reaches the docs of the version it belongs to, and the pre-2019 sets are in a
SQLite format nothing opens any more. This reads both formats — 30 releases on the machine it was
built on — and lets you switch between them from a popup.

Searching

  • Members are searchable, which the shipped index cannot do. In the modern documentation only a
    deprecated member gets a page of its own, so DesktopListBox.AddRow is a section inside its class
    page and page-level search cannot see it. Better Xojo Help harvests them — 15 502 on 2026r1.2.
  • and / or / exact for multi-word queries. Type list add, leave it on and, and you get
    the DesktopListBox members that match both words wherever they sit in the title or the path.
  • Deprecated results sort last, whatever their score, because a deprecated page repeats the name
    of whatever replaced it and would otherwise rank first. Switchable in Settings.
  • Results are ranked by how often the term actually appears in the page, the count shown per row.
  • Selecting a member scrolls to that member, not to the top of its class page.

Reading

  • Links work on both documentation formats and open in the app.
  • Tabs: Cmd-click a link or a topic to open one behind what you are reading. Cmd+T, Cmd+W.
  • Back and Forward on Cmd+← / Cmd+→.
  • Favourites on Cmd+D, kept per documentation version.
  • A globe that opens the current page on documentation.xojo.com.
  • Code samples carry a Copy button, and keep the syntax colouring the release shipped.

Before you start

Xojo does not install its documentation by default. In Xojo:
Preferences → General → Documentation → Install Local Documentation, once per release you care
about. Without it the app has nothing to read.

2019r2 through 2022r1 shipped no local documentation at all, so those releases never appear.

Notes

  • macOS on Apple Silicon. The download is signed and notarised, so it opens without a Gatekeeper
    warning. Intel and Universal builds are not provided yet; building from source works on either.
  • Works entirely offline. Nothing is downloaded, nothing is written outside the app's own folder, and
    your Xojo installation is only ever read.
  • MIT licensed.