From: nolade <nola.aunger@inkbridge.io>
Date: Mon, 26 May 2025 18:40:31 +0000 (-0400)
Subject: docs: buildfix-howto-reference - updated xref links and nav files to point to correct... 
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=91cef962a41b3a4e40edf4dd45ced1874fdd0c87;p=thirdparty%2Ffreeradius-server.git

docs: buildfix-howto-reference - updated xref links and nav files to point to correct locations.
---

diff --git a/doc/antora/modules/howto/pages/protocols/dhcp/policy_common_options.adoc b/doc/antora/modules/howto/pages/protocols/dhcp/policy_common_options.adoc
index d044076ee8d..6f8076a02a7 100644
--- a/doc/antora/modules/howto/pages/protocols/dhcp/policy_common_options.adoc
+++ b/doc/antora/modules/howto/pages/protocols/dhcp/policy_common_options.adoc
@@ -39,7 +39,7 @@ dhcp_common {
 }
 ----
 
-See the xref:unlang/edit.adoc[edit] documentation for instructions on
+See the xref:reference:unlang/edit.adoc[edit] documentation for instructions on
 creating and editing attributes.
 
 These edit operation allow for attributes to be set to default values and then
diff --git a/doc/antora/modules/howto/pages/protocols/dhcp/policy_device_options.adoc b/doc/antora/modules/howto/pages/protocols/dhcp/policy_device_options.adoc
index 9ddff4c6b6c..80de9a0a4ae 100644
--- a/doc/antora/modules/howto/pages/protocols/dhcp/policy_device_options.adoc
+++ b/doc/antora/modules/howto/pages/protocols/dhcp/policy_device_options.adoc
@@ -44,7 +44,7 @@ subclass "pxeclient" "iPXE" {
 }
 ----
 
-See also the xref:raddb/mods-available/isc_dhcp.adoc[isc_dhcp] module,
+See also the xref:reference:raddb/mods-available/isc_dhcp.adoc[isc_dhcp] module,
 which can read a subset of the ISC DHCP configuration files.
 
 Or the equivalent Kea configuration:
diff --git a/doc/antora/modules/reference/nav.adoc b/doc/antora/modules/reference/nav.adoc
index 9f555d02c85..1aad8e01e76 100644
--- a/doc/antora/modules/reference/nav.adoc
+++ b/doc/antora/modules/reference/nav.adoc
@@ -69,14 +69,12 @@
 *** xref:type/string/unquoted.adoc[Unquoted Strings]
 
 ** xref:xlat/index.adoc[Dynamic Expansion]
-*** xref:xlat/all.adoc[list of Built-in Functions]
+*** xref:xlat/all.adoc[Summary of Built-in Functions]
 *** xref:xlat/alternation.adoc[Alternation Syntax]
 *** xref:xlat/attribute.adoc[Attribute References]
 *** xref:xlat/conversion.adoc[Data Conversion]
 *** xref:xlat/deprecated.adoc[Deprecated Functions]
-
-*** xref:mods-available/dict.adoc[Dictionary Handling]
-
+*** xref:xlat/dict.adoc[Dictionary Handling]
 *** xref:xlat/file/index.adoc[File Handling]
 **** xref:reference:xlat/file/escape.adoc[escape]
 **** xref:xlat/file/exists.adoc[exists]
@@ -100,7 +98,7 @@
 **** xref:xlat/misc/rand.adoc[rand]
 
 *** xref:xlat/pairs/index.adoc[Pairs]
-**** xref:xlat/pairs/debug.adoc[Write to debug output]
+**** xref:xlat/interpreter.adoc#debug_xlat[Write to debug output]
 **** xref:xlat/pairs/immutable.adoc[Mark as immutable]
 **** xref:xlat/pairs/print.adoc[Print to string]
 
@@ -116,7 +114,7 @@
 
 *** xref:xlat/time/index.adoc[Time Management]
 **** xref:xlat/time/character.adoc[Single Character]
-**** xref:xlat/time/generic.adoc[Generic]                 
+**** xref:xlat/time/generic.adoc[Generic]
 **** xref:xlat/time/is_dst.adoc[Daylight Savings]
 **** xref:xlat/time/now.adoc[Now]
 **** xref:xlat/time/offset.adoc[UTC Offset]
