PasseRR

xie__hai@sina.com

Confluence常用配置

10 May 2022 » operation

1. Confluence页面添加返回顶部

设置 -> 自定义HTML -> BODY尾部中添加如下代码。

<script type="text/javascript">
//<![CDATA[
AJS.toInit(function(){
    //If the scroll button doesn't exist add it and set up the listeners
    if(AJS.$('#scroll-top').length == 0) {
        AJS.$('#main-content').prepend('<button id="scroll-top" class="aui-button aui-button-primary scroll-top-button" style="display: none; position: fixed; bottom: 10px; right: 10px; z-index: 10;" title="返回顶部"><span class="aui-icon aui-icon-small aui-iconfont-chevron-up">Back to Top</span></button>');

        //Check to see if the window is top if not then display button
        AJS.$(window).scroll(function(){
            if (AJS.$(this).scrollTop() > 100) {
                AJS.$('#scroll-top').fadeIn();
            } else {
                AJS.$('#scroll-top').fadeOut();
            }
        });

        //Click event to scroll to top
        AJS.$('#scroll-top').click(function(){
            AJS.$('html, body').animate({scrollTop : 0}, 500);
            return false;
        });
    }
});
//]]>
</script>

top

2. 右侧浮动导航宏

设置 -> 用户宏 -> 创建用户宏,然后在编辑器中插入创建的宏。

## Macro title: toc-right
## Macro has a body:  N
##
## Developed by: Benjamin DUPUIS
## Date created: 05/08/2011
## Date Updated: 30/11/2016
## Installed by: Benjamin DUPUIS
## @param Maxlvl:title=MaxLvl|type=int|required=true|desc=Max Level|default=5
## @param Float:title=Float|type=boolean|required=true|desc=Float/Fixed Position|default=true
## @param Hidable:title=Hidable|type=boolean|required=true|desc=Hidable (Float menu only)|default=true

#set($globalHelper=$action.getHelper())
#if ($content.id == $globalHelper.getPage().id)
  #if (!$paramMaxlvl)
    #set ($paramMaxlvl=5)
  #end

  #set($mytoc=$globalHelper.renderConfluenceMacro("{toc:maxLevel=$paramMaxlvl}"))

  #if ($paramFloat == true)
    #if ($paramHidable == true)
      <div id="show_customtoc" style="right:15px; top:100px; position:fixed; z-index:99; margin-left:8px; padding:10px; background:#ae0015; border-radius: 3px; writing-mode: vertical-lr; display: none">
        <a style="color:white; cursor:pointer" onclick="jQuery('#customtoc').toggle(true); jQuery('#show_customtoc').toggle(false)">显示目录</a>
      </div>
    #end
  <div id="customtoc" style="right:25px; top:100px; position:fixed; max-height: 80%; z-index:99; overflow: auto; margin-left:8px;background:white;;opacity: .8">
  #else
    #if ($paramHidable == true)
      <div id="show_customtoc" style="float:right; margin-left:8px; padding:10px; background:#ae0015; border-radius: 3px; writing-mode: vertical-lr; display: none">
        <a style="color:white; cursor:pointer" onclick="jQuery('#customtoc').toggle(true); jQuery('#show_customtoc').toggle(false)">显示目录</a>
      </div>
    #end
  <div id="customtoc" style="float:right; margin-left:8px;background:white">
  #end
    <table>
      <thead>
        <tr>
         <th>目录
  #if ($paramHidable == true)
           <a style="margin: -5px; padding: 0; float: right; font-weight:bold; font-size:2em; line-height: 1em" onclick="jQuery('#customtoc').toggle(false); jQuery('#show_customtoc').toggle(true)">×</a>
  #end
         </th>
        </tr>
      </thead>
      <tbody>
        <tr>
           <td>
             $mytoc
           </td>
        </tr>
      </tbody>
    </table>
  </div>
</script>
#end

使用html宏实现

toc

3. 右侧导航插件(Easy Heading Macro)【推荐】

Easy Heading Macro

离线插件下载easy-heading-free-2.2.1.jar,上传插件安装就可以使用

插件目录可以使用wiki全局配置、按照空间配置、按照页面配置自由选择,并且支持内容按照标题展开、收起。

  • 配置wiki
    {easy-heading-free:selector=h1,h2,h3,h4,h5,h6|navigationTitle=目录|navigationExpandOption=expand-all-by-default}
    
  • 全局配置
    设置 -> 外观 -> 边栏/页眉及页脚,在页脚中添加配置wiki脚本
  • 空间配置
    空间管理 -> 外观 -> 侧边栏,页眉和页脚,在页脚中添加配置wiki脚本
  • 页面配置
    创建页面 -> 插入更多内容 -> 其他宏 -> 导航 -> Easy Heading Free
  • 配置参数说明

    参数名默认值描述
    enabledtrue是否启用宏
    selectorh1,h2,h3从h1到h6,标题选择器,逗号分隔
    titleExpandClickablefalse点击标题自动展开目录
    headingIndent20内容标题缩进像素
    expandOptionexpand-all-by-default内容标题展开方式,可选值expand-all-by-default、collapse-all-by-default、collapse-all-but-headings-1、collapse-all-but-headings-1-2、collapse-all-but-headings-1-3、collapse-all-but-headings-1-4、disable-expand-collapse
    useNavigationtrue是否浮动目录
    useNavigationHiddenModefalse首次进入目录是否隐藏
    wrapNavigationTextfalse若标题超过限定长度是否自动截断,false截断,true不截断
    navigationTitleTable of Content目录名称
    navigationWidth230目录宽度像素
    navigationIndent10标题目录不同级别的缩进像素
    navigationExpandOptionexpand-all-by-default导航目录展开方式,可选值expand-all-by-default、collapse-all-by-default、collapse-all-but-headings-1、collapse-all-but-headings-1-2、collapse-all-but-headings-1-3、collapse-all-but-headings-1-4、disable-expand-collapse
    disableNavLinksUnder0当标题少于多少个时目录不可用

plugin

4. confluence多个地址访问时提示Your URL doesn’t match

confluence只能设置一个基础url,当confluence通过内网或外网ip访问时,每当访问任意页面时会提示Your URL doesn’t match, 为了避免这种情况,通过修改Confluence Base URL Plugin插件配置。

设置 -> 插件管理 -> 系统 -> Confluence Base URL Plugin -> 禁用模块Base URL plugin filter