<!-- If you want to validate or edit this document separately, uncomment
this prolog

<?xml version="1.0" ?>
<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd">

-->
<chapter id="tutorial">
<chapterinfo>
<authorgroup>
<author
><firstname
>Alexander</firstname
> <surname
>Dymo</surname
> <affiliation
> <address
><email
>cloudtemple@mksat.net</email
></address>
</affiliation>
</author>
<author
><firstname
>Phil</firstname
> <surname
>Thompson</surname
> <affiliation
> <address
><email
>phil@river-bank.demon.co.uk</email
></address>
</affiliation>
</author>
<othercredit role="translator"
><firstname
>Marcus</firstname
><surname
>Gama</surname
><affiliation
><address
><email
>marcus.gama@gmail.com</email
></address
></affiliation
><contrib
>Tradução</contrib
></othercredit
> 
</authorgroup>
</chapterinfo>
<title
>Tutorial</title>

<para
>Este tutorial tenta ser uma rápida introdução ao Kugar.</para>

<para
>Você criará um modelo de relatório exemplo com o &kudesigner;, um arquivo de dados exemplo e finalmente irá gerar um relatório completo.</para>

<para
>O código-fonte para os modelos dos exemplos e os arquivos de dados poderão ser encontrados no <filename
>sample1.ktf</filename
> e no <filename
>sample1.kdf</filename
> que são distribuídos com o &kugar;.</para>


<sect1 id="tut-1">
<title
>Criando um modelo de relatório com o &kudesigner;</title>

<para
>Execute o Kugar Designer digitando <command
>kudesigner</command
> no shell. </para>

<para
>Após você iniciar o designer, escolha <guimenu
>Arquivo</guimenu
>|<guilabel
>Novo</guilabel
> e configure o tamanho da página para <guilabel
>Carta</guilabel
> e a orientação do papel para <guilabel
>Paisagem</guilabel
>. Configure as margens esquerda e direita para 48, e as margens superior e inferior para 40. Todas as dimensões no &kudesigner; (margens de página, tamanhos, posições, &etc;) são mensuradas em milímetros. <screenshot
> <mediaobject>
<imageobject>
<imagedata fileref="tut_file_new.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>Diálogo <interface
>Novo Relatório</interface
></phrase>
</textobject>
</mediaobject>
</screenshot>
</para>

<para
>Um novo relatório é agora criado e todos os botões na <guilabel
>Barra de Ferramentas Items</guilabel
> e <guilabel
>Barra de Ferramentas Seções</guilabel
> são agora habilitados (os ítens correspondentes de menu no <guilabel
>Ítems</guilabel
> e <guilabel
>Seções</guilabel
> são também habilitados). <screenshot
> <mediaobject>
<imageobject>
<imagedata fileref="tut_empty_report.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>Janela de Relatório Vazio</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>

<para
>Agora é hora de adicionar algumas seções ao relatório e determinar os seus tamanhos. Nós adicionaremos o <link linkend="report-header-and-footer"
>cabeçalho e o rodapé do relatório</link
>, o <link linkend="page-header-and-footer"
>cabeçalho e o rodapé da página</link
> e uma única seção de <link linkend="detail"
>detalhe</link
>. Os cabeçalhos e rodapés do relatório são impressos na primeira página e na última página do relatório antes e depois de quaisquer dados do relatório. Os rodapés dos relatórios são locais óptimos para os <link linkend="calculated-field-element"
>campos calculados</link
>. Os cabeçalhos e rodapés das páginas são impressos no início e no fim de cada página. O relatório do exemplo irá ter uma seção de detalhe com o nível 0. Isto significa que todas as linhas de dados irão ter uma estrutura idêntica (&ie;, campos). Se a estrutura de dados for mais complexa ou se for organizada com uma relação de mestre-detalhe, poderão ser criados mais níveis de detalhe. Veja o <filename
>sample3.kut</filename
> e o <filename
>sample3.kud</filename
> para ver um exemplo de como isto poderá ser feito. Veja as <link linkend="template-elements"
>descrições dos elementos do modelo</link
> para mais informações. </para>

<para
>As seções são adicionadas usando o menu <guilabel
>Seções</guilabel
> ou uma <guilabel
>Barra de Seções</guilabel
>. A partir de agora, adicione o cabeçalho e o rodapé do relatório e das páginas e, finalmente, o detalhe. Ao adicionar a seção de detalhe, coloque o seu nível a 0 como é mostrado na imagem abaixo. <screenshot
> <mediaobject>
<imageobject>
<imagedata fileref="tut_set_level.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>Configurando o nível de detalhe</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>

