rearrange as per new outline

diff --git a/doc/antora/antora.yml b/doc/antora/antora.yml
index c3a8cd9e018167d4c6943438758387ffef6b6457..7a1e44168aed10a6a33ce598cc44344cc2a930e1 100644 (file)
--- a/doc/antora/antora.yml
+++ b/doc/antora/antora.yml
@@ -13,6 +13,6 @@ nav:
 - modules/concepts/nav.adoc
 - modules/howto/nav.adoc
 - modules/tutorials/nav.adoc
-- modules/unlang/nav.adoc
+- modules/reference/nav.adoc
 - modules/developers/nav.adoc
 - modules/raddb/nav.adoc

diff --git a/doc/antora/modules/reference/nav.adoc b/doc/antora/modules/reference/nav.adoc
new file mode 100644 (file)
index 0000000..af88d64
--- /dev/null
+++ b/doc/antora/modules/reference/nav.adoc
@@ -0,0 +1,60 @@
+* xref:index.adoc[Reference Documentation]
+
+** xref:unlang/index.adoc[Unlang Policy Language]
+
+*** xref:unlang/list.adoc[Attribute Lists]
+*** xref:unlang/attr.adoc[Attribute References]
+*** xref:unlang/return_codes.adoc[Return Codes]
+
+*** xref:unlang/keywords.adoc[Keywords]
+**** xref:unlang/break.adoc[break]
+**** xref:unlang/call.adoc[call]
+**** xref:unlang/caller.adoc[caller]
+**** xref:unlang/case.adoc[case]
+**** xref:unlang/detach.adoc[detach]
+**** xref:unlang/else.adoc[else]
+**** xref:unlang/elsif.adoc[elsif]
+**** xref:unlang/filter.adoc[filter]
+**** xref:unlang/foreach.adoc[foreach]
+**** xref:unlang/group.adoc[group]
+**** xref:unlang/if.adoc[if]
+**** xref:unlang/load-balance.adoc[load-balance]
+**** xref:unlang/map.adoc[map]
+**** xref:unlang/parallel.adoc[parallel]
+**** xref:unlang/redundant-load-balance.adoc[redundant-load-balance]
+**** xref:unlang/redundant.adoc[redundant]
+**** xref:unlang/return.adoc[return]
+**** xref:unlang/subrequest.adoc[subrequest]
+**** xref:unlang/switch.adoc[switch]
+**** xref:unlang/update.adoc[update]
+
+*** xref:unlang/module.adoc[Modules]
+**** xref:unlang/module_method.adoc[Module Methods]
+**** xref:unlang/module_builtin.adoc[Built-in Modules]
+
+*** xref:unlang/condition/index.adoc[Conditional Expressions]
+**** xref:unlang/condition/cmp.adoc[Comparisons]
+**** xref:unlang/condition/operands.adoc[Operands]
+**** xref:unlang/condition/return_code.adoc[The Return Code Operator]
+**** xref:unlang/condition/eq.adoc[The '==' Operator]
+**** xref:unlang/condition/and.adoc[The '&&' Operator]
+**** xref:unlang/condition/or.adoc[The '||' Operator]
+**** xref:unlang/condition/not.adoc[The '!' Operator]
+**** xref:unlang/condition/para.adoc[The '( )' Operator]
+**** xref:unlang/condition/regex.adoc[Regular Expressions]
+
+** xref:type/index.adoc[Data Types]
+*** xref:type/index.adoc[List of Data Types]
+*** xref:type/ip.adoc[IP Addresses]
+*** xref:type/numb.adoc[Numbers]
+*** xref:type/string/single.adoc[Single Quoted Strings]
+*** xref:type/string/double.adoc[Double Quoted Strings]
+*** xref:type/string/backticks.adoc[Backtick-quoted string]
+*** xref:type/string/unquoted.adoc[Unquoted Strings]
+
+** xref:xlat/index.adoc[String Expansion]
+*** xref:xlat/alternation.adoc[Alternation Syntax]
+*** xref:xlat/builtin.adoc[Built-in Expansions]
+*** xref:xlat/character.adoc[Single Letter Expansions]
+*** xref:xlat/attribute.adoc[Attribute References]
+*** xref:xlat/module.adoc[Module References]

