Identify main documentation file for *__doc packages in MiKTex Console Documentation page#1739
Open
AndyJenks wants to merge 1 commit into
Open
Identify main documentation file for *__doc packages in MiKTex Console Documentation page#1739AndyJenks wants to merge 1 commit into
AndyJenks wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Currently, the Documentation page in MiKTex Console lists one main documentation file per package. If there exists a documentation file of which the name (excluding extension) that matches the package name, this file is selected, otherwise the first alphabetically ordered file name is used (subject to hierarchy of preferred file types). This works fine for non-split packages, but where there is a separate
pkgname__docpackage (e.g.biblatex__doc,todonotes__doc) the actual main pdf (biblatex.pdf,todonotes.pdf) is missed in favour of an alphabetically earlier one in the folder (examples/01-introduction-biber.pdf,examples/alterAppearanceOfListOfTodos.pdfrespectively)This PR sets the preferred name of packages of the form
pkgname__doctopkgname, so that the main documentation file is found as would have been if the package was not split.Tested & working on Ubuntu 24.04 (WSL)