Fonts spec template for multiple fonts

From FedoraProject

Revision as of 19:23, 15 January 2009 by Nim (Talk | contribs)

Jump to: navigation, search

A page of the Fonts Special Interest Group

Warning (medium size).png
Complex formatting ahead
This page presents an heavily annotated template. Its official version is always available in plain text in the fontpackages package.

Foreword

This template can be used with complex multi-font releases (several font families in one upstream archive):

  • if you intend to package a single font family, use this simpler template;
  • if upstream releases separate fonts in separate archives, do not try to stuff them in a single spec/package, just package them separately.
Note.png
What is a font family?
  • A font family corresponds to one entry in GUI font lists. For example, DejaVu Sans, DejaVu Serif and DejaVu Sans Mono are three different font families.
  • A font family is subdivided in faces or styles. DejaVu Sans Normal, DejaVu Sans Bold, DejaVu Sans Condensed Italic are three faces of the DejaVu Sans font family.
  • A font-metadata aware tool such as gnome-font-viewer[1] or fontforge[2] can be used to check the font family name and the font face/style declared by a font file.

The template

Replace <FONTNAME> with something appropriate such as foundryname-fontname. For Fedora purposes a “foundry” is an entity that publishes a set of fonts with consistent QA rules[3]. If fontname already includes the font or fonts affix, drop it.
%define fontname <FONTNAME>
fontconf is the optional fontconfig ruleset for the fonts being packaged. For more information on choosing the right fontconfig priorities, see this page.
%define fontconf <XX>-%{fontname}

Optional
#define archivename %{name}-%{version}


It is possible to define a description block that will be reused in every sub-package description. Please do not forget to complete it with subpackage-specific information later.
%define common_desc \
<FONT COLLECTION DESCRIPTION>


Name:           %{fontname}-fonts
Do not trust font metadata versionning[4], unless you've checked upstream does update versions on file changes. When in doubt use the timestamp of the most recent font file as version, for example 20081231.
Version:        
     
Release:        1%{?dist}
Font summaries need to be short and to the point. Usual informations are font style and Unicode coverage. Only repeat the font name(s) if you don't have anything else to write.
Summary:        

Group:          User Interface/X
Make sure you've read and understand our legal page.
License:        
URL:            
Source0:        
Source1:        %{name}-fontconfig.conf
BuildRoot:      %(mktemp -ud %{_tmppath}/%{name}-%{version}-%{release}-XXXXXX)

BuildArch:     noarch
BuildRequires: fontpackages-devel

%description
%common_desc


%package common
Summary:  Common files for <NAME> (documentation…)
Group:    User Interface/X
Requires: fontpackages-filesystem

%description common
%common_desc

This package consists of files used by other %{name} packages.

In this template, you must repeat blocks of instructions for every packaged font family.
%package -n %{fontname}-<FAMILY>-fonts
Font summaries need to be short and to the point. Usual informations are font style and Unicode coverage. Only repeat the font name(s) if you don't have anything else to write.
Summary:        
Group:    User Interface/X
Requires: %{name}-common = %{version}-%{release}


Font descriptions must detail information on the font style, Unicode coverage, and intended use[5] to help users choose the right packages to install. Also, it is considered good form to credit the original font designer and sum up the font history.

Incidentally, this is a good way to check if the licensing information declared by upstream is correct and if some fontconfig substitution rules can be added to the package.

Examples of terrific font descriptions are found on the Greek Font Society web site. This is what other font packages should strive to emulate.

%description -n %{fontname}-<FAMILY>-fonts
%common_desc

<FAMILY DESCRIPTION>

The %_font_pkg macro takes the following arguments:
  • an optional -n name subpackage name
  • an optional -f pattern fontconfig pattern name. The corresponding files must be installed by the packager in %{_fontconfig_templatedir} and %{_fontconfig_confdir} in the %install section.
  • a list of font names or font name patterns. The corresponding files must be installed by the packager in %{_fontdir} in the %install section.
%_font_pkg -n <FAMILY> -f %{fontconf}-<FAMILY>.conf <NAME>*.ttf


%prep
%setup -q


Building fonts from sources is always preferred. For GPLed or LGPLed fonts this is required by the license.
%build


%install
rm -fr %{buildroot}

install -m 0755 -d %{buildroot}%{_fontdir}
Change *.ttf to the actual location of your font files (in a subdirectory, in this directory with an otf extension, etc).
install -m 0644 -p *.ttf %{buildroot}%{_fontdir}

install -m 0755 -d %{buildroot}%{_fontconfig_templatedir} \
                   %{buildroot}%{_fontconfig_confdir}

In this template, you must repeat blocks of instructions for every packaged font family.
install -m 0644 -p %{SOURCEX} \
        %{buildroot}%{_fontconfig_templatedir}/%{fontconf}-<FAMILYX>.conf


To package a fontconfig ruleset disabled by default:
  • install it in %{_fontconfig_templatedir},
  • create symbolic link with the same name in %{_fontconfig_confdir}, that points to /dev/null.
for fconf in %{fontconf}-<FAMILYX>.conf \
                %{fontconf}-<FAMILYY>.conf \
                %{fontconf}-<FAMILYZ>.conf ; do
  ln -s %{_fontconfig_templatedir}/$fconf \
        %{buildroot}%{_fontconfig_confdir}/$fconf
done


%clean
rm -fr %{buildroot}


%files common
%defattr(0644,root,root,0755)
Documentation usually includes licensing and other information in plain text or PDF[6] format. Make sure your text files use maximum 80 column lines with Unix-style line ends and are encoded in UTF-8.
%doc

%dir %{_fontdir}

Use one of the approved formats.
%changelog


Notes:

  1. Simple, but sadly not available in each and every Fedora release.
  2. Type <CTRL> + <SHIFT> + <F> to open the font metadata window in fontforge.
  3. Thus Sourceforge is not a foundry
  4. The metadata embedded in TTF or OTF files.
  5. Print, screen, headings, code…
  6. For example, font specimen pages


Idea.png
Fonts in Fedora
The Fonts SIG takes loving care of Fedora fonts. Please join this special interest group if you are interested in creating, improving, packaging, or just suggesting a font. Any help will be appreciated.