diff --git a/doc/antora/modules/reference/pages/index.adoc b/doc/antora/modules/reference/pages/index.adoc
new file mode 100644 (file)
index 0000000..34aee7b
--- /dev/null
+++ b/doc/antora/modules/reference/pages/index.adoc
@@ -0,0 +1,7 @@
+= Reference Documentation
+
+We have a lot of stuff
+
+* xref:type/index.adoc[Data Types] in the server
+* xref:unlang/index.adoc[Unlang] syntax
+* xref:xlat/index.adoc[String expansions] i.e. "xlat"s.

diff --git a/doc/antora/modules/unlang/pages/type/all_types.adoc b/doc/antora/modules/reference/pages/type/all_types.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/type/all_types.adoc
rename to doc/antora/modules/reference/pages/type/all_types.adoc

diff --git a/doc/antora/modules/unlang/pages/type/double.adoc b/doc/antora/modules/reference/pages/type/double.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/type/double.adoc
rename to doc/antora/modules/reference/pages/type/double.adoc

diff --git a/doc/antora/modules/unlang/pages/type/index.adoc b/doc/antora/modules/reference/pages/type/index.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/type/index.adoc
rename to doc/antora/modules/reference/pages/type/index.adoc

diff --git a/doc/antora/modules/unlang/pages/type/ip.adoc b/doc/antora/modules/reference/pages/type/ip.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/type/ip.adoc
rename to doc/antora/modules/reference/pages/type/ip.adoc

diff --git a/doc/antora/modules/unlang/pages/type/numb.adoc b/doc/antora/modules/reference/pages/type/numb.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/type/numb.adoc
rename to doc/antora/modules/reference/pages/type/numb.adoc

diff --git a/doc/antora/modules/unlang/pages/type/string/backticks.adoc b/doc/antora/modules/reference/pages/type/string/backticks.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/type/string/backticks.adoc
rename to doc/antora/modules/reference/pages/type/string/backticks.adoc

diff --git a/doc/antora/modules/unlang/pages/type/string/double.adoc b/doc/antora/modules/reference/pages/type/string/double.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/type/string/double.adoc
rename to doc/antora/modules/reference/pages/type/string/double.adoc

diff --git a/doc/antora/modules/unlang/pages/type/string/escaping.adoc b/doc/antora/modules/reference/pages/type/string/escaping.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/type/string/escaping.adoc
rename to doc/antora/modules/reference/pages/type/string/escaping.adoc

diff --git a/doc/antora/modules/unlang/pages/type/string/single.adoc b/doc/antora/modules/reference/pages/type/string/single.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/type/string/single.adoc
rename to doc/antora/modules/reference/pages/type/string/single.adoc

diff --git a/doc/antora/modules/unlang/pages/type/string/unquoted.adoc b/doc/antora/modules/reference/pages/type/string/unquoted.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/type/string/unquoted.adoc
rename to doc/antora/modules/reference/pages/type/string/unquoted.adoc

diff --git a/doc/antora/modules/unlang/pages/attr.adoc b/doc/antora/modules/reference/pages/unlang/attr.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/attr.adoc
rename to doc/antora/modules/reference/pages/unlang/attr.adoc

diff --git a/doc/antora/modules/unlang/pages/break.adoc b/doc/antora/modules/reference/pages/unlang/break.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/break.adoc
rename to doc/antora/modules/reference/pages/unlang/break.adoc

diff --git a/doc/antora/modules/unlang/pages/call.adoc b/doc/antora/modules/reference/pages/unlang/call.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/call.adoc
rename to doc/antora/modules/reference/pages/unlang/call.adoc

diff --git a/doc/antora/modules/unlang/pages/caller.adoc b/doc/antora/modules/reference/pages/unlang/caller.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/caller.adoc
rename to doc/antora/modules/reference/pages/unlang/caller.adoc

diff --git a/doc/antora/modules/unlang/pages/case.adoc b/doc/antora/modules/reference/pages/unlang/case.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/case.adoc
rename to doc/antora/modules/reference/pages/unlang/case.adoc

diff --git a/doc/antora/modules/unlang/pages/condition/and.adoc b/doc/antora/modules/reference/pages/unlang/condition/and.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/condition/and.adoc
rename to doc/antora/modules/reference/pages/unlang/condition/and.adoc

