Hoofdstuk 13. Auteur, licentie en versie-informatie

U heeft dus een aantal plugins geschreven, en u wilt uw werk ter beschikking stellen aan anderen. Om er zeker van te zijn dat gebruikers weten waar uw werk over gaat, onder welke voorwaarden u het uitgeeft, en bij wie ze moeten zijn bij problemen of met ideeën, moet u wat extra informatie geven over uw plugins. Dit kan met het <about>-element, of in de .pluginmap of in afzonderlijke plugin .xml-bestanden (in beide gevallen als een directe child van de document-tag). Wanneer dit in de .pluginmap wordt opgegeven, geldt het voor alle plugins. Indien <about> op beide plaatsen wordt opgegeven, heeft <about> -informatie in het plugin .xml-bestand voorrang boven die in het .pluginmap -bestand. U kunt ook een <about>-element toevoegen aan .rkh-pagina's, die niet bij een plugin behoren, indien dat nodig is.

Hier volgt een voorbeeld van een .pluginmap-bestand met slechts een beetje informatie. In geval van twijfel kan er meer informatie beschikbaar zijn in de naslag (reference).

<document 
        namespace="rkward"
        id="SquaretheCircle_rkward"
>
        <about 
                name="Square the Circle"
                shortinfo="Cirkel-kwadratuur met Heisenberg compensatie."
                version="0.1-3"
                releasedate="2011-09-19"
                url="http://eternalwondermaths.example.org/23/stc.html"
                license="GPL"
                category="Meetkunde"
        >
                <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>

Het meeste is vanzelfsprekend, dus bespreken we niet elk tag-element. Maar laten we enkele details bekijken waar wat meer uitleg bij nodig zou kunnen zijn (SquaretheCircle : "Kwadratuur van de cirkel", een van de drie grote meetkundige problemen uit de oudheid, onoplosbaar met passer en liniaal).

Het category-element in <about> kan wat ruim worden gedefinieerd, maar moet betekenisvol zijn, omdat de bedoeling is dat het wordt gebruikt om plugins in groepen in te delen. Alle andere attributen in deze openingstag zijn verplicht en moeten worden ingevuld met een redelijke inhoud.

Ook moet minstens een <author> met een geldig emailadres en de role “aut” (“author”) worden opgegeven. Voor het geval dat er een probleem is met uw plugin, of als iemand u wilt bedanken, moet het eenvoudig zijn even contact met u op te nemen. Voor verdere informatie over andere valide rollen, zoals “ctb” voor mensen die code hebben bijgedragen (contribute), of “cre” voor pakketonderhoud (creator), zie R-documentatie over person().