Support stable heading id for non english languages

Feature

I need ability to make refrences to headers from external documentation (some_chapter.html#zagalovok).
Unfortunately If I have a title in a non english language it will have numeric id which can be changed in any time.
It is difficult to automate and it is unstable because such number can be changed at any time.

<section id="id2">

Solution

I want to have the ablility to define the id generation function in my conf.py to a function that accepts a string and returns a stable id.

The function will generate stable id by a node title.

<section id="zagalovok">

I have maken some test in the function generate_heading_target

name = nodes.fully_normalize_name(implicit_text)
name = conf.make_id_by_any_lang(name)

It seems It is working.

Will it be accepted If I make a pull request?

Alternative decision is to add ability configuring custom markdown plugins.
A plugin can add id to token similar to attrs_block extension

It is not difficult to add custom function to configure md in create_md_parser

    custom_md_config(md)
    md.options.update(
        {
            "typographer": typographer,
            "linkify": "linkify" in config.enable_extensions,
            "myst_config": config,
        }
    )

Heya, what exactly does make_id_by_any_lang do, how is it different to

MyST-Parser/myst_parser/mdit_to_docutils/base.py

Lines 774 to 775 in 1038800

    
           name = nodes.fully_normalize_name(implicit_text) 
        
           node["names"].append(name)

what exactly does make_id_by_any_lang do, how is it different to

It generates an english name from other language. It allows to use static id.

def make_id_by_any_lang(str:str)->str:
    # see https://pypi.org/project/transliterate/
    tr_str = translit(str,"ru",reversed=True)
    #This function is a modified version of ``docutils.nodes.make_id()`` of
    #docutils-0.16
    # It is test code so probably it is not nessasary
    result = _make_id(tr_str).lower()
    return result

We have implemented pull request which allows to do it

Navigation Menu

Repository navigation

Support stable heading id for non english languages #968

Feature

Solution

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	name = nodes.fully_normalize_name(implicit_text)
	node["names"].append(name)

Support stable heading id for non english languages #968

Description

Feature

Solution

Activity

Alexey-NM commented on Aug 26, 2024

chrisjsewell commented on Aug 27, 2024

Alexey-NM commented on Aug 27, 2024

Alexey-NM commented on Jan 27, 2025

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions