博客园随笔如何自动生成目录（原理：页脚js函数且执行）

博客园随笔如何自动生成目录（原理：页脚js函数且执行）

一、总结

一句话总结：用的是jquery的dom操作知识，主要操作就是在标题那里添加锚点，然后在目录那里链接到锚点

1、如何在标题前面添加锚点？

用before方法

 30                     var li3_anchor = '<a name="_label' + i + '_' + j + '"></a>'; //添加锚点
 31                     $(h3_list[j]).before(li3_anchor);

 

2、如何在目录那里链接到锚点？

a标签的href属性到锚点a标签的name属性

 32                     li3_content += '<li><a href="#_label' + i + '_' + j + '">'
 33                             + $(h3_list[j]).text() + '</a></li>'; //链接到锚点

 

3、将标题插入到开头用的什么方法？

prepend内部之前插入方法

 99         var title_h1 = $('#cnblogs_post_body h1');//将标题信息插入到开头
100         $(mainContent[0]).prepend(title_h1[0]);

 

 

 

实现原理：在页脚添加了一个js函数，然后调用执行，用了很多类选择器和dom里面的知识， 里面有jquery

 

二、让博客园博客自动生成章节目录索引

对于比较长的文章，有一个好的目录索引是很有必要的，可以让读者比较清楚地了解文章内容和层次。然而，目前（2015.7）博客园不像csdn博客那样，会对发布的文章自动生成目录索引。不过，一些网友通过博客园后台提供的一些自定义功能，自己写脚本实现了这一功能。我用的脚本主要就是参考@薰衣草的旋律 的，文章地址是：http://www.cnblogs.com/wangqiguo/p/4355032.html。

原作者的脚本只支持1级目录，我改了两级：第1级是h2，第2级是h3。还添加了一些小玩意，比如讨论qq群号。效果如下图所示：

 

 

添加功能的具体步骤是：

1. 确保自己的博客园后台支持js
   这个默认是不支持，需要向官方发个邮件申请开通（邮箱是contact@cnblogs.com），我简单写了封邮件，1小时就回复了，邮件内容我只写了两个字：如题。。。。
2. 到后台加入脚本
   打开博客园后台，进入“设置”标签页，在最下面的“页脚Html代码”对应的编辑框粘贴你的js代码，然后点“保存”按钮保存。
3. 按格式写文章
   在写新博文的时候，注意按照你js脚本里设定的格式来划分章节，比如h2,h3等。当然，以前发布的文章如果有h2,h3之类，也会自动生成目录索引。

 

 

脚本如下：

<script language="javascript" type="text/javascript">

// 生成目录索引列表
// ref: http://www.cnblogs.com/wangqiguo/p/4355032.html
// modified by: zzq
function GenerateContentList()
{
    var mainContent = $('#cnblogs_post_body');
    var h2_list = $('#cnblogs_post_body h2');//如果你的章节标题不是h2,只需要将这里的h2换掉即可

    if(mainContent.length < 1)
        return;
 
    if(h2_list.length>0)
    {
        var content = '<a name="_labelTop"></a>';
        content += '<div id="navCategory">';
        content += '<p style="font-size:18px"><b>目录</b></p>';
        content += '<ul>';
        for(var i=0; i<h2_list.length; i++)
        {
            var go_to_top = '<div style="text-align: right"><a href="#_labelTop">回到顶部</a><a name="_label' + i + '"></a></div>';
            $(h2_list[i]).before(go_to_top);
            
            var h3_list = $(h2_list[i]).nextAll("h3");
            var li3_content = '';
            for(var j=0; j<h3_list.length; j++)
            {
                var tmp = $(h3_list[j]).prevAll('h2').first();
                if(!tmp.is(h2_list[i]))
                    break;
                var li3_anchor = '<a name="_label' + i + '_' + j + '"></a>';
                $(h3_list[j]).before(li3_anchor);
                li3_content += '<li><a href="#_label' + i + '_' + j + '">' + $(h3_list[j]).text() + '</a></li>';
            }
            
            var li2_content = '';
            if(li3_content.length > 0)
                li2_content = '<li><a href="#_label' + i + '">' + $(h2_list[i]).text() + '</a><ul>' + li3_content + '</ul></li>';
            else
                li2_content = '<li><a href="#_label' + i + '">' + $(h2_list[i]).text() + '</a></li>';
            content += li2_content;
        }
        content += '</ul>';
        content += '</div><p>&nbsp;</p>';
        content += '<p style="font-size:18px"><b>正文</b></p>';
        if($('#cnblogs_post_body').length != 0 )
        {
            $($('#cnblogs_post_body')[0]).prepend(content);
        }
    }   

    var qqinfo =  '<p style="color:navy;font-size:12px">讨论QQ群：135202158</p>';
    $(mainContent[0]).prepend(qqinfo);
}

GenerateContentList();
</script>

 

【参考】@薰衣草的旋律： http://www.cnblogs.com/wangqiguo/p/4355032.html

 

参考：

让博客园博客自动生成章节目录索引 - 赵子清 - 博客园
https://www.cnblogs.com/zzqcn/p/4657124.html

 