diff --git a/doc/antora/modules/unlang/pages/condition/cmp.adoc b/doc/antora/modules/reference/pages/unlang/condition/cmp.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/condition/cmp.adoc
rename to doc/antora/modules/reference/pages/unlang/condition/cmp.adoc

diff --git a/doc/antora/modules/unlang/pages/condition/eq.adoc b/doc/antora/modules/reference/pages/unlang/condition/eq.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/condition/eq.adoc
rename to doc/antora/modules/reference/pages/unlang/condition/eq.adoc

diff --git a/doc/antora/modules/unlang/pages/condition/index.adoc b/doc/antora/modules/reference/pages/unlang/condition/index.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/condition/index.adoc
rename to doc/antora/modules/reference/pages/unlang/condition/index.adoc

diff --git a/doc/antora/modules/unlang/pages/condition/not.adoc b/doc/antora/modules/reference/pages/unlang/condition/not.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/condition/not.adoc
rename to doc/antora/modules/reference/pages/unlang/condition/not.adoc

diff --git a/doc/antora/modules/unlang/pages/condition/operands.adoc b/doc/antora/modules/reference/pages/unlang/condition/operands.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/condition/operands.adoc
rename to doc/antora/modules/reference/pages/unlang/condition/operands.adoc

diff --git a/doc/antora/modules/unlang/pages/condition/or.adoc b/doc/antora/modules/reference/pages/unlang/condition/or.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/condition/or.adoc
rename to doc/antora/modules/reference/pages/unlang/condition/or.adoc

diff --git a/doc/antora/modules/unlang/pages/condition/para.adoc b/doc/antora/modules/reference/pages/unlang/condition/para.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/condition/para.adoc
rename to doc/antora/modules/reference/pages/unlang/condition/para.adoc

diff --git a/doc/antora/modules/unlang/pages/condition/regex.adoc b/doc/antora/modules/reference/pages/unlang/condition/regex.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/condition/regex.adoc
rename to doc/antora/modules/reference/pages/unlang/condition/regex.adoc

diff --git a/doc/antora/modules/unlang/pages/condition/return_codes.adoc b/doc/antora/modules/reference/pages/unlang/condition/return_codes.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/condition/return_codes.adoc
rename to doc/antora/modules/reference/pages/unlang/condition/return_codes.adoc

diff --git a/doc/antora/modules/unlang/pages/default.adoc b/doc/antora/modules/reference/pages/unlang/default.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/default.adoc
rename to doc/antora/modules/reference/pages/unlang/default.adoc

diff --git a/doc/antora/modules/unlang/pages/detach.adoc b/doc/antora/modules/reference/pages/unlang/detach.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/detach.adoc
rename to doc/antora/modules/reference/pages/unlang/detach.adoc

diff --git a/doc/antora/modules/unlang/pages/else.adoc b/doc/antora/modules/reference/pages/unlang/else.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/else.adoc
rename to doc/antora/modules/reference/pages/unlang/else.adoc

diff --git a/doc/antora/modules/unlang/pages/elsif.adoc b/doc/antora/modules/reference/pages/unlang/elsif.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/elsif.adoc
rename to doc/antora/modules/reference/pages/unlang/elsif.adoc

diff --git a/doc/antora/modules/unlang/pages/filter.adoc b/doc/antora/modules/reference/pages/unlang/filter.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/filter.adoc
rename to doc/antora/modules/reference/pages/unlang/filter.adoc

diff --git a/doc/antora/modules/unlang/pages/foreach.adoc b/doc/antora/modules/reference/pages/unlang/foreach.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/foreach.adoc
rename to doc/antora/modules/reference/pages/unlang/foreach.adoc

diff --git a/doc/antora/modules/unlang/pages/group.adoc b/doc/antora/modules/reference/pages/unlang/group.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/group.adoc
rename to doc/antora/modules/reference/pages/unlang/group.adoc

diff --git a/doc/antora/modules/unlang/pages/if.adoc b/doc/antora/modules/reference/pages/unlang/if.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/if.adoc
rename to doc/antora/modules/reference/pages/unlang/if.adoc

diff --git a/doc/antora/modules/unlang/pages/index.adoc b/doc/antora/modules/reference/pages/unlang/index.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/index.adoc
rename to doc/antora/modules/reference/pages/unlang/index.adoc

