Poglavje 13. Informacije o avtorju, licenci in različici

Torej ste napisali niz vtičnikov in se pripravljate na delite svoje delo. Da bi zagotovili, da bodo uporabniki vedeli, kaj je vaše delo, pod kakšnimi pogoji lahko uporabljajo in ga distribuirajo in na koga naj se obrnejo glede težav ali idej, dodate nekaj informacij o vaših vtičnikih. To lahko storite z elementom <about>. Lahko se uporablja bodisi v .pluginmap ali v posameznem vtičniku .xml (v obeh primerih kot neposredni podrejeni datotekioznaka dokumenta). Ko je podano v .pluginmap veljalo bo za vsevtičniki. Če je <about> podan na obeh mestih,informacije <about> v vtičniku .xml bo preglasila tisto v datoteki .pluginmap. Dodate lahko tudi element <about> v .rkh-strani, ki niso povezane z vtičnikom, če je to potrebno.

Tukaj je primer .pluginmap datoteko z le nekaj pojasnili spodaj. V primeru dvoma lahko več informacij dobite pri referenci.

<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>

Večino tega je treba razložiti samo po sebi, zato ne bomo razpravljali o vsaki oznaki elementa posebej. Toda poglejmo nekaj podrobnosti, ki verjetno potrebujejo nekaj komentarja za lažje razumevanje.

Element category v <about> je mogoče definirati precej prosto, vendar bi moral biti smiseln, kot jenaj bi se uporabljal za razvrščanje vtičnikov v skupine. Vsi drugi atributi v tej začetni oznaka so obvezni in morajo biti napolnjeni z razumno vsebino.

Vsaj en <author> z veljavnim e-poštnim naslovom mora biti podan tudi vloga “aut” (“avtor”) mora biti podana. V primeru, da vaš vtičnik povzroča težave ali bi ga kdo želel deliti z drugimi hvaležnost z vami, mora biti enostavno vzpostaviti stik z nekom, ki je vpleten. Za dodatne informacije o drugih veljavnih vlogah, kot je “ctb” za kodoprispevke ali “cre” za vzdrževanje paketa, glejteR dokumentacija o person().