diff --git a/doc/antora/modules/reference/pages/raddb/mods-available/dict.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/dict.adoc
index 4813ff8ab0e..6dbbe9a396c 100644
--- a/doc/antora/modules/reference/pages/raddb/mods-available/dict.adoc
+++ b/doc/antora/modules/reference/pages/raddb/mods-available/dict.adoc
@@ -1,7 +1,3 @@
-
-
-
-
 = Dict Module
 
 The `dict` module registers expansions which query the dictionaries.
diff --git a/doc/antora/modules/reference/pages/raddb/mods-available/isc_dhcp.adoc b/doc/antora/modules/reference/pages/raddb/mods-available/isc_dhcp.adoc
index 931be642740..f9896db6d4d 100644
--- a/doc/antora/modules/reference/pages/raddb/mods-available/isc_dhcp.adoc
+++ b/doc/antora/modules/reference/pages/raddb/mods-available/isc_dhcp.adoc
@@ -134,7 +134,7 @@ the module is configured with `pedantic = true`
 | omapi-port UINT16
 | pid-file-name STRING
 | remote-port UINT16
-|==
+|===
 
 
 
diff --git a/doc/antora/modules/reference/pages/xlat/all.adoc b/doc/antora/modules/reference/pages/xlat/all.adoc
index f0c5d155e0a..c8132352389 100644
--- a/doc/antora/modules/reference/pages/xlat/all.adoc
+++ b/doc/antora/modules/reference/pages/xlat/all.adoc
@@ -1,4 +1,4 @@
-= Summary of Dynamic Expansions
+= Summary of Built-in Functions
 
 
 .File Handling Functions
