Apêndice A. 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 em 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 arquivo CSS) que adiciona mais valor às personalizações :).

Guia de referência.

O formato Adium consiste numa estrutura em pastas, modelos em HTML, arquivos CSS e palavras-chave que são substituídas 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 operacional. Da mesma forma, você 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, uma vez 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

Sobre o <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 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 usá-lo, coloque apenas um arquivo vazio.

Footer.html (Obrigatório)

Este é, normalmente, o mesmo que o Header, mas aplica-se no rodapé de uma conversa. Este modelo é inserido após o elemento 'div' Chat. Se não usá-lo, basta colocar um arquivo 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 (por exemplo: Recepção de Arquivo). 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. Certifique-se de 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 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 direção 'Incoming' (recepção) e 'Outgoing' (envio). As mensagens de ação são mensagens especiais que nos indicam que está ocorrendo uma ação. Por exemplo, "/me está instalando o Kopete" seria apresentado como "Marcus está instalando 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 distingui-lo das mensagens normais.

Sobre os estilos e variantes de CSS

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

-main.css

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

-Variantes

As variantes são arquivos CSS, localizados na pasta Variants/. Cada uma das variantes é um único arquivo 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 criá-lo.

-Salve uma conversação de exemplo.

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

-Desative a 'cache' de estilos.

Existe uma pequena opção de configuração que permite desativar a 'cache' de estilos. Quando estiver ativa, ela irá carregar novamente os modelos de HTML, cada vez que o estilo for requisitado. Adicione as seguintes linhas ao seu arquivo kopeterc. É muito útil quando estiver testando 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. Para cada mensagem nova, eles são substituídos pelo valor correto, 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 atual. Numa sessão típica, mostra o nome do contato e o seu estado. No caso do IRC, ele mostra o tópico de um canal.

%sourceName%, %destinationName%

Estes são os nomes dos contatos de uma sessão de conversação. O %sourceName% é o seu nome. O %destinationName% é o nome do contato com quem está conversando. De preferência, use o %chatName% em vez destes, uma vez que poderão causar confusão nas conversas em grupo e no IRC.

%incomingIconPath%, %outgoingIconPath%

Estas são as imagens/fotos/avatares dos contatos de uma sessão de conversação. O 'Incoming' representa a foto do contato e o 'Outgoing' representa a sua própria foto. Se você não tiver nenhuma fotografia disponível, ele 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 pré-definido para a região em questão. Se você 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 para cada mensagem.

%userIconPath%

Esta é a imagem/foto/avatar do contato associado à mensagem. Se não existir nenhuma fotografia disponível, será usada a imagem buddy_icon.png, que está nas pastas Incoming ou Outgoing, dependendo da direção da mensagem.

%senderScreenName%

Este é o ID do contato associado à mensagem. Exemplos: eu@hotmail.com, 45566576, MarcusGama.

%sender%

Este é o nome do contato associado à mensagem. Será usado 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ênteses e use-o apenas como %textbackgroundcolor{}.

%senderStatusIcon% (extensão do Kopete)

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

%senderColor%, %senderColor{N}% (extensão do Kopete)

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

%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 contato. Se N for igual a 150, é 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 contato.

Se você quiser usar estas cores numa determinada variante, mas não no estilo principal, você terá que fazer uma correçã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 arquivo 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 pré-definido para a região em questão. Se você 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 direção da mensagem, se ela deve ser apresentada da esquerda-para-a-direita, ou da direita-para-a-esquerda. O valor tanto pode ser "rtl" ou "ltr". Leia a seção Linhas-guia da Direção da Mensagem para ver como usar esta palavra-chave adequadamente.