latex3 / latex3/hyperref

nameref and gettitlestring

Open
#129 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
205
Forks
41
PR merge metrics
No merged PRs in 30d

Description

It would be a nice feature for nameref to optionally use the expansion method of gettitlestring without setting the corresponding package option globally. This request is actually motivated by this discussion: https://github.com/latex3/latex2e/issues/307

As soon as there are some user-defined commands which should be ignored for generating \@currentlabelname one has to use the expansion method of gettitlestring. Setting \GetTitleStringSetup{expand=true} globally is maybe error prone, although I do not have a particular case in mind.

Maybe using protected expansion at least in headings by default or via option would be good as well. See also https://github.com/ho-tex/gettitlestring/issues/2 and https://github.com/ho-tex/gettitlestring/issues/3 The expansion is already protected.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading how nameref currently obtains and processes @currentlabelname, then compare that behavior with gettitlestring's expansion method. Review the linked latex2e and gettitlestring discussions to determine the intended opt-in interface and its interaction with existing package options. Done means the behavior and scope are agreed and covered by appropriate package tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
latex, tex
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.