Aller au contenu principal
API PDF4meIntégrationsBase de connaissancesExtensionsTesteur d'APIBlog

Hyperliens dans les modèles - Guide des liens dynamiques

Les hyperliens sont devenus des éléments essentiels des documents modernes ; on les retrouve dans les factures, les contrats, les devis, les documents juridiques, les rapports et diverses communications commerciales. PDF4me permet l'insertion dynamique de liens hypertextes dans les documents générés, vous permettant ainsi de créer une documentation interactive et connectée au Web.

Syntaxe des hyperliens​

Insérez des hyperliens cliquables dans vos documents en utilisant la syntaxe de modèle suivante :

<<link[linkUrl][linkDisplay]>>

Composants :

  • linkUrl - La cible URL ou adresse web
  • linkDisplay - Le texte affiché pour le lien cliquable

Exemple de lien hypertexte basique​

Insertion de lien simple​

Syntaxe du modèle :

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

Source de données (JSON) :

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

Résultat généré :

Visit our website: PDF4me API Website

(Où "PDF4me API « Site Web » est un lien cliquable vers https://dev.pdf4me.com/)

Liens hypertextes multiples​

Générez plusieurs hyperliens au sein d'un document en utilisant différents champs de données.

Exemple : Informations de contact​

Modèle:

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

Données:

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

Liens hypertextes dans les tableaux​

Combinez les hyperliens avec des structures de tableau pour des présentations de liens organisées.

Exemple de tableau de ressources​

Modèle:

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

Données:

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

Dynamique URL Construction​

Construire URLs dynamiquement à l'aide d'expressions et de concaténation.

Exemple : Liens vers les produits​

Modèle:

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

Exemple : Liens de messagerie​

Modèle:

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

Données:

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

Sortir:

Contact: John Smith

(Un clic ouvre le client de messagerie avec l'adresse du modèle.)

Liens hypertextes conditionnels​

Afficher les liens hypertextes uniquement lorsque certaines conditions sont remplies.

Exemple : Lien vers un site Web (facultatif)​

Modèle:

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

Modèle avec Foreach :

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

Texte d'affichage formaté​

Appliquer une mise en forme au texte affiché des liens hypertextes stylisés.

Exemple : Liens en majuscules​

Modèle:

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

Données:

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

Sortir:

Visit: Pdf4me Solutions

(Avec une mise en majuscules correcte et un lien cliquable)

Cas d'utilisation courants​

Pied de page de facture avec liens​

Modèle:

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

Références du rapport​

Modèle:

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

Catalogue de produits​

Modèle:

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

<</foreach>>

Meilleures pratiques en matière de liens hypertextes​

URL Gestion​

  1. Valider URLs - Assurer URLs sont correctement formatés avant d'être transmis aux modèles
  2. Utiliser HTTPS - Privilégier la sécurité HTTPS URLs lorsque possible
  3. Texte court affiché - Veillez à ce que le texte des liens soit concis et descriptif.
  4. Liens de test - Vérifiez que tous les liens générés fonctionnent correctement.

Style de lien​

  1. Mise en forme cohérente - Utilisez des modèles de texte de lien similaires dans tous les documents.
  2. Contexte clair - Indiquez clairement l'objectif du lien dans le texte affiché.
  3. distinction visuelle - S'assurer que les liens sont visuellement distincts (généralement automatique)

Préparation des données​

  1. Encoder les caractères spéciaux - Gérer les caractères spéciaux dans URLs correctement
  2. Fournir des valeurs par défaut - Prévoir des valeurs de repli pour les valeurs manquantes URL données
  3. Validation - Valider URL formatez votre application avant le traitement du modèle

Types de liens hypertextes pris en charge​

Liens Web​

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

Liens de messagerie​

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

Utilisez votre propre adresse e-mail ou une adresse e-mail générique ; évitez d’utiliser des adresses e-mail brutes pour le support ou les contacts dans les modèles afin d’éviter les liens brisés chez certains hébergeurs.

Liens vers les documents​

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

Liens téléphoniques (pour les visionneuses compatibles)​

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

Dépannage​

Problèmes courants​

Problème: Liens non cliquables dans le document généré
Solution: Vérifiez que la syntaxe correspond exactement : <<link[url][text]>>

Problème: Cassé URLs en sortie
Solution: Vérifier la présence de caractères spéciaux ; encoder URLs correctement

Problème: Le texte affiché indique la syntaxe du champ de fusion
Solution: Assurez-vous de la fermeture >> des parenthèses sont présentes

Problème: Les liens s'affichent en texte brut
Solution: Vérifiez que la visionneuse de documents prend en charge les hyperliens.

Exemple complet : Communication avec les clients​

Modèle:

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

Données:

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

:::conseil Test des liens

Testez systématiquement les documents générés avec de véritables liens hypertextes pour vous assurer de leur bon fonctionnement sur différents supports. PDF Certains utilisateurs et plateformes peuvent gérer différemment certains types de liens.

:::