From: nolade <nola.aunger@inkbridge.io>
Date: Fri, 9 May 2025 18:16:43 +0000 (-0400)
Subject: docs: added  xlat summary file
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c4a04a7e1b3e39b4be81d7625a249c6d331cef85;p=thirdparty%2Ffreeradius-server.git

docs: added  xlat summary file
---

diff --git a/doc/antora/modules/reference/nav.adoc b/doc/antora/modules/reference/nav.adoc
index 228ecc51fbd..ce9ef6a42d9 100644
--- a/doc/antora/modules/reference/nav.adoc
+++ b/doc/antora/modules/reference/nav.adoc
@@ -69,6 +69,7 @@
 *** xref:type/string/unquoted.adoc[Unquoted Strings]
 
 ** xref:xlat/index.adoc[Dynamic Expansion]
+*** xref:xlat/all.adoc[list of Built-in Functions]
 *** xref:xlat/alternation.adoc[Alternation Syntax]
 *** xref:xlat/conversion.adoc[Data Conversion]
 *** xref:xlat/deprecated.adoc[Deprecated Functions]
diff --git a/doc/antora/modules/reference/pages/xlat/all.adoc b/doc/antora/modules/reference/pages/xlat/all.adoc
new file mode 100644
index 00000000000..01c62474a67
--- /dev/null
+++ b/doc/antora/modules/reference/pages/xlat/all.adoc
@@ -0,0 +1,45 @@
+= Summary of Dynamic Expansions
+
+
+
+== Miscellaneous Functions
+
+.Miscellaneous Functions
+[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/pairs.adoc[pairs.print]	    | print attributes with name and value.
+| xref:xlat/misc/rand.adoc[rand]	            | random integers|
+===
+
+
+.File Handling Functions
+[options="headers, autowidth]
+|===
+| *Function*				                        | *Description*
+| xref:reference:xlat/file/escape.adoc[escape]		        | Returns an escaped or safe version of the input string.
+| xref:xlat/file/exists.adoc[exists]		                | Checks to see if a file exists on the filesystem.
+| xref:xlat/file/head.adoc[head]		                | Returns the first line of the file.
+| xref:xlat/file/rm.adoc[rm]			                | Removes a file from the filesystem.
+| xref:xlat/file/size.adoc[remove]		                | Returns the size of a file.
+| xref:xlat/file/tail.adoc[tail]		                | Return the last line of a file or the last number(n) of lines of a file.
+|===
+
+== String Manipulation
+
+.String manipulation
+[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
+|=====
diff --git a/doc/antora/modules/reference/pages/xlat/file/index.adoc b/doc/antora/modules/reference/pages/xlat/file/index.adoc
index ebb5ab6619a..3c8def99715 100644
--- a/doc/antora/modules/reference/pages/xlat/file/index.adoc
+++ b/doc/antora/modules/reference/pages/xlat/file/index.adoc
@@ -14,7 +14,7 @@ For example, the "unsafe" string `user@freeradius.org/..` will turn into the fil
 | xref:xlat/file/exists.adoc[exists]		        | Checks to see if a file exists on the filesystem.
 | xref:xlat/file/head.adoc[head]	                | Returns the first line of the file.
 | xref:xlat/file/rm.adoc[rm]	                	| Removes a file from the filesystem.
-| xref:xlat/file/size.adoc[size]		        | Calculates the size of a file.
+| xref:xlat/file/size.adoc[size]		        | Returns the size of a file.
 | xref:xlat/file/tail.adoc[tail]		        | Return the last line of a file or the last number(n) of lines of a file.
 |===
 
diff --git a/doc/antora/modules/reference/pages/xlat/file/size.adoc b/doc/antora/modules/reference/pages/xlat/file/size.adoc
index 9aaddbe7ae8..9b4e22e80ac 100644
--- a/doc/antora/modules/reference/pages/xlat/file/size.adoc
+++ b/doc/antora/modules/reference/pages/xlat/file/size.adoc
@@ -1,6 +1,6 @@
 = Size
 
-The `size` function is used to calculate the size of a file on the filesystem.
+The `size` function returns the size (in bytes) of the given file.
 
 [#syntax]
 == Syntax