https://github.com/googlefonts/fontreport

Tool to create PDF files containing glyph images and information about a font.
https://github.com/googlefonts/fontreport

Last synced: 28 days ago
JSON representation

Tool to create PDF files containing glyph images and information about a font.

• Host: GitHub
• URL: https://github.com/googlefonts/fontreport
• Owner: googlefonts
• License: apache-2.0
• Archived: true
• Created: 2016-05-02T22:48:39.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2022-08-12T15:05:20.000Z (over 2 years ago)
• Last Synced: 2024-11-02T16:07:54.013Z (about 1 month ago)
• Language: Python
• Size: 244 KB
• Stars: 62
• Watchers: 40
• Forks: 18
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-typography - FontReport - Tool to create PDF files containing glyph images and information about a font. (Python)

README

        
# FontReport

FontReport is a tool that allows the user to generate a report about a given

font (TTF or OTF) listing its features in the plain-text (default) or PDF

format. It is useful in quickly identifying such things as the Unicode coverage

of the font, what glyphs are in it, what Open Type features it supports,

available ligatures, and glyph substitutions.

## Requirements

Install TeX Live following installation instructions for your platform. (Text

Live is needed because FontReport uses xetex to generate PDF from .tex source.)

Also, make sure python setuptools are installed.

### Ubuntu

apt-get install python-setuptools texlive-xetex texlive-latex-recommended

### Mac OS X

Setuptools are pre-installed for MacOS-X. To set up TeX Live, download and run

MacTeX installation package at http://tug.org/cgi-bin/mactex-download/MacTeX.pkg

### Other platforms

See http://www.tug.org/texlive/

## Installation

    sudo python setup.py install

## Usage samples

### Generate a PDF report

    fontreport NotoSansMalayalam-Regular.ttf Malayalam.pdf

Resulting report: [malayalam.pdf](./examples/malayalam.pdf)

### Generate a plain-text report

    fontreport NotoSansMalayalam-Regular.ttf Malayalam.txt

Resulting report: [malayalam.txt](./examples/malayalam.txt)

### Find out if a given Unicode character is included in what fonts in a directory

    for file in *.ttf; do fontreport "$file" | grep U+XXXX > temp.txt && echo $file && cat temp.txt; done > summary.txt

### Find language-specific substitutions defined in a font

    fontreport NotoKufiArabic-Regular.ttf | grep locl

The output is:

    locl  Localized Forms arab-URD  1

       1  locl                  uni0667 -> uni06F7.urdu

       1  locl                  uni06F4 -> uni06F4.urdu

       1  locl                  uni06F6 -> uni0666

## Report Content

Currently a report consists of several tables:

*  Unicode coverage

*  Glyphs coverage

*  OpenType Features

*  Ligatures

*  Substitutions