三、自己的目录

修改了一下上面的代码

• 优化了一下格式，
• 并且功能修改为在有h2的时候目录结构为h2和h3，没有h2的时候目录结构为h3和h4，
• 也把标题放到了目录之前
• 也增加了一些代码注释

 

<!-- 自动生成目录 -->
<script language="javascript" type="text/javascript">
    // 生成目录索引列表
    // ref: http://www.cnblogs.com/wangqiguo/p/4355032.html
    // modified by: zzq
    // ref: https://www.cnblogs.com/zzqcn/p/4657124.html
    // modified by: fry
    function GenerateContentList() {
        var mainContent = $('#cnblogs_post_body');
        var h2_list = $('#cnblogs_post_body h2');//如果你的章节标题不是h2,只需要将这里的h2换掉即可

        if (mainContent.length < 1)
            return;

        if (h2_list.length > 0) {
            var content = '<a name="_labelTop"></a>';
            content += '<div id="navCategory">';
            content += '<p ><h2>目录</h2></p>';
            content += '<ul>';
            for ( var i = 0; i < h2_list.length; i++) {
                var go_to_top = '<div style="text-align: right"><a href="#_labelTop">回到顶部</a><a name="_label' + i + '"></a></div>'; //在h2上添加回到顶部
                $(h2_list[i]).before(go_to_top);

                var h3_list = $(h2_list[i]).nextAll("h3");
                var li3_content = '';
                for ( var j = 0; j < h3_list.length; j++) {
                    var tmp = $(h3_list[j]).prevAll('h2').first(); //找h3的所属父亲h2
                    if (!tmp.is(h2_list[i])) //如果h3不是当前这个h2的孩子
                        break;
                    var li3_anchor = '<a name="_label' + i + '_' + j + '"></a>'; //添加锚点
                    $(h3_list[j]).before(li3_anchor);
                    li3_content += '<li><a href="#_label' + i + '_' + j + '">'
                            + $(h3_list[j]).text() + '</a></li>'; //链接到锚点
                }

                var li2_content = '';
                if (li3_content.length > 0) //如果当前h2有h3,那么h2和h3的内容都加到目录
                    li2_content = '<li><a href="#_label' + i + '">'
                            + $(h2_list[i]).text() + '</a><ul>' + li3_content
                            + '</ul></li>';
                else
                    li2_content = '<li><a href="#_label' + i + '">'
                            + $(h2_list[i]).text() + '</a></li>';
                content += li2_content;
            }
            content += '</ul>';
            content += '</div><p>&nbsp;</p>';
            /* content += '<p style="font-size:18px"><b>正文</b></p>'; */
            if ($('#cnblogs_post_body').length != 0) {
                $($('#cnblogs_post_body')[0]).prepend(content);
            }
        } else { //当页面没有h2标签而有h3标签的时候：就去检索h3和h4
            var h3_list = $('#cnblogs_post_body h3'); //获取h3
            if (h3_list.length > 0) {
                var content = '<a name="_labelTop"></a>';
                content += '<div id="navCategory">';
                content += '<p ><h2>自动生成的目录</h2></p>';
                content += '<ul>';
                for ( var i = 0; i < h3_list.length; i++) {
                    var go_to_top = '<div style="text-align: right"><a href="#_labelTop">回到顶部</a><a name="_label' + i + '"></a></div>';
                    $(h3_list[i]).before(go_to_top); //在每个h3之前添加回到顶部

                    var h4_list = $(h3_list[i]).nextAll("h4"); //获取每个h3下面的h4
                    var li4_content = '';
                    for ( var j = 0; j < h4_list.length; j++) {
                        var tmp = $(h4_list[j]).prevAll('h3').first();
                        if (!tmp.is(h3_list[i]))
                            break;
                        var li4_anchor = '<a name="_label' + i + '_' + j + '"></a>'; //添加锚点
                        $(h4_list[j]).before(li4_anchor);
                        li4_content += '<li><a href="#_label' + i + '_' + j + '">'
                                + $(h4_list[j]).text() + '</a></li>'; //链接到锚点
                    }

                    var li3_content = '';
                    if (li4_content.length > 0)
                        li3_content = '<li><a href="#_label' + i + '">'
                                + $(h3_list[i]).text() + '</a><ul>'
                                + li4_content + '</ul></li>';
                    else
                        li3_content = '<li><a href="#_label' + i + '">'
                                + $(h3_list[i]).text() + '</a></li>';
                    content += li3_content;
                }
                content += '</ul>';
                content += '</div><p>&nbsp;</p>';
                /* content += '<p style="font-size:18px"><b>正文</b></p>'; */
                if ($('#cnblogs_post_body').length != 0) {
                    $($('#cnblogs_post_body')[0]).prepend(content);
                }

            }

        }

        var qqinfo = '<p style="text-align:right;color:navy;font-size:12px">讨论QQ群：********</p>';
        $(mainContent[0]).prepend(qqinfo);

        var title_h1 = $('#cnblogs_post_body h1');//将标题信息插入到开头
        $(mainContent[0]).prepend(title_h1[0]);
    }

    GenerateContentList();//运行这个js函数
</script>