Розділ 13. Відомості про автора, умови ліцензування та версію

Отже, нехай вами створено набір додатків, і ви готові поділитися вашою роботою. Щоб повідомити користувачам про призначення вашої роботи, умови ліцензування та поширення та про те, з ким слід зв’язатися, якщо виникає потреба у сповіщенні про вади та побажання, вам слід додати відомості щодо ваших додатків. Зробити це можна за допомогою елемента <about>. Ним можна скористатися у .pluginmap або файлах .xml окремих додатків (у обох випадках як безпосереднім дочірнім елементом теґу document). Якщо цей елемент використано у .pluginmap, він стосуватиметься усіх додатків. Якщо <about> вказано у обох місцях, дані у <about> .xml окремого додатка матимуть пріоритет над даними з файла .pluginmap. Ви також можете додати елемент <about> у сторінки .rkh, які не з’єднано з додатками, якщо у цьому є потреба.

Нижче наведено приклад файла .pluginmap лише з декількома поясненнями. Якщо щось є незрозумілим, будь ласка, зверніться з довідника щодо теґів.

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

Більша частина коду доволі очевидна, тому ми не будемо обговорювати усі теґи. Втім, ми розглянемо детально елементи, які потребують пояснень для кращого розуміння.

Елемент category у <about> може визначатися довільним чином, але має бути зрозумілим для програміста, оскільки його має бути використано для упорядковування додатків за групами. Усі інші атрибути у цьому початковому тезі є обов’язковими і мають бути заповнені відповідним чином.

Має бути також вказано принаймні один елемент <author> із коректною адресою електронної пошти і роллю «aut» («автор»). Якщо з вашим додатком виникатимуть проблеми або хтось захоче вам подякувати, має бути надійний спосіб зв’язатися із кимось причетним до додатка. Щоб дізнатися більше про інші коректні ролі учасників розробки, зокрема «ctb» для програмістів або «cre» для супровідників пакунка, будь ласка, зверніться до документації R з функції person().