Простые пакеты

Простой пакет состоит из одного файла исходного кода Emacs Lisp. Файл должен соответствовать соглашениям заголовков библиотек Emacs Lisp (см. Заголовки библиотек). Атрибуты пакета берутся из различных заголовков, как показано в следующем примере:

;;; superfrobnicator.el --- Frobnicate and bifurcate flanges

;; Copyright (C) 2011 Free Software Foundation, Inc.

;; Author: J. R. Hacker <jrh@example.com>
;; Version: 1.3
;; Package-Requires: ((flange "1.0"))
;; Keywords: multimedia, hypermedia
;; URL: https://example.com/jrhacker/superfrobnicate

…

;;; Commentary:

;; This package provides a minor mode to frobnicate and/or
;; bifurcate any flanges you desire.  To activate it, just type
…

;;;###autoload
(define-minor-mode superfrobnicator-mode
…

Имя пакета совпадает с базовым именем файла, записанным в первой строке. Здесь это ‘superfrobnicator’.

Краткое описание также взято из первой строки. Здесь это ‘Frobnicate and bifurcate flanges’.

Номер версии берется из заголовка ‘Package-Version’, если он существует, или из заголовка ‘Version’ в противном случае. Один из них обязательно должен присутствовать. Здесь номер версии 1.3.

Если файл имеет раздел ‘;;; Commentary:’, этот раздел используется в качестве подробного описания. (При отображении описания Emacs опускает строку ‘;;; Commentary:’, а также начальные символы комментария в самом комментарии.)

Если файл имеет заголовок ‘Package-Requires’, он используется как зависимости пакета. В приведенном выше примере пакет зависит от пакета ‘flange’ версии 1.0 или выше. Смотрите Заголовки библиотек для описания заголовка ‘Package-Requires’. Если заголовок опущен, пакет не имеет зависимостей.

Заголовки ‘Keywords’ и ‘URL’ необязательны, но рекомендуются. Команда describe-package использует их для добавления ссылок в свой вывод. Заголовок ‘Keywords’ должен содержать по крайней мере один стандартный ключевой термин из списка finder-known-keywords.

Файл также должен содержать один или несколько магических комментариев autoload, как объяснено в Основы упаковки. В приведенном выше примере магический комментарий выполняет autoload superfrobnicator-mode.

См. Архивы пакетов для объяснения того, как добавить пакет из одного файла в архив пакетов.