# Guia de Estilos da Janela de Conversação do &kopete;

## A referência dos Estilos da Janela da Conversação do &kopete;.

Desde o &kopete; 0.12, passou-se a usar o formato do Adium para os estilos da Janela de Conversação. O formato do tema baseia-se em modelos de HTML e em CSS. São mais simples de criar e desenvolver, sendo apenas necessário algum conhecimento de HTML e CSS. Da mesma forma, os estilos podem ter variantes (definidas como um ficheiro CSS) que adiciona mais valor às personalizações :).

### Guia de referência.

O formato Adium consiste numa estrutura em pastas, modelos em HTML, ficheiros CSS e palavras-chave que são substituídas de cada vez que o modelo é processado. A conversação final é uma página em XHTML onde as mensagens são adicionadas com operações de DOM. O elemento central é um elemento 'div' chamado `Chat`. Antes e depois deste elemento 'div' vem o modelo 'Header' e 'Footer'. As mensagens são filhas do elemento do 'div' `Chat`.

#### Estrutura de Pastas

Um estilo deverá respeitar esta estrutura de pastas. O código no &kopete; raciocina com esta estrutura. Ao criar o pacote do estilo, arquive a pasta `styleName`. A estrutura de pastas é uma estrutura de um pacote do Mac OS X, para os que estão familiarizados com esse sistema operativo. Da mesma forma, deverá respeitar a capitalização apresentada aqui, porque um sistema UNIX faz distinção entre maiúsculas e minúsculas.

    styleName\ (poderá ter .adiumMessageStyle como sufixo, dado que no Mac OS X é um pacote)
            Contents\
                    Info.plist
                    Resources\
                            main.css
                            Header.html
                            Footer.html
                            Status.html
                            Incoming\ (e Outgoing\)
                                    Content.html
                                    NextContent.html (para as mensagens consecutivas)
                                    Context.html (para o histórico de mensagens)
                                    NextContext.html
                                    Action.html
                            Variants\
                                    *.css

#### Acerca do <div id="insert"></div>

Este é um elemento do 'div' especial, que é usado internamente. É uma substituição que indica onde inserir a mensagem seguinte. Se for uma mensagem nova, esta é removida e a mensagem nova toma lugar. Porém, se for uma mensagem consecutiva, o elemento do 'div' é substituído pelo conteúdo da mensagem nova. Este elemento especial do 'div' é obrigatório nos modelos 'Content', 'Context', 'NextContent' e 'NextContext', ainda que não haja mal algum em colocá-lo também nos modelos 'Action' e 'Status'.

#### Modelos de HTML.

##### Descrição do modelo.

`Header.html` (Obrigatório)

  Use o modelo Header para mostrar um cabeçalho bonito na conversa. Este modelo é inserido antes do elemento 'div' `Chat`. Se não o usar, coloque apenas um ficheiro vazio.

`Footer.html` (Obrigatório)

  Este é, normalmente, o mesmo que o Header, mas aplica-se no rodapé de uma conversa. Este modelo é inserido a seguir ao elemento 'div' `Chat`. Se não o usar, basta colocar um ficheiro vazio.

`Status.html` (Obrigatório)

  Este modelo é usado para mostrar uma mensagem interna. As mensagens internas, como a mudança de estado, uma mensagem do Kopete (ex.: Recepção de Ficheiro). Quando o estilo não fornecer um modelo Action, é usado para mostrar a mensagem Action.

`Incoming/Content.html`
`Outgoing/Content.html` (Obrigatório)

  O modelo do conteúdo é o núcleo da mensagem. Pense neste modelo como um bloco que irá conter as mensagens. Tenha a certeza que está pronto para receber as mensagens consecutivas e não o desenhe para mostrar apenas uma mensagem. As mensagens consecutivas serão inseridas no elemento do 'div' 'insert'.

`Incoming/NextContent.html`
`Outgoing/NextContent.html` (Obrigatório)

  O modelo 'NextContent' é um fragmento da mensagem para as mensagens consecutivas. Será inserido no próximo bloco principal da mensagem. O modelo de HTML deverá conter o mínimo dos mínimos para mostrar uma mensagem.

`Incoming/Action.html`
`Outgoing/Action.html` (Opcional) (Extensão do &kopete;)

  Este modelo é uma extensão do &kopete; ao formato do Adium. Está disponível para a direcção 'Incoming' (recepção) e 'Outgoing' (envio). As mensagens de acção são mensagens especiais que nos indicam que está a ocorrer uma acção. Por exemplo, "/me está a instalar o &kopete;" seria apresentado como "ZePires está a instalar o &kopete;".

`Incoming/Context.html`
`Incoming/NextContext.html`
`Outgoing/Context.html`
`Outgoing/NextContext.html` (Opcional)

  Estes modelos não são usados no Kopete. No Adium, são usados para mostrar o histórico. É praticamente a mesma coisa que o 'Content' e o 'NextContent', apenas com algumas diferenças para o distinguir das mensagens normais.