<para
>Nosso relatório deverá parecer agora como este na captura de tela. <screenshot
> <mediaobject>
<imageobject>
<imagedata fileref="tut_rep_look1.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>Relatório com seções</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>

<para
>Todas as seções do exemplo possuem uma altura pré-definida - 50 mm. Vamos mudá-la. Para fazer isso, clique com o &RMB; na seção do Cabeçalho do Relatório ou clique no botão <guilabel
>Editar Propriedades</guilabel
> da <guilabel
>Barra de Edição</guilabel
> e, finalmente, escolha uma seção. A janela de propriedades deverá então aparecer. <screenshot
> <mediaobject>
<imageobject>
<imagedata fileref="tut_edit_height.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>Edição da altura da seção</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>

<para
>Defina agora a altura do Cabeçalho do Relatório como sendo igual a 70. Vamos executar este procedimento para todas as outras seções. Configure a altura do Cabeçalho da Página para ser igual a 45 e do Detalhe como sendo igual a 30. Os Rodapés da Página e do Relatório deverão ter 32 mm de altura. </para>

<para
>Um modelo de relatório com as seções dimensionadas corretamente está pronto para ser preenchido com itens de relatório. <screenshot
> <mediaobject>
<imageobject>
<imagedata fileref="tut_rep_look2.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>Relatório com as seções dimensionadas</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>

<para
>Você poderá agora adicionar itens às seções do relatório. Poderão ser adicionados cinco tipos diferentes de itens. A <link linkend="label-element"
>Legenda</link
> é uma área retangular que poderá ter uma borda e poderá ser preenchida com qualquer tipo de dados em texto. O texto em si e as cores de fundo, assim como os tipos de fonte, poderão ser alterados. Os tipos de borda e as cores das linhas poderão também ser personalizadas. O <link linkend="field-element"
>Campo</link
> poderá ser colocado numa seção de detalhe. Os campos representam campos de dados e os seus valores serão obtidos a partir de um arquivo de dados ao gerar um relatório. As quantidades, somas, médias, &etc; dos valores dos campos poderão ser impressas no relatório através dos <link linkend="calculated-field-element"
>Campos Calculados</link
>. Os <link linkend="special-element"
>Especiais</link
> são legendas com algum texto pré-definido, como a data atual ou o número de página. A aparência geral do relatório pode ser refinada com as <link linkend="line-element"
>Linhas</link
>. </para>

<para
>Para adicionar um item de relatório clique o botão do item correspondente na <guilabel
>Barra de Ferramentas Items</guilabel
> e coloque-o (clique) na seção. O item escolhido será colocado na seção selecionada com o canto superior esquerdo nas coordenadas fornecidas. Outras propriedades são configuradas com os valores padrão e podem ser mudadas com o diálogo <guilabel
>Opções de Item de Relatório</guilabel
> (da mesma maneira que nós fizemos para mudar a altura da seção). </para>

<para
>Assim, vamos adicionar legendas ao cabeçalho e ao rodapé do relatório, tal como mostrado na imagem abaixo. Note que a legenda <quote
>Mutiny Bay Software</quote
> tem o seu <guilabel
>BorderStyle</guilabel
> e o seu <guilabel
>BorderWidth</guilabel
> iguais a 0 e o <quote
>Software Inventory Report</quote
> - 1mm. Todas as cores estão definidas como uma combinação de três valores (RGB- vermelho, verde e azul) separados por vírgulas. </para>

<para
>Nós adicionamos também elementos de campos na seção do detalhe. Assumindo que existem quatro campos - título, versão, plataforma e cópias. Assim, deverão ser colocados quatro elementos <guilabel
>Campo</guilabel
>, assim como deverão ser configuradas as propriedades do <guilabel
>Campo</guilabel
>. Note que a propriedade do <guilabel
>Texto</guilabel
> é configurada automaticamente como <quote
>[<userinput
>nome_campo</userinput
>]</quote
>. </para>

<para
>O rodapé da página é um bom local para mostrar a data atual e o número da página, assim deverão ser adicionados dois campos especiais e configurados o seu <guilabel
>Type</guilabel
> como sendo  0 e 1. O especial com Type=0 irá representar a data e o Type=1 o número da página. Note que a propriedade <guilabel
>Text</guilabel
> do ítem especial é alterada automaticamente. </para>

