mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-07 03:09:44 +03:00
Reference in document in a table of contents type of way #4845
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @mankiiii on GitHub (Jul 3, 2024).
Describe the feature you'd like
Basically like in the table of contents in a pdf or something where you can click on the section you want and you are then "teleported" to the section which is in the same document. For now as i can see you can only add a link taking you to another bookstack document or to another website(i think) but nothing regarding the same document and moving down.
Describe the benefits this would bring to existing BookStack users
This feature would allow a better flow and navigation of the document if the document is huge so you don't have to scroll up and down.
Can the goal of this request already be achieved via other means?
There is no way i have seen yet for someone to be able to do it. I might be wrong
Have you searched for an existing open/closed issue?
How long have you been using BookStack?
Under 3 months
Additional context
No response
@ssddanbrown commented on GitHub (Jul 3, 2024):
Hi @mankiiii,
We already generate a table of contents for the page based upon headings:
Page screenshotted: https://demo.bookstackapp.com/books/bookstack-demo-site/page/header-level-examples
Or are you specifically referring to PDF exports?
@mankiiii commented on GitHub (Jul 3, 2024):
Hello,
Well I mean I know the table of contents exist. what i mean is
For example in my LaTeX document if i click the 3.1 it will take me to the figure. In this case the reference to the figure shown in the first picture is on page 10 and the actual figure is on page 20.
@mankiiii commented on GitHub (Jul 4, 2024):
I would like to add that, if you inspect element and find the id of the header element. And you put the URL/#id, if you add a link to the document that goes to URL/#id it will refresh the page and "teleport" you to that section of the document. But that still isn't the desired behavior as it has to reload the page to do it. I mean it is a work around but someone that doesn't know how to find the id of the element(someone not technical) can't do this
@ssddanbrown commented on GitHub (Jul 4, 2024):
@mankiiii If you remove the
URL/#idpart of the link, and just use the#idpart you may have some success.If using the WYSIWYG editor you can use a
#in the URL input (or press the down arrow on keyboard) to show a list of headings within the current document you can link to:@mankiiii commented on GitHub (Jul 5, 2024):
Ah okay perfect that is exactly what I wanted. Is there documentation for this that I missed? or is it like hidden :)
@ssddanbrown commented on GitHub (Jul 5, 2024):
@mankiiii I don't think we have any specific documentation for this feature (most minor features of the WYSIWYG are undocumented). Maybe something to improve upon but we'll likely be changing editors soon so not something to do right now.
Good to hear, I'll therefore close this request off since the above meets the desire.