Extension:WikiHiero

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
WikiHiero

Release status: stable

Implementation Tag
Description Enables the use of hieroglyphs with additional syntaxes
Author(s) Guillaume Blanchard, Max Semenik and others
License GPL
Download
Example
A2 B4 C6 D8
Tags
<hiero>
Hooks used
ParserFirstCallInit

BeforePageDisplay

Translate the WikiHiero extension if possible

Check usage and version matrix; code metrics
Bugs: list open list all report

The WikiHiero extension allows to add Ancient Egyptian hieroglyphs from a text written according to the Hieroglyph coding manual syntax.

Syntax[edit | edit source]

Look at the Hieroglyph coding manual for details.

In brief:

- separator
: subdivision
* juxtaposition
! end of line

Each hieroglyph is given a unique code:

  • A letter [A-Z + Aa] that represents the hieroglyph category (human, god, bird, etc.)
  • A number that represents the rank in this category [1-...]

This unique code is an extension of Gardiner's list of hieroglyph.
The Hieroglyph coding manual also allows using the more common phonemes as well as unique code.

For details, see WikiHiero's syntax.

Download[edit | edit source]

You can download the extension directly from the MediaWiki source code repository (browse code). You can get:

One of the extensions tags

Not all extensions have tags. Some extensions have tags for each release, in which case those tags have the same stability as the release. To download a tag

  • Go to the tags list
  • Click the name of the tag you want to download
  • Click "snapshot"
The latest version of one of the extensions branches

Each extension has a master branch containing the latest code (might be unstable). Extensions can have further branches as well.

  • Go to the branches list
  • Click the branch name
  • Click "snapshot"
A snapshot made during the release of a MediaWiki version.

This might be unstable and is not guaranteed to work with the associated MediaWiki version.

After you've got the code, save it into the extensions/wikihiero directory of your wiki.

If you are familiar with git and have shell access to your server, you can obtain the extension, with all its tags and branches, as follows:

cd extensions
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/wikihiero.git

Installation[edit | edit source]

  • Download and extract the files in a directory called wikihiero in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository.
  • Add the following code at the bottom of your LocalSettings.php:
require_once( "$IP/extensions/wikihiero/wikihiero.php" );
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.
Testing

Then try with some example wiki text like this:

<hiero>A1</hiero> which should produce the following output:

A1

Licence[edit | edit source]

Version history[edit | edit source]

Version number Details
0.2.0 New parser
0.2.1 Fix link to hieroglyph tables
0.2.2
  • Fix hieroglyph size when into a cartouche
  • Fix phonemes table to use 'Aa' category rather than 'J'
0.2.3 Add Swedish interface
0.2.4 Add Japanese and Dutch interface
0.2.5
  • Fix Swedish interface
  • Create a function to handle language entries lack
  • Change 'height' option by a 'scale' (in percentage)
  • Add a 'line' option to split text lines
0.2.6 * Add source annotation.
  • Support of both '-' and ' ' as separator
0.2.7
  • Add parsing process duration.
  • Add download section
0.2.8
  • Add Chinese interface.
  • Minor fix
0.2.9 This version is running at http://test.wikipedia.org/
  • Add Esperanto interface.
  • Fix cartouche size
0.2.10
  • Add Interlingua and Portuguese interface.
  • Fix cartouche images
0.2.11 XHTML 1.0 validation
0.2.12
0.2.15 incoming...
  • Add Català, Deutsch, Español and Latina interface.
  • Add a setting file for project specific features.
1.0 Major rewrite, now uses HTML5, CSS and written using OOP. Introduces a new special page, Hieroglyphs, for interactive experimentation with markup.

Todo list[edit | edit source]

  • Add number converter
  • Add space as a separator (like '-')
  • Add bracket support
  • Fix cartouche rendering (90%)
  • Optimize parser (avoid buffer reallocation)
  • Comment the source
  • Add individual glyph scale
  • Create CSS only rendering version (30%)
  • Add support for shading (need CSS)
  • Add individual glyph rotation (for image rendering)
  • Add support for comment and annotation code
  • Create image rendering (for far future)
  • Add red font

See also[edit | edit source]

External links[edit | edit source]