跳到主要内容
PDF4me API集成知识库扩展API 测试员博客

模板中的超链接 - 动态链接指南

超链接已成为现代文档的重要组成部分，出现在发票、合同、报价单、法律文件、报告和各种商业通信中。 PDF4me 可在生成的文档中动态插入超链接，从而创建交互式、联网文档。

超链接语法​

使用以下模板语法在文档中插入可点击的超链接：

<<link[linkUrl][linkDisplay]>>

成分：

  • linkUrl 目标 URL 或网址
  • linkDisplay 点击链接时显示的文本

基本超链接示例​

简单链接插入​

模板语法：

Visit our website: <<link[websiteUrl][companyName]>>

数据源（JSON）：

{
  "websiteUrl": "https://dev.pdf4me.com/",
  "companyName": "PDF4me API Website"
}

生成的输出：

Visit our website: PDF4me API Website

（在哪里 ”PDF4me API “网站”是一个可点击的链接 https://dev.pdf4me.com/）

多个超链接​

使用不同的数据字段在文档中生成多个超链接。

示例：联系信息​

模板：

Website: <<link[website][websiteName]>>
Support Portal: <<link[supportUrl][supportText]>>
Documentation: <<link[docsUrl][docsText]>>

数据：

{
  "website": "https://pdf4me.com/",
  "websiteName": "PDF4me Homepage",
  "supportUrl": "https://dev.pdf4me.com/support/",
  "supportText": "Contact Support",
  "docsUrl": "https://dev.pdf4me.com/documentation/",
  "docsText": "View Documentation"
}

表格中的超链接​

将超链接与表格结构结合起来，可以更清晰地展示链接。

资源表示例​

模板：

Resource | Link
<<foreach [resource in resources]>>
<<[resource.name]>> | <<link[resource.url][resource.linkText]>>
<</foreach>>

数据：

{
  "resources": [
    {
      "name": "API Documentation",
      "url": "https://dev.pdf4me.com/documentation/",
      "linkText": "View Docs"
    },
    {
      "name": "Support Center",
      "url": "https://dev.pdf4me.com/support/",
      "linkText": "Get Help"
    },
    {
      "name": "Code Samples",
      "url": "https://github.com/pdf4me/samples",
      "linkText": "Browse Code"
    }
  ]
}

动态的 URL 建造​

建造 URLs 使用表达式和连接进行动态操作。

示例：产品链接​

模板：

<<foreach [product in products]>>
Product: <<[product.name]>>
View Details: <<link["https://example.com/product/" + product.id][product.name]>>
<</foreach>>

示例：电子邮件链接​

模板：

Contact: <<link["mailto:" + employee.email][employee.name]>>

数据：

{
  "employee": {
    "name": "John Smith",
    "email": "[email protected]"
  }
}

输出：

Contact: John Smith

（点击后将打开电子邮件客户端，并显示模板中的地址。）

条件超链接​

仅当满足特定条件时才显示超链接。

示例：可选网站链接​

模板：

<<if [websiteUrl != null]>>
Visit us: <<link[websiteUrl][websiteName]>>
<</if>>

使用 Foreach 循环的模板：

<<foreach [contact in contacts]>>
<<[contact.name]>>
<<if [contact.website != null]>> - <<link[contact.website]["Visit Website"]>><</if>>
<</foreach>>

格式化显示文本​

对样式链接的超链接显示文本应用文本格式。

例如：大写链接​

模板：

Visit: <<link[url][companyName:caps]>>

数据：

{
  "url": "https://pdf4me.com",
  "companyName": "pdf4me solutions"
}

输出：

Visit: Pdf4me Solutions

（需正确使用大写字母并添加可点击链接）

常见用例​

发票页脚链接​

模板：

Questions? Visit our FAQ: <<link[faqUrl]["FAQ Page"]>>
Payment Portal: <<link[paymentUrl]["Pay Invoice"]>>
Contact Support: <<link["mailto:" + supportEmail]["Email Support"]>>

报告参考文献​

模板：

Data Sources:
<<foreach [source in dataSources]>>
- <<[source.name]>>: <<link[source.url][source.description]>>
<</foreach>>

产品目录​

模板：

<<foreach [product in products]>>
Product Name: <<[product.name]>>
Price: $<<[product.price]>>
More Info: <<link[product.detailsUrl]["View Details"]>>

<</foreach>>

超链接最佳实践​

URL 管理​

  1. 证实 URLs - 确保 URLs 在传递给模板之前，请确保格式正确。
  2. 使用 HTTPS - 优先选择安全措施 HTTPS URLs 尽可能
  3. 简短显示文本 链接文本应简洁明了、描述性强。
  4. 测试链接 - 验证所有生成的链接是否有效

链接样式​

  1. 统一的格式 - 在整个文档中使用类似的链接文本模式
  2. 清晰的语境 - 从显示文本中明确链接用途
  3. 视觉区分 确保链接在视觉上易于区分（通常是自动的）

数据准备​

  1. 对特殊字符进行编码 - 处理特殊字符 URLs 适当地
  2. 提供默认值 - 为缺失值设置备用值 URL 数据
  3. 验证 - 证实 URL 在模板处理之前，请先在应用程序中设置格式。

支持的超链接类型​

网页链接​

<<link["https://example.com"]["Visit Website"]>>

电子邮件链接​

<<link["mailto:[email protected]"]["Email Us"]>>

请使用您自己的电子邮件地址或占位符；避免在模板中使用原始的支持/联系电子邮件地址，以防止某些主机上的链接失效。

文档链接​

<<link["file:///path/to/document.pdf"]["View PDF"]>>

电话链接（适用于兼容的查看器）​

<<link["tel:+1234567890"]["Call Us"]>>

故障排除​

常见问题​

问题： 生成的文档中链接无法点击。
解决方案： 验证语法是否完全匹配： <<link[url][text]>>

问题： 破碎的 URLs 输出
解决方案： 检查特殊字符；编码 URLs 适当地

问题： 显示文本显示合并字段语法
解决方案： 确保关闭 >> 括号已存在

问题： 链接以纯文本形式显示。
解决方案： 验证文档查看器是否支持超链接。

完整示例：客户沟通​

模板：

Dear <<[customerName]>>,

Thank you for your recent purchase. Your order details are available at:
<<link[orderTrackingUrl]["Track Your Order"]>>

For assistance, please visit:
- Help Center: <<link[helpUrl]["Get Help"]>>
- Email Support: <<link["mailto:" + supportEmail]["Contact Support"]>>
- Live Chat: <<link[chatUrl]["Start Chat"]>>

Best regards,
<<[companyName]>>

数据：

{
  "customerName": "John Smith",
  "orderTrackingUrl": "https://example.com/track/12345",
  "helpUrl": "https://example.com/help",
  "supportEmail": "[email protected]",
  "chatUrl": "https://example.com/chat",
  "companyName": "Acme Corporation"
}

:::提示 链接测试

务必使用实际的超链接测试生成的文档，以确保它们在不同环境下都能正常工作。 PDF 观看者和平台。某些观看者对特定链接类型的处理方式可能有所不同。

:::