DATA STRUCTURE of *.ref and *.rel files

diff --git a/lib/link.php b/lib/link.php
index 711be8d..42cffba 100644 (file)
--- a/lib/link.php
+++ b/lib/link.php
@@ -1,18 +1,31 @@
 <?php
 // PukiWiki - Yet another WikiWikiWeb clone
-// $Id: link.php,v 1.4 2005/01/29 13:51:44 henoheno Exp $
+// $Id: link.php,v 1.5 2005/04/23 00:13:00 henoheno Exp $
 //
 // Backlinks / AutoLinks related functions
 
-/*
- * CACHE_DIR/encode(¥Ú¡¼¥¸Ì¾).ref
- * »²¾È¸µ¥Ú¡¼¥¸Ì¾<tab>AutoLink¤Ë¤è¤ë¥ê¥ó¥¯¤Î¤ß¤Î¤È¤­1\n
- * »²¾È¸µ¥Ú¡¼¥¸Ì¾<tab>AutoLink¤Ë¤è¤ë¥ê¥ó¥¯¤Î¤ß¤Î¤È¤­1\n
- * ...
- *
- * CACHE_DIR/encode(¥Ú¡¼¥¸Ì¾).rel
- * »²¾ÈÀè¥Ú¡¼¥¸Ì¾<tab>»²¾ÈÀè¥Ú¡¼¥¸Ì¾<tab>...
- */
+// ------------------------------------------------------------
+// DATA STRUCTURE of *.ref and *.rel files
+
+// CACHE_DIR/encode('foobar').ref
+// ---------------------------------
+// Page-name1<tab>0<\n>
+// Page-name2<tab>1<\n>
+// ...
+// Page-nameN<tab>0<\n>
+//
+//     0 = Added when link(s) to 'foobar' added clearly at this page
+//     1 = Added when the sentence 'foobar' found from the page
+//         by AutoLink feature
+
+// CACHE_DIR/encode('foobar').rel
+// ---------------------------------
+// Page-name1<tab>Page-name2<tab> ... <tab>Page-nameN
+//
+//     List of page-names linked from 'foobar'
+
+// ------------------------------------------------------------
+
 
 // ¥Ç¡¼¥¿¥Ù¡¼¥¹¤«¤é´ØÏ¢¥Ú¡¼¥¸¤òÆÀ¤ë
 function links_get_related_db($page)