diff --git a/doc/antora/modules/unlang/pages/keywords.adoc b/doc/antora/modules/reference/pages/unlang/keywords.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/keywords.adoc
rename to doc/antora/modules/reference/pages/unlang/keywords.adoc

diff --git a/doc/antora/modules/unlang/pages/list.adoc b/doc/antora/modules/reference/pages/unlang/list.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/list.adoc
rename to doc/antora/modules/reference/pages/unlang/list.adoc

diff --git a/doc/antora/modules/unlang/pages/load-balance.adoc b/doc/antora/modules/reference/pages/unlang/load-balance.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/load-balance.adoc
rename to doc/antora/modules/reference/pages/unlang/load-balance.adoc

diff --git a/doc/antora/modules/unlang/pages/map.adoc b/doc/antora/modules/reference/pages/unlang/map.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/map.adoc
rename to doc/antora/modules/reference/pages/unlang/map.adoc

diff --git a/doc/antora/modules/unlang/pages/module.adoc b/doc/antora/modules/reference/pages/unlang/module.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/module.adoc
rename to doc/antora/modules/reference/pages/unlang/module.adoc

diff --git a/doc/antora/modules/unlang/pages/module_builtin.adoc b/doc/antora/modules/reference/pages/unlang/module_builtin.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/module_builtin.adoc
rename to doc/antora/modules/reference/pages/unlang/module_builtin.adoc

diff --git a/doc/antora/modules/unlang/pages/module_method.adoc b/doc/antora/modules/reference/pages/unlang/module_method.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/module_method.adoc
rename to doc/antora/modules/reference/pages/unlang/module_method.adoc

diff --git a/doc/antora/modules/unlang/pages/parallel.adoc b/doc/antora/modules/reference/pages/unlang/parallel.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/parallel.adoc
rename to doc/antora/modules/reference/pages/unlang/parallel.adoc

diff --git a/doc/antora/modules/unlang/pages/redundant-load-balance.adoc b/doc/antora/modules/reference/pages/unlang/redundant-load-balance.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/redundant-load-balance.adoc
rename to doc/antora/modules/reference/pages/unlang/redundant-load-balance.adoc

diff --git a/doc/antora/modules/unlang/pages/redundant.adoc b/doc/antora/modules/reference/pages/unlang/redundant.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/redundant.adoc
rename to doc/antora/modules/reference/pages/unlang/redundant.adoc

diff --git a/doc/antora/modules/unlang/pages/return.adoc b/doc/antora/modules/reference/pages/unlang/return.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/return.adoc
rename to doc/antora/modules/reference/pages/unlang/return.adoc

diff --git a/doc/antora/modules/unlang/pages/return_codes.adoc b/doc/antora/modules/reference/pages/unlang/return_codes.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/return_codes.adoc
rename to doc/antora/modules/reference/pages/unlang/return_codes.adoc

diff --git a/doc/antora/modules/unlang/pages/subrequest.adoc b/doc/antora/modules/reference/pages/unlang/subrequest.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/subrequest.adoc
rename to doc/antora/modules/reference/pages/unlang/subrequest.adoc

diff --git a/doc/antora/modules/unlang/pages/switch.adoc b/doc/antora/modules/reference/pages/unlang/switch.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/switch.adoc
rename to doc/antora/modules/reference/pages/unlang/switch.adoc

diff --git a/doc/antora/modules/unlang/pages/update.adoc b/doc/antora/modules/reference/pages/unlang/update.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/update.adoc
rename to doc/antora/modules/reference/pages/unlang/update.adoc

diff --git a/doc/antora/modules/unlang/pages/xlat/alternation.adoc b/doc/antora/modules/reference/pages/xlat/alternation.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/xlat/alternation.adoc
rename to doc/antora/modules/reference/pages/xlat/alternation.adoc

diff --git a/doc/antora/modules/unlang/pages/xlat/attribute.adoc b/doc/antora/modules/reference/pages/xlat/attribute.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/xlat/attribute.adoc
rename to doc/antora/modules/reference/pages/xlat/attribute.adoc

diff --git a/doc/antora/modules/unlang/pages/xlat/builtin.adoc b/doc/antora/modules/reference/pages/xlat/builtin.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/xlat/builtin.adoc
rename to doc/antora/modules/reference/pages/xlat/builtin.adoc

