4.11 Documento

Comando

Descrição

DOC

<DOC [atributos]>

Atributo

Descrição

Tipo

Default

LANG

Language

Número inteiro

1

APR

Apply in RTF ?

Boleano

1 (sim)

APHS

Apply in HTML Single Page ?

Boleano

1 (sim)

APHM

Apply in HTML Multi Page ?

Boleano

1 (sim)

Atributo "LANG" : Language

Este comando é útil quando você deseja fazer seu manual em diversas línguas (português, inglês, etc.).

Normalmente nesses casos você escreve um documento em um idioma (aqui vamos considerar português) e outro documento em outro idioma (aqui vamos considerar inglês).

Quando você tem que fazer modificações no seu documento, você tem que atualizar ambas as versões e convertê-las separadamente.

Isso "vai bem" até quando seu documento fica muito grande ou com vários arquivos de includes.

Nesses casos seria conveniente que, por exemplo, em cada arquivo incluído você tivesse uma parte escrita em português e a parte, digamos inferior, escrita em inglês.

Este comando permite isso. Assim, nos "blocos" em português você insere (antes deles) o comando:

<doc lang=1>

e antes dos blocos em inglês você insere:

<doc lang=2>

Assim, quando você converter seu documento, basta especificar o Language desejado (no Form 5.3 Jobs) e fazer a conversão que será gerado o documento na linguagem desejada.

Obviamente, você precisará especificar o Output Path em locais diferentes para cada linguagem, pois os nomes de muitos arquivos gerados serão os mesmos.

Não existe limite no número de linguagens que você pode utilizar.

Importante: Se você utilizar este comando defina-o sempre antes das definições de suas páginas. Isso porque se você o fizer dentro de uma página, o que vier depois do comando não aparecerá na linguagem desejada, pois a página não pertencerá à nova linguagem e sim à antiga.

Exemplo:

<doc lang=1>
    <pp>
    <pg n=PA1 cp={Página 1}>

        Hello World.

        Aqui você digita os parágrafos do seu documento.

    <pg n=PA2 own=PA1 cp={Página 2}>

        Aqui começa uma nova página.

        Note que esta página é uma "sub-página" da primeira.

<doc lang=2>
    <pp>
    <pg n=PB1 cp={Page 1}>

        Hello World.

        Here you type your documents paragraphs.

    <pg n=PB2 own=PB1 cp={Page 2}>

        Here new page starts.

        Notice that this page is a "sub-page" of first page.

_

Resultado:

O resultado você pode observar em:

...\DMHelp\Examples\Language\Converted_Portugues

e

...\DMHelp\Examples\Language\Converted_English

_

Atributos "AP..."

Definem que o que vier após este comando seja aplicado em determinadas saídas.

Este comando é útil quando você deseja adicionar textos somente em determinados tipos de saídas (.RTF, .HTML Single Page ou .HTML Multi Page).

Se o que você deseja diferenciar é "pequeno" (uma ou poucas palavras) pode, e até deve, utilizar o comando Campo (FI) com Field Kind : AP, que é mais simples.

Este comando se aplica quando a diferenciação é mais extensa, por exemplo, se você desejar colocar algumas páginas que somente apareçam nas saídas .HTML mas que essas páginas não apareçam na saída .RTF.

Uma vez definido este comando, essa "setagem" permanece até que nova definição seja feita.

Atributo "APR" : Apply in RTF ?

Define o valor boleano que especifica se o que vier após este comando vai (ou não) aparecer nas saídas .RTF.

Atributo "APHS" : Apply in HTML Single Page ?

Define o valor boleano que especifica se o que vier após este comando vai (ou não) aparecer nas saídas .HTML Single Page.

Atributo "APHM" : Apply in HTML Multi Page ?

Define o valor boleano que especifica se o que vier após este comando vai (ou não) aparecer nas saídas .HTML Multi Page.

Exemplo

Exemplo:

<doc APR=1 APHS=0 APHM=0>
Este parágrafo aparece apenas nas saídas .RTF.

<doc APR=0 APHS=1 APHM=0>
Este parágrafo aparece apenas nas saídas .HTML Single Page.

<doc APR=0 APHS=0 APHM=1>
Este parágrafo aparece apenas nas saídas .HTML Multi Page.

<doc APR=1 APHS=1 APHM=1>

_

Resultado:

Este parágrafo aparece apenas nas saídas .HTML Multi Page.

_

Note que após as aplicações específicas foi necessário o comando:

<doc APR=1 APHS=1 APHM=1>

para "informar" ao DMHelp que o que vem a seguir se aplica a todas as saídas.

Importante

Este comando não afeta o comando IN (<IN [atributos]>), ou seja, todas as declarações de includes resultarão na inclusão dos arquivos correspondentes, independentemente do atributo Language ou dos atributos AP... deste comando.