Referência de saída do Microsoft Word para projetar modelos

Revise estas informações para aprender mais sobre como gerar documentos do Microsoft Word com o Rational Publishing Engine.

Finalidade

Para gerar saída do modelo para os seguintes documentos:
Extensão Formato do documento gerado
.doc Microsoft Word Binary Document 1997-2003, 2007, 2010 ou 2013
.docx Microsoft Word 2007, 2010 ou 2013, sem a capacidade de executar macros
.docm Microsoft Word 2007, 2010, ou 2013, com a capacidade de executar macros

Visualizadores de conteúdo suportados

Para obter uma lista dos produtos suportados para visualização desse tipo de saída:
  1. Abra o Requisitos do sistema .
  2. Na seção Por Tipo, clique em Software.
  3. Role para a seção Visualizadores de Conteúdo. São listados os nomes e versões dos produtos que são suportados para visualização da saída da Rational Publishing Engine.

O driver PDF padrão produz arquivos PDF da versão 1.5. O driver PDF anterior não é mais suportado. Se sua especificação de documento apontar para o driver PDF anterior, modifique a especificação para se referir ao driver PDF padrão.

Elementos do Modelo

Tabela 1. Elementos do modelo disponíveis para uso para o formato de saída do Microsoft Word
Element Descrição Pode conter outros elementos Pode conter valores de conteúdo e expressões

ícone Parágrafo Parágrafo

Use para agrupar uma seção de elementos. Inclui um retorno de linha em seus elementos filhos na saída.

Sim

No

ícone Contêiner Contêiner

Use para agrupar uma seção de elementos. Não pode ser estilizado e não afeta a formatação da saída.

Quando usados em outros elementos, os elementos filhos disponíveis para uso no contêiner podem ser limitados. Por exemplo:
  • Em linhas, os contêineres podem hospedar apenas células
  • Em listas, os contêineres podem hospedar apenas elementos de detalhes da lista de hosts

Sim

No

ícone Texto Texto

O conteúdo é renderizado com a mesma formatação especificada.

No

Sim

ícone Texto estilizado Texto estilizado

Um bloco de texto que pode ter formatação exclusiva em palavras individuais. Use negrito, itálico, sublinhado, riscado ou formatação de cor em uma seleção de palavras no elemento. O texto é estático.

No

Sim

ícone Hiperlink Hiperlink

Cria um hiperlink na saída. O hiperlink pode apontar para um local dentro do documento ou para um local externo.

No

Sim

ícone Imagem Imagem

Exibe uma imagem .gif, .png, .jpg, emf ou wmf na saída. O designer de relatório pode especificar o caminho da imagem no modelo ou o gerador de relatórios pode especificar o caminho no tempo de execução.

No

Sim

ícone Tabela Tabela

Cria uma tabela na saída. Uma tabela pode conter linhas ou elementos do contêiner.

Sim

No

ícone Linha Linha

Cria uma linha na tabela atual.

Sim

No

ícone Célula Célula

Cria uma célula na linha atual da tabela atual.

Sim

No

ícone Lista Lista

Cria uma lista com marcadores ou numérica na saída.

Sim

No

ícone Item da lista Detalhes da lista

Cria um item da lista na lista atual na saída.

Sim

No

ícone Configuração da origem de dados Configuração da origem de dados

Consulte Incluindo um elemento de configuração de origem de dados.

No

No

ícone Arquivo include Arquivo include

Inclui o arquivo especificado na saída como um campo INCLUDETEXT.

  • O arquivo incluído pode ter uma extensão .doc, .docx, .txt ou .rtf.
  • Para saída do Microsoft Word, você deve atualizar todos os campos com a macro para ver o arquivo incluído.
  • Para saída de HTML e XSL-FO, o arquivo incluído é um hiperlink para o documento.

No

Sim

ícone Nota de rodapé Nota de rodapé

Cria uma nota de rodapé na página de saída atual. O texto da nota de rodapé é o conteúdo do elemento de nota de rodapé. Suportado apenas para a saída do Microsoft Word.

