From 2cc730a358da2e7b059aad3cbc266ab4b7d2f4b4 Mon Sep 17 00:00:00 2001 From: Henning Thielemann Date: Fri, 13 Sep 2024 18:54:53 +0200 Subject: [PATCH] doc: Commands/Balance.md: document hyperlinks and --base-url --- hledger/Hledger/Cli/Commands/Balance.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/hledger/Hledger/Cli/Commands/Balance.md b/hledger/Hledger/Cli/Commands/Balance.md index 147c5414800..509e825db17 100644 --- a/hledger/Hledger/Cli/Commands/Balance.md +++ b/hledger/Hledger/Cli/Commands/Balance.md @@ -385,6 +385,19 @@ $ hledger bal -% cur:\\$ $ hledger bal -% cur:€ ``` +### Hyperlinks + +The HTML and FODS output formats support hyperlinks to `hledger-web`'s +Register pages for every account and period. +E.g. if your `hledger-web` server is reachable +under the URL `http://localhost:5000/` +then you might run the `balance` command +with the extra option `--base-url=http://localhost:5000/`. +The export function will not add any slash +in order to support relative hyperreferences. +Thus it is important that you add the trailing slash to the URL yourselves, +where needed. + ### Multi-period balance report With a [report interval](#report-intervals) (set by the `-D/--daily`,