Hyperlinks in Vorlagen – Leitfaden für dynamische Links

Hyperlinks sind zu unverzichtbaren Bestandteilen moderner Dokumente geworden und finden sich in Rechnungen, Verträgen, Angeboten, juristischen Dokumenten, Berichten und verschiedenen Geschäftskorrespondenzen. PDF4me Ermöglicht das dynamische Einfügen von Hyperlinks in generierte Dokumente und erlaubt Ihnen so die Erstellung interaktiver, webbasierter Dokumentationen.

---

Hyperlink-Syntax

Fügen Sie anklickbare Hyperlinks mithilfe der folgenden Vorlagensyntax in Ihre Dokumente ein:

<<link[linkUrl][linkDisplay]>>

Komponenten:

• linkUrl - Das Ziel URL oder Webadresse
• linkDisplay - Der Text, der für den anklickbaren Link angezeigt wird

---

Einfaches Hyperlink-Beispiel

Einfache Link-Einfügung

Vorlagensyntax:

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

Datenquelle (JSON):

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

Generierte Ausgabe:

Visit our website: PDF4me API Website

(Wo "PDF4me API „Website“ ist ein anklickbarer Link zu https://dev.pdf4me.com/)

---

Mehrere Hyperlinks

Erzeugen Sie mehrere Hyperlinks innerhalb eines Dokuments mithilfe verschiedener Datenfelder.

Beispiel: Kontaktinformationen

Vorlage:

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

Daten:

{
  "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"
}

---

Hyperlinks in Tabellen

Kombinieren Sie Hyperlinks mit Tabellenstrukturen für eine übersichtliche Linkdarstellung.

Beispiel einer Ressourcentabelle

Vorlage:

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

Daten:

{
  "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"
    }
  ]
}

---

Dynamisch URL Konstruktion

Bauen URLs dynamisch unter Verwendung von Ausdrücken und Verkettung.

Beispiel: Produktlinks

Vorlage:

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

Beispiel: E-Mail-Links

Vorlage:

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

Daten:

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

Ausgabe:

Contact: John Smith

(Durch Klicken öffnet sich ein E-Mail-Client mit der Adresse aus der Vorlage.)

---

Bedingte Hyperlinks

Hyperlinks werden nur angezeigt, wenn bestimmte Bedingungen erfüllt sind.

Beispiel: Optionaler Website-Link

Vorlage:

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

Vorlage mit Foreach:

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

---

Formatierter Anzeigetext

Wenden Sie Textformatierung auf den Anzeigetext von Hyperlinks für formatierte Links an.

Beispiel: Großgeschriebene Links

Vorlage:

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

Daten:

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

Ausgabe:

Visit: Pdf4me Solutions

(Mit korrekter Groß- und Kleinschreibung und anklickbarem Link)

---

Häufige Anwendungsfälle

Rechnungsfußzeile mit Links

Vorlage:

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

---

Berichtsreferenzen

Vorlage:

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

---

Produktkatalog

Vorlage:

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

<</foreach>>

---

Best Practices für Hyperlinks

URL Management

1. Validieren URLs - Sicherstellen URLs werden vor der Übergabe an die Vorlagen korrekt formatiert.
2. Verwenden HTTPS - Sicher bevorzugen HTTPS URLs wo möglich
3. Kurzer Anzeigetext - Halten Sie den Linktext kurz und aussagekräftig.
4. Testlinks - Überprüfen Sie, ob alle generierten Links korrekt funktionieren.

Link-Styling

1. Einheitliche Formatierung - Verwenden Sie in allen Dokumenten ähnliche Linktextmuster.
2. Klarer Kontext - Machen Sie den Zweck des Links aus dem Anzeigetext deutlich.
3. Visuelle Unterscheidung - Sicherstellen, dass die Links optisch unterscheidbar sind (in der Regel automatisch)

Datenaufbereitung

1. Sonderzeichen kodieren - Sonderzeichen behandeln in URLs richtig
2. Standardwerte bereitstellen - Für fehlende Werte Ausweichwerte festlegen URL Daten
3. Validierung - Validieren URL Formate in Ihrer Anwendung vor der Vorlagenverarbeitung

---

Unterstützte Hyperlink-Typen

Weblinks

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

E-Mail-Links

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

Verwenden Sie Ihre eigene E-Mail-Adresse oder einen Platzhalter; vermeiden Sie unformatierte Support-/Kontakt-E-Mail-Adressen in Vorlagen, um defekte Links bei einigen Hosting-Anbietern zu verhindern.

Dokumentenlinks

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

Telefon-Links (für kompatible Anzeigegeräte)

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

---

Fehlerbehebung

Häufige Probleme

Ausgabe: Links im generierten Dokument nicht anklickbar
Lösung: Überprüfen Sie, ob die Syntax exakt übereinstimmt: <<link[url][text]>>

Ausgabe: Gebrochen URLs in der Ausgabe
Lösung: Auf Sonderzeichen prüfen; kodieren URLs richtig

Ausgabe: Der Anzeigetext zeigt die Syntax für Seriendruckfelder an.
Lösung: Sicherstellen, dass der Abschluss abgeschlossen ist >> Klammern sind vorhanden

Ausgabe: Links werden als Klartext angezeigt
Lösung: Prüfen Sie, ob der Dokumentenbetrachter Hyperlinks unterstützt.

---

Vollständiges Beispiel: Kundenkommunikation

Vorlage:

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]>>

Daten:

{
  "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"
}

---

:::Tipp Linktest Testen Sie generierte Dokumente immer mit echten Hyperlinks, um sicherzustellen, dass sie auf verschiedenen Plattformen korrekt funktionieren. PDF Zuschauer und Plattformen. Manche Zuschauer verarbeiten bestimmte Linktypen anders.

:::