如何在ReportLab生成的PDF页脚添加返回目录的可点击超链接

问题说明 #

现有基于ReportLab的PDF生成代码已实现基础模板（包含目录、页码页脚等），需要在每一页（除首页外）的页脚左侧添加可点击的“返回目录”文本，点击后跳转至文档目录页。

解决方案 #

步骤1：给目录页添加唯一书签 #

要实现跳转，首先需要给目录所在页面标记一个唯一书签，后续链接可通过该书签定位目录页。在MyDocTemplate类的afterFlowable方法中，增加对目录组件的判断逻辑：

def afterFlowable(self, flowable):
        "Registers TOC entries."
        if flowable.__class__.__name__ == 'Paragraph':
            text = flowable.getPlainText()
            style = flowable.style.name
            if style == 'Heading1':
                self.notify('TOCEntry', (0, text, self.page))
            if style == 'Heading2':
                key = 'h2-%s' % self.seq.nextf('heading2')
                self.canv.bookmarkPage(key)
                self.notify('TOCEntry', (1, text, self.page, key))
            if style == 'Heading3':
                key = 'h3-%s' % self.seq.nextf('heading3')
                self.canv.bookmarkPage(key)
                self.notify('TOCEntry', (2, text, self.page, key))
        # 新增：给目录页添加书签
        elif flowable.__class__.__name__ == 'TableOfContents':
            self.canv.bookmarkPage('toc_bookmark')

步骤2：在页脚绘制可点击文本 #

修改FooterCanvas类的draw_canvas方法，添加代码绘制带跳转功能的“返回目录”文本：

• 设置蓝色字体模拟超链接样式
• 在页脚左侧固定位置绘制文本
• 创建覆盖文本区域的跳转链接，指向目录页的书签

修改后的draw_canvas方法：

def draw_canvas(self, page_count):
        page = f"Page {self._pageNumber} of {page_count}"
        x = 128
        self.saveState()
        self.setStrokeColorRGB(0, 0, 0)
        self.setLineWidth(0.5)
        self.line(66, 78, LETTER[0] - 66, 78)
        self.setFont('Helvetica', 10)
        # 绘制可点击的返回目录文本
        self.setFillColor(colors.blue)
        back_to_toc_text = "返回目录"
        text_x = 66
        text_y = 65
        self.drawString(text_x, text_y, back_to_toc_text)
        # 添加跳转链接，覆盖文本区域
        text_width = self.stringWidth(back_to_toc_text, 'Helvetica', 10)
        self.linkAbsolute(back_to_toc_text, destination='toc_bookmark', 
                          rect=(text_x, text_y-2, text_x+text_width, text_y+8),
                          relative=0)
        # 恢复默认颜色绘制页码
        self.setFillColorRGB(0,0,0)
        self.drawString(LETTER[0]-x, 65, page)
        self.restoreState()

修改后的完整代码 #

from datetime import datetime
from reportlab.pdfgen import canvas
from reportlab.platypus.doctemplate import PageTemplate, BaseDocTemplate
from reportlab.platypus.frames import Frame
from reportlab.lib.units import cm
from reportlab.platypus import Paragraph, Spacer, PageBreak
from reportlab.platypus.tableofcontents import TableOfContents
from reportlab.lib.styles import getSampleStyleSheet, ParagraphStyle
from reportlab.lib import colors
from reportlab.lib.pagesizes import LETTER


class FooterCanvas(canvas.Canvas):

    def __init__(self, *args, **kwargs):
        canvas.Canvas.__init__(self, *args, **kwargs)
        self.pages = []

    def showPage(self):
        self.pages.append(dict(self.__dict__))
        self._startPage()

    def save(self):
        page_count = len(self.pages)
        for page in self.pages:
            self.__dict__.update(page)
            if (self._pageNumber > 1):
                self.draw_canvas(page_count)
            canvas.Canvas.showPage(self)
        canvas.Canvas.save(self)

    def draw_canvas(self, page_count):
        page = f"Page {self._pageNumber} of {page_count}"
        x = 128
        self.saveState()
        self.setStrokeColorRGB(0, 0, 0)
        self.setLineWidth(0.5)
        self.line(66, 78, LETTER[0] - 66, 78)
        self.setFont('Helvetica', 10)
        # 绘制可点击的返回目录文本
        self.setFillColor(colors.blue)
        back_to_toc_text = "返回目录"
        text_x = 66
        text_y = 65
        self.drawString(text_x, text_y, back_to_toc_text)
        # 添加跳转链接，覆盖文本区域
        text_width = self.stringWidth(back_to_toc_text, 'Helvetica', 10)
        self.linkAbsolute(back_to_toc_text, destination='toc_bookmark', 
                          rect=(text_x, text_y-2, text_x+text_width, text_y+8),
                          relative=0)
        # 恢复默认颜色绘制页码
        self.setFillColorRGB(0,0,0)
        self.drawString(LETTER[0]-x, 65, page)
        self.restoreState()