No

Sim

Ícone Região Região

Regiões são elementos estáticos que permitem alterar o fluxo de saída redirecionando o conteúdo de outros elementos ou grupos de elementos. Se um elemento tiver a propriedade região de destino especificada com o nome de um elemento de região, seu conteúdo será renderizado na região especificada em vez de em sua posição no documento.

No

No

ícone Favorito Favorito

Define um marcador no documento. O nome do marcador gerado é o conteúdo para o marcador. Ao gerar os documentos, o Rational Publishing Engine gera um nome exclusivo para cada marcador. O nome é baseado no nome fornecido no tempo de design e um identificador exclusivo gerado no tempo de execução.

No

Sim

ícone Comentário Comentário

Inclui um comentário na saída. O formato e a forma do comentário de saída são específicos do formato de saída.

Suportado para Microsoft Word e PDF.

No

Sim

ícone Quebra de página Quebra de página

Inclui uma quebra de página na saída.

No

No

ícone Quebra de seção Quebra de seção

Inclui uma quebra de seção na saída.

No

No

ícone Índice Índice

Inclui um índice na saída.

No

No

ícone Índice de tabelas Índice de tabelas

Inclui uma tabela de tabelas na saída. Você deve incluir Legendas de Tabela em seu modelo de documento para gerar uma tabela de tabelas na saída.

Suportado apenas para a saída do Microsoft Word.

Você deve atualizar todos os campos no documento do Microsoft Word para ver e poder atualizar o valor do campo.

No

No

ícone Índice de tabelas Índice de tabelas

Inclui uma tabela de tabelas na saída. Você deve incluir Legendas de Tabela em seu modelo de documento para gerar uma tabela de tabelas na saída.

Suportado apenas para a saída do Microsoft Word.

Você deve atualizar todos os campos no documento do Microsoft Word para ver e poder atualizar o valor do campo.

No

No

ícone Campo Campo

Inclui um elemento de campo genérico do Microsoft Word. É possível digitar qualquer código válido do Microsoft Word na propriedade do código de campo.

Suportado apenas para a saída do Microsoft Word.

Você deve atualizar todos os campos no documento do Microsoft Word para ver e poder atualizar o valor do campo.

No

No

ícone Número da página Número da página

Inclui um número da página na saída. Suportado apenas na saída do Microsoft Word e do PDF.

No

No

ícone Número total de páginas Número total de páginas

Inclui o número total de páginas na saída. Suportado apenas para a saída do Microsoft Word e do PDF.

No

No

ícone Legenda da tabela Legenda da tabela

Inclui uma legenda da tabela. Embora não seja possível especificar conteúdo dinâmico em uma legenda da tabela, qualquer elemento de texto subsequente é concatenado a ela.

Suportado para saídas do Microsoft Word e de PDF.

Você deve atualizar todos os campos no documento do Microsoft Word para ver e poder atualizar o valor do campo.

No

Sim

ícone Legenda da figura Legenda da figura

Inclui uma legenda da figura. Embora não seja possível especificar conteúdo dinâmico em uma legenda da figura, qualquer elemento de texto subsequente é concatenado a ela.

Suportado para saídas do Microsoft Word e de PDF.

Você deve atualizar todos os campos no documento do Microsoft Word para ver e poder atualizar o valor do campo.

No

Sim

Propriedades do elemento

