boost/website-v2
2
0
Fork 0
mirror of https://github.com/boostorg/website-v2.git synced 2026-01-19 04:42:17 +00:00
Code Issues Projects Releases Wiki Activity

Documentation anchor links fixes (#1585)

Browse Source
This commit is contained in:
daveoconnor
2025-01-09 10:07:03 -08:00
committed by GitHub
parent c9f4d36afb
commit b8c04c42df
3 changed files with 30 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
core/htmlhelper.py
View File

@@ -176,6 +176,8 @@ def modernize_legacy_page(
for tag in result.find_all(tag_name, tag_attrs):
tag.attrs.pop("class")
result = convert_name_to_id(result)
# Use the base HTML to later extract the <head> and (part of) the <body>
placeholder = BeautifulSoup(base_html, "html.parser")
if isinstance(head_selector, str):
@@ -280,6 +282,15 @@ def convert_h1_to_h2(soup):
return soup
def convert_name_to_id(soup):
"""Convert all (deprecated) name attributes to id attributes."""
for tag in soup.find_all(attrs={"name": True}):
tag["id"] = tag["name"]
del tag["name"]
return soup
def format_nested_lists(soup):
"""Flattens nested lists"""
try:

3
core/views.py
View File

@@ -34,7 +34,7 @@ from .boostrenderer import (
get_s3_client,
)
from .constants import SourceDocType
from .htmlhelper import modernize_legacy_page
from .htmlhelper import modernize_legacy_page, convert_name_to_id
from .markdown import process_md
from .models import RenderedContent
from .tasks import (
@@ -472,6 +472,7 @@ class DocLibsTemplateView(BaseStaticContentTemplateView):
if source_content_type == SourceDocType.ASCIIDOC:
extracted_content = content.decode(chardet.detect(content)["encoding"])
soup = BeautifulSoup(extracted_content, "html.parser")
soup = convert_name_to_id(soup)
soup.find("head").append(
soup.new_tag("script", src=f"{STATIC_URL}js/theme_handling.js")
)

23
templates/docsiframe.html
View File

@@ -12,23 +12,34 @@
{#resizeIframe(iframe);#}
addClickInterception(iframeDoc);
addBase(iframeDoc);
if (window.location.hash) {
scrollToAnchor(iframeDoc, window.location.hash.slice(1));
}
}
function resizeIframe(obj) {
obj.style.height = obj.contentWindow.document.documentElement.scrollHeight + 'px';
}
function addClickInterception(iframeDoc) {
let anchorLinks = iframeDoc.querySelectorAll('a[href^="#"]');
function scrollToAnchor(iframeDoc, hash) {
const targetElement = iframeDoc.getElementById(hash);
if (targetElement) {
targetElement.scrollIntoView({behavior: 'smooth'});
}
}
function addClickInterception(iframeDoc) {
let anchorLinks = iframeDoc.querySelectorAll('a[href*="#"]');
anchorLinks.forEach(function (anchor) {
anchor.addEventListener('click', function (event) {
const href = this.getAttribute('href');
const hrefSplit = href.split('#');
event.preventDefault();
let targetId = this.getAttribute('href').substring(1);
let targetElement = iframeDoc.getElementById(targetId);
if (targetElement) {
targetElement.scrollIntoView({behavior: 'smooth'});
{# here we account for anchors on different pages #}
if (!window.location.href.endsWith(hrefSplit[0])) {
window.location.href = href;
}
scrollToAnchor(iframeDoc, hrefSplit[1]);
});
});
}