#DOCUMENTATION by cg
authorClaus Gittinger <cg@exept.de>
Thu, 13 Oct 2016 12:44:38 +0200
changeset 4125 d597206782cc
parent 4124 2d4e83bec872
child 4126 4d3ec803fddf
#DOCUMENTATION by cg class: KeywordInContextIndexBuilder comment/format in: #documentation #examples
KeywordInContextIndexBuilder.st
--- a/KeywordInContextIndexBuilder.st	Thu Oct 13 12:39:18 2016 +0200
+++ b/KeywordInContextIndexBuilder.st	Thu Oct 13 12:44:38 2016 +0200
@@ -40,6 +40,7 @@
 "
     A support class for building a KWIC (Keyword in Context) index.
     (for example, to build a KWIC index on html pages or class documentation).
+    
     To generate a kwic, add each line together with a reference (or page number, or whatever),
     using addLine:reference:.
     Then, when finished, enumerate the kwic.
@@ -52,7 +53,9 @@
     [class variables:]
 
     [see also:]
-
+        https://en.wikipedia.org/wiki/Key_Word_in_Context (english)
+        https://de.wikipedia.org/wiki/Permutiertes_Register (german)
+        
 "
 !
 
@@ -65,6 +68,7 @@
     kwic excluded:#('the' 'and' 'a' 'an').
 
     kwic addLine:'bla bla bla' reference:1.
+    kwic addLine:'foo, bar. baz' reference:1.
     kwic addLine:'one two three' reference:2.
     kwic addLine:'a cat and a dog' reference:3.
     kwic addLine:'the man in the middle' reference:4.