Kapitel 13. Information om upphovsman, licens och version

Så du har skrivit ett antal insticksprogram och är klar att att dela med dig av ditt arbete. För att vara säker på att användare vet vad ditt arbete handlar om, med vilka villkor de kan använda och distribuera det, och vem de ska kontakta om problem eller idéer, bör du lägga till en del information om insticksprogrammen. Det kan göras med elementet <about>, som antingen kan användas i en .pluginmap eller i .xml-filer i enskilda insticksprogram (i båda fall som ett direkt underliggande objekt till dokumenttaggen). När det anges i en .pluginmap gäller det alla insticksprogram. Om <about> anges på båda ställen, överskrider informationen i <about> i insticksprogrammets .xml-fil den i .pluginmap-filen. Det går också att lägga till elementet <about> på .rkh-sidor, som inte är kopplade till ett insticksprogram, om det finns behov av det.

Nedan är ett exempel på en .pluginmap-fil med bara några få förklaringar. I tveksamma fall, kan mer information finnas tillgänglig i referensen.

<document 
        namespace="rkward"
        id="SquaretheCircle_rkward"
>
        <about 
                name="Square the Circle"
                shortinfo="Squares the circle using Heisenberg compensation."
                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>

Det mesta av det här bör vara självförklarande, så vi diskuterar inte varenda tagg-element. Men låt oss ta en titt på en del detaljer som troligen behöver några kommentarer för bättre förståelse.

Elementet category i <about> kan definieras ganska fritt, men bör vara meningsfullt, eftersom det är avsett att ordna insticksprogram i grupper. Alla andra egenskaper i den inledande taggen krävs, och måste fyllas i med rimligt innehåll.

Åtminstone en <author> med en giltig e-postadress och rollen ”aut” (”author”) måste också anges. Ifall insticksprogrammet orsakar problem, eller någon skulle vilja dela sin tacksamhet med dig, bör det vara enkelt att kontakta någon som är inblandad. För ytterligare information om andra giltiga roller, såsom ”ctb” för bidragsgivare av kod eller ”cre” för paketunderhåll, se R-dokumentation om person().