<para
>O último elemento a ser colocado é o <guilabel
>Campo Calculado</guilabel
> para o campo <quote
>cópias</quote
>. Para adquirir um conjunto de soma da cópias, configure a propriedade <guilabel
>Field</guilabel
> do campo calculado como sendo o <quote
>copies</quote
> e o <guilabel
>CalculationType</guilabel
> igual a 1 (a função de soma). </para>

<para
>Finalmente, nosso modelo de relatório deve parecer-se com isto: <screenshot
> <mediaobject>
<imageobject>
<imagedata fileref="tut_rep_complete.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>Relatório completo</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>

</sect1>



<sect1 id="tut-2">
<title
>Criando um arquivo de dados de relatório</title>

<para
>De um modo geral, os arquivos de dados poderão ser criados de várias formas. Alguns irão usar tabelas de transformação de XSL para gerar um &XML; válido a partir de outro documento em &XML; (como uma planilha do &kspread;); outros irão usar o seu próprio programa para obter os dados de um banco de dados e preencher o arquivo de dados. Neste tutorial, nós simplesmente criaremos este arquivo de maneira manual. O código-fonte do exemplo, poderá ser encontrado no arquivo <filename
>sample1.kdf</filename
> ou copiado do exemplo abaixo. </para>

<programlisting
>&lt;?xml version=<quote
>1.0</quote
> encoding=<quote
>UTF-8</quote
>?&gt;

&lt;!DOCTYPE KugarData [
    &lt;!ELEMENT KugarData (Row* )&gt;
    &lt;!ATTLIST KugarData
        Template CDATA #REQUIRED&gt;

    &lt;!ELEMENT Row EMPTY&gt;
    &lt;!ATTLIST Row
        level CDATA #REQUIRED
        title CDATA #REQUIRED
        version CDATA #REQUIRED
        platform CDATA #REQUIRED
        copies CDATA #REQUIRED&gt;
]&gt;

&lt;KugarData Template="sample1.ktf"&gt;
    &lt;Row level="0" title="  BRU" version="15.0" platform="x86" copies="1"/&gt;
    &lt;Row level="0" title="  Caldera Open Linux" version="2.2" platform="x86" copies="3"/&gt;
    &lt;Row level="0" title="  K Desktop" version="1.1.1" platform="x86" copies="1"/&gt;
    &lt;Row level="0" title="  Netscape Communicator" version="4.6" platform="x86" copies="10"/&gt;
    &lt;Row level="0" title="  Redhat Linux" version="5.0" platform="x86" copies="11"/&gt;
    &lt;Row level="0" title="  Redhat Linux" version="5.1" platform="x86" copies="12"/&gt;
    &lt;Row level="0" title="  Redhat Linux" version="5.2" platform="x86" copies="14"/&gt;
    &lt;Row level="0" title="  Redhat Linux" version="6.0" platform="x86" copies="15"/&gt;
    &lt;Row level="0" title="  Star Office" version="5.0" platform="x86" copies="1"/&gt;
    &lt;Row level="0" title="  Star Office" version="5.1" platform="x86" copies="3"/&gt;
    &lt;Row level="0" title="  Microsoft Windows NT" version="3.1" platform="x86" copies="1"/&gt;
    &lt;Row level="0" title="  Microsoft Windows NT" version="3.51" platform="x86" copies="1"/&gt;
    &lt;Row level="0" title="  Microsoft Windows NT" version="4.0" platform="x86" copies="1"/&gt;
    &lt;Row level="0" title="  Microsoft Windows NT" version="5.0" platform="x86" copies="1"/&gt;
    &lt;Row level="0" title="  Sun Solaris" version="2.5" platform="Sparc" copies="1"/&gt;
&lt;/KugarData&gt;
</programlisting>

</sect1>

<sect1 id="tut-3">
<title
>Gerando o relatório</title>

<para
>Neste momento nós temos um modelo de relatório (<filename
>sample1.ktf</filename
>) e um arquivo de dados de relatório (<filename
>sample1.kdf</filename
>). </para>
<para
>Para gerar um relatório, digite o seguinte comando no console: <command
>kugar <option
>-r <replaceable
>sample1.ktf</replaceable
></option
> <option
>-d <replaceable
>sample1.kdf</replaceable
></option
></command
> </para>

<para
>Isto trará uma janela de shell do &kugar; com o relatório gerado. <screenshot
> <mediaobject>
<imageobject>
<imagedata fileref="tut_rep_generated.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>Relatório gerado</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>

</sect1>

</chapter>
