spirangle/horus-hieroglyphic

Include Egyptian hieroglyphic into webpages.

V2.0.1 2022-06-10 17:44 UTC

Requires

• php: >=7.4

Requires (Dev)

• phpunit/phpunit: ^9.5.20

MIT

• Per Löwgren

README

This package makes it possible to include Egyptian hieroglyphic into web pages. No font download is required in the web pages, instead all glyphs have been rendered as images, which are scaled to fill its attributed space. The syntax for writing hieroglyphic is based on WikiHiero so hieroglyphic texts can be copy-pasted from Wikipedia and then transliterated and scaled into glyph images. The images, scaling and rendering in Horus Hieroglyphic has been significantly improved.

It is also possible to generate new renditions of any hieroglyphic fonts into png images, and this package includes the script bin/generate which only requires that Image Magik is installed, as well as the font. The default font NewGardiner is however already pre-rendered and can be used as is.

Installing:

1. Extract the archive file NewGardiner.zip which contains the TTF-font and a complete set of PNG-images generated from the font. Make sure the extracted directory can be reached by a web browser. The URL to access the folder should be used for the option font-url.
2. Make sure the files in the assets directory can be reached by the browser.

Example:

To install the files to a LAMP stack, the files should be copied to /var/www/html/public. Then the directory structure should look like this:

|- /var/www/html/public
  |- /var/www/html/public/assets
    |- /var/www/html/public/assets/NewGardiner
    | |- A1.png ... Z9.png
    |- cartouche-left-1.png
    |- cartouche-left-2.png
    |- cartouche-right-1.png
    |- cartouche-right-2.png
    |- hiero.css

Acknowledgements:

• Mark-Jan Nederhof - For creating and kindly sharing the NewGardiner font, which is included in this package, and can be found at his web page: https://mjn.host.cs.st-andrews.ac.uk/egyptian/fonts/newgardiner.html

Versions:

2.0 (2022-06-06) Re-package project to a PHP composer module, and update PHP code to 7.4. 1.0 (2016-01-07) Initial release

The scripts are fully free for all private, academic and non-commercial use, including modification and redistribution. Acknowledgements where appropriate will of course be appreciated. If you're a company wanting to use the scripts for commercial purposes, please contact me first.