Pular para o conteúdo principal
API PDF4meIntegraçõesBase de conhecimentoExtensõesTestador de APIBlog

Word Sintaxe de Modelo - Guia de Campos de Mesclagem

A geração de documentos por meio de mala direta é o processo de leitura de dados de uma fonte de dados e substituição das variáveis correspondentes em um documento modelo. Essa abordagem agiliza a criação de documentos personalizados em larga escala, combinando conteúdo fixo com dados dinâmicos.

Entendendo os modelos de mala direta​

Um processo típico de mala direta requer dois componentes essenciais:

  1. Documento Modelo - Contém campos de mesclagem (variáveis) que serão substituídos por dados reais.
  2. Fonte de dados - Contém instruções de formatação e informações que permanecem idênticas em todos os documentos gerados.

PDF4me Suporta vários formatos de modelo, incluindo Word, HTML, e PDF documentos, proporcionando flexibilidade na forma como você cria e estrutura seus modelos de documentos.

Sintaxe básica de campos de mesclagem​

Para criar campos de mesclagem em seu Word Para os modelos, utilize a seguinte sintaxe:

<<[FieldName]>>

Essa sintaxe define marcadores de posição em seu modelo que serão substituídos por dados reais durante o processo de geração do documento.

Criação manual de campos de mesclagem​

Você pode inserir campos de mesclagem manualmente diretamente no seu Word Documente digitando a sintaxe mostrada acima. O nome do campo deve corresponder à propriedade correspondente em sua fonte de dados.

campo de mesclagem manual

Exemplo de uso​

Modelo:

Dear <<[CustomerName]>>,

Thank you for your order #<<[OrderNumber]>>.

Fonte de dados (JSON):

{
  "CustomerName": "John Smith",
  "OrderNumber": "12345"
}

Resultado gerado:

Dear John Smith,

Thank you for your order #12345.

Melhores práticas de design de modelos​

Convenções de nomenclatura de campos​

  • Use nomes de campos descritivos e significativos.
  • Siga padrões de nomenclatura consistentes (por exemplo, camelCase ou PascalCase).
  • Evite caracteres especiais nos nomes dos campos.
  • Mantenha os nomes dos campos concisos, porém claros.

Organização de modelos​

  • Estruture seu modelo logicamente antes de adicionar campos de mesclagem.
  • Aplique a formatação aos campos mesclados no próprio modelo.
  • Teste os modelos com dados de exemplo antes de usá-los em produção.
  • Manter versões de modelos para diferentes tipos de documentos.

Formatos de modelo suportados​

PDF4me Aceita os seguintes formatos de modelo para geração de documentos:

  • Word Documentos (.docx, .doc) - Suporte completo para Word sintaxe do modelo
  • HTML Modelos (.html) - Estruturas de modelos baseadas na Web
  • PDF Modelos (.pdf) - Baseado em formulário PDF modelos

Cada formato suporta a mesma sintaxe de campos de mesclagem, garantindo consistência entre diferentes tipos de modelos.

Próximos passos​

Agora que você entende a sintaxe básica, explore os recursos avançados do modelo:

Recursos relacionados​

Document Generation APIGet Started with PDF4me

:::dica Criando Modelos Avançados Para obter orientações detalhadas sobre como criar modelos sofisticados Word Para obter modelos com recursos avançados, consulte nossa documentação completa de modelos nas seções a seguir. :::