Wagtail 教程 4：自动生成文章右侧TOC导航
程序员文章站
2024-01-29 10:24:58
...
Wagtail 教程系列 记录了基于 Wagtail 搭建博客站点的整个过程，博客站点所呈现的即是搭建过程的最新效果。
更多 Wagtail 内容：https://slowread.net/tags/?tag=Wagtail
自动生成文章右侧TOC导航
此部分属于通用内容，非 Wagtail 必需内容，是为了完善/优化基于 Wagtail 搭建的博客。
说明
- 需要在文章页面中创建一对 DIV 标签，涵盖范围为需要自动生成TOC导航的文章内容部分，ID 为 JS 脚本中设定的名字 sowread_post_body。
- JS 脚本自动查找第一个标题级别，只显示两级目录。
CSS
/* TOC 导航 */
#TOCbar{
text-align:left; position:fixed; width: auto; color:#2F7CFF;
height: auto; top:4em; right:0; margin: 0.25em /*离页面顶部与右侧的距离*/
}
#TOCbarTab{
float:left; width: 2.5em; border:1px solid #e5e5e5; border-right:none;
text-align:center; background:#ffffff;
}
#TOCbarContents{
float:left; overflow:auto; overflow-x:hidden; padding: 0.5em; color:#2F7CFF;
width:18em; min-height:6em; max-height:50em;
border:1px solid #e5e5e5; border-right:none; background:#ffffff;
}
#TOCbarContents dl{ margin:0; padding:0; }
#TOCbarContents dt{ margin-left: 0;}
#TOCbarContents dd{ padding-left: 1.5em; margin-bottom: 0;}
#TOCbarContents dd, dt { cursor: pointer; }
#TOCbarContents dd:hover, dt:hover { color:#ffffff;background:#2F7CFF;}
/* TOC 导航 */
JavaScript
// 自动生成 TOC 导航
var BlogDirectory = {
/*
获取元素位置，距浏览器左边界的距离（left）和距浏览器上边界的距离（top）
*/
getElementPosition:function (ele) {
var topPosition = 0;
var leftPosition = 0;
while (ele){
topPosition += ele.offsetTop;
leftPosition += ele.offsetLeft;
ele = ele.offsetParent;
}
return {top:topPosition, left:leftPosition};
},
/*
获取滚动条当前位置
*/
getScrollBarPosition:function () {
var scrollBarPosition = document.body.scrollTop || document.documentElement.scrollTop;
return scrollBarPosition;
},
/*
移动滚动条，finalPos 为目的位置，internal 为移动速度
*/
moveScrollBar:function(finalpos, interval) {
// 若不支持此方法，则退出
if(!window.scrollTo) {
return false;
}
// 窗体滚动时，禁用鼠标滚轮
window.onmousewheel = function(){
return false;
};
// 清除计时
if (document.body.movement) {
clearTimeout(document.body.movement);
}
var currentpos =BlogDirectory.getScrollBarPosition(); // 获取滚动条当前位置
var dist = 0;
if (currentpos == finalpos) { // 到达预定位置，则解禁鼠标滚轮，并退出
window.onmousewheel = function(){
return true;
};
return true;
}
if (currentpos < finalpos) { // 未到达，则计算下一步所要移动的距离
dist = Math.ceil((finalpos - currentpos)/10);
currentpos += dist;
}
if (currentpos > finalpos) {
dist = Math.ceil((currentpos - finalpos)/10);
currentpos -= dist;
}
var scrTop = BlogDirectory.getScrollBarPosition(); // 获取滚动条当前位置
window.scrollTo(0, currentpos); // 移动窗口
if(BlogDirectory.getScrollBarPosition() == scrTop) // 若已到底部，则解禁鼠标滚轮，并退出
{
window.onmousewheel = function(){
return true;
};
return true;
}
// 进行下一步移动
var repeat = "BlogDirectory.moveScrollBar(" + finalpos + "," + interval + ")";
document.body.movement = setTimeout(repeat, interval);
},
htmlDecode:function (text){
var temp = document.createElement("div");
temp.innerHTML = text;
var output = temp.innerText || temp.textContent;
temp = null;
return output;
},
/*
创建博客目录，id表示包含博文正文的 div 容器的 id，mt 和 st 分别表示主标题和次级标题的标签名称，interval 表示移动的速度
*/
createBlogDirectory:function (id, mt, st, interval){
// 获取博文正文div容器
var elem = document.getElementById(id);
if(!elem) return false;
// 获取div中所有元素结点
var nodes = elem.getElementsByTagName("*");
// 创建博客目录的div容器
var divTOCbar = document.createElement('DIV');
divTOCbar.className = 'TOCbar';
divTOCbar.setAttribute('id', 'TOCbar');
var divTOCbarTab = document.createElement('DIV');
divTOCbarTab.setAttribute('id', 'TOCbarTab');
divTOCbar.appendChild(divTOCbarTab);
var h3 = document.createElement('h4');
divTOCbarTab.appendChild(h3);
var txt = document.createTextNode('<'); // 目录导航名字
h3.appendChild(txt);
var divTOCbarContents = document.createElement('DIV');
divTOCbarContents.style.display = 'none';
divTOCbarContents.setAttribute('id', 'TOCbarContents');
divTOCbar.appendChild(divTOCbarContents);
// 创建自定义列表
var dlist = document.createElement("dl");
divTOCbarContents.appendChild(dlist);
var num = 0; // 统计找到的mt和st
// mt = mt.toUpperCase(); // 转化成大写
// st = st.toUpperCase(); // 转化成大写
mt = "H1";
st = "H2";
var hhArray = ["H1","H2","H3","H4","H5","H6"];
// 查找第一个 标题 级别，如果找到 自动设置下一级标题
for(var x=0; x<nodes.length; x++)
{
if ($.inArray(nodes[x].nodeName,hhArray) != -1)
{
mt = hhArray[$.inArray(nodes[x].nodeName,hhArray)];
if ($.inArray(nodes[x].nodeName,hhArray) <= 4)
{
st = hhArray[$.inArray(nodes[x].nodeName,hhArray) + 1];
}
break;
}
}
// 遍历所有元素结点
for(var i=0; i<nodes.length; i++)
{
if(nodes[i].nodeName == mt|| nodes[i].nodeName == st)
{
// 获取标题文本
var nodetext = nodes[i].innerHTML.replace(/<\/?[^>]+>/g,""); // innerHTML里面的内容可能有HTML标签，所以用正则表达式去除HTML的标签
nodetext = nodetext.replace(/ /ig, ""); // 替换掉所有的
nodetext = BlogDirectory.htmlDecode(nodetext);
// 插入锚
nodes[i].setAttribute("id", "blogTitle" + num);
var item;
switch(nodes[i].nodeName)
{
case mt: // 若为主标题
item = document.createElement("dt");
break;
case st: // 若为子标题
item = document.createElement("dd");
break;
}
// 创建锚链接
var itemtext = document.createTextNode(nodetext);
item.appendChild(itemtext);
item.setAttribute("name", num);
item.onclick = function(){ // 添加鼠标点击触发函数
var pos = BlogDirectory.getElementPosition(document.getElementById("blogTitle" + this.getAttribute("name")));
if(!BlogDirectory.moveScrollBar(pos.top, interval)) return false;
};
// 将自定义表项加入自定义列表中
dlist.appendChild(item);
num++;
}
}
if(num == 0) return false;
/* 鼠标进入时的事件处理 */
divTOCbarTab.onmouseenter = function(){
divTOCbarContents.style.display = 'block';
};
/* 鼠标离开时的事件处理 */
divTOCbar.onmouseleave = function() {
divTOCbarContents.style.display = 'none';
};
document.body.appendChild(divTOCbar);
}
};
window.onload=function(){
/* 页面加载完成之后生成博客目录 */
// h2,h3 非必须指定，程序内部自动查找第一个标题级别 2018-12-21
BlogDirectory.createBlogDirectory("sowread_post_body","h2","h3",20);
};
// 自动生成 TOC 导航