[exim-dev] [Bug 3018] New: Do write the explanations for † (†) and ‡ (‡) also at a more obvious, easy to memorize, place

[Exim Bugzilla via Exim-dev]

https://bugs.exim.org/show_bug.cgi?id=3018

            Bug ID: 3018
           Summary: Do write the explanations for † (†) and ‡
                    (‡) also at a more obvious, easy to memorize,
                    place
           Product: Exim
           Version: 4.96+
          Hardware: All
                OS: All
            Status: NEW
          Severity: wishlist
          Priority: medium
         Component: Documentation
          Assignee: unalloca...@exim.org
          Reporter: u...@net9.cf
                CC: exim-dev@lists.exim.org

Whenever I see the symbol † (†) in the documentation, I keep looking for
where it is explained what it stands for. Eventually landing at the beginning
of
https://exim.org/exim-html-current/doc/html/spec_html/ch-main_configuration.html#SECTalomo
:

    Those options that undergo string expansion before use are marked with †.

Or at the beginning of
https://exim.org/exim-html-current/doc/html/spec_html/ch-string_expansions.html
:

    in this documentation, options for which string expansion is performed are
marked with † after the data type.

I have a similar issue with the symbol ‡ (‡). Which is explained at the
beginning of
https://exim.org/exim-html-current/doc/html/spec_html/ch-generic_options_for_routers.html
:

    Those that are preconditions are marked with ‡ in the “use” field.

I think the explanations for both symbols should also be in a more obvious,
hopefully more easy to memorize, place. Perhaps as part of the "Options index"
index, before the letter A. .makeindex "Options index" is found at the bottom
of doc/doc-docbook/spec.xfpt.

--- Comment #1 from u34 <u...@net9.cf> ---
Would the following patch achieve a reference to the &dagger; and the &Dagger;
symbols at one of Concept Index or Option Index? Should the &dagger; and the
&Dagger; symbols mentioned in one of those indices? If they should appear in
one of these indices, but the following patch doesn't achieve that, how can it
be achieved?

index 554b692a6..5096437bb 100644
--- a/doc/doc-docbook/spec.xfpt
+++ b/doc/doc-docbook/spec.xfpt
@@ -15307,6 +15307,7 @@ See also the &'Policy controls'& section above.


 .section "Alphabetical list of main options" "SECTalomo"
+.cindex "&dagger; options that undergo string expansion before use"
 Those options that undergo string expansion before use are marked with
 &dagger;.

@@ -19225,6 +19226,7 @@ See chapter &<<CHAPlog>>& for details of what Exim
writes to its logs.
 .chapter "Generic options for routers" "CHAProutergeneric"
 .scindex IIDgenoprou1 "options" "generic; for routers"
 .scindex IIDgenoprou2 "generic options" "router"
+.cindex "&Dagger; routers preconditions"
 This chapter describes the generic options that apply to all routers.
 Those that are preconditions are marked with &Dagger; in the &"use"& field.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

-- 
## subscription configuration (requires account):
##   https://lists.exim.org/mailman3/postorius/lists/exim-dev.lists.exim.org/
## unsubscribe (doesn't require an account):
##   exim-dev-unsubscr...@lists.exim.org
## Exim details at http://www.exim.org/
## Please use the Wiki with this list - http://wiki.exim.org/