Passa al contenuto principale
PDF4me APIIntegrazioniBase di conoscenzaEstensioniTester APIBlog

Collegamenti ipertestuali nei modelli - Guida ai collegamenti dinamici

I collegamenti ipertestuali sono diventati componenti essenziali dei documenti moderni, comparendo in fatture, contratti, preventivi, documenti legali, report e varie comunicazioni aziendali. PDF4me Consente l'inserimento dinamico di collegamenti ipertestuali all'interno dei documenti generati, permettendo di creare documentazione interattiva e connessa al web.

Sintassi del collegamento ipertestuale​

Inserisci collegamenti ipertestuali cliccabili nei tuoi documenti utilizzando la seguente sintassi:

<<link[linkUrl][linkDisplay]>>

Componenti:

  • linkUrl - L'obiettivo URL o indirizzo web
  • linkDisplay - Il testo visualizzato per il link cliccabile

Esempio di collegamento ipertestuale di base​

Sintassi del modello:

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

Fonte dati (JSON):

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

Output generato:

Visit our website: PDF4me API Website

(Dove "PDF4me API "Sito Web" è un collegamento cliccabile a https://dev.pdf4me.com/)

molteplici collegamenti ipertestuali​

Genera più collegamenti ipertestuali all'interno di un documento utilizzando diversi campi dati.

Esempio: Informazioni di contatto​

Modello:

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

Dati:

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

Collegamenti ipertestuali nelle tabelle​

Combina i collegamenti ipertestuali con le strutture tabellari per una presentazione organizzata dei link.

Esempio di tabella delle risorse​

Modello:

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

Dati:

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

Dinamico URL Costruzione​

Costruire URLs in modo dinamico utilizzando espressioni e concatenazione.

Esempio: collegamenti ai prodotti​

Modello:

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

Esempio: collegamenti e-mail​

Modello:

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

Dati:

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

Produzione:

Contact: John Smith

(Cliccando si apre il client di posta elettronica con l'indirizzo presente nel modello.)

Collegamenti ipertestuali condizionali​

Visualizza i collegamenti ipertestuali solo quando vengono soddisfatte determinate condizioni.

Esempio: collegamento facoltativo al sito web​

Modello:

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

Modello con ciclo Foreach:

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

Testo formattato​

Applica la formattazione del testo al testo visualizzato dei collegamenti ipertestuali per i collegamenti stilizzati.

Modello:

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

Dati:

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

Produzione:

Visit: Pdf4me Solutions

(Con la corretta capitalizzazione e il link cliccabile)

Casi d'uso comuni​

Modello:

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

Riferimenti al rapporto​

Modello:

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

Catalogo prodotti​

Modello:

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

<</foreach>>

Migliori pratiche per i collegamenti ipertestuali​

URL Gestione​

  1. Convalidare URLs - Garantire URLs vengono formattati correttamente prima di essere passati ai modelli
  2. Utilizzo HTTPS - Preferisci la sicurezza HTTPS URLs ove possibile
  3. Testo breve da visualizzare - Mantieni il testo del link conciso e descrittivo
  4. Link di prova - Verificare che tutti i link generati funzionino correttamente

Stile del collegamento​

  1. Formattazione coerente - Utilizzare modelli di testo per i link simili in tutti i documenti
  2. Contesto chiaro - Rendere chiaro lo scopo del collegamento dal testo visualizzato
  3. distinzione visiva - Assicurarsi che i collegamenti siano visivamente distinguibili (di solito in modo automatico)

Elaborazione dei dati​

  1. Codifica i caratteri speciali - Gestire i caratteri speciali in URLs correttamente
  2. Fornire valori predefiniti - Avere valori di fallback per i valori mancanti URL dati
  3. Validazione - Convalida URL formati nella tua applicazione prima dell'elaborazione del modello

Tipi di collegamenti ipertestuali supportati​

Collegamenti web​

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

Collegamenti e-mail​

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

Utilizza il tuo indirizzo email o un indirizzo segnaposto; evita di inserire indirizzi email di supporto/contatto non elaborati nei modelli per prevenire link non funzionanti su alcuni host.

Collegamenti ai documenti​

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

Collegamenti telefonici (per visualizzatori compatibili)​

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

Risoluzione dei problemi​

Problemi comuni​

Problema: I link non sono cliccabili nel documento generato.
Soluzione: Verificare che la sintassi corrisponda esattamente: <<link[url][text]>>

Problema: Rotto URLs in output
Soluzione: Verifica la presenza di caratteri speciali; codifica URLs correttamente

Problema: Il testo visualizzato mostra la sintassi del campo di unione
Soluzione: Assicurarsi della chiusura >> sono presenti parentesi

Problema: I link vengono visualizzati come testo semplice
Soluzione: Verificare che il visualizzatore di documenti supporti i collegamenti ipertestuali.

Esempio completo: Comunicazione con il cliente​

Modello:

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

Dati:

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

:::suggerimento per il test dei link Testa sempre i documenti generati con collegamenti ipertestuali reali per assicurarti che funzionino correttamente su diversi dispositivi. PDF Visualizzatori e piattaforme. Alcuni visualizzatori potrebbero gestire determinati tipi di link in modo diverso.

:::