Revise essas notas para entender mais sobre como especificar as propriedades do elemento em modelos que são projetados para gerar documentos do Microsoft Word.
Tabela 2. Propriedades de célula
Propriedades de célula Observações
Largura da borda Você deve especificar um valor de largura de borda entre 1 e 30 pixels para criar uma borda na saída.
Alinhamento de célula Essa propriedade especifica a posição do texto dentro da célula. O valor justificar não é suportado para este formato de saída.
Largura da Célula Insira um valor em pontos ou pixels. Se você inserir um valor em pixels, o valor será convertido em pontos e assumirá que a exibição seja de 96 dpi. Se você inserir um valor como uma porcentagem, o valor será ignorado. Quando você estiver combinando tabelas, deverá configurar a propriedade largura da célula para assegurar que os tamanhos de coluna sejam os mesmos.
Tabela 3. Propriedades de comentário
Propriedades de comentário Observações
Conteúdo Se você incluir hiperlinks na propriedade Conteúdo de elementos Comentário, os hiperlinks não serão clicáveis na saída do Microsoft Word.
Tabela 4. Propriedades de legenda da figura
Propriedades de legenda da figura Observações
Largura da borda Não use para este formato de saída.
Código de campo Numerais arábicos ou romanos são exibidos sequencialmente em cada legenda.
Tabela 5. Propriedades de nota de rodapé
Propriedades de nota de rodapé Observações
Nome do Estilo Se você aplicar um estilo a elementos sequenciais, como notas de rodapé, texto, texto estilizado ou tabelas, o estilo será aplicado a todos os elementos sequenciais até o próximo elemento do bloco, como um parágrafo. Por exemplo, se você incluir um estilo em um elemento de nota de rodapé e houver um elemento de texto estilizado nele, o estilo também será aplicado ao elemento de texto estilizado.
Tabela 6. Propriedades da imagem
Propriedades da imagem Observações
Largura da borda Não use para este formato de saída.
Conteúdo Formatos de imagem suportados: imagens .bmp, .emf, .gif, .jpg, .png, .wmf

.svg são suportadas pelo Rational Publishing Engine, mas não são suportadas pelo Microsoft Word. Para gerar o documento corretamente na saída do Microsoft Word, imagens .svg são convertidas em imagens .png. O processo de conversão pode distorcer a exibição da imagem na saída.

Tabela 7. Propriedades de detalhes da lista
Propriedades de detalhes da lista Observações
Largura da borda Não use para este formato de saída.
Tabela 8. Propriedades de número da página
Propriedades de número da página Observações
Largura da borda Não use para este formato de saída.
Tabela 9. Propriedades de parágrafo
Propriedades de parágrafo Observações
Largura da borda Você deve especificar um valor de largura de borda entre 1 e 30 pixels para criar uma borda na saída.
Alinhamento de Parágrafos Espaça o texto na página com um certo alinhamento.

esquerdo, direito e centro criam bordas irregulares de parágrafo, ajustando quantas palavras em um parágrafo forem possíveis. Justificar cria bordas regulares de parágrafo, inserindo espaço adicional entre palavras em todas as linhas, exceto a última. Distribuído é semelhante a justificar, exceto pelo fato de que o espaço também é inserido entre palavras na última linha do parágrafo.

Controle de viúva/órfã Quando configurado como true, o espaçamento de linha será ajustado para evitar os seguintes resultados de formatação:
  • Uma única palavra encerrando um parágrafo em uma nova linha
  • Uma única linha encerrando um parágrafo em uma nova página

Quando configurado como false, o espaçamento não é ajustado.

Tabela 10. Propriedades da linha
Propriedades da linha Observações
Quebra de linha entre páginas Quando configurado como true, o conteúdo de uma linha que aparece no final de uma página é dividido, se necessário. O conteúdo que não se ajusta à página é carregado durante na próxima página como uma nova linha.

Quando configurado como false, o conteúdo de uma linha no final da página não é dividido. A linha inteira é carregada na próxima página.

