Capítulo 13. Informações de autor, licença e versão

Você criou um conjunto de plugins e está se preparando para compartilhar seu trabalho. Para garantir que os usuários saibam do que se trata o seu trabalho, sob quais termos eles podem usá-lo e distribuí-lo, e com quem devem entrar em contato para problemas ou ideias, você deve adicionar algumas informações sobre seus plugins. Isso pode ser feito usando o elemento <about>. Ele pode ser usado tanto no .pluginmap quanto em arquivos .xml de plugins individuais (em ambos os casos, como um filho direto da tag document). Quando especificado no .pluginmap, ele se aplicará a todos os plugins. Se <about> for especificado em ambos os locais, as informações de <about> no arquivo .xml do plugin substituirão as do arquivo do .pluginmap. Você também pode adicionar um elemento <about> às páginas .rkh que não estão conectadas a um plugin, se necessário.

Aqui está um exemplo de arquivo .pluginmap com apenas algumas explicações. Em caso de dúvida, mais informações podem ser encontradas na documentação.

<document 
        namespace="rkward"
        id="SquaretheCircle_rkward"
>
        <about 
                name="Quadrado para Círculo"
                shortinfo="Quadrado para círculo usando a compensação de Heisenberg."
                version="0.1-3"
                releasedate="2011-09-19"
                url="http://eternalwondermaths.example.org/23/stc.html"
                license="GPL"
                category="Geometry"
        >
                <author 
                        given="E.A."
                        family="Dölle"
                        email="doelle@eternalwondermaths.example.org"
                        role="aut"
                 />
                <author 
                        given="A."
                        family="Assistant"
                        email="alterego@eternalwondermaths.example.org"
                        role="cre, ctb"
                 />
        </about>
        <dependencies>
                ...
        </dependencies>
        <components>
                ...
        </components>
        <hierarchy>
                ...
        </hierarchy>
</document>

A maior parte disso deve se explicar por si só, então não vamos discutir cada elemento de tag individualmente. Mas vamos analisar alguns detalhes que provavelmente precisam de comentários para facilitar a compreensão.

O elemento category em <about> pode ser definido de forma bastante livre, mas deve ser significativo, pois ele é usado para organizar plugins em grupos. Todos os outros atributos nesta tag de abertura são obrigatórios e devem ser preenchidos com conteúdo relevante.

Pelo menos um <author> com um endereço de e-mail válido e a função “aut” (“author”) também devem ser fornecidos. Caso seu plugin cause problemas ou alguém queira expressar sua gratidão, você poderá entrar em contato com alguém envolvido. Para mais informações sobre outras funções válidas, como “ctb” para contribuidores de código ou “cre” para manutenção de pacotes, consulte a documentação do R sobre person().