/usr/share/doc/appstream/html/sect-Metadata-Fonts.html is in appstream-doc 0.10.6-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title xmlns:d="http://docbook.org/ns/docbook">2.5. Fonts</title><link rel="stylesheet" type="text/css" href="Common_Content/css/default.css" /><link rel="stylesheet" media="print" href="Common_Content/css/print.css" type="text/css" /><meta xmlns:d="http://docbook.org/ns/docbook" name="generator" content="publican v4.3.2" /><meta xmlns:d="http://docbook.org/ns/docbook" name="package" content="AppStream-AppStream-0.10-en-US-0.0-0" /><link rel="home" href="index.html" title="AppStream" /><link rel="up" href="chap-Metadata.html" title="Chapter 2. Upstream Metadata" /><link rel="prev" href="sect-Metadata-Addon.html" title="2.4. Addons" /><link rel="next" href="sect-Metadata-Codec.html" title="2.6. Codecs" /></head><body><p id="title"><a class="left" href="http://www.freedesktop.org/wiki/Distributions/AppStream/"><img alt="Product Site" src="Common_Content/images//image_left.png" /></a><a class="right" href="http://www.freedesktop.org/software/appstream/docs/"><img alt="Documentation Site" src="Common_Content/images//image_right.png" /></a></p><ul class="docnav top"><li class="previous"><a accesskey="p" href="sect-Metadata-Addon.html"><strong>Prev</strong></a></li><li class="home">AppStream</li><li class="next"><a accesskey="n" href="sect-Metadata-Codec.html"><strong>Next</strong></a></li></ul><div xml:lang="en-US" class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title"><a id="sect-Metadata-Fonts">
</a>2.5. Fonts</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-fontdata-introduction">
</a>2.5.1. Introduction</h3></div></div></div><div class="para">
A software center can allow users to install additional fonts using font metadata. Also, applications can use font metadata to find missing fonts (for example, if a special mathematical font is needed) in the distribution's software sources. This metainfo specification describes how metadata for fonts or font collections should be structured.
</div><div class="para">
Font packages can ship one or more files in <code class="filename">/usr/share/metainfo/%{id}.metainfo.xml</code>.
</div><div class="para">
Font metadata files can – just like all other metainfo files – be translated. See the section about translation for more information.
</div><div xmlns:d="http://docbook.org/ns/docbook" class="note"><div class="admonition_header"><p><strong>Note</strong></p></div><div class="admonition"><div class="para">
A <code class="literal">font</code> component is in most cases not describing a single font, but rather a collection of fonts that are grouped together, usually by their art style or font-family.
</div><div class="para">
To make the individual fonts known to the system, use the <a class="xref" href="sect-Metadata-Fonts.html#tag-font-provides"><provides/> ↪ <font/></a> tag.
</div></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-fontdata-example">
</a>2.5.2. Example file</h3></div></div></div><div class="para">
A minimal font metainfo file can look like this:
</div><pre class="programlisting"><span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"><?xml</span> version="1.0" encoding="UTF-8"<span xmlns="" class="perl_Keyword">?></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"><component</span><span xmlns="" class="perl_Others"> type=</span><span xmlns="" class="perl_String">"font"</span><span xmlns="" class="perl_Keyword">></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><id></span>com.latofonts.Lato<span xmlns="" class="perl_Keyword"></id></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><metadata_license></span>MIT<span xmlns="" class="perl_Keyword"></metadata_license></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><project_license></span>OFL-1.1<span xmlns="" class="perl_Keyword"></project_license></span>
<span xmlns="" class="line"></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><name></span>Lato<span xmlns="" class="perl_Keyword"></name></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><summary></span>A sanserif typeface family<span xmlns="" class="perl_Keyword"></summary></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><description></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><p></span>
<span xmlns="" class="line"></span> Lato is a sanserif typeface family designed in the Summer 2010 by Warsaw-based designer
<span xmlns="" class="line"></span> Łukasz Dziedzic (“Lato” means “Summer” in Polish). In December 2010 the Lato family
<span xmlns="" class="line"></span> was published under the open-source Open Font License by his foundry tyPoland, with
<span xmlns="" class="line"></span> support from Google.
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></p></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></description></span>
<span xmlns="" class="line"></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><provides></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><font></span>Lato Regular<span xmlns="" class="perl_Keyword"></font></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><font></span>Lato Italic<span xmlns="" class="perl_Keyword"></font></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><font></span>Lato Bold<span xmlns="" class="perl_Keyword"></font></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><font></span>Lato Light<span xmlns="" class="perl_Keyword"></font></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><font></span>Lato Light Italic<span xmlns="" class="perl_Keyword"></font></span>
<span xmlns="" class="line"></span> ...
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></provides></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"></component></span></pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-fontdata-filespec">
</a>2.5.3. File specification</h3></div></div></div><div class="para">
Note that the XML root must have the <code class="literal">type</code> property set to <code class="code">font</code>. This clearly identifies this metainfo document as describing a font.
</div><div class="variablelist"><dl class="variablelist"><dt><span class="term"><id/></span></dt><dd><div class="para">
For fonts, the <code class="literal">%{id}</code> must follow the reverse-DNS scheme as described for generic components. For the product name part, it is recommended to take the the name of the font or font bundle without whitespace.
</div></dd><dt><span class="term"><metadata_license/></span></dt><dd><div class="para">
The <code class="code"><metadata_license/></code> tag is required. See <a class="xref" href="chap-Metadata.html#tag-metadata_license"><metadata_license/></a> for a description of this tag.
</div></dd><dt><span class="term"><name/></span></dt><dd><div class="para">
Set a name for the font or font collection.
</div></dd><dt><span class="term"><summary/></span></dt><dd><div class="para">
A short description of the font described in this metainfo file.
</div></dd><dt><span class="term"><description/></span></dt><dd><div class="para">
Add a long description of your font. Do not assume the format is HTML. Only paragraph, ordered list and unordered list are supported at this time.
</div><div class="para">
See the generic component <a class="xref" href="chap-Metadata.html#tag-description"><description/></a> for a detailed description of this tag.
</div></dd><dt><span class="term"><screenshots/></span></dt><dd><div class="para">
A screenshot presents your font to the outside world.
</div><div class="para">
If the font metadata does not define an own screenshot, the AppStream generator is supposed to render one or multiple sample images using the respective font.
</div><div class="para">
See the generic component <a class="xref" href="chap-Metadata.html#tag-screenshots"><screenshots/></a> for a detailed description of this tag.
</div></dd><dt><span class="term"><url/></span></dt><dd><div class="para">
This is a recommended tag for links of type <code class="code">homepage</code>. Links of type <code class="code">homepage</code> should be a link to the upstream homepage for the application. See the generic component <a class="xref" href="chap-Metadata.html#tag-url"><url/></a> for a description of this tag.
</div></dd><dt><a id="tag-font-provides">
</a><span class="term"><provides/> ↪ <font/></span></dt><dd><div class="para">
This tag is described in detail for generic components at <a class="xref" href="chap-Metadata.html#tag-provides"><provides/></a>.
</div><div class="para">
You should add one or more children of type <code class="code"><font/></code> to make the font's full-names known. The full-name should be the same as given in the font file for the English language. If no full-name is set, a space-separated combination of the font's <code class="literal">family</code> and <code class="literal">style</code> is used instead. The font <span class="emphasis"><em>must</em></span> have a <code class="literal">family</code> defined to be included.
</div><div class="para">
The full-name entry should show the complete name of a typeface in its “natural” form, including style and character set information (if any), and without abbreviations. This is the name that some systems and applications look at to determine full, unabbreviated font menu names.
</div><div class="para">
If you want to query the full-name and its <code class="literal">family</code> and <code class="literal">style</code> to see what needs to be added to this tag, you can use the <code class="command">fc-query</code> utility of Fonconfig:
</div><pre class="screen"><code class="command">fc-query</code> --format='FN: %{fullname[0]}\nFS: %{family[0]} %{style[0]}\n' <strong class="userinput"><code>FONT-FILENAME</code></strong></pre><div class="para">
Examples:
</div><pre class="programlisting"><span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"><provides></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><font></span>Lato Heavy Italic<span xmlns="" class="perl_Keyword"></font></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><font></span>Noto Kufi Arabic Bold<span xmlns="" class="perl_Keyword"></font></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><font></span>Liberation Serif Bold Italic<span xmlns="" class="perl_Keyword"></font></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><font></span>FontAwesome Regular<span xmlns="" class="perl_Keyword"></font></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"></provides></span></pre><div class="para">
If no <code class="code"><font/></code> tags were defined, the AppStream collection data generator should try to extract them from the actual font files found in the software package/bundle.
</div><div class="para">
In every case, the names given in the provides tag <span class="emphasis"><em>must</em></span> match the metadat the fonts contain themselves. If the data of the font files is incomplete, the data can not be extended by the <code class="code"><font/></code> tag. This is important because the AppStream generator may use the data to pick the right fonts, and because applications expect the exact font they requested via AppStream to be present on the system after the component was installed (and not one which has different metadata).
</div></dd><dt><a id="tag-font-languages">
</a><span class="term"><languages/></span></dt><dd><div class="para">
This tag gives information about the locale a font supports.
</div><div class="para">
This tak allows specifying the main locale (and thereby scripts) the font can be used with. It does not have to contain an extensive list, as the AppStream metadata generator will try get obtain that information from the font files themselves, but it is useful to define to hint the generator in the right direction.
</div><div class="para">
If samples of the font are rendered as screenshots by the collection metadata generator, the locale mentioned in the metainfo file will be preferred over automatically (or heuristically) defined ones.
</div><div class="para">
You can use the following command to determine which languages a font supports:
</div><pre class="screen"><code class="command">fc-query</code> --format='%{lang}\n' <strong class="userinput"><code>FONT-FILENAME</code></strong></pre><div class="para">
Tag example:
</div><pre class="programlisting"><span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"><languages></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><lang></span>de<span xmlns="" class="perl_Keyword"></lang></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><lang></span>en<span xmlns="" class="perl_Keyword"></lang></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><lang></span>cn<span xmlns="" class="perl_Keyword"></lang></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"></languages></span>
</pre></dd></dl></div><div class="para">
For a component of type <code class="literal">font</code>, the following tags are required and must be present: <a class="xref" href="chap-Metadata.html#tag-id-generic"><id/></a>, <a class="xref" href="chap-Metadata.html#tag-name"><name/></a>, <a class="xref" href="chap-Metadata.html#tag-summary"><summary/></a>, <a class="xref" href="chap-Metadata.html#tag-metadata_license"><metadata_license/></a>, <a class="xref" href="sect-Metadata-Fonts.html#tag-font-provides"><provides/> ↪ <font/></a>.
</div></div></div><ul class="docnav"><li class="previous"><a accesskey="p" href="sect-Metadata-Addon.html"><strong>Prev</strong>2.4. Addons</a></li><li class="up"><a accesskey="u" href="#"><strong>Up</strong></a></li><li class="home"><a accesskey="h" href="index.html"><strong>Home</strong></a></li><li class="next"><a accesskey="n" href="sect-Metadata-Codec.html"><strong>Next</strong>2.6. Codecs</a></li></ul></body></html>
|