[latex3-commits] [git/LaTeX3-latex3-latex3] master: New \g_msg_module_documentation_prop variable (fixes #471) (49e7e13)
Joseph Wright
joseph.wright at morningstar2.co.uk
Sun Sep 30 22:09:07 CEST 2018
Repository : https://github.com/latex3/latex3
On branch : master
Link : https://github.com/latex3/latex3/commit/49e7e136cd88fe197cd92ffedb28d844a94dc8e1
>---------------------------------------------------------------
commit 49e7e136cd88fe197cd92ffedb28d844a94dc8e1
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date: Sun Sep 30 21:09:07 2018 +0100
New \g_msg_module_documentation_prop variable (fixes #471)
>---------------------------------------------------------------
49e7e136cd88fe197cd92ffedb28d844a94dc8e1
l3kernel/CHANGELOG.md | 4 ++++
l3kernel/l3msg.dtx | 27 +++++++++++++++++++++------
l3kernel/testfiles/m3expl001.luatex.tlg | 1 +
l3kernel/testfiles/m3expl001.ptex.tlg | 1 +
l3kernel/testfiles/m3expl001.tlg | 1 +
l3kernel/testfiles/m3expl001.uptex.tlg | 1 +
l3kernel/testfiles/m3expl001.xetex.tlg | 1 +
l3kernel/testfiles/m3expl003.luatex.tlg | 1 +
l3kernel/testfiles/m3expl003.ptex.tlg | 1 +
l3kernel/testfiles/m3expl003.tlg | 1 +
l3kernel/testfiles/m3expl003.uptex.tlg | 1 +
l3kernel/testfiles/m3expl003.xetex.tlg | 1 +
12 files changed, 35 insertions(+), 6 deletions(-)
diff --git a/l3kernel/CHANGELOG.md b/l3kernel/CHANGELOG.md
index 8dfb9b7..2b67419 100644
--- a/l3kernel/CHANGELOG.md
+++ b/l3kernel/CHANGELOG.md
@@ -7,6 +7,10 @@ this project uses date-based 'snapshot' version identifiers.
## [Unreleased]
+### Added
+
+- `\g_msg_module_documentation_prop` (see #471)
+
### Fixed
- Handling of inheritance for choice keys (fixes #483)
diff --git a/l3kernel/l3msg.dtx b/l3kernel/l3msg.dtx
index f4351fb..3eb7c4b 100644
--- a/l3kernel/l3msg.dtx
+++ b/l3kernel/l3msg.dtx
@@ -211,7 +211,7 @@
% be included.
% \end{function}
%
-% \begin{function}[EXP]{\msg_see_documentation_text:n}
+% \begin{function}[EXP,updated = 2018-09-30]{\msg_see_documentation_text:n}
% \begin{syntax}
% \cs{msg_see_documentation_text:n} \Arg{module}
% \end{syntax}
@@ -223,9 +223,16 @@
% \end{quote}
% This function can be redefined to alter the language in which the
% message is given, using |#1| as the name of the \meta{module} to
-% be included.
+% be included. The name of the \meta{module} may be altered by use of
+% \cs{g_msg_module_documentation_prop}
% \end{function}
%
+% \begin{variable}{\g_msg_module_documentation_prop}
+% Provides a mapping between the module name used for messages, and that
+% for documentation. For example, \LaTeX{}3 core messages are stored in
+% the reserved |LaTeX| tree, but are printed as |LaTeX3|.
+% \end{variable}
+%
% \section{Issuing messages}
%
% Messages behave differently depending on the message class. In all cases,
@@ -891,15 +898,23 @@
% \end{macrocode}
% \end{macro}
%
+% \begin{variable}{\g_msg_module_documentation_prop}
+% \begin{macrocode}
+\prop_new:N \g_msg_module_documentation_prop
+\prop_gput:Nnn \g_msg_module_documentation_prop { LaTeX } { LaTeX3 }
+% \end{macrocode}
+% \end{variable}
+%
% \begin{macro}{\msg_see_documentation_text:n}
-% Contextual footer information. The \LaTeX{} module only comprises
-% \LaTeX3 code, so we refer to the \LaTeX3 documentation rather than
-% simply \enquote{\LaTeX{}}.
+% Contextual footer information, with the potential to give modules an
+% alternative name.
% \begin{macrocode}
\cs_new:Npn \msg_see_documentation_text:n #1
{
\\ \\ See~the~
- \str_if_eq:nnTF {#1} { LaTeX } { LaTeX3 } {#1} ~
+ \prop_if_in:NnTF \g_msg_module_documentation_prop {#1}
+ { \prop_item:Nn \g_msg_module_documentation_prop {#1} }
+ {#1} ~
documentation~for~further~information.
}
% \end{macrocode}
diff --git a/l3kernel/testfiles/m3expl001.luatex.tlg b/l3kernel/testfiles/m3expl001.luatex.tlg
index 53f3b2d..9df9da5 100644
--- a/l3kernel/testfiles/m3expl001.luatex.tlg
+++ b/l3kernel/testfiles/m3expl001.luatex.tlg
@@ -2492,6 +2492,7 @@ Defining \msg_critical_text:n on line ...
Defining \msg_error_text:n on line ...
Defining \msg_warning_text:n on line ...
Defining \msg_info_text:n on line ...
+Defining \g_msg_module_documentation_prop on line ...
Defining \msg_see_documentation_text:n on line ...
Defining \l__msg_redirect_fatal_prop on line ...
Defining \__msg_fatal_code:nnnnnn on line ...
diff --git a/l3kernel/testfiles/m3expl001.ptex.tlg b/l3kernel/testfiles/m3expl001.ptex.tlg
index d85dbe9..0af0ffe 100644
--- a/l3kernel/testfiles/m3expl001.ptex.tlg
+++ b/l3kernel/testfiles/m3expl001.ptex.tlg
@@ -2784,6 +2784,7 @@ Defining \msg_critical_text:n on line ...
Defining \msg_error_text:n on line ...
Defining \msg_warning_text:n on line ...
Defining \msg_info_text:n on line ...
+Defining \g_msg_module_documentation_prop on line ...
Defining \msg_see_documentation_text:n on line ...
Defining \l__msg_redirect_fatal_prop on line ...
Defining \__msg_fatal_code:nnnnnn on line ...
diff --git a/l3kernel/testfiles/m3expl001.tlg b/l3kernel/testfiles/m3expl001.tlg
index b5028b3..c50ba0f 100644
--- a/l3kernel/testfiles/m3expl001.tlg
+++ b/l3kernel/testfiles/m3expl001.tlg
@@ -2784,6 +2784,7 @@ Defining \msg_critical_text:n on line ...
Defining \msg_error_text:n on line ...
Defining \msg_warning_text:n on line ...
Defining \msg_info_text:n on line ...
+Defining \g_msg_module_documentation_prop on line ...
Defining \msg_see_documentation_text:n on line ...
Defining \l__msg_redirect_fatal_prop on line ...
Defining \__msg_fatal_code:nnnnnn on line ...
diff --git a/l3kernel/testfiles/m3expl001.uptex.tlg b/l3kernel/testfiles/m3expl001.uptex.tlg
index 7a3a1cb..ea2d624 100644
--- a/l3kernel/testfiles/m3expl001.uptex.tlg
+++ b/l3kernel/testfiles/m3expl001.uptex.tlg
@@ -2784,6 +2784,7 @@ Defining \msg_critical_text:n on line ...
Defining \msg_error_text:n on line ...
Defining \msg_warning_text:n on line ...
Defining \msg_info_text:n on line ...
+Defining \g_msg_module_documentation_prop on line ...
Defining \msg_see_documentation_text:n on line ...
Defining \l__msg_redirect_fatal_prop on line ...
Defining \__msg_fatal_code:nnnnnn on line ...
diff --git a/l3kernel/testfiles/m3expl001.xetex.tlg b/l3kernel/testfiles/m3expl001.xetex.tlg
index 95306aa..0b538ae 100644
--- a/l3kernel/testfiles/m3expl001.xetex.tlg
+++ b/l3kernel/testfiles/m3expl001.xetex.tlg
@@ -2529,6 +2529,7 @@ Defining \msg_critical_text:n on line ...
Defining \msg_error_text:n on line ...
Defining \msg_warning_text:n on line ...
Defining \msg_info_text:n on line ...
+Defining \g_msg_module_documentation_prop on line ...
Defining \msg_see_documentation_text:n on line ...
Defining \l__msg_redirect_fatal_prop on line ...
Defining \__msg_fatal_code:nnnnnn on line ...
diff --git a/l3kernel/testfiles/m3expl003.luatex.tlg b/l3kernel/testfiles/m3expl003.luatex.tlg
index 53f3b2d..9df9da5 100644
--- a/l3kernel/testfiles/m3expl003.luatex.tlg
+++ b/l3kernel/testfiles/m3expl003.luatex.tlg
@@ -2492,6 +2492,7 @@ Defining \msg_critical_text:n on line ...
Defining \msg_error_text:n on line ...
Defining \msg_warning_text:n on line ...
Defining \msg_info_text:n on line ...
+Defining \g_msg_module_documentation_prop on line ...
Defining \msg_see_documentation_text:n on line ...
Defining \l__msg_redirect_fatal_prop on line ...
Defining \__msg_fatal_code:nnnnnn on line ...
diff --git a/l3kernel/testfiles/m3expl003.ptex.tlg b/l3kernel/testfiles/m3expl003.ptex.tlg
index d85dbe9..0af0ffe 100644
--- a/l3kernel/testfiles/m3expl003.ptex.tlg
+++ b/l3kernel/testfiles/m3expl003.ptex.tlg
@@ -2784,6 +2784,7 @@ Defining \msg_critical_text:n on line ...
Defining \msg_error_text:n on line ...
Defining \msg_warning_text:n on line ...
Defining \msg_info_text:n on line ...
+Defining \g_msg_module_documentation_prop on line ...
Defining \msg_see_documentation_text:n on line ...
Defining \l__msg_redirect_fatal_prop on line ...
Defining \__msg_fatal_code:nnnnnn on line ...
diff --git a/l3kernel/testfiles/m3expl003.tlg b/l3kernel/testfiles/m3expl003.tlg
index b5028b3..c50ba0f 100644
--- a/l3kernel/testfiles/m3expl003.tlg
+++ b/l3kernel/testfiles/m3expl003.tlg
@@ -2784,6 +2784,7 @@ Defining \msg_critical_text:n on line ...
Defining \msg_error_text:n on line ...
Defining \msg_warning_text:n on line ...
Defining \msg_info_text:n on line ...
+Defining \g_msg_module_documentation_prop on line ...
Defining \msg_see_documentation_text:n on line ...
Defining \l__msg_redirect_fatal_prop on line ...
Defining \__msg_fatal_code:nnnnnn on line ...
diff --git a/l3kernel/testfiles/m3expl003.uptex.tlg b/l3kernel/testfiles/m3expl003.uptex.tlg
index 7a3a1cb..ea2d624 100644
--- a/l3kernel/testfiles/m3expl003.uptex.tlg
+++ b/l3kernel/testfiles/m3expl003.uptex.tlg
@@ -2784,6 +2784,7 @@ Defining \msg_critical_text:n on line ...
Defining \msg_error_text:n on line ...
Defining \msg_warning_text:n on line ...
Defining \msg_info_text:n on line ...
+Defining \g_msg_module_documentation_prop on line ...
Defining \msg_see_documentation_text:n on line ...
Defining \l__msg_redirect_fatal_prop on line ...
Defining \__msg_fatal_code:nnnnnn on line ...
diff --git a/l3kernel/testfiles/m3expl003.xetex.tlg b/l3kernel/testfiles/m3expl003.xetex.tlg
index 95306aa..0b538ae 100644
--- a/l3kernel/testfiles/m3expl003.xetex.tlg
+++ b/l3kernel/testfiles/m3expl003.xetex.tlg
@@ -2529,6 +2529,7 @@ Defining \msg_critical_text:n on line ...
Defining \msg_error_text:n on line ...
Defining \msg_warning_text:n on line ...
Defining \msg_info_text:n on line ...
+Defining \g_msg_module_documentation_prop on line ...
Defining \msg_see_documentation_text:n on line ...
Defining \l__msg_redirect_fatal_prop on line ...
Defining \__msg_fatal_code:nnnnnn on line ...
More information about the latex3-commits
mailing list