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

TOC Structure related issues #123

Open
biswalneelam opened this issue Oct 17, 2024 · 2 comments
Open

TOC Structure related issues #123

biswalneelam opened this issue Oct 17, 2024 · 2 comments

Comments

@biswalneelam
Copy link

biswalneelam commented Oct 17, 2024

Hi @timvink

We have an extensive set of documentation with various hierarchical levels.. Please review the following concerns and provide your suggestions.

Issues with Table of Contents (TOC):

  1. TOC Depth Not Displaying Properly: I have set the TOC depth to 6, but it only displays the up to level 2 in TOC. What level does the TOC actually consider when generating the output?

  2. Inconsistent Numbering in TOC: The TOC numbering seems bit weird, using a mix of Roman numerals and regular numbers. For example: in your print preview:
    image

    • The first two top-level sections display as "1" and "2".
    • But the third heading (which has further sub-levels) is displayed with a Roman numeral "I".
  3. Proposed Numbering Structure: To simplify and make the structure clearer, the numbering should follow the logical hierarchy. As sections drill down, they should follow the main section number. For instance:




1 Home
2 Options
3 How-To Guides
   3.1 Export to PDF
   3.2 Export to HTML
   3.3 Adding a Print Button
   3.4 Adding a PDF Button
   3.5 Customize the Cover Page
   3.6 Customize the Print Site Banner
   3.7 Exclude Content from Print
4 Demo Content
5 Contributing

If there are additional sub-sections under “3.1 Export to PDF,” they should be numbered like this:


3.1 Export to PDF
   3.1.1 ...
    3.1.2 ...

Similarly, under “4 Demo Content,” sub-sections should be numbered "4.1", "4.2", etc.

  1. Code Reference: I used the same code from your repository and set the TOC depth to 6 because I have multiple levels. See my site screenshot here. I am suggesting the following logical numbering (highlighted in red) in the screenshot below.

image

HTML Tags Related Issue:

Additionally, image references using HTML tags are not displaying properly and show an image error. For example:

image

Could you help resolve these issues?

@timvink
Copy link
Owner

timvink commented Oct 22, 2024

  1. The toc dept setting control the table of contents in the print page, not the side bar
  2. Actually those roman numbers reflect sections. You have a nested navigation iemand the side bar tries to reflect that.
  3. Actually we will change the numbering in the sidebar, see the work in progress here: Rewrite sidebar TOC generation to be recursive #115

@biswalneelam
Copy link
Author

Hi @timvink

Thanks for your reply.

Could you kindly provide an estimated timeframe for when #115 might be addressed? That will be helpful. Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants
@timvink @biswalneelam and others