Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc documentation (bug?): 'symbolic' name for \levelchar in \index{} example on page 11 produces garbled entry #1418

Open
cfr42 opened this issue Jul 27, 2024 · 4 comments
Assignees
Labels
bug (documentation) category base (latex) fixed in dev Fixed in development branch, not in stable release

Comments

@cfr42
Copy link
Contributor

cfr42 commented Jul 27, 2024

% \index{index entries\levelchar Special macros for \*}
gives as an example

\index{index entries\levelchar Special macros for \*}

but \levelchar can't work here as it results in

\indexentry{index entries\levelchar Special macros for \*}{1}

in the idx and

\item index entries\levelchar Special macros for \*\pfill 1

in the ind which results in a garbled entry.

% \iffalse
%<*driver>
\ProvidesFile{exp.dtx}[2024-07-26 v0.0]
\documentclass{ltxdoc}
\usepackage{exp}
\EnableCrossrefs
\CodelineIndex
\begin{document}
  \DocInput{exp.dtx}
\end{document}
%</driver>
% \fi
%
% Example\index{index entries\levelchar Special macros for \*}
%
% \MaybeStop{%
% \PrintIndex
% }
%
%\Finale
@cfr42 cfr42 changed the title doc documentation bug: 'symbolic' name for \levelchar in \index{} example on page 11 produces garbled entry doc documentation (bug?): 'symbolic' name for \levelchar in \index{} example on page 11 produces garbled entry Jul 27, 2024
@muzimuzhi
Copy link
Contributor

Also found a line of rollback comment is leaked into doc.pdf (v3.0p, 2024/04/26) thus takes up its first page.

diff --git a/base/doc.dtx b/base/doc.dtx
index 4cb8dd6b..3af0fa37 100644
--- a/base/doc.dtx
+++ b/base/doc.dtx
@@ -34,7 +34,7 @@
 %\catcode`\<=14
 %<+package|shortvrb>\NeedsTeXFormat{LaTeX2e}[1994/12/01]
 %<+package>
-% Any rollback request before 2016-02-15 we try to fulfill with the 2016 version:
+% ^^A Any rollback request before 2016-02-15 we try to fulfill with the 2016 version:
 %<+package>\DeclareRelease{}{1994-06-01}
 %<+package>                      {doc-2016-02-15.sty}
 %<+package>\DeclareRelease{v2.1g}{2016-02-15}

Copy link

This issue has been automatically marked as stale because it has not had recent activity.

Copy link

This issue has been automatically marked as stale because it has not had recent activity.

@github-actions github-actions bot added the stale label Dec 22, 2024
@FrankMittelbach FrankMittelbach added bug (documentation) fixed in dev Fixed in development branch, not in stable release and removed to analyse further stale labels Dec 25, 2024
FrankMittelbach added a commit that referenced this issue Dec 25, 2024
@github-project-automation github-project-automation bot moved this to Pool (unscheduled issues) in upcoming LaTeX2e releases Dec 25, 2024
@FrankMittelbach FrankMittelbach added this to the Release 2025 Spring milestone Dec 25, 2024
@FrankMittelbach FrankMittelbach moved this from Pool (unscheduled issues) to Done in dev in upcoming LaTeX2e releases Dec 25, 2024
@FrankMittelbach
Copy link
Member

ah put it in the wrong branch (but too lazy to undo all that) --- that branch will be merge soon as well

FrankMittelbach added a commit that referenced this issue Dec 28, 2024
* fix for #1585

* not sure why that changed, needs investigation

* forgot to upload ltnews41

* WIP

* adjust longtable to array change

* some docu fixes, suggested by @Skillmon

* docu fix for #1418
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug (documentation) category base (latex) fixed in dev Fixed in development branch, not in stable release
Projects
Status: Done in dev
Development

No branches or pull requests

4 participants