#### Acerca dos Estilos e Variantes em CSS

Os modelos em HTML são usados para descrever como é que fica a estrutura. Contudo, todo o estilo é descrito em ficheiros CSS. O `main.css` é o estilo principal, enquanto as variantes são apenas pequenas alterações ao estilo principal. Os exemplos das variantes são, por exemplo, cores diferentes ou a apresentação ou não da fotografia do utilizador. Tanto o `main.css` como as variantes são importados para a página XHTML final.

##### -`main.css`

Este é o ficheiro CSS principal, comum a todas as variantes. Este ficheiro deverá conter toda a descrição principal do estilo.

##### -Variantes

As variantes são ficheiros CSS, localizados na pasta `Variants/`. Cada uma das variantes é um único ficheiro CSS que inclui o `main.css` e faz alterações ao estilo principal.

#### Depurar os estilos

Existem duas sugestões para testar um estilo, antes de o criar.

##### -Grave uma conversação de exemplo.

Na Janela de Conversação, poderá gravar uma conversação. Esta é uma cópia da página XHTML interna que é apresentada. Use-a no Konqueror para testar os seus ficheiros CSS.

##### -Desactive a 'cache' de estilos.

Existe uma pequena opção de configuração quue permite desactivar a 'cache' de estilos. Quando estiver activa, irá carregar de novo os modelos de HTML, de cada vez que o estilo for requisitado. Adicione as seguintes linhas ao seu ficheiro `kopeterc`. É muito útil quando estiver a testar um estilo no &kopete;

    [KopeteStyleDebug]
    disableStyleCache=true

### Referência das palavras-chave

As palavras-chave são pequenos buracos que são preenchidos com os detalhes. Por cada mensagem nova, estes são substituídos pelo valor correcto, correspondendo ao seu contexto. Para suportar por completo todas as funcionalidades do Kopete, foram adicionadas algumas extensões ao Adium. Do mesmo modo, algumas palavras-chave só estão disponíveis em certos contextos.

#### Lista de palavras-chave para os modelos 'Header' e 'Footer'.

Estas palavras-chave são processadas no início da conversação.

`%chatName%`

  Este é o nome da sessão de conversação actual. Numa sessão típica, mostra o nome do contacto e o seu estado. No caso do IRC, ele mostra o tópico de um canal.

`%sourceName%`
`%destinationName%`

  Estes são os nomes dos contactos de uma sessão de conversação. O `%sourceName%` é o seu nome. O `%destinationName%` é o nome do contacto com quem está a conversar. De preferência, use o `%chatName%` em vez destes, dado que poderão ser confusos nas conversas em grupo e no IRC.

`%incomingIconPath%`
`%outgoingIconPath%`

  Estas são as imagens/fotos/avatares dos contactos de uma sessão de conversação. O 'Incoming' representa a foto do contacto e o 'Outgoing' representa a sua própria foto. Se não estiver nenhuma fotografia disponível, irá usar a imagem `buddy_icon.png`, que está nas pastas `Incoming` ou `Outgoing`.

`%timeOpened%`
`%timeOpened{X}%`

  É a hora em que a sessão de conversação começou. O `%timeOpened%` usa o formato de hora predefinido para a região em questão. Se preferir usar um outro formato de hora, use o `%timeOpened{X}%`, onde o X é um texto que contém o formato de hora. Os parâmetros de hora são os mesmos da função `strftime` da 'glibc'. Faça um `man strftime` para obter uma lista de parâmetros disponíveis.

#### Lista de palavras-chave dos modelos 'Content', 'NextContent', 'Context', 'NextContext', 'Action'

Estas palavras-chave são processadas por cada mensagem.

`%userIconPath%`

  Esta é a imagem/foto/avatar do contacto associado à mensagem. Se não estiver nenhuma fotografia disponível, irá usar a imagem `buddy_icon.png`, que está nas pastas `Incoming` ou `Outgoing`, dependendo da direcção da mensagem.

`%senderScreenName%`

  Este o ID do contacto associado à mensagem. Exemplos: eu@hotmail.com, 45566576, ZePires.

`%sender%`

  Este é o nome do contacto associado à mensagem. Irá usar o nome formato do 'MetaContact' como origem.

`%service%`

  Mostra o nome do serviço associado à mensagem. Exemplos: Jabber, Yahoo, MSN.

`%textbackgroundcolor{X}%`

  No &kopete;, esta palavra-chave é usada para representar a cor de fundo realçada. Ignore o parâmetro entre parêntesis e use-o apenas como `%textbackgroundcolor{}`.

`%senderStatusIcon%` (extensão do &kopete;)

  Mostra o ícone de estado do contacto associado à mensagem. É a localização de um ficheiro.