Tabela 11. Propriedades de texto de estilo
Propriedades de texto de estilo Observações
Nome do Estilo Se você aplicar um estilo a elementos sequenciais, como notas de rodapé, texto, texto estilizado ou tabelas, o estilo será aplicado a todos os elementos sequenciais até o próximo elemento do bloco, como um parágrafo. Por exemplo, se você incluir um estilo em um elemento de nota de rodapé e houver um elemento de texto estilizado nele, o estilo também será aplicado ao elemento de texto estilizado.
Tabela 12. Propriedades da tabela
Propriedades da tabela Observações
Ajuste automático para conteúdo Redimensiona a tabela para ajustar o conteúdo que cada célula contém. Quando você usa essa propriedade, também configura a propriedade Redimensionar para ajustar conteúdo como true.
Largura da borda Você deve especificar um valor de largura de borda entre 1 e 30 pixels para criar uma borda na saída.
Estilo borda Utilize o valor única em vez de larga, linha no topo, inserção, ou remoção. A mesma formatação é aplicada para todos esses valores e assemelha-se mais ao que você esperaria ver em única.
Largura da célula fixa na coluna Especifique um valor em pixels para assegurar que todas as células em uma coluna sejam da mesma largura.
Redimensionar para ajustar conteúdo Quando configurado como true, linhas não são quebradas, a menos que um espaço esteja presente. Quando você não tiver espaço, linhas não são quebradas e a largura da coluna é aumentada para a largura do texto. Se ajuste automático para conteúdo estiver configurado, você deverá configurar redimensionar para ajustar conteúdo como true.

Quando configurado como false, a largura da coluna é fixada e as linhas quebram independentemente dos espaços usados ou do comprimento do texto. Além disso, a propriedade ajuste automático da tabela é ignorada.

Nome do Estilo Se você aplicar um estilo a elementos sequenciais, como notas de rodapé, texto, texto estilizado ou tabelas, o estilo será aplicado a todos os elementos sequenciais até o próximo elemento do bloco, como um parágrafo. Por exemplo, se você incluir um estilo em um elemento de nota de rodapé e houver um elemento de texto estilizado nele, o estilo também será aplicado ao elemento de texto estilizado.
Ajuste automático de tabela Quando configurado como true, a tabela é redimensionada para ajustar a largura da página. Quando redimensionar para ajustar conteúdo também é configurado como true, larguras da célula são ignoradas e a tabela é redimensionada para corresponder ao conteúdo.

Não é possível inserir largura da coluna fixa como um valor. Use a propriedade largura da célula fixa.

Largura Especifique um valor.
Tabela 13. Propriedades de legenda da tabela
Propriedades de legenda da tabela Observações
Largura da borda Não use para este formato de saída.
Código de campo Numerais arábicos ou romanos são exibidos sequencialmente em cada legenda.
Tabela 14. Propriedades do Texto
Propriedades do Texto Observações
Largura da borda Você deve especificar um valor de largura de borda entre 1 e 30 pixels para criar uma borda na saída.
Nome do Estilo Se você aplicar um estilo a elementos sequenciais, como notas de rodapé, texto, texto estilizado ou tabelas, o estilo será aplicado a todos os elementos sequenciais até o próximo elemento do bloco, como um parágrafo. Por exemplo, se você incluir um estilo em um elemento de nota de rodapé e houver um elemento de texto estilizado nele, o estilo também será aplicado ao elemento de texto estilizado.
Tabela 15. Propriedades de número total de páginas
Propriedades de número total de páginas Observações
Largura da borda Não use para este formato de saída.

Comprimento da tabela

Quando você estiver projetando modelos que devem ser gerados nos documentos do Microsoft Word, o comprimento da tabela pode ser um fator a considerar.

Tabelas longas podem precisar ser transportadas para mais de uma página. Quando ocorrer esse requisito, selecione um elemento Linha na tabela e, na visualização Propriedades, configure a propriedade quebra de linha na página como true. Com essa propriedade configurada, suas tabelas podem continuar em várias páginas.

Índices, figuras e tabelas nos documentos do Microsoft Word

Para incluir um índice em sua saída, defina o índice em seu modelo ou folha de estilo. Se você definir o índice no modelo, a tabela não será mostrada no documento do Microsoft Word até que você atualize os campos do documento. Para atualizar os campos, use o recurso Atualizar campos ou Atualizar tabela no Microsoft Word ou use as macros contidas na folha de estilo rpe.dot. Você pode localizar a folha de estilo rpe.dot na instalação do Rational Publishing Engine: RPE_HOME\utils\word\rpe.dot. O mesmo processo se aplica a tabelas de figuras e índice de tabelas.

