Capitolo 13. Informazioni su autore, licenza e versione

Avete scritto una serie di estensioni e vi state preparando a condividere il vostro lavoro. Per assicurarvi che gli utenti sappiano di cosa tratta, in quali termini possono usarlo e distribuirlo e chi dovrebbero contattare per problemi o idee, dovreste aggiungere alcune informazioni sulle vostre estensioni. Questo può essere fatto utilizzando l'elemento <about>. Può essere utilizzato sia nella .pluginmap o in singoli file .xml delle estensioni (in entrambi i casi come figlio diretto del tag document). Quando specificato nella .pluginmap si applicherà a tutte le estensioni. Se <about> è specificato in entrambi i posti, le informazioni <about> nel file .xml dell'estensione sovrascriveranno quelle nel file .pluginmap. Potete anche aggiungere un elemento <about> alle pagine .rkh, che non sono collegate a un'estensione, se ce n'è bisogno.

Ecco un file .pluginmap di esempio con solo alcune spiegazioni, di seguito. In caso di dubbio, ulteriori informazioni potrebbero essere disponibili dalla guida.

<document 
        namespace="rkward"
        id="QuadraturadelCerchio_rkward"
>
        <about 
                name="Quadratura del cerchio"
                shortinfo="Trova la quadratura del cerchio utilizzando la compensazione di Heisenberg."
                version="0.1-3"
                releasedate="2011-09-19"
                url="http://eternalwondermaths.example.org/23/stc.html"
                license="GPL"
                category="Geometria"
        >
                <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>

La maggior parte di questo dovrebbe spiegarsi da sola, quindi non discuteremo ogni singolo elemento del tag. Ma diamo un'occhiata ad alcuni dettagli che probabilmente necessitano di qualche commento per una più facile comprensione.

L'elemento category in <about> può essere definito piuttosto liberamente, ma dovrebbe essere significativo, poiché si ritiene che venga utilizzato per ordinare le estensioni. Tutti gli altri attributi in questo tag di apertura sono obbligatori e devono essere riempiti con un contenuto ragionevole.

Deve essere fornito anche almeno un <author> con un indirizzo email valido e il ruolo «aut» («author»). Nel caso in cui l'estensione causi problemi o qualcuno voglia condividere la sua gratitudine con voi, dovrebbe essere facile contattare qualcuno coinvolto. Per ulteriori informazioni su altri ruoli validi, come «ctb» per i contributori del codice o «cre» per la manutenzione dei pacchetti, fare riferimento alla documentazione documentazione di R su person().