@@ -19,10 +19,10 @@
 [options="headers, autowidth]
 |===
 | *Function*				            | *Description*
-| xref:xlat/misc/config.adoc[Server Configuration]  | Examine configuration items
-| xref:xlat/misc/length.adoc[length]	            | Get the length of data
-| xref:xlat/misc/misc.adoc[Miscellaneous]	    | Functions to execute regular expression search on string, using pattern.
-| xref:xlat/misc/rand.adoc[rand]	            | random integers
+| xref:xlat/misc/config.adoc[Server Configuration]  | Examine configuration items.
+| xref:xlat/misc/length.adoc[length]	            | Get the length of data.
+| xref:xlat/misc/misc.adoc[Miscellaneous]	    | Functions to execute. regular expression search on string, using pattern.
+| xref:xlat/misc/rand.adoc[rand]	            | Generate random integers.
 |===
 
 == Pair Manipulation
@@ -31,9 +31,9 @@
 [options="headers, autowidth]
 |===
 | *Function*					| *Description*
-| xref:xlat/pairs/debug.adoc[debug]  		| Print attributes to the debug output
-| xref:xlat/pairs/immutable.adoc[immutable]     | Mark attributes as immutable (cannot be changed)
-| xref:xlat/pairs/print.adoc[print]		| Print attribute name and value to string
+| xref:xlat/interpreter.adoc#debug_xlat[debug]  | Print attributes to the debug output.
+| xref:xlat/pairs/immutable.adoc[immutable]     | Mark attributes as immutable (cannot be changed).
+| xref:xlat/pairs/print.adoc[print]		| Print attribute name and value to string.
 |===
 
 == String Manipulation
@@ -42,14 +42,14 @@
 [options="header, autowidth"]
 |===
 | *Function*                                        | *Description*
-| xref:xlat/str/concat.adoc[concat]                 | Concatenate strings with delimiters
-| xref:xlat/str/split.adoc[split]                   | Split a string based on delimiters
-| xref:xlat/misc/misc.adoc#length[length]           | Returns the size of the data
-| xref:xlat/str/lpad.adoc[lpad]                     | Left pad a string
-| xref:xlat/str/rpad.adoc[rpad]                     | Right pad a string
-| xref:xlat/str/rand.adoc[rand]                     | Return a random string based on input format
-| xref:xlat/str/lower.adoc[lower]                   | Convert the input string to lowercase.
-| xref:xlat/str/upper.adoc[upper]                   | Convert the input string to uppercase
+| xref:xlat/str/concat.adoc[concat]                 | Concatenate strings with delimiters.
+| xref:xlat/str/split.adoc[split]                   | Split a string based on delimiters.
+| xref:xlat/misc/misc.adoc#length[length]           | Returns the size of the data.
+| xref:xlat/str/lpad.adoc[lpad]                     | Left pad a string.
+| xref:xlat/str/rpad.adoc[rpad]                     | Right pad a string.
+| xref:xlat/str/rand.adoc[rand]                     | Return a random string .based on input format
+| xref:xlat/str/lower.adoc[lower]                   | Convert the input string. to lowercase.
+| xref:xlat/str/upper.adoc[upper]                   | Convert the input string. to uppercase
 |===
 
 == Time Management
@@ -59,10 +59,10 @@
 [cols="30%,70%"]
 |=====
 | Function | Description
-| xref:xlat/time/character.adoc[character]          | Single character expansions
-| xref:xlat/time/generic.adoc[time]                 | Generic (too complex) time function
-| xref:xlat/time/is_dst.adoc[is_dst]                | Is the system running in DST?
-| xref:xlat/time/now.adoc[now]                      | Return the current time
-| xref:xlat/time/offset.adoc[offset]                | Return UTC offset
+| xref:xlat/time/character.adoc[character]          | Single character. expansions
+| xref:xlat/time/generic.adoc[time]                 | Generic (too complex). time function
+| xref:xlat/time/is_dst.adoc[is_dst]                | Is the system running in DST?.
+| xref:xlat/time/now.adoc[now]                      | Return the current time.
+| xref:xlat/time/offset.adoc[offset]                | Return UTC offset.
 | xref:xlat/time/request.adoc[request]              | Return the time when the request was received.
 |=====
diff --git a/doc/antora/modules/reference/pages/xlat/dict.adoc b/doc/antora/modules/reference/pages/xlat/dict.adoc
index 6d01d6e42a4..67c96a092eb 100644
--- a/doc/antora/modules/reference/pages/xlat/dict.adoc
+++ b/doc/antora/modules/reference/pages/xlat/dict.adoc
@@ -2,7 +2,7 @@
 
 The following functions perform lookups based on dictionary names and numbers.
 
-The functions are defined in the `dict` module.  It must be listed in
+The functions are defined in the xref:raddb/mods-available/dict.adoc[`dict` module].  It must be listed in
 the `mods-enabled/` directory in order for the expansions to work.
 
 == %str.concat(<ref:[idx]>, <delim>)
diff --git a/doc/antora/modules/reference/pages/xlat/hmac.adoc b/doc/antora/modules/reference/pages/xlat/hmac.adoc
index ae0f22caedf..36bca26809e 100644
--- a/doc/antora/modules/reference/pages/xlat/hmac.adoc
+++ b/doc/antora/modules/reference/pages/xlat/hmac.adoc
@@ -4,7 +4,7 @@ The following functions perform HMAC calculations.
 
 All of the hash functions take a key, along with arbitrary data, and turn binary data as `octet`s.
 
-= %hmac.md5(<shared_key>, <string>)
+== %hmac.md5(<shared_key>, <string>)
 
 Generate `HMAC-MD5` of string.
 
diff --git a/doc/antora/modules/reference/pages/xlat/index.adoc b/doc/antora/modules/reference/pages/xlat/index.adoc
index c740f00e6ae..e02d6898b21 100644
--- a/doc/antora/modules/reference/pages/xlat/index.adoc
+++ b/doc/antora/modules/reference/pages/xlat/index.adoc
@@ -22,11 +22,11 @@ references, function calls, etc.  The table below gives more examples of expansi
 | Keyword                                 | Description
 | xref:xlat/attribute.adoc[attributes]    | Expand the value of a named attribute.
 | xref:xlat/function.adoc[functions]      | Function call syntax.
-| xref:xlat/misc.adoc[misc]               | Miscellaneous functions
-| xref:xlat/str.adoc[str]                 | String mandling
-| xref:xlat/time.adoc[time]               | Time handling
+| xref:xlat/misc/misc.adoc[misc]          | Miscellaneous functions.
+| xref:xlat/str/index.adoc[str]           | String handling.
+| xref:xlat/time/index.adoc[time]         | Time handling.
 | xref:xlat/alternation.adoc[condition]   | Conditionally expand a string.
-| xref:xlat/all.adoc[all]                 | List of all functions
+| xref:xlat/all.adoc[all]                 | List of all functions.
 |=====
 
 Expansions are used inside of
diff --git a/doc/antora/modules/reference/pages/xlat/interpreter.adoc b/doc/antora/modules/reference/pages/xlat/interpreter.adoc
index 5587fa73b6f..34e9fe79df7 100644
--- a/doc/antora/modules/reference/pages/xlat/interpreter.adoc
+++ b/doc/antora/modules/reference/pages/xlat/interpreter.adoc
@@ -2,11 +2,12 @@
 
 The following functions allow inspection and/or manipulation of the `unlang` interpreter as it is running.
 
+<<debug_xlat>>
 == Debug Functions
 
 The following functions allow changing the debug level, or printing out specific lists of attributes.
 
-=== %debug(<level>)
+== %debug(<level>)
 
 Dynamically change the debug level to something high, recording the old level.
 
@@ -42,7 +43,7 @@ recv Access-Request {
 ...
 ```
 
-=== %debug_attr(<list:[index]>)
+=== `%debug_attr(<list:[index]>)`
 
 Print to debug output all instances of current attribute, or all attributes in a list.
 expands to a zero-length string.
diff --git a/doc/antora/modules/reference/pages/xlat/pairs/index.adoc b/doc/antora/modules/reference/pages/xlat/pairs/index.adoc
index 959c4ae54a3..a27e2264320 100644
--- a/doc/antora/modules/reference/pages/xlat/pairs/index.adoc
+++ b/doc/antora/modules/reference/pages/xlat/pairs/index.adoc
@@ -6,9 +6,9 @@ These functions manipulate attribute-value pairs.
 [options="headers, autowidth]
 |===
 | *Function*					| *Description*
-| xref:xlat/pairs/debug.adoc[debug]  		| Print attributes to the debug output
-| xref:xlat/pairs/immutable.adoc[immutable]     | Mark attributes as immutable (cannot be changed)
-| xref:xlat/pairs/print.adoc[print]		| Print attribute name and value to string
+| xref:xlat/interpreter.adoc#debug_xlat[debug]  | Print attributes to the debug output.
+| xref:xlat/pairs/immutable.adoc[immutable]     | Mark attributes as immutable (cannot be changed).
+| xref:xlat/pairs/print.adoc[print]		| Print attribute name and value to string.
 |===
 
 // Copyright (C) 2025 Network RADIUS SAS.  Licenced under CC-by-NC 4.0.
diff --git a/doc/antora/modules/reference/pages/xlat/time/generic.adoc b/doc/antora/modules/reference/pages/xlat/time/generic.adoc
index 196c8440181..42d765db11c 100644
--- a/doc/antora/modules/reference/pages/xlat/time/generic.adoc
+++ b/doc/antora/modules/reference/pages/xlat/time/generic.adoc
@@ -41,7 +41,7 @@ server cannot support them all.
 
 [NOTE]
 ====
-This expansion should be used in preference to the xref:xlat/character.adoc[single letter expansions] `%l`.  That expansion returns integer seconds, and is not suitable for millisecond or microsecond resolution.
+This expansion should be used in preference to the xref:xlat/time/character.adoc[single letter expansions] `%l`.  That expansion returns integer seconds, and is not suitable for millisecond or microsecond resolution.
 ====
 
 Due to limitations in the underlying time functions (both system and
diff --git a/doc/antora/modules/reference/pages/xlat/time/index.adoc b/doc/antora/modules/reference/pages/xlat/time/index.adoc
index bc9c7c63b93..2c1a3c93007 100644
--- a/doc/antora/modules/reference/pages/xlat/time/index.adoc
+++ b/doc/antora/modules/reference/pages/xlat/time/index.adoc
@@ -8,12 +8,12 @@ including daylight savings and UTC offset.
 [cols="30%,70%"]
 |=====
 | Function | Description
-| xref:xlat/time/character.adoc[character] | Single character expansions
-| xref:xlat/time/generic.adoc[time]        | Generic (too complex) time function
+| xref:xlat/time/character.adoc[character] | Single character expansions.
+| xref:xlat/time/generic.adoc[time]        | Generic (too complex) time function.
 | xref:xlat/time/is_dst.adoc[is_dst]       | Is the system running in DST?
-| xref:xlat/time/now.adoc[now]             | Return the current time
-| xref:xlat/time/offset.adoc[offset]       | Return UTC offset
-| xref:xlat/time/request.adoc[request]     | Return the time when the request was received.
+| xref:xlat/time/now.adoc[now]             | Return the current time.
+| xref:xlat/time/offset.adoc[offset]       | Return UTC offset.
+| xref:xlat/time/request.adoc[request]     | Return the time when the request. was received.
 |=====
 
 // Copyright (C) 2025 Network RADIUS SAS.  Licenced under CC-by-NC 4.0.