search

dotnet / docfx

Static site generator for .NET API documentation.
https://dotnet.github.io/docfx/
MIT License
4.08k stars 865 forks source link

[Bug] The title is not displayed in the bookmark hierarchy in a PDF document #9764

Closed MrDmitrij closed 6 months ago

MrDmitrij commented 8 months ago

Describe the bug A title starting with the Cyrillic characters "Ш" or "Щ" is not displayed in the bookmark hierarchy of a PDF document. image

To Reproduce

  1. Create a TOC file with a name starting with the Cyrillic characters "Ш" or "Щ". image

  2. Follow the instructions to generate a PDF from the documentation.

  3. Open the PDF file and view the bookmark hierarchy.

Expected behavior The bookmark hierarchy in PDF should be displayed correctly using the Cyrillic characters "Ш" or "Щ".

Context (please complete the following information):

filzrev commented 8 months ago

A title starting with the Cyrillic characters "Ш" or "Щ" is not displayed in the bookmark hierarchy of a PDF document.

On my environment. it can't reproduce problems.| I've create toc files that contains "Ш" /"Щ" chars and save file with UTF-8 encoding. Is it able to provide minimum reproducible source files?

It can be reproduced by following toc.yml file.

- name: Introduction
  href: introduction.md
- name: Getting Started
  href: getting-started.md
- name: Ш
  href: getting-started.md
MrDmitrij commented 8 months ago

Yes, the name of the TOC node must begin with the characters "Ш" or "Щ".

filzrev commented 8 months ago

PDF bookmarks problems seem to be caused by PdfPig library. I've created a separate issue at PdfPig repository. https://github.com/UglyToad/PdfPig/issues/789

filzrev commented 8 months ago

PdfPig bookmark problems are resolved by #9783.

This issue will be resolved in next docfx release.

MrDmitrij commented 8 months ago

Проблемы с закладками PdfPig решены с помощью #9783 .

Эта проблема будет решена в следующем выпуске docfx.

Thank you very much for your wonderful work!)

@filzrev, please tell me when docfx is planned to be released?

filzrev commented 7 months ago

It's expected to be fixed with latest docfx version (v2.76.0).

@MrDmitrij Is it able to confirms problems are fixed in latest version?

MrDmitrij commented 6 months ago

It's expected to be fixed with latest docfx version (v2.76.0).

@MrDmitrij Is it able to confirms problems are fixed in latest version?

@filzrev Yes, the problems are fixed in the docfx version (v2.76.0). Everything works well.

Thank you for your excellent work! =)

filzrev commented 6 months ago

@MrDmitrij Thanks for your confirmation. Please close issue if no additional problems.