search

casperngeen / pe

0 stars 0 forks source link

UG hyperlinks not working as intended #6

Open casperngeen opened 1 week ago

casperngeen commented 1 week ago

I was redirected to this part of the UG [see image below] when I clicked on the hyperlink for "GraphicalUserInterface". I was directed to the blank space below GUI instead of the header of the GUI section.

I believe the same issue occurs for all internal hyperlinks.

image.png

soc-se-bot commented 1 week ago

Team's Response

Thanks for raising this issue. We believe that this is a limitation of the PDF reader or PDF conversion process and not our User Guide. We have checked the links in the markdown to be correct, but as the link scrolls the page to a position such that the linked section is at the top of the page, the section headers and the content (especially if it is short) may be blocked by the the ribbon or the toolbar. We have also followed the conversion process described in the course textbook (see: https://se-education.org/guides/tutorials/savingPdf.html)

I was redirected to this part of the UG [see image below] when I clicked on the hyperlink for "GraphicalUserInterface".

In your case, we suspect that the section is obscured by the PDF reader's toolbar or ribbon. For example, in Microsoft Edge, the section would be obscured by the toolbar indicated by the red box below.

image.png

Similarly for Google Chrome:

image.png

However, the link on our User Guide hosted on GitHub pages does not have this issue (see: https://ay2425s1-cs2103t-t15-4.github.io/tp/UserGuide.html#graphical-user-interface)

We think that this limitation of the PDF reader or conversion process would be more obvious if the hyperlink for "JSON" was clicked, showing how the first few lines would be obscured by the toolbar.

image.png

In summary, we think that this is a limitation of the PDF reader or the PDF conversion process and not a limitation of our User Guide. Nevertheless, thanks for raising this issue!

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: I understand that the conversion may have caused the problem here, but I know of some groups (mine included) that manage to preserve the functionality of the internal hyperlinks after converting it to PDF.