`%senderColor%`
`%senderColor{N}%` (extensão do &kopete;)

  Gera uma cor do ID do contacto do remetente. Pode ser usado para mostrar uma cor diferente para a alcunha do contacto.

  `%senderColor{N}%`, onde o N é um número positivo. Se o N for maior que 100, representa uma cor mais clara que a cor do contacto. Se N for igual a 160, é uma cor 50% mais clara. Se N for menor que 100, então é uma cor mais escura. É útil para ter um fundo com uma cor diferente para cada contacto.

  Se quiser usar estas cores numa dada variante, mas não no estilo principal, terá de fazer uma correcção alternativa.

      <div style="color:%senderColor%;border:none;border-color:%senderColor{40}%;"
      ><p class="message"
      >...</p
      ></div>

  poderá aplicar a cor ao elemento 'p.message' do seu ficheiro `main.css` e, na sua variante, colocar algo do género

      p.message { color:inherit; border-color:inherit; }

#### Lista de palavras-chave comuns para as mensagens e o 'Status.html'

`%message%`

  A mensagem em si. Este é um fragmento de HTML.

`%time%`
`%time{X}%`

  A hora em que a mensagem foi recebida. O `%time%` usa o formato de hora predefinido para a região em questão. Se preferir usar um outro formato de hora, use o `%time{X}%`, onde o X é um texto que contém o formato de hora. Os parâmetros de hora são os mesmos da função `strftime` da 'glibc'. Faça um `man strftime` para obter uma lista de parâmetros disponíveis.

`%messageDirection%` (Extensão do &kopete;)

  Representa a direcção da mensagem, se esta precisar de ser apresentada da esquerda-para-a-direita, ou da direita-para-a-esquerda. O valor tanto pode ser "rtl" ou "ltr". Leia a secção Linhas-guia da Direcção da Mensagem para ver como usar esta palavra-chave adequadamente.

## Linhas-Guia do Estilo da Janela de Conversação do &kopete;

As Linhas-Guia do Estilo da Janela de Conversação do &kopete; são um conjunto de coisas que o seu estilo de Janela de Conversação precisa de suportar para estar em conformidade com o Kopete.

### Suportar o realce

O seu estilo deve conseguir mostrar texto realçado. No Kopete e no Adium, o `%textbackgroundcolor{}%` é substituído pela cor de realce. Adicione este atributo ao estilo: `background-color: %textbackgroundcolor{}%` no elemento em HTML que mostra a mensagem.

### São necessários modelos para as mensagens consecutivas.

Estas linhas-guia são para as pessoas que estão a reescrever os estilos antigos em XSL no formato novo. Todos os estilos deverão fornecer um modelo para as mensagens consecutivas. Esta é agora uma funcionalidade predefinida.

### Use a codificação UTF-8.

O título diz tudo. Deverá gravar os seus ficheiros em UTF-8.

### Forneça o `Contents/Info.plist`, para estar também em conformidade com o Adium

O ficheiro `Contents/Info.plist` ainda não é usado no Kopete. Porém, se quiser que o seu estilo seja compatível com o Adium, deverá fornecer este ficheiro. Aqui está um ficheiro de exemplo básico. Os textos a substituir estão entre "$".

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
    <plist version="1.0">
    <dict>
            <key
    >CFBundleDevelopmentRegion</key>
            <string
    >English</string>
            <key
    >CFBundleGetInfoString</key>
            <string
    >$O nome completo do seu estilo$</string>
            <key
    >CFBundleIdentifier</key>
            <string
    >$O seu ID de estilo ID no formato: com.adiumx.smooth.operator.estilo$</string>
            <key
    >CFBundleInfoDictionaryVersion</key>
            <string
    >1.0</string>
            <key
    >CFBundleName</key>
            <string
    >$O nome do seu estilo aqui$</string>
            <key
    >CFBundlePackageType</key>
            <string
    >AdIM</string>
            <key
    >MessageViewVersion</key>
            <integer
    >3</integer>
    </dict>
    </plist>

### Forneça o `buddy_icon.png`

Deverá colocar um ficheiro chamado `buddy_icon.png` nas pastas `Incoming` e `Outgoing`. Estas imagens serão usadas quando o contacto não tiver nenhuma fotografia.

### Suporte as línguas da direita-para-a-esquerda com a palavra-chave `%messageDirection%`.

A palavra-chave `%messageDirection%` está presente nas línguas do mundo que escrevem da direita-para-a-esquerda. Esta define a direcção da mensagem, se é "rtl" (direita-para-a-esquerda) ou "ltr"(esquerda-para-a-direita). Adicione este atributo de estilo ao elemento de HTML que mostra a mensagem: `direction: %messageDirection%`. A antevisão do estilo na configuração da aparência inclui um texto da direita-para-a-esquerda, para verificar se a configuração do seu estilo aparece correctamente. Deverá iniciar o texto a partir da direita.