docs: reference table

doc/modules/ROOT/nav.adoc

@@ -14,10 +14,6 @@
 ** xref:grammar/combinators.adoc[]
 ** xref:grammar/range.adoc[]
 ** xref:grammar/rfc3986.adoc[]
-* Concepts
-** xref:concepts/CharSet.adoc[]
-** xref:concepts/Rule.adoc[]
-** xref:concepts/StringToken.adoc[]
 * Examples
 ** xref:examples/qrcode.adoc[]
 ** xref:examples/finicky.adoc[]
@@ -26,5 +22,10 @@
 ** xref:examples/file-router.adoc[]
 ** xref:examples/router.adoc[]
 ** xref:examples/sanitize.adoc[]
-* xref:reference:boost/urls.adoc[Reference]
-* xref:HelpCard.adoc[]
+* Reference
+** xref:reference.adoc[Index]
+** Concepts
+*** xref:concepts/CharSet.adoc[]
+*** xref:concepts/Rule.adoc[]
+*** xref:concepts/StringToken.adoc[]
+** xref:HelpCard.adoc[]

doc/modules/ROOT/pages/reference.adoc

@@ -0,0 +1,303 @@
+//
+// Copyright (c) 2023 Alan de Freitas (alandefreitas@gmail.com)
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
+//
+// Official repository: https://github.com/boostorg/url
+//
+
+
+[#reference]
+= Reference
+
+[width=100%]
+|===
+3+| *URL* | *Encoding* | *Aliases*
+
+| *Types (1/2)*
+
+xref:reference:boost/urls/authority_view.adoc[`authority_view`]
+
+xref:reference:boost/urls/ignore_case_param.adoc[`ignore_case_param`]
+
+xref:reference:boost/urls/ipv4_address.adoc[`ipv4_address`]
+
+xref:reference:boost/urls/ipv6_address.adoc[`ipv6_address`]
+
+xref:reference:boost/urls/no_value_t.adoc[`no_value_t`]
+
+xref:reference:boost/urls/param.adoc[`param`]
+
+xref:reference:boost/urls/param_pct_view.adoc[`param_pct_view`]
+
+xref:reference:boost/urls/param_view.adoc[`param_view`]
+
+xref:reference:boost/urls/params_base.adoc[`params_base`]
+
+xref:reference:boost/urls/params_encoded_base.adoc[`params_encoded_base`]
+
+xref:reference:boost/urls/params_encoded_ref.adoc[`params_encoded_ref`]
+
+xref:reference:boost/urls/params_encoded_view.adoc[`params_encoded_view`]
+
+xref:reference:boost/urls/params_ref.adoc[`params_ref`]
+
+xref:reference:boost/urls/params_view.adoc[`params_view`]
+
+xref:reference:boost/urls/segments_base.adoc[`segments_base`]
+
+xref:reference:boost/urls/segments_view.adoc[`segments_view`]
+
+xref:reference:boost/urls/segments_encoded_base.adoc[`segments_encoded_base`]
+
+| **Types (2/2)**
+
+xref:reference:boost/urls/segments_encoded_ref.adoc[`segments_encoded_ref`]
+
+xref:reference:boost/urls/segments_encoded_view.adoc[`segments_encoded_view`]
+
+xref:reference:boost/urls/segments_ref.adoc[`segments_ref`]
+
+xref:reference:boost/urls/static_url.adoc[`static_url`]
+
+xref:reference:boost/urls/static_url_base.adoc[`static_url_base`]
+
+xref:reference:boost/urls/url.adoc[`url`]
+
+xref:reference:boost/urls/url_base.adoc[`url_base`]
+
+xref:reference:boost/urls/url_view.adoc[`url_view`]
+
+xref:reference:boost/urls/url_view_base.adoc[`url_view_base`]
+
+**Constants**
+
+xref:reference:boost/urls/error.adoc[`error`]
+
+xref:reference:boost/urls/ignore_case.adoc[`ignore_case`]
+
+xref:reference:boost/urls/host_type.adoc[`host_type`]
+
+xref:reference:boost/urls/no_value.adoc[`no_value`]
+
+xref:reference:boost/urls/scheme.adoc[`scheme`]
+
+| **Functions**
+
+xref:reference:boost/urls/operator_lshift.adoc[`operator<<`]
+
+xref:reference:boost/urls/arg.adoc[`arg`]
+
+xref:reference:boost/urls/format.adoc[`format`]
+
+xref:reference:boost/urls/format_to.adoc[`format_to`]
+
+xref:reference:boost/urls/parse_absolute_uri.adoc[`parse_absolute_uri`]
+
+xref:reference:boost/urls/parse_authority.adoc[`parse_authority`]
+
+xref:reference:boost/urls/parse_origin_form.adoc[`parse_origin_form`]
+
+xref:reference:boost/urls/parse_path.adoc[`parse_path`]
+
+xref:reference:boost/urls/parse_query.adoc[`parse_query`]
+
+xref:reference:boost/urls/parse_relative_ref.adoc[`parse_relative_ref`]
+
+xref:reference:boost/urls/parse_uri.adoc[`parse_uri`]
+
+xref:reference:boost/urls/parse_uri_reference.adoc[`parse_uri_reference`]
+
+xref:reference:boost/urls/resolve.adoc[`resolve`]
+
+| **Functions**
+
+xref:reference:boost/urls/encode.adoc[`encode`]
+
+xref:reference:boost/urls/encoded_size.adoc[`encoded_size`]
+
+xref:reference:boost/urls/make_pct_string_view.adoc[`make_pct_string_view`]
+
+**Types**
+
+xref:reference:boost/urls/decode_view.adoc[`decode_view`]
+
+xref:reference:boost/urls/encoding_opts.adoc[`encoding_opts`]
+
+xref:reference:boost/urls/pct_string_view.adoc[`pct_string_view`]
+
+| **Types**
+
+xref:reference:boost/urls/error_types/errc.adoc[`errc`]
+
+xref:reference:boost/urls/error_types/error_category.adoc[`error_category`]
+
+xref:reference:boost/urls/error_types/error_code.adoc[`error_code`]
+
+xref:reference:boost/urls/error_types/error_condition.adoc[`error_condition`]
+
+xref:reference:boost/urls/error_types/generic_category.adoc[`generic_category`]
+
+xref:reference:boost/urls/optional.adoc[`optional`]
+
+xref:reference:boost/urls/error_types/result.adoc[`result`]
+
+xref:reference:boost/urls/string_view.adoc[`string_view`]
+
+xref:reference:boost/urls/error_types/system_category.adoc[`system_category`]
+
+xref:reference:boost/urls/error_types/system_error.adoc[`system_error`]
+
+|===
+
+[width=100%]
+|===
+4+| *RFC3986* | *Grammar*
+
+| **Grammar**
+
+xref:reference:boost/urls/absolute_uri_rule.adoc[`absolute_uri_rule`]
+
+xref:reference:boost/urls/authority_rule.adoc[`authority_rule`]
+
+xref:reference:boost/urls/gen_delim_chars.adoc[`gen_delim_chars`]
+
+xref:reference:boost/urls/ipv4_address_rule.adoc[`ipv4_address_rule`]
+
+xref:reference:boost/urls/ipv6_address_rule.adoc[`ipv6_address_rule`]
+
+xref:reference:boost/urls/pchars.adoc[`pchars`]
+
+xref:reference:boost/urls/pct_encoded_rule.adoc[`pct_encoded_rule`]
+
+xref:reference:boost/urls/query_rule.adoc[`query_rule`]
+
+xref:reference:boost/urls/relative_ref_rule.adoc[`relative_ref_rule`]
+
+xref:reference:boost/urls/reserved_chars.adoc[`reserved_chars`]
+
+xref:reference:boost/urls/sub_delim_chars.adoc[`sub_delim_chars`]
+
+xref:reference:boost/urls/unreserved_chars.adoc[`unreserved_chars`]
+
+xref:reference:boost/urls/uri_reference_rule.adoc[`uri_reference_rule`]
+
+xref:reference:boost/urls/uri_rule.adoc[`uri_rule`]
+
+| **Functions (1/2)**
+
+xref:reference:boost/urls/grammar/ci_compare.adoc[`ci_compare`]
+
+xref:reference:boost/urls/grammar/ci_digest.adoc[`ci_digest`]
+
+xref:reference:boost/urls/grammar/ci_is_equal.adoc[`ci_is_equal`]
+
+xref:reference:boost/urls/grammar/ci_is_less.adoc[`ci_is_less`]
+
+xref:reference:boost/urls/grammar/delim_rule.adoc[`delim_rule`]
+
+xref:reference:boost/urls/grammar/find_if.adoc[`find_if`]
+
+xref:reference:boost/urls/grammar/find_if_not.adoc[`find_if_not`]
+
+xref:reference:boost/urls/grammar/hexdig_value.adoc[`hexdig_value`]
+
+xref:reference:boost/urls/grammar/not_empty_rule.adoc[`not_empty_rule`]
+
+xref:reference:boost/urls/grammar/optional_rule.adoc[`optional_rule`]
+
+xref:reference:boost/urls/grammar/parse.adoc[`parse`]
+
+xref:reference:boost/urls/grammar/range_rule.adoc[`range_rule`]
+
+xref:reference:boost/urls/grammar/ref.adoc[`ref`]
+
+| **Functions (2/2)**
+
+xref:reference:boost/urls/grammar/squelch.adoc[`squelch`]
+
+xref:reference:boost/urls/grammar/to_lower.adoc[`to_lower`]
+
+xref:reference:boost/urls/grammar/to_upper.adoc[`to_upper`]
+
+xref:reference:boost/urls/grammar/token_rule.adoc[`token_rule`]
+
+xref:reference:boost/urls/grammar/tuple_rule.adoc[`tuple_rule`]
+
+xref:reference:boost/urls/grammar/variant_rule.adoc[`variant_rule`]
+
+**Type Traits**
+
+xref:reference:boost/urls/grammar/is_charset-0c.adoc[`is_charset`]
+
+xref:reference:boost/urls/grammar/is_rule-0a.adoc[`is_rule`]
+
+| **Types**
+
+xref:reference:boost/urls/grammar/aligned_storage.adoc[`aligned_storage`]
+
+xref:reference:boost/urls/grammar/ci_hash.adoc[`ci_hash`]
+
+xref:reference:boost/urls/grammar/ci_equal.adoc[`ci_equal`]
+
+xref:reference:boost/urls/grammar/ci_less.adoc[`ci_less`]
+
+xref:reference:boost/urls/grammar/lut_chars.adoc[`lut_chars`]
+
+xref:reference:boost/urls/grammar/range.adoc[`range`]
+
+xref:reference:boost/urls/grammar/recycled.adoc[`recycled`]
+
+xref:reference:boost/urls/grammar/recycled_ptr.adoc[`recycled_ptr`]
+
+xref:reference:boost/urls/grammar/string_view_base.adoc[`string_view_base`]
+
+xref:reference:boost/urls/grammar/unsigned_rule.adoc[`unsigned_rule`]
+
+**StringToken**
+
+xref:reference:boost/urls/string_token/append_to.adoc[`append_to`]
+
+xref:reference:boost/urls/string_token/arg.adoc[`arg`]
+
+xref:reference:boost/urls/string_token/assign_to.adoc[`assign_to`]
+
+xref:reference:boost/urls/string_token/is_token-0a.adoc[`is_token`]
+
+xref:reference:boost/urls/string_token/preserve_size.adoc[`preserve_size`]
+
+xref:reference:boost/urls/string_token/return_string.adoc[`return_string`]
+
+| **Constants**
+
+xref:reference:boost/urls/grammar/all_chars.adoc[`all_chars`]
+
+xref:reference:boost/urls/grammar/alnum_chars.adoc[`alnum_chars`]
+
+xref:reference:boost/urls/grammar/alpha_chars.adoc[`alpha_chars`]
+
+xref:reference:boost/urls/grammar/condition.adoc[`condition`]
+
+xref:reference:boost/urls/grammar/dec_octet_rule.adoc[`dec_octet_rule`]
+
+xref:reference:boost/urls/grammar/digit_chars.adoc[`digit_chars`]
+
+xref:reference:boost/urls/grammar/error.adoc[`error`]
+
+xref:reference:boost/urls/grammar/hexdig_chars.adoc[`hexdig_chars`]
+
+xref:reference:boost/urls/grammar/not_empty_rule.adoc[`not_empty_rule`]
+
+xref:reference:boost/urls/grammar/vchars.adoc[`vchars`]
+
+**Concepts**
+
+xref:concepts/CharSet.adoc[`CharSet`]
+
+xref:concepts/Rule.adoc[`Rule`]
+
+xref:concepts/StringToken.adoc[`StringToken`]
+
+|===
+