class MyDocTemplate(BaseDocTemplate):

    def __init__(self, filename, **kw):
        self.allowSplitting = 0
        BaseDocTemplate.__init__(self, filename, **kw)
        template = PageTemplate('normal', [Frame(2.5*cm, 2.5*cm, 15*cm, 25*cm, id='F1')])
        self.addPageTemplates(template)


    def afterFlowable(self, flowable):
            "Registers TOC entries."
            if flowable.__class__.__name__ == 'Paragraph':
                text = flowable.getPlainText()
                style = flowable.style.name
                if style == 'Heading1':
                    self.notify('TOCEntry', (0, text, self.page))
                if style == 'Heading2':
                    key = 'h2-%s' % self.seq.nextf('heading2')
                    self.canv.bookmarkPage(key)
                    self.notify('TOCEntry', (1, text, self.page, key))
                if style == 'Heading3':
                    key = 'h3-%s' % self.seq.nextf('heading3')
                    self.canv.bookmarkPage(key)
                    self.notify('TOCEntry', (2, text, self.page, key))
            # 给目录页添加书签
            elif flowable.__class__.__name__ == 'TableOfContents':
                self.canv.bookmarkPage('toc_bookmark')


timestamp_now = datetime.now().strftime("%Y-%m-%dT%H_%M_%S")
date_now = datetime.now().strftime("%d.%m.%Y")

doc = MyDocTemplate(
  filename="mydoc.pdf",
  author="Person A"
  )

# Define styles
styles = getSampleStyleSheet()

content = []

# Add title to the PDF
title = Paragraph(text="My Document", style=styles["Title"])
content.append(title)

content.append(Spacer(width=0 * cm, height=15 * cm))
content.append(Paragraph(text="Authors", style=styles['h4']))
for author in ["Person A", "Person B", "Person C"]:
        author_para = Paragraph(author, styles["Italic"])
        content.append(author_para)


content.append(Spacer(width=0 * cm, height=4 * cm))
date_para = Paragraph(
  text=f"Document Compiled on {date_now}",
  style=ParagraphStyle(name='centered_date', parent=styles["h4"], alignment=1)
)
content.append(date_para)

# Add a table of contents
content.append(PageBreak())
toc = TableOfContents()


toc.levelStyles = [
  toc.getLevelStyle(0),
  ParagraphStyle(name='blue_hyperlinks', parent=toc.getLevelStyle(1), textColor=colors.blue),
  ParagraphStyle(name='blue_hyperlinks', parent=toc.getLevelStyle(2), textColor=colors.blue)
  ]


content.append(toc)

content.append(PageBreak())
content.append(Paragraph(text="This is an h1 heading", style=styles['Heading1']))
content.append(Paragraph(text="This is an h2 heading", style=styles['Heading2']))

content.append(PageBreak())
content.append(Paragraph(text="This is an h3  heading", style=styles['Heading3']))

content.append(PageBreak())
content.append(Paragraph(text="This is an h2  heading", style=styles['Heading2']))
content.append(Paragraph(text="This is an h3  heading", style=styles['Heading3']))

doc.multiBuild(story=content, canvasmaker=FooterCanvas)

说明 #

• 书签toc_bookmark会自动绑定到目录所在页面，无需手动指定页码
• 页脚左侧的蓝色“返回目录”文本点击后直接跳转至目录页
• 链接区域覆盖文本上下少量留白，提升点击体验

内容的提问来源于stack exchange，提问作者Oliver Angelil