Legendas em documentos do Microsoft Word

Legendas de figuras e tabelas não são atualizadas automaticamente. Para atualizar os campos, use o recurso Atualizar campos no Microsoft Word ou use as macros contidas na folha de estilo rpe.dot. Você pode localizar a folha de estilo rpe.dot na instalação do Rational Publishing Engine: RPE_HOME\utils\word\rpe.dot.

Incluir elemento do arquivo

É possível escolher vincular o arquivo ou o arquivo fisicamente integrado em seu documento de saída. No entanto, o caminho que elementos de arquivo include são manipulados depende do formato de saída e do local do qual você está recuperando o arquivo.
Para saída do Microsoft Word, Rational Publishing Engine atualiza campos do Microsoft Word automaticamente durante a geração do documento. Se um campo INCLUDE TEXT for gerado, a macro não terá sido executada e a tarefa de importação do arquivo será delegado para Microsoft Word. Um arquivo include não está visível no documento de saída até que todos os campos sejam atualizados. Para atualizar os campos, use o recurso Atualizar campos no Microsoft Word ou use as macros que estão contidas na folha de estilo RPE_HOME\utils\word\rpe.dot.
Dica: Um documento do Microsoft Word que se vincula a outros arquivos não é autocontido. Mover o documento em outros computadores o impede de visualizar o conteúdo dos documentos vinculados. Se a visualização for necessária, use o recurso Separar links no Microsoft Word para incluir o conteúdo de um arquivo vinculado.

Estilos do título

Para usar os estilos de título predefinidos para Microsoft Word (Título 1, Título 2,... , Título 9), use o nome do estilo 1, 2 a 9.

Estilos do Rational Publishing Engine versus estilos externos

Use os estilos externos, que são definidos em uma folha de estilo, tanto quanto possível. Essa abordagem permite alterar rapidamente a aparência do documento de saída e impinge uma verificação uniforme em toda a empresa.

Numerando títulos para Microsoft Word

Use uma folha de estilo com títulos numerados para obter títulos numerados como uma lista hierárquica.

Dados Unicode na saída

Todos os dados Unicode são renderizados se a fonte que é usada suportar Unicode. Para saída do Microsoft Word, se você usou uma fonte não Unicode, mude a fonte no documento de saída após a geração do documento.

Objetos OLE

Você pode extrair objetos integrados, como vinculação e incorporação de objetos (objetos OLE), de atributos em uma origem de dados. Para saída do Microsoft Word, você deve configurar a propriedade OLEs como imagens estáticas na seção de metadados da especificação do documento.
A pasta ref contém arquivos .rtf para os objetos OLE. Para cada objeto OLE exportado, a saída do Microsoft Word tem um campo incluído apontando para um arquivo .rtf. Como o IBM® Rational Publishing Engine não pode atualizar os campos do Microsoft Word, os campos incluídos não ficarão visíveis quando o documento do Microsoft Word for aberto. Para tornar os campos visíveis, execute uma das seguintes ações:
Tabela 16. Ações
Ação Resultado
Selecione o conteúdo do documento inteiro e use a função Atualizar campos no Microsoft Word. Os objetos OLE são exibidos no documento. O documento não é autocontido.
Use a macro updateFields fornecida pelo Rational Publishing Engine. Os objetos OLE são exibidos no documento. O documento não é autocontido.
Use a macro insertOLEs fornecida pelo Rational Publishing Engine. Os objetos OLE são exibidos no documento. O documento é autocontido.
Use as macros rpe ou insertOLEs fornecidas pelo Rational Publishing Engine. Os objetos OLE são exibidos no documento. O documento é autocontido.
Nota: Se você mover um documento que não está autocontido para outro computador, não poderá editar os objetos OLE. Para evitar esse problema, execute a macro insertOLEs.