Extendendo o &quantaplus; Christopher Hornbaker
chrishornbaker@earthlink.net
András Mantia
amantia@kde.org
MarcusGama
marcus_gama@uol.com.br
Tradução
Extendendo o &quantaplus; Este capítulo descreve como personalizar o &quantaplus; para suas necessidades particulares e como você pode ajudar o &quantaplus; a ficar ainda melhor. Pacote de Edição de Tipo de Documento (&DTEP;) Os Pacotes de Edição de Tipo de Documento (&DTEP;) são usados no &quantaplus; para adicionar suporte para marcação, linguagens de scripting e &CSS;. Eles permitem que o &quantaplus; forneça recursos de auto-complementação e nós de árvores. Sua simplicidade e flexibilidade são o que faz o &quantaplus; uma &IDE; rápida e amigável para desenvolvedores web. Eles são o que torna o &quantaplus; um ambiente produtivo e fácil de usar. Os &DTEP;s vem em dois sabores: Família 1, que são para marcação, e Família 2 que são para scripting e &CSS;. Os &DTEP; são feitos de duas partes: a Pasta Marcas e as Barras de Ferramentas. Pastas de Marcas são compostas de dois tipos de arquivos: o &descriptionrc; e os arquivos TagXML, que carregam a extensão .tag. Barras de ferramentas são abas de botões orientadas à ícones e acessíveis (acima da janela de edição) que colocam texto em um documento mais rápido do que o usuário pode digitar. Os &DTEP;s podem ser criados manualmente (veja abaixo), obtidos da Internet ou criados automaticamente a partir de uma DTD existente. Veja em os detalhes da conversão. Este documento descreve como criar arquivos TagXML, o &descriptionrc; e as barras de ferramentas. Em resumo, um &DTEP;. Arquivos TagXML (.tag) definem tanto os atributos específicos de uma marca como a disposição e conteúdo do diálogo de propriedades que o &quantaplus; mostra para a marca. O arquivo &descriptionrc; fornece regras e informações sobre o &DTEP; propriamente dito. Barras de ferramentas fornecem uma maneira rápida de adicionar marcas ao documento sem se preocupar com erros tais como de sintaxe. Empacotando Pastas de Marcas são somente isto: pastas. Elas são compostas somente do &descriptionrc; e arquivos TagXML. Pastas de Marcas carregam o nome da linguagem de marcação e versão, se aplicável. (Por exemplo, html-4.01-strict) TagXML A tabela abaixo lista os elementos definidos na TagXML e declara se eles são necessários ou não. Apesar de nem todos serem necessários, é recomendável que você use o máximo que puder de modo que outros usuários possam ter uma experiência melhor e mais informações sobre como trabalhar com eles. Elemento Uso Padrão Uso da Caixa MARCAS necessário sempre marca necessário sempre label opcional necessário para criar um diálogo de propriedades attr opcional necessário para definir um atributo tooltip opcional necessário para que o diálogo de propriedades exiba uma dica whatsthis opcional necessário que que o diálogo de propriedades exiba um O que é Isto list opcional necessário que um atributo é do tipo lista item opcional necessário que <lista> é usado textlocation opcional sempre location opcional necessário quando um rótulo é usado text opcional necessário quando um rótulo é usado children opcional lista de marcas que podem aparecer dentro de uma marca sendo definida child necessário uma entrada filha stoppingtags opcional lista de marcas que envia outra marca para o fim stoppingtag necessário uma entrada stoppingtags Descrições de Elemento TagXML As seções a seguir descreverão, em detalhes, cada elemento. Tudo sobre onde eles podem ir, o que eles fazem lá, e apresentados de uma maneira fácil de seguir. MARCAS Este é o elemento raiz de um documento TagXML. Ele deve aparecer em um documento somente uma vez. Ele pode conter a definição de múltiplas marcas. Isto é um elemento tipo elemento-somente. Pai(s) Filho NENHUM marca marca Envoltório para marca que está sendo definida. Este é um elemento tipo elemento-somente. Pai(s) Filho MARCAS label, attr, stoppingtags AtributoTipoValores PadrãoUsoDescrição nomestring necessárioEspecifica o nome da marca que está sendo definida. simplesbooleano opcionalEspecifica se a marca precisa ou não de um fechamento de marca </(nomemarca)>. typestringxmltag opcionalEspecifica o tipo da marca que está sendo definida. xmltag Tipo de marca é baseado-XML. (Família 1 somente.) entity A marca descreve uma entidade. (Família 1 somente.) property Tipo da marca é relacionado ao &CSS;. (Família 2 somente.) function Tipo da marca é uma função de script. Quando usado <attr> se torna argumentos da função. (Família 2 somente.) class Tipo da marca é uma classe de script. (Família 2 somente.) method Type of tag is a class method. (Family 2 only.) returnTypestringvoid opcionalEspecifica o tipo de retorno da marca que está sendo definida. (Família 2 somente.) void Tipo da marca retorna void. int Tipo da marca retorna inteiro. float Tipo da marca retorna flutuante. long Tipo da marca retorna longo. string Tipo da marca retorna string. versionstring opcionalIndica a versão da linguagem para a qual esta marca é válida extendsstring opcionalValid only if the type of the tag is "class". The name of the base class for this class. (Family 2 only.) classstring opcionalValid only if the type is "method". Specifies the name of the class to where this method belongs. (Family 2 only.) commonbooleano opcionalSe for igual a "yes", a marca corresponde a um grupo de atributos comum e os atributos desta marca poderão ser anexados a qualquer outra marca. (Apenas na Família 1.) commentstring opcionalo texto do comentário aparece perto do nome da marca na lista de completação label Coloca um rótulo no diálogo. O texto especificado pela marca <texto>. Este é um elemento tipo elemento-somente. Pai(s) Filho marca text, location attr Define um atributo da marca. Este elemento ocorre uma vez para cada atributo. Ele define o nome e tipo do atributo. Ele contém também marcas adicionais que especificam como este atributo deve ser exibido, etc. Este é um elemento tipo elemento-somente. Pai(s) Filho marca location, list, tooltip, whatsthis, textlocation AtributoTipoValores PadrãoUsoDescrição nomestring necessárioEspecifica o nome do atributo que está sendo definido. typestringinput necessárioEspecifica o tipo de atributo que está sendo definido. input Campo suporta entradas de texto livre (campo texto). check O valor do campo é booleano (caixa de verificação). color O valor do campo é uma cor. url O valor do campo é uma &URL;. (Arquivo local para referir-se.) list O valor do campo é um ítem de uma lista especificada. statusstringopcional necessárioEspecifica se o argumento é ou não obrigatório. (Família 2 somente.) opcional Argumento é opcional. necessário Argumento é obrigatório. implied Argumento é implicado. sourcestring opcionalIndica as origens usadas para preencher o item do atributo no diálogo de edição da marca e na árvore de atributos selection O texto seleccionado será usado como origem dcop Será usado o resultado de um método de DCOP como origem interfacestring opcionalNecessita do 'source="dcop"'. A interface de DCOP a partir da qual o &quantaplus; irá buscar os dados de origem. methodstring opcionalNecessita do 'source="dcop"' e do nome de uma interface. O nome do método de DCOP a partir do qual o &quantaplus; irá buscar os dados de origem. argumentsstring opcionalNecessita do 'source="dcop"', de uma interface e de um nome de um método. Os argumentos que são passados ao método. Poderá estar em branco ou aceitar o "%tagname%", que corresponde ao nome atual da marca. tooltip Define a dica para o campo no diálogo. Este elemento é somente-texto. Atualmente somente texto plano é suportado (você não pode usar qualquer marcação). Pai(s) Filho attr NENHUM whatsthis Define a ajuda 'O que é Isso' para um campo no diálogo. Este elemento é somente-texto. Atualmente somente texto plano é suportado (você não pode usar qualquer marcação). Pai(s) Filho attr NENHUM list Uma marca de contenção que agrupa juntos os ítens em uma lista. Isto pode aparecer somente uma vez para cada descrição de atributo. Este é um elemento tipo somente-elemento. Pai(s) Filho attr item item Define um ítem em uma lista. Este elemento é somente-texto. Pai(s) Filho list NENHUM textlocation Especifica a posição de um texto de atributo da marca dentro de um diálogo. Esta marca somente pode ocorrer uma vez para cada atibuto no diálogo (&ie; uma para cada marca <attr>). Este elemento é vazio. Pai(s) Filho attr NENHUM AtributoTipo UsoDescrição rownonNegativeInteger necessárioEspecifica a linha na disposição do diálogo de um campo ou rótulo. colnonNegativeInteger necessárioEspecifica a coluna na disposição do diálogo de um campo ou rótulo. rowspannonNegativeInteger opcionalEspecifica o número de linhas que um campo deve se extender. colspannonNegativeInteger opcionalEspecifica o número de colunas que um campo deve se extender. location Especifica a posição e tamanho do campo no diálogo. Esta marca somente pode ocorrer uma vez para cada campo no diálogo (&ie; uma para cada marca <attr> e <label>). Este elemento é vazio. Pai(s)Filho label, attrNENHUM AtributoTipo UsoDescrição rownonNegativeInteger necessárioEspecifica a linha na disposição do diálogo de um campo ou rótulo. colnonNegativeInteger necessárioEspecifica a coluna na disposição do diálogo de um campo ou rótulo. rowspannonNegativeInteger opcionalEspecifica o número de linhas que um campo deve se extender. colspannonNegativeInteger opcionalEspecifica o número de colunas que um campo deve se extender. text Define o texto para um rótulo ou caixa de verificação. Este elemento é somente-texto. Pai(s)Filho label, attrNENHUM children Define uma lista de elementos que podem aparecer dentro da marca que está sendo especificada. Este elemento é um elemento tipo elemento-somente. Pai(s)Filho marcachild child Define uma marca filha. Este elemento é vazio. Pai(s)Filho childrenNENHUM AtributoTipoValores UsoDescrição nomestring necessárioEspecifica uma marca que pode aparecer dentro de uma determinada marca. usagestring opcionalSpecifies the relation with the parent. necessário The parent must have at least one child with this name. stoppingtags Define uma lista de elemento que forçam o fim da marca. Este elemento é um elemento tipo elemento-somente. Pai(s)Filho marcastoppingtag stoppingtag Define uma marca de parada. Este elemento é vazio. Pai(s)Filho stoppingtagsNENHUM AtributoTipo UsoDescrição nomestring necessárioEspecifica que marcas forçam o fim de outra marca. Uso do TagXML Todos os arquivos TagXML devem iniciar com a declaração &XML;: <?xml version="1.0" encoding="UTF-8"?> e devem estar corretamente aninhado e fechado. Espaços não afetam nada, mas observe os caracteres & e <. Eles devem ser substituídos por &amp; e &lt; respectivamente em elementos como <tooltip>, <whatsthis>, e <text>. Não fazer isto não causará travamentos, mas você terá pedaços do seu trabalho desaparecendo neste caso. Validação do TagXML Para validar seus arquivos TagXML, simplesmente clique no menu Ferramentas do &quantaplus; e selecione Validar TagXML. Um diálogo será apresentado e você precisará somente seguir as orientações fornecidas. Este recurso atualmente não está presente. Atualmente a validação ocorre quando os arquivos TagXML são carregados no &quantaplus;. Exemplos de TagXML Família 1 O exemplo a seguir mostrará um arquivo TagXML da Família 1 válido. Este arquivo procura descrever o elemento <schema> do Esquema do &W3C; &XML;. O nome do arquivo para este arquivo TagXML será schema.tag. Simples, não? <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE TAGS> <TAGS> <tag name="schema"> <label> <text>id</text> <location col="0" row="0"/> </label> <attr name="id" type="input"> <tooltip>Um ID único para o elemento.</tooltip> <whatsthis>Um ID único para o elemento.</whatsthis> <location col="1" row="0"/> </attr> <label> <text>version</text> <location col="0" row="1"/> </label> <attr name="version" type="input"> <tooltip>Versão do esquema.</tooltip> <whatsthis>Versão do esquema.</whatsthis> <location col="1" row="1"/> </attr> <label> <text>targetNamespace</text> <location col="0" row="2"/> </label> <attr name="targetNamespace" type="input"> <tooltip>Referência de &URI; do espaço de nomes para este esquema.</tooltip> <whatsthis>Referência de &URI; do espaço de nomes para este esquema.</whatsthis> <location col="1" row="2"/> </attr> <label> <text>xmlns</text> <location col="0" row="3"/> </label> <attr name="xmlns" type="input"> <tooltip>Referência de &URI; do espaço de nomes para uso neste esquema. Se nenhum prefixo é usado, então componentes deste espaço de nomes podem ser usados sem qualificação.</tooltip> <whatsthis>Referência de &URI; do espaço de nomes para uso neste esquema. Se nenhum prefixo é usado, então componentes deste espaço de nomes podem ser usados sem qualificação.</whatsthis> <location col="1" row="3"/> </attr> <label> <text>attributeFormDefault</text> <location col="0" row="4"/> </label> <attr name="attributeFormDefault" type="list"> <items> <item>qualified</item> <item>unqualified</item> </items> <tooltip>Forma padrão para todos os atributos dentro deste esquema.</tooltip> <whatsthis>Forma padrão para todos os atributos dentro deste esquema.</whatsthis> <location col="1" row="4"/> </attr> <label> <text>elementFormDefault</text> <location col="0" row="5"/> </label> <attr name="elementFormDefault" type="list"> <items> <item>qualified</item> <item>unqualified</item> </items> <tooltip>Forma padrão para todos os atributos dentro deste esquema.</tooltip> <whatsthis>Forma padrão para todos os atributos dentro deste esquema.</whatsthis> <location col="1" row="5"/> </attr> <label> <text>blockDefault</text> <location col="0" row="6"/> </label> <attr name="blockDefault" type="input"> <location col="1" row="6"/> </attr> <label> <text>finalDefault</text> <location col="0" row="7"/> </label> <attr name="finalDefault" type="input"> <location col="1" row="7"/> </attr> </tag> </TAGS> Família 2 O exemplo a seguir mostrará um arquivo TagXML da Família 2 válido. Este arquivo procura descrever a função de sobrecarga do &PHP;. O nome do arquivo para este arquivo TagXML será overload.tag. <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE tags> <tags> <tag name="overload" type="function" returnType="void"> <attr name="class_name" type="string" status="optional"/> </tag> </tags> &descriptionrc; O arquivo &descriptionrc; também é bastante simples e existe um editor para ele, acessível através da opção DTDEditar a Configuração da DTD. Isto irá editar o &descriptionrc; de um &DTEP; que você poderá selecionar numa lista. Para editar o &descriptionrc; para um &DTEP; acabado de criar, você deverá criar um único &descriptionrc; com os seguintes itens: [General] Version = Use 1 para o &quantaplus; versão <=3.1.2 e 2 para as versões posteriores. Name = Texto de definição da DTD. (-//&W3C;//DTD HTML 4.01 Transitional//EN) NickName = O nome bonito da DTD. (HTML 4.01 Transitional). Se não estiver definido, o Name é usado como NickName. Logo que o tenha criado e colocado junto com os arquivos de marcas, carregue o &DTEP; acabado de criar com a opção DTDCarregar o Pacote de DTD (DTEP) e, depois de carregado, você poderá prosseguir com a edição da configuração do &DTEP;. Verifique as dicas e o texto 'o que é isto' no diálogo do editor para compreender o significado de cada item. Em alternativa, você poderá ler o arquivo quanta/data/dtep/dtd-description.txt do pacote de código, que contém uma descrição do formato. Ações Definidas pelo Usuário Ações são muito comuns em qualquer aplicativo. Você irá valorizá-las ao usar qualquer aplicativo. Clicar em um ícone na barra de ferramentas, selecionar um item de menu ou usar um atalho de teclado normalmente executa uma ação. No &quantaplus; ações atingiram um próximo nível. Ao invés de ações de codificação difícil (que são criadas pelo programador do aplicativo a nível de código fonte) é possível para o usuário comum criar e modificar ações e deste modo adicionar novas funcionalidades ao &quantaplus;. Estas são as ações definidas pelo usuário, e muitas das ações padrão do &quantaplus; são definidas (e modificadas) pelo usuário também. Existem três tipos de ações definíveis pelo usuário: Ações de texto Ações de marca Ações de script Criando ações Você pode criar uma ação indo para Configurações Configurar Ações . Clique em Nova Ação e você obterá um diálogo semelhante a isto: Tipo Especifica o tipo da ação (Texto, Marca, Script). Texto O nome visível ao usuário da ação. O botão próximo ao rótulo Texto O ícone atribuído a esta ação. Clique nele para mudar o ícone atual. Dica da ferramenta Uma descrição curta do que a ação faz. Atalho Um atalho atribuído a esta ação. Clique em Personalizado ou no botão próximo ao Personalizado para atribuir um atalho; clique em Nenhum para remover o atalho atualmente atribuído. Barras de ferramentas recipiente A barra de ferramentas definida pelo usuário onde esta ação aparece. Veja . Configurações Detalhadas Especifica configurações para os diferentes tipos de ação. Veja abaixo. Ações de texto As ações mais simples. Você pode inserir algum texto na área de Configurações Detalhadas e sempre que a ação é executada este texto será inserido em seu documento na posição atual do cursor. Veja o exemplo abaixo. Ações de marca Útil para inserir marcas XML, mas é claro você pode usá-las para outras finalidades também. <marca> O nome da marca. </marca> Se habilitado quando a ação é executada este texto será inserido como uma marca fechada. Se existir uma área selecionada no documento antes de você executar a ação, o <marca> será inserido antes da área selecionada e o </marca> após. Executar diálogo "Editar marca" se disponível Se habilitado e existir um arquivo tagXML para esta marca, um diálogo de definição de marca será mostrado antes de inserir a marca dentro do documento, de modo que você possa ajustar os atributos da marca. O <marca> e </marca> serão inseridos como você digitá-los aqui. O <, > ou o sinal / não serão automaticamente adicionados. Ações de script O mais poderoso tipo de ação. Com a ajuda desta ação você poderá executar aplicativos externos (normalmente scripts, mas isto não é limitado somente aos scripts), que podem alterar seu documento ou usar seu documento (ou parte dele) como entrada. Exemplos do próprio &quantaplus; são o diálogo Início Rápido, as várias ações Ver Em... para os DTEPs do (X)HTML. Primeiro você deve inserir o nome do seu script com o interpretador que deverá ser usado com ele. Exemplo sh /home/minhaCasa/meuScript.sh. Apesar de você poder usar caminhos completos, a maneira recomendada é usar a variável %scriptdir na linha de comando, como sh %scriptdir/meuScript.sh. Deste modo o &quantaplus; tentará localizar seu script nos seguintes locais: pasta de script global: $TDEDIR/share/apps/quanta/scripts pasta de script local: $TDEHOME/share/apps/quanta/scripts seu caminho: $PATH Existem outras variáveis especiais que você pode usar na linha de comando: %f: será substituída com a URL do documento atual. No caso de documentos locais, file:/ será retirado do documento. %input: será substituído com a entrada selecionada. Veja abaixo. %projectbase: será substituída com a URL do projeto atual. Isto é vazio se nenhum projeto está carregado. %pid: será substituída com o PID do processo do &quantaplus; em execução. Se o &quantaplus; estiver rodando em modo único, o texto "unique" prefixará o número PID. Útil ao usar o DCOP para controlar o &quantaplus; a partir de um script externo. %userarguments: útil no caso de eventos. Esta entrada será substituída pela propriedade do evento na seguinte ordem: Primeiro argumento O identificador único do 'script' Segundo argumento o nome do evento Terceiro argumento os parâmetros do evento, sendo normalmente o nome do documento atual ou a localização do arquivo do projeto. Além dos métodos acima o script pode receber entrada a partir do &quantaplus; na entrada padrão. Na caixa combinada Entrada você pode selecionar o que enviar para a entrada padrão: As opções são: Nada: nada é enviado para o script. Documento atual: todo o documento é enviado para o script. Texto selecionado: a área selecionada do documento é enviada para o script. Usar a variável %input normalmente faz sentido somente ao usar esta configuração. Semelhante à Entrada você pode obter a saída do aplicativo executado. Existem dois tipos de saída: saída normal, impressa para a saída padrão; mensagens de erro, impressa para a saída de erro padrão. Você pode especificar o que deve acontecer com o texto impresso na saída padrão. Isto pode ser feito modificando o valor da caixa combinada Saída: Nada: a saída do aplicativo é ignorada. Inserir na posição do cursor: a saída será inserida no documento atual na posição do cursor. Substituir seleção: a área selecionada do documento será substituída com a saída. Substituir seleção: a área selecionada do documento será substituída com a saída. Criar um novo documento: um novo documento será criado e conterá toda a saída do script. Substituir documento atual: todo o documento será substituído com a saída. Janela de mensagem: a saída aparecerá na visão da ferramenta Mensagens. As opções para a saída de erro padrão (Erro) são as mesmas da saída normal. Criando Barras de Ferramentas O texto a seguir mostrará como criar barras de ferramentas para um &DTEP;. Barras de ferramentas são elementos gráficos que possuem ações atribuídas. Ações, no &quantaplus;, são a base para todas as outras extensões que o &quantaplus; possui e possuirá no futuro. O mesmo mecanismo que define uma ação no &quantaplus; habilita a auto-completamentação e diálogos de marca. Com ações, o limite do que você pode fazer é virtualmente infinito. Para entender através de um exemplo, nós usaremos &HTML; arrumado em nossas páginas web. Do Zero para o Completo Para inciar, você precisará criar uma barra de ferramentas de usuário. Selecione Barras de Ferramentas Adicionar Barra de Ferramentas de Usuário. Se existirem muitas marcas para a linguagem de marcação, é recomendável que você divida as marcas em grupos lógicos. Você precisará criar uma nova barra de ferramentas de usuário para cada grupo. Neste caso, não existem muitas, por isso nós iremos criar uma barra de ferramentas e nomeá-la com o nome da marcação. Uma vez que todas as suas barras de ferramentas estejam criadas, você deve adicioná-as e configurar as ações. Para fazer isto, selecione Configurações Configurar Ações . As partes desta janelas são bem objetivas. Pressione o botão Nova ação na base da janela para entrar no modo de edição. Preencha todos os campos necessários e adicione a marca para a(s) barra(s) de ferramentas apropriada(s). Complete o resto e,se a marca tiver atributos e você planeja sempre usá-los, habilite a caixa Executar o diálogo "Editar marca" se disponível de modo que você seja questionado sempre que a ação é usada. Você deve agora ter algo como o seguinte. Pressione o botão Aplicar e você verá a ação adicionada à(s) barra(s) de ferramentas selecionada(s). Opa! Este ícone é terrível. Como eu mesmo e os outros associarão este ícone com aquela ação? Vamos substituí-lo antes de surgirem problemas. Para criar um ícone que descreva mais precisamente aquela ação, nós iremos usar o &kiconedit;. Selecione-o a partir do &kmenu;, Gráficos Mais Programas (ou onde a sua distribuição o tenha colocado). O padrão do &kiconedit; é o tamanho de 32x32 pixéis, mas nós precisamos de 22x22. Para mudar isto, selecione Editar Redimensionar . Tenha em mente que você está criando um ícone que ajudará não somente você a lembrar-se que ação ele faz, mas também outros usuários do &DTEP;. Uma vez que a marca para qual eu estou criando o ícone é chamada iniciar, eu decidi criar um Sinal de iniciar. Use a cor verde (verde é frequentemente interpretado como ir, iniciar, ou proceder), ou, pelo menos, apresente um mensagem ara o usuário que clicar nesta ação colocará uma marca <iniciar> no documento atual. Agora que eu terminei a criação do ícone, eu o salvarei. Uma vez que você tenha terminado a criação do(s) ícone(s), você deve associá-lo com a ação. Para fazer isto, abra Configurações Configurar Ações novamente (no &quantaplus;) e selecione a ação a qual deseja associar o ícone. Ao lado do campo Texto, você verá um botão; clique-o. Selecione Outros Ícones e então clique o botão Navegar. Vá para a pasta na qual você salvou o ícone, selecione o ícone e clique OK. Pressione o botão Aplicar e continue a fazer o mesmo com as outras marcas, se for o caso, ou clique em OK para terminar. Vamos dizer que você deseje adicionar algumas funções comuns do &quantaplus; na sua barra de ferramentas ou talvez ache que sua barra de ferramentas poderia ser melhor organizada de uma maneira diferente, com alguns separadores para agrupar ações. Abra o diálogo Configurar Barras de Ferramentas acessando Configurações Configurar Barras de Ferramentas . Certifique-se de que sua barra de ferramentas está selecionada. Eu irei escolher o separador (topo da coluna da esquerda) para a minha barra de ferramentas. Uma vez que você tenha selecionado o ítem que deseja adicionar a sua barra de ferramentas, pressione o botão de seta para direita. Isto adicionará o ítem a sua barra de ferramentas. Eu acho que gostaria de ter uma maneira rápida de acessar a Previsão do Konqueror. Eu selecionarei este ítem e o adicionarei à barra de ferramentas. Observe como o separador auxiliar no agrupamento. Alguém que não conheça minha barra de ferramentas poderá pensar que o botão do &konqueror; foi colocado como ou em oposição ao botão iniciar. Aplique suas mudanças e, quando tiver concluído, pressione OK para terminar. Ah, veja a nova e fantástica barra de ferramentas! Muito mais manipulável agora. Lembre de testar sua barra de ferramentas, clicando em todos os butões, de modo que você saiba se a saída é correta. Agora para salvar a barra de ferramentas, nós selecionaremos Barras de Ferramentas Salvar Barras de Ferramentas Salvar como Barra de Ferramentas Local . Salve-a para a pasta correta. Uma vez que NeXML não existe, eu simplesmente a terei na pasta de nível superior, mas sua barra de ferramentas deve ser salva para a pasta correta. Certifique-se de ajustar seu &descriptionrc; para fazer com que ela seja carregada quando um novo arquivo do tipo especificado seja criado. Criando Sua Própria Documentação Robert Nickel
robert@artnickel.com
MarcusGama
marcus_gama@uol.com.br
Tradução
Criando Sua Própria Documentação Provavelmente as adições mais notáveis ao &quantaplus; para o usuário em geral serão as adições de documentação para linguagens de marcação ou script que você mais gosta. Para este fim, este capítulo explanará como eu criei a árvore de documentação do &PHP; para meu uso pessoal. Antes de iniciar a criação de sua própria documentação, você pode desejar verificar o repositório do &quantaplus; para ver se alguém já fez isto para você. Existem duas fases para este processo. Primeiro, você deve obter a documentação existente para a linguagem de marcação/script/&etc; que você deseja. Segundo, você deve criar o arquivo docrc. O primeiro depende de você, o segundo será abordado aqui. A forma geral do arquivo docrc é a seguinte: #KDE Config File [Tree] Doc dir=caminho, relativo a este arquivo, dos arquivos de documentação html ⪚ php42/ #top level elements Top Element=Sua descrição desyes documentos> ⪚ documentação do &PHP; 4.2 Section 1=Section1.html Section 2=#Sec2.1,#Sec2.2,#Sec2.3 Sec2.1=Sec2.1.html Sec2.2=Sec2.2.html Sec2.3=Sec2.3.html ... [Context] ContextList=func1,func2,marca1,marca2,marca3 func1=func1.html func2=func2.html marca1=marca1.html marca2=marca2.html marca3=marca3.html O docrc é dividido em duas seções: Tree e Context. A seção Tree define o aspecto da apresentação da documentação na aba de documentação. Por exemplo, você verá que nos documentos você terá algo como i&PHP;sto: Relacionado com o mostrado acima, meu docrc do &PHP; se parece com isto: #KDE Config File [Tree] Doc dir=php42/ #top level elements Top Element=Documentação PHP 4.2 Documentação PHP 4.2=Índice,#Iniciando,#Referência de Linguagem Índice=index.html Iniciando=Introdução, ... Introdução=introduction.html ... Referência de Linguagem=Sintaxe básica, ... Sintaxe básica=language.basic-syntax.html ... Observe o # na frente do Iniciando e Referência de Linguagem. Ele indica que estes são sub-recipientes na árvore e tem seu próprio conteúdo. Eu não acredito que existe um limite de profundidade aqui (isto deve ser feito de acordo com seu bom senso) — use seu julgamento. Para o Índice, você observará que ele se referencia diretamente a um arquivo (e consequentemente mostra acima na base da visão de árvore — diretórios primeiro|). Espaços não afetam nada, mas observe os caracteres & e <. Eles devem ser separados por &amp; e &lt; respectivamente em todos os arquivos de recursos do &quantaplus; baseados em &XML;. A seção Context é a seção do arquivo docrc que é usada para facilitar a ajuda sensível ao contexto. Por exemplo, você esté escrevendo um script e você gostaria de ve&PHP;r a documentação para a função mysql_fecth_array. Você simplesmente destaca a função e então pressiona &Ctrl;H para ajuda de contexto. A documentação do mysql_fetch_array será imediatamente exibida. Existem apenas dois tipos de entrada aqui: a ContextList e as linhas de associação de arquivo. ContextList Realmente simples, isto é apenas uma lista separada por vírgulas dos itens de contexto que você deseja tornar disponíveis (para o &PHP;, estes são as funções do &PHP;). Linhas de associação de arquivos Estas seguem a forma item de contexto=página do doc html. ⪚ acos=function.acos.html Um exemplo abaixo da versão da seção Context do meu docrc é o seguinte: #Keywords for context help [Context] ContextList=abs,acos,acosh,addcslashes,addslashes,... abs=function.abs.html acos=function.acos.html acosh=function.acosh.html addcslashes=function.addcslashes.html addslashes=function.addslashes.html ... Agora você pode salvar seu arquivo docrc, salve-o no $HOME/.trinity/share/apps/quanta/doc ou $TDEDIR/share/apps/quanta/doc para uso local ou global respectivamente. Então crie uma pasta (a especificada em seu arquivo docrc) no mesmo diretório do seu docrc e copie suas páginas &HTML; nele. Você precisará reiniciar o &quantaplus; e então você verá seus documentos. Uma vez que você tenha certeza de que eles são bons e podem ser compartilhados, envie seu docrc com uma descrição de qualquer informação pertinente sobre que documentos você usou para o repositório do &quantaplus; para uso pela comunidade do &quantaplus;. Você não ficará rico, mas se sentirá bem em saber que contribuiu para a melhor plataforma de desenvolvimento web do mundo.
Compartilhar Recursos Com o &quantaplus;, você não está sozinho. É possível compartilhar os vários recursos (pacotes DTEP, barras de ferramentas com ações, programas, modelos) com outras pessoas. Existem duas formas de fazer isso: Enviar por E-mail Os recursos poderão ser enviados por e-mail para os seus amigos, colegas ou para quem você quiser. Irá ver os itens de menu Enviar por E-mail em vários locais, como o DTDEnviar o Pacote de DTD (DTEP) por E-mail, Barras de FerramentasEnviar a Barra de Ferramentas por E-mail, no menu de contexto dos arquivos e pastas dos e na árvore de Modelos e Scripts. Enviar para o servidor principal Os recursos podem ser remetidos para o nosso repositório principal, a partir do qual todos os outros usuários do &quantaplus; poderão obtê-los. Os envios são revistos e disponibilizados, se a nossa equipe considerar que estão corretos e são úteis. Para fazer um envio válido, sugere-se que assine os recursos, pelo que irá necessitar de uma chave de GPG/PGP. Esta informação é usada para verificar a origem dos recursos, tanto pela nossa equipe como por quem irá obter os recursos. Para saber como obter os recursos do servidor principal, veja em . Ao enviar, será pedido para inserir a senha da sua chave privada de GPG (a senha não será gravada) ou, no caso de ter mais chaves privadas, poderá escolher a que deseja usar. No diálogo para Compartilhar Coisas Novas, preencha os campos de entrada (o URL de Previsão poderá ficar em branco) e inicie o envio, clicando em OK. O envio poderá ser iniciado em DTDEnviar o Pacote do DTD (DTEP), Barras de FerramentasEnviar a Barra de Ferramentas, no menu de contexto dos arquivos e pastas na árvore de Modelos e Scripts. Obtendo os Recursos É possível atualizar o seu &quantaplus; sem obter uma versão nova, obtendo os recursos novos como os pacotes DTEP, as barras de ferramentas com ações, modelos, 'scripts' e documentação. Uma possibilidade será obter os recursos por e-mail ou a partir de um servidor Web; nesses casos, você terá que instalá-los manualmente. Se você teve sorte, você também obteve um programa de instalação no local de onde transferiu os recursos. Contudo, o &quantaplus; tem um servidor dedicado que mantém os recursos que não foram instalados na distribuição principal, devido aos seus tamanhos ou a uso pouco frequente ou que foram contribuídos posteriormente pelos usuários, sendo estes recursos instalados automaticamente. Para obter esses recursos, use os vários itens de menu para Obter. Você poderá encontrá-los em DTDObter o Pacote de DTD (DTEP), Barras de FerramentaObter Barra de Ferramentas, no menu de contexto ou numa área vazia ou num item de topo nas árvores de Modelos, Scripts e Documentação. Depois de obter um recurso, mas antes de instalá-lo, o &quantaplus; verifica se o recurso é válido, verificando a integridade e a assinatura. No caso de ocorrerem problemas, ele irá avisá-lo e você poderá decidir se deseja continuar ou não. Por favor reveja os diálogos de avisos com cuidado. No caso da integridade ser correta e o recurso estar devidamente assinado, você irá obter ainda um diálogo de informação, para que possa ver quem criou o recurso. Certifique-se de instalar os recursos, principalmente as barras de ferramentas e os scripts, apenas a partir de fontes de confiança! Convertendo uma DTD para um &DTEP; É possível trabalhar em linguagens de XML que não sejam suportadas atualmente pelo &quantaplus; se criar um pacote DTEP. Contudo, a criação poderá levar bastante tempo, uma vez que poderá ter que escrever centenas de arquivos de marcas no formato tagXML. Obviamente, existe uma forma melhor de fazer isso, convertendo a DTD automaticamente para um pacote DTEP. A conversão poderá ser iniciada a partir da opção do menu DTDCarregar e Converter a DTD. Selecione o arquivo .dtd que define a DTD que deseja usar, onde irá ver o seguinte diálogo: Os itens são: Nome da pasta-alvo:o &DTEP; recém criado irá parar, com este nome, na pasta $TDEHOME/share/apps/quanta/dtep. Nome: o nome (texto de definição) do DTD Apelido: o nome visto pelo usuário do &DTEP; Linha de definição do !DOCTYPE: o texto que deverá aparecer na marca !DOCTYPE, como por exemplo HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd" URL do DTD: o URL apontando para o arquivo DTD Extensão padrão: a extensão que será usada normalmente para os arquivos que foram escritos nesta DTD Marcas e atributos sensíveis à cais: esta opção costuma estar assinalada para o caso das variantes da linguagem XML Ajustar o DTEP após a conversão: se estiver assinalado, após a conversão, o &quantaplus; irá invocar o editor do &descriptionrc;, de modo a que você possa ajustar alguns detalhes do &DTEP; acabado de criar. Recomenda-se que deixe esta opção assinalada.