![](/trunk5/en/kdoctools5-common/top-kde.jpg)
Així que heu escrit un conjunt de connectors, i us esteu preparant per a compartir el vostre treball. Per a assegurar-vos que els usuaris sàpiguen de què tracta el vostre treball, amb quins termes poden utilitzar-lo i distribuir-lo, i a qui han de contactar sobre problemes o idees, heu d'afegir informació sobre els vostres connectors. Això es pot fer utilitzant l'element <about>. Es pot utilitzar en el .pluginmap
o en els fitxers .xml
d'un connector individual (en ambdós casos com a fill directe de l'etiqueta «document»). Quan s'especifica en el .pluginmap
s'aplicarà a tots els connectors. Si s'especifica <about> en ambdós llocs, la informació <about> del fitxer .xml
del connector substituirà la del fitxer .pluginmap
. També podeu afegir un element <about> a les pàgines .rkh, que no estan connectades a cap connector, si cal.
Aquest és un exemple del fitxer .pluginmap
amb només algunes explicacions, a continuació. En cas de dubte, es pot disposar de més informació a la referència.
<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>
La majoria d'això s'explica per si mateix, de manera que no debatrem cada element de l'etiqueta. Però mirem alguns detalls que probablement necessiten un comentari per a una comprensió més fàcil.
L'element category
a <about> es pot definir de forma bastant lliure, però hauria de ser significatiu, ja que es creu que s'utilitza per a ordenar connectors en grups. Tots els altres atributs d'aquesta etiqueta d'obertura són obligatoris i s'han d'omplir amb contingut raonable.
També s'ha d'indicar almenys un <author> amb una adreça de correu electrònic vàlida i també s'ha de donar el rol «aut» («author»). En cas que el vostre connector causi problemes o algú vulgui compartir la seva gratitud amb vosaltres, hauria de ser fàcil contactar algú que hi estigui implicat. Per a més informació sobre altres rols vàlids, com «ctb» per als col·laboradors de codi o «cre» per al manteniment de paquets, consulteu la documentació de l'R sobre person()
.
Nota
Recordeu que podeu utilitzar <include> i <insert> per a repetir informació a través de diversos fitxers .xml
(p. ex., informació sobre un autor que estava implicat en diversos connectors). Més informació.
Suggeriment
No heu d'escriure aquest codi XML a mà. Si utilitzeu la funció rk.plugin.skeleton()
des del paquet rkwarddev i proporcioneu tota la informació necessària a través de l'opció about
, es crearà automàticament un fitxer .pluginmap
amb una secció <about> funcional.