diff --git a/doc/antora/modules/unlang/pages/xlat/character.adoc b/doc/antora/modules/reference/pages/xlat/character.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/xlat/character.adoc
rename to doc/antora/modules/reference/pages/xlat/character.adoc

diff --git a/doc/antora/modules/unlang/pages/xlat/index.adoc b/doc/antora/modules/reference/pages/xlat/index.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/xlat/index.adoc
rename to doc/antora/modules/reference/pages/xlat/index.adoc

diff --git a/doc/antora/modules/unlang/pages/xlat/module.adoc b/doc/antora/modules/reference/pages/xlat/module.adoc
similarity index 100%
rename from doc/antora/modules/unlang/pages/xlat/module.adoc
rename to doc/antora/modules/reference/pages/xlat/module.adoc

diff --git a/doc/antora/modules/unlang/partials/rcode_table.adoc b/doc/antora/modules/reference/partials/rcode_table.adoc
similarity index 100%
rename from doc/antora/modules/unlang/partials/rcode_table.adoc
rename to doc/antora/modules/reference/partials/rcode_table.adoc

diff --git a/doc/antora/modules/unlang/nav.adoc b/doc/antora/modules/unlang/nav.adoc
deleted file mode 100644 (file)
index 7e1525a..0000000
--- a/doc/antora/modules/unlang/nav.adoc
+++ /dev/null
@@ -1,58 +0,0 @@
-* xref:index.adoc[Unlang Policy Language]
-
-** xref:list.adoc[Attribute Lists]
-** xref:attr.adoc[Attribute References]
-** xref:return_codes.adoc[Return Codes]
-
-** xref:keywords.adoc[Keywords]
-*** xref:break.adoc[break]
-*** xref:call.adoc[call]
-*** xref:caller.adoc[caller]
-*** xref:case.adoc[case]
-*** xref:detach.adoc[detach]
-*** xref:else.adoc[else]
-*** xref:elsif.adoc[elsif]
-*** xref:filter.adoc[filter]
-*** xref:foreach.adoc[foreach]
-*** xref:group.adoc[group]
-*** xref:if.adoc[if]
-*** xref:load-balance.adoc[load-balance]
-*** xref:map.adoc[map]
-*** xref:parallel.adoc[parallel]
-*** xref:redundant-load-balance.adoc[redundant-load-balance]
-*** xref:redundant.adoc[redundant]
-*** xref:return.adoc[return]
-*** xref:subrequest.adoc[subrequest]
-*** xref:switch.adoc[switch]
-*** xref:update.adoc[update]
-
-** xref:module.adoc[Modules]
-*** xref:module_method.adoc[Module Methods]
-*** xref:module_builtin.adoc[Built-in Modules]
-
-** xref:type/index.adoc[Data Types]
-*** xref:type/index.adoc[List of Data Types]
-*** xref:type/ip.adoc[IP Addresses]
-*** xref:type/numb.adoc[Numbers]
-*** xref:type/string/single.adoc[Single Quoted Strings]
-*** xref:type/string/double.adoc[Double Quoted Strings]
-*** xref:type/string/backticks.adoc[Backtick-quoted string]
-*** xref:type/string/unquoted.adoc[Unquoted Strings]
-
-** xref:condition/index.adoc[Conditional Expressions]
-*** xref:condition/cmp.adoc[Comparisons]
-*** xref:condition/operands.adoc[Operands]
-*** xref:condition/return_code.adoc[The Return Code Operator]
-*** xref:condition/eq.adoc[The '==' Operator]
-*** xref:condition/and.adoc[The '&&' Operator]
-*** xref:condition/or.adoc[The '||' Operator]
-*** xref:condition/not.adoc[The '!' Operator]
-*** xref:condition/para.adoc[The '( )' Operator]
-*** xref:condition/regex.adoc[Regular Expressions]
-
-** xref:xlat/index.adoc[String Expansion]
-*** xref:xlat/alternation.adoc[Alternation Syntax]
-*** xref:xlat/builtin.adoc[Built-in Expansions]
-*** xref:xlat/character.adoc[Single Letter Expansions]
-*** xref:xlat/attribute.adoc[Attribute References]
-*** xref:xlat/module.adoc[Module References]