Commits

Lars Yencken committed e59df58

Gives an overview of the gazetteer

  • Participants
  • Parent commits 2f6d6f6

Comments (0)

Files changed (1)

-== Welcome ==
-
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
-
-=== Wiki features ===
-
-This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
-
-The wiki itself is actually a hg repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
-
-Go ahead and try:
-
-{{{
-$ hg clone http://bitbucket.org/lars512/japan-post-gazetteer/wiki/
-}}}
-
-Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
-
-=== Syntax highlighting ===
-
-You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
-
-Here's an example of some Python code:
-
-{{{
-#!python
-
-def wiki_rocks(text):
-	formatter = lambda t: "funky"+t
-	return formatter(text)
-}}}
-
-You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
-
-Have fun!
+== Overview ==
+
+The Japan Post Gazetteer is a simple hierarchical resource listing Japanese place names in the prefecture and ward in which they occur. It was mined from the Japan Post web site, from their list of postal codes. Currently, this information is used to provide place names for the [[http://foks.info/|FOKS dictionary]], but it might be useful for other purposes.
+
+== Format ==
+
+The data is stored in a simple format, where each line is a space separated (depth, name, reading) tuple. Let's take a look at the first few lines of the file:
+
+{{{
+0 日本 にほん
+1 北海道 None
+2 北見市 キタミシ
+}}}
+
+The 0-level is the root node, listed as 日本 (Japan). For any other depth //n//, its parent is the previous node of depth (//n-1//).