RubyGems - langhelp - Versions diffs - 0.9.8 - Mend

langhelp 0.9.8

Files changed (40) hide show

data/Changes +2530 -0
data/bin/mklanghelp +50 -0
data/data/langhelp/config.sample +889 -0
data/files +39 -0
data/graphviz-dot.jpg +0 -0
data/langhelp.en.html +409 -0
data/langhelp.en.rd +390 -0
data/langhelp.ja.html +524 -0
data/langhelp.ja.rd +487 -0
data/lib/el4r/emacsruby/autoload/50langhelp.rb +2 -0
data/lib/el4r/emacsruby/langhelp.rb +864 -0
data/lib/el4r/emacsruby/test-langhelp.rb +300 -0
data/lib/langhelp/langhelp-base.rb +649 -0
data/lib/langhelp/langhelp-sub.rb +1023 -0
data/lib/langhelp/lh_lua.rb +25 -0
data/lib/langhelp/lh_perl.rb +112 -0
data/lib/langhelp/lh_php.rb +34 -0
data/lib/langhelp/lh_python.rb +31 -0
data/lib/langhelp/lh_ruby.rb +400 -0
data/lib/langhelp/mklanghelp.rb +140 -0
data/lib/langhelp/parse-info.rb +145 -0
data/ri.jpg +0 -0
data/setup.rb +1551 -0
data/test/a_classes.lst +2 -0
data/test/a_methods.lst +2 -0
data/test/b_classes.lst +2 -0
data/test/b_methods.lst +2 -0
data/test/c_methods.lst +4 -0
data/test/common.rb +15 -0
data/test/d_methods.lst +4 -0
data/test/langhelp.e +566 -0
data/test/ruby.e +3 -0
data/test/tagify01-before.html +11 -0
data/test/tagify02-before.html +11 -0
data/test/test-base.rb +538 -0
data/test/test-command.rb +92 -0
data/test/test-parse-info.rb +175 -0
data/test/test-ruby.rb +242 -0
data/test/testdoc.rd +6 -0
metadata +84 -0

data/files ADDED Viewed

@@ -0,0 +1,39 @@
+Changes
+bin/mklanghelp
+data/langhelp/config.sample
+files
+graphviz-dot.jpg
+langhelp.en.html
+langhelp.en.rd
+langhelp.ja.html
+langhelp.ja.rd
+lib/el4r/emacsruby/autoload/50langhelp.rb
+lib/el4r/emacsruby/langhelp.rb
+lib/el4r/emacsruby/test-langhelp.rb
+lib/langhelp/langhelp-base.rb
+lib/langhelp/langhelp-sub.rb
+lib/langhelp/lh_lua.rb
+lib/langhelp/lh_perl.rb
+lib/langhelp/lh_php.rb
+lib/langhelp/lh_python.rb
+lib/langhelp/lh_ruby.rb
+lib/langhelp/mklanghelp.rb
+lib/langhelp/parse-info.rb
+ri.jpg
+setup.rb
+test/a_classes.lst
+test/a_methods.lst
+test/b_classes.lst
+test/b_methods.lst
+test/c_methods.lst
+test/common.rb
+test/d_methods.lst
+test/langhelp.e
+test/ruby.e
+test/tagify01-before.html
+test/tagify02-before.html
+test/test-base.rb
+test/test-command.rb
+test/test-parse-info.rb
+test/test-ruby.rb
+test/testdoc.rd

data/graphviz-dot.jpg ADDED Viewed

Binary file

data/langhelp.en.html ADDED Viewed

@@ -0,0 +1,409 @@
+<?xml version="1.0" encoding="iso-2022-jp" ?>
+<!DOCTYPE html
+  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="ja" xml:lang="ja">
+<head>
+<title>langhelp: Integrated help system in EmacsRuby</title>
+<meta http-equiv="Content-type" content="text/html; charset=iso-2022-jp" />
+<!-- head-element:nil -->
+</head>
+<body>
+<h2>Index</h2>
+<ul>
+<li><p><a href="#label:1">What's new</a></p>
+<ul>
+<li><a href="#label:2">[2006/09/21] 0.9.8 released</a></li>
+<li><a href="#label:3">[2006/08/03] 0.9.7 released</a></li>
+<li><a href="#label:4">[2006/02/09] 0.9.6 released</a></li>
+<li><a href="#label:5">[2006/02/01] 0.9.5 released</a></li>
+<li><a href="#label:6">[2005/12/23] 0.9.4 released</a></li>
+<li><a href="#label:7">[2005/12/11] 0.9.3 released</a></li>
+<li><a href="#label:8">[2005/12/10] 0.9.2 released</a></li>
+<li><a href="#label:9">[2005/12/03] 0.9.1 released</a></li>
+<li><a href="#label:10">[2005/12/02] 0.9.0 released</a></li>
+</ul></li>
+<li><a href="#label:11">Abstract</a></li>
+<li><a href="#label:12">Screenshots</a></li>
+<li><p><a href="#label:13">Environment</a></p>
+<ul>
+<li><a href="#label:14">Langhelp support tools</a></li>
+</ul></li>
+<li><a href="#label:24">Install</a></li>
+<li><p><a href="#label:25">Configuration file</a></p>
+<ul>
+<li><a href="#label:26">Quick start</a></li>
+<li><a href="#label:27">Language-specific configuration</a></li>
+<li><a href="#label:28">Checking document definitions</a></li>
+<li><a href="#label:29">Troubleshooting</a></li>
+</ul></li>
+<li><p><a href="#label:30">How to Use</a></p>
+<ul>
+<li><a href="#label:31">Making Indexes</a></li>
+<li><p><a href="#label:32">In Emacs</a></p>
+<ul>
+<li><a href="#label:33">With `C-u'</a></li>
+<li><a href="#label:34">With `C-u C-u'</a></li>
+</ul></li>
+</ul></li>
+<li><p><a href="#label:35">Customizing</a></p>
+<ul>
+<li><a href="#label:36">`~/.langhelp/mklanghelp-init.rb'</a></li>
+<li><a href="#label:37">`~/.el4r/init.rb'</a></li>
+<li><a href="#label:38">If you do not like frames</a></li>
+</ul></li>
+<li><a href="#label:39">Porting to Other Editors</a></li>
+<li><a href="#label:40">Feedbacks</a></li>
+<li><a href="#label:41">License</a></li>
+</ul>
+<hr />
+<h1><a name="Title:" href="#Title:">Title:</a> <a name="label:0">langhelp: Integrated help system in EmacsRuby</a></h1><!-- RDLabel: "langhelp: Integrated help system in EmacsRuby" -->
+<h2><a name="1" href="#1">1</a> <a name="label:1">What's new</a></h2><!-- RDLabel: "What's new" -->
+<h3><a name="1.1" href="#1.1">1.1</a> <a name="label:2">[2006/09/21] 0.9.8 released</a></h3><!-- RDLabel: "[2006/09/21] 0.9.8 released" -->
+<ul>
+<li>The code was refactored, so langhelp needs el4r 1.0.4 or newer.</li>
+<li>Better Ri for (X)Emacs handling.</li>
+<li>New function: lh-man*</li>
+<li>New command: langhelp-test-definition-this-line</li>
+</ul>
+<h3><a name="1.2" href="#1.2">1.2</a> <a name="label:3">[2006/08/03] 0.9.7 released</a></h3><!-- RDLabel: "[2006/08/03] 0.9.7 released" -->
+<ul>
+<li>`langhelp-at-point' enables you to search for current word.</li>
+<li>Langhelp uses its own frame by default.</li>
+<li>Added a script to fetch <a href="http://srfi.schemers.org/">SRFI</a> documents.</li>
+<li>Adjusted to Emacs 22.</li>
+</ul>
+<h3><a name="1.3" href="#1.3">1.3</a> <a name="label:4">[2006/02/09] 0.9.6 released</a></h3><!-- RDLabel: "[2006/02/09] 0.9.6 released" -->
+<ul>
+<li>Fixed display problem of `lh-ri' function with ri-emacs.</li>
+<li><p>Many ways to follow link.</p>
+<ul>
+<li>Follow link in this line and put point on screen top. (normal:l, RET)</li>
+<li>Follow link in this line and center point in window. (;, L, C)</li>
+<li>Follow link in this line and select the help window to edit. (o)</li>
+<li>Follow link in this line and kill the help window buffer. (K, D)</li>
+</ul></li>
+</ul>
+<h3><a name="1.4" href="#1.4">1.4</a> <a name="label:5">[2006/02/01] 0.9.5 released</a></h3><!-- RDLabel: "[2006/02/01] 0.9.5 released" -->
+<ul>
+<li>Colorized title</li>
+<li>New function: lh-file, lh-center</li>
+<li>Narrowing to section</li>
+<li>*langhelp index* was sorted</li>
+<li>Many bug fix</li>
+</ul>
+<h3><a name="1.5" href="#1.5">1.5</a> <a name="label:6">[2005/12/23] 0.9.4 released</a></h3><!-- RDLabel: "[2005/12/23] 0.9.4 released" -->
+<ul>
+<li>New function: lh-to</li>
+<li>Reimplemented function: lh-goto-link</li>
+<li>Speeduped function: lh-w3m</li>
+<li>config: cvsbook, cvsbook-ja, WWWC documents</li>
+<li><p>class HTML</p>
+<ul>
+<li>new attributes: :recursive, :basedir</li>
+</ul></li>
+<li>Indented by tab.</li>
+</ul>
+<h3><a name="1.6" href="#1.6">1.6</a> <a name="label:7">[2005/12/11] 0.9.3 released</a></h3><!-- RDLabel: "[2005/12/11] 0.9.3 released" -->
+<ul>
+<li><p>class HTML</p>
+<ul>
+<li>Now you can specify multiple HTMLs.</li>
+<li>Extract the HTML title.</li>
+<li>Disable charset conversion with `:noconv' attribute.</li>
+<li>Support subversion book using these features.</li>
+</ul></li>
+</ul>
+<h3><a name="1.7" href="#1.7">1.7</a> <a name="label:8">[2005/12/10] 0.9.2 released</a></h3><!-- RDLabel: "[2005/12/10] 0.9.2 released" -->
+<ul>
+<li>langhelp full index (<kbd>d</kbd> in langhelp buffer or <kbd>C-u C-c s</kbd>).</li>
+<li>New class: HTML; create HTML index.</li>
+<li>More config settings. Not only programming languages but also shell commands.</li>
+</ul>
+<h3><a name="1.8" href="#1.8">1.8</a> <a name="label:9">[2005/12/03] 0.9.1 released</a></h3><!-- RDLabel: "[2005/12/03] 0.9.1 released" -->
+<ul>
+<li>Adjust to Ruby1.9.</li>
+<li>Langhelp default key binding (<kbd>C-c s</kbd>).</li>
+</ul>
+<h3><a name="1.9" href="#1.9">1.9</a> <a name="label:10">[2005/12/02] 0.9.0 released</a></h3><!-- RDLabel: "[2005/12/02] 0.9.0 released" -->
+<p>Initial release</p>
+<h2><a name="2" href="#2">2</a> <a name="label:11">Abstract</a></h2><!-- RDLabel: "Abstract" -->
+<p>Langhelp creates an index of documents of various programming languages and shell commands.
+Langhelp enables you to search documents instantly in Emacs.
+If you are a programmer, then you may sometimes wonder, what is the usage of this function?
+If you use Unices, then you may wonder, what is the usage of this command?
+Langhelp answers the question INSTANTLY.</p>
+<p>Currently langhelp supports languages and commands below.</p>
+<pre>planner, xnee, html, svn, bison,
+cvs, libtool, latex, ratpoisonrc, java,
+id-utils, gengetopt, wget, lua, php,
+texinfo, c++, c, standards, grep,
+rb, gdb, diff, octave, scheme,
+python, global, flex, tcl, m4,
+sed, screenrc, xmms-shell, gzip, perl,
+emacs-lisp, ruby, autoconf, sgrep, hurd,
+el4r, binutils, awk, graphviz-dot, makefile,
+sh, </pre>
+<p>Langhelp may be the first tool written in EmacsRuby in the world.
+In other words, langhelp is an practical example of EmacsRuby script.</p>
+<h2><a name="3" href="#3">3</a> <a name="label:12">Screenshots</a></h2><!-- RDLabel: "Screenshots" -->
+<ul>
+<li><a href="ri.jpg">Calling `ri' from langhelp. (Ruby)</a></li>
+<li><a href="graphviz-dot.jpg">Seeing HTML document of Graphviz DOT language.</a></li>
+</ul>
+<h2><a name="4" href="#4">4</a> <a name="label:13">Environment</a></h2><!-- RDLabel: "Environment" -->
+<p>Langhelp depends on some tools.</p>
+<ul>
+<li><a href="http://www.ruby-lang.org/">Ruby 1.8.2 or upper</a></li>
+<li>emacs21 / xemacs21 / emacs22</li>
+<li><a href="http://www.rubyist.net/~rubikitch/computer/el4r/">el4r 1.0.4 or upper</a></li>
+</ul>
+<p>I use Debian GNU/Linux and Emacs21<a name="footmark:1" id="footmark:1" href="#foottext:1"><sup><small>*1</small></sup></a>.
+Langhelp probably works on other GNU/Linux or Unices.
+Langhelp also works on Windows(Meadow + Cygwin).</p>
+<p>Langhelp does not compete against other document-lookup tools, but langhelp INTEGRATES document-lookup tools.
+The more you have tools, the more usefule langhelp is.</p>
+<h3><a name="4.1" href="#4.1">4.1</a> <a name="label:14">Langhelp support tools</a></h3><!-- RDLabel: "Langhelp support tools" -->
+<p>The following tools are not mandatory but strengthens langhelp.</p>
+<dl>
+<dt><a name="label:15" id="label:15"></a>various Info documents</dt><!-- RDLabel: "various Info documents" -->
+<dd>
+<p>Langhelp treats Info documents VERY EASY.</p>
+</dd>
+<dt><a name="label:16" id="label:16"></a><a href="http://w3m.sourceforge.net/">w3m</a>, <a href="http://emacs-w3m.namazu.org/">emacs_w3m</a></dt><!-- RDLabel: ", " -->
+<dd>
+<p>W3m processes HTML documents.
+Emacs-w3m is a WWW browser in Emacs, uses w3m internally.</p>
+</dd>
+<dt><a name="label:17" id="label:17"></a>Ri</dt><!-- RDLabel: "Ri" -->
+<dd>
+<p>Ri looks up Ruby methods. It is bundled in Ruby distribution.</p>
+</dd>
+<dt><a name="label:18" id="label:18"></a><a href="http://rubyforge.org/projects/ri-emacs/">Ri for (X)Emacs</a></dt><!-- RDLabel: "" -->
+<dd>
+<p>This tool speeds up `ri' calls.</p>
+</dd>
+<dt><a name="label:19" id="label:19"></a><a href="http://lua-users.org/files/wiki_insecure/users/NormanRamsey/luahelp">luahelp</a></dt><!-- RDLabel: "" -->
+<dd>
+<p>Luahelp searches <a href="http://www.lua.org/">Lua</a> documents.</p>
+</dd>
+<dt><a name="label:20" id="label:20"></a><a href="http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.html">Emacs Lisp List</a></dt><!-- RDLabel: "" -->
+<dd>
+<p>There are MANY EmacsLisp programs.</p>
+</dd>
+<dt><a name="label:21" id="label:21"></a><a href="http://www.rubyist.net/~rubikitch/computer/screenrc-mode/">screenrc.el</a></dt><!-- RDLabel: "" -->
+<dd>
+<p>Major mode for editing screenrc.</p>
+</dd>
+<dt><a name="label:22" id="label:22"></a>ratpoison.el</dt><!-- RDLabel: "ratpoison.el" -->
+<dd>
+<p>Major mode for editing ratpoisonrc. It is bundled in ratpoison distribution.</p>
+</dd>
+<dt><a name="label:23" id="label:23"></a><a href="http://cvs.savannah.gnu.org/viewcvs/*checkout*/bm/bm/bm.el?rev=HEAD&amp;content-type=text/plain">bm.el</a></dt><!-- RDLabel: "" -->
+<dd>
+<p>Visible bookmarks in buffer.</p>
+</dd>
+</dl>
+<h2><a name="5" href="#5">5</a> <a name="label:24">Install</a></h2><!-- RDLabel: "Install" -->
+<p>First install el4r to run EmacsRuby scripts.</p>
+<pre>ruby -ropen-uri -e 'URI("http://www.rubyist.net/~rubikitch/archive/el4r-1.0.4.tar.gz").read.display' &gt; el4r-1.0.4.tar.gz
+tar xzf el4r-1.0.4.tar.gz
+cd el4r-1.0.4
+ruby setup.rb
+ruby -S el4r-rctool -p
+ruby -S el4r-rctool -i</pre>
+<p>Then install langhelp.
+Please execute the following commands.</p>
+<pre>ruby -ropen-uri -e 'URI("http://www.rubyist.net/~rubikitch/archive/langhelp-0.9.8.tar.gz").read.display' &gt; langhelp-0.9.8.tar.gz
+tar xzvf langhelp-0.9.8.tar.gz</pre>
+<p>When you failed, please download it from the next link.</p>
+<ul>
+<li><a href="http://www.rubyist.net/~rubikitch/archive/langhelp-0.9.8.tar.gz">langhelp-0.9.8.tar.gz</a></li>
+</ul>
+<p>Then, install it.</p>
+<pre>cd langhelp-0.9.8
+ruby setup.rb</pre>
+<p>Victor Borja created <a href="http://darcs.thehatcher.com/vic/erebor-ebuilds/app-emacs/">Gentoo ebuild</a>. Thanks.</p>
+<p>Boris Daix created <a href="http://alysse.dyndns.org/~bdaix/debian/">Debian package</a>. Thanks.
+Put the following to your /etc/apt/sources.list:</p>
+<pre>deb http://alysse.dyndns.org/~bdaix/debian/packages unstable/
+deb-src http://alysse.dyndns.org/~bdaix/debian/packages unstable/</pre>
+<h2><a name="6" href="#6">6</a> <a name="label:25">Configuration file</a></h2><!-- RDLabel: "Configuration file" -->
+<p>The user configuration file of langhelp is `~/.langhelp/config', which is pure Ruby script.</p>
+<p>If you install langhelp for the first time, copy `data/langhelp/config.sample' to `~/.langhelp/config'.</p>
+<pre>cp data/langhelp/config.sample ~/.langhelp/config</pre>
+<p>Writing config from scratch is very very hard, so `config.sample' is also installed.
+The following command indicates where `config.sample' is.</p>
+<pre>ruby -rrbconfig -e 'puts "#{Config::CONFIG["datadir"]}/langhelp/config.sample"'</pre>
+<h3><a name="6.1" href="#6.1">6.1</a> <a name="label:26">Quick start</a></h3><!-- RDLabel: "Quick start" -->
+<p>First execute `mklanghelp' command. Beware two hyphens.</p>
+<pre>mklanghelp --all</pre>
+<p>If you use Windows, you may use `ruby -S'.</p>
+<pre>ruby -S mklanghelp --all</pre>
+<p>Probably you would encounter with many error messages because the documents does not exist in the path specified in the config file.
+Errors are ignored and langhelp does the best effort.</p>
+<p>Errors are erased by</p>
+<ul>
+<li>installing missing documents later</li>
+<li>fixing the paths</li>
+<li>commenting out the line</li>
+</ul>
+<p>Modify your config file after reading comments in config file CAREFULLY.</p>
+<h3><a name="6.2" href="#6.2">6.2</a> <a name="label:27">Language-specific configuration</a></h3><!-- RDLabel: "Language-specific configuration" -->
+<p>Langhelp works in Emacs.
+Many major modes for programming languages exist.
+Normally the name of major mode ends with `-mode'.</p>
+<p>Langhelp knows currently editing language by major mode.
+Here the `language name' of langhelp is defined: <em>the string removed `-mode' from major mode name</em>.
+For instance, ruby-mode is the major mode of Ruby, then the language name is `ruby'.
+graphviz-dot-mode is the major mode of <a href="http://www.graphviz.org/">Graphviz DOT language</a>, then the language name is `graphviz-dot'.</p>
+<p>If there is no major mode, use `define-generic-mode' or `define-derived-mode' to fabricate major mode.
+It is needed that the major mode ONLY exists.</p>
+<pre>Example:
+(define-generic-mode 'foo-mode (list ?#) nil nil nil nil)
+(define-derived-mode baz-mode fundamental-mode "baz")</pre>
+<p>Language-specific configuration means to specify @lang variable properly.</p>
+<p>The details are written in `data/langhelp/config.sample'.</p>
+<h3><a name="6.3" href="#6.3">6.3</a> <a name="label:28">Checking document definitions</a></h3><!-- RDLabel: "Checking document definitions" -->
+<p>Since version 0.9.8, langhelp provides document definition check function.
+Point the line containing file name (document definition Hash) and issue</p>
+<pre>M-x langhelp-test-definition-this-line</pre>
+<p>You check the index the document definition outputs.</p>
+<h3><a name="6.4" href="#6.4">6.4</a> <a name="label:29">Troubleshooting</a></h3><!-- RDLabel: "Troubleshooting" -->
+<p>The following command does syntax check.</p>
+<pre>ruby -c ~/.langhelp/config</pre>
+<h2><a name="7" href="#7">7</a> <a name="label:30">How to Use</a></h2><!-- RDLabel: "How to Use" -->
+<h3><a name="7.1" href="#7.1">7.1</a> <a name="label:31">Making Indexes</a></h3><!-- RDLabel: "Making Indexes" -->
+<p>Langhelp has indexes by language.
+`mklanghelp' command makes indexes based on config file.</p>
+<p>Invoking langhelp without arguments shows the usage.</p>
+<pre>Usage: mklanghelp [options] [languages]
+Supported languages: planner, xnee, html, svn, bison, cvs, libtool, latex, ratpoisonrc, java, id-utils, gengetopt, wget, lua, php, texinfo, c++, c, standards, grep, rb, gdb, diff, octave, scheme, python, global, flex, tcl, m4, sed, screenrc, xmms-shell, gzip, perl, emacs-lisp, ruby, autoconf, sgrep, hurd, el4r, binutils, awk, graphviz-dot, makefile, sh
+    -a, --all                        Output index of all languages.
+        --home=DIR                   Output directory of index files.
+        --suffix=SUFFIX              Suffix of index files [default: .e]
+    -c, --init-script FILE           Initialize script name [default: /home/rubikitch/.langhelp/mklanghelp-init.rb]
+    -f                               Suppress read of init script.
+        --langs                      Output supported languages.
+        --stdout                     Output index into stdout.
+    -e, --eval=EXP                   Evaluate.
+    -d, --debug                      Output stack trace when error occurred.</pre>
+<p>Invoking langhelp with arguments makes indexes of each languages.
+With `--all' option, languages makes indexes of all languages.</p>
+<pre>Example:
+mklanghelp ruby emacs-lisp
+mklanghelp --all</pre>
+<h3><a name="7.2" href="#7.2">7.2</a> <a name="label:32">In Emacs</a></h3><!-- RDLabel: "In Emacs" -->
+<p>If you want to access documents managed by langhelp, type</p>
+<pre>C-c s</pre>
+<p>If you are upgrading from 0.9.0, add the line below to config.</p>
+<pre>@langhelp_key = '\C-cs'</pre>
+<p>Then, the `*langhelp:langname*' buffer appears and starts incremental search.</p>
+<p>When you call langhelp, many lines containing EmacsLisp sexps appear.
+Sexp are colored by font-lock.
+Langhelp accesses information sources by evaluating sexps, so called lisp-hyperlink.
+This means that if you define the appropriate EmacsLisp function then langhelp can call EVERYTHING!</p>
+<p>The cursor movement is performed by vi-like <kbd>k</kbd>/<kbd>j</kbd> as well as <kbd>p</kbd>/<kbd>n</kbd>.</p>
+<p>To follow the link, type <kbd>l</kbd> or <kbd>RET</kbd>.
+Some links specify LINE to jump(line number or line contents).
+<kbd>l</kbd> or <kbd>RET</kbd> follow link in this line and put point on screen top.
+<kbd>;</kbd>, <kbd>L</kbd> or <kbd>C</kbd> follow link in this line and center point in window.
+<kbd>o</kbd> follows link in this line and selects the help window to edit.</p>
+<p>Following many links increase buffers.
+Typing <kbd>K</kbd> or <kbd>D</kbd> kills the help window buffer.</p>
+<p>Typing <kbd>C-o</kbd> in incremental search does search refinement.</p>
+<p>If <a href="http://cvs.savannah.gnu.org/viewcvs/*checkout*/bm/bm/bm.el?rev=HEAD&amp;content-type=text/plain">bm.el</a> are installed, typing <kbd>m</kbd> makes bookmark.
+<kbd>P</kbd> and <kbd>N</kbd> perform bookmark jump.</p>
+<p><kbd>C-c C-n</kbd> toggles narrowing to this section.</p>
+<p>Typing <kbd>C-c C-c</kbd> exits langhelp and restore window configuration before langhelp was called.</p>
+<p>Some people may perfer using `window manager' of Emacs.
+Install <a href="http://www.gentei.org/~yuuji/software/windows.el">windows.el</a>,  <a href="http://www.splode.com/~friedman/software/emacs-lisp/src/escreen.el">escreen.el</a> or <a href="http://www.morishima.net/~naoto/software/elscreen/">elscreen.el</a> when you want to save window configuration.</p>
+<p>Remember to restart el4r when you remake indexes or modify config file after starting langhelp.</p>
+<pre>M-x el4r-boot</pre>
+<h4><a name="7.2.1" href="#7.2.1">7.2.1</a> <a name="label:33">With `C-u'</a></h4><!-- RDLabel: "With `C-u'" -->
+<p>Typing <kbd>C-u C-c s</kbd> shows langhelp full index, which is the list of languages managed by langhelp.
+Typing <kbd>d</kbd> in langhelp buffer also shows langhelp full index.</p>
+<h4><a name="7.2.2" href="#7.2.2">7.2.2</a> <a name="label:34">With `C-u C-u'</a></h4><!-- RDLabel: "With `C-u C-u'" -->
+<p>Typing <kbd>C-u C-u C-c s</kbd> searches current word. (since v0.9.7)</p>
+<p>Alternatively typing</p>
+<pre>M-x langhelp-at-point</pre>
+<p>does the same thing.</p>
+<h2><a name="8" href="#8">8</a> <a name="label:35">Customizing</a></h2><!-- RDLabel: "Customizing" -->
+<p>If you want to customize langhelp, read config file carefully.</p>
+<p>As explaining in the config file there are some general purpose classes:`Grep', `W3MGrep'.
+`Grep' extracts lines matching the regexp and makes index.
+`W3MGrep' is almost the same as `Grep', the only difference is that the plain-text generated by w3m is to be processed.
+Manuals in plain-text or HTML can be imported into langhelp easily by regexp.</p>
+<h3><a name="8.1" href="#8.1">8.1</a> <a name="label:36">`~/.langhelp/mklanghelp-init.rb'</a></h3><!-- RDLabel: "`~/.langhelp/mklanghelp-init.rb'" -->
+<p>`~/.langhelp/mklanghelp-init.rb' is a Ruby script called by `mklanghelp' before processing.</p>
+<p>Index classes are subclass of AbstractIndex.
+Write your own index classes in that file.</p>
+<p>After defining new index classes you can use it by specifying config file.</p>
+<pre>Example:
+@lang["foo"] = [
+  {:FooIndex =&gt; true, :title=&gt;"Foo", :cmd=&gt;"fooindex"},
+]</pre>
+<p>Then execute `mklanghelp'.</p>
+<h3><a name="8.2" href="#8.2">8.2</a> <a name="label:37">`~/.el4r/init.rb'</a></h3><!-- RDLabel: "`~/.el4r/init.rb'" -->
+<p>`~/.el4r/init.rb' are loaded when starting el4r.</p>
+<p>Langhelp can treat any EmacsLisp functions as lisp-hyperlink.
+But the functions with the prefix `lh-' are colorized by font-lock.</p>
+<h3><a name="8.3" href="#8.3">8.3</a> <a name="label:38">If you do not like frames</a></h3><!-- RDLabel: "If you do not like frames" -->
+<p>Since v0.9.7, langhelp on Emacs on window systems uses its own frame.
+If you do not like frames, add</p>
+<pre>@NO_FRAME = true</pre>
+<p>to `~/.langhelp/config'.</p>
+<h2><a name="9" href="#9">9</a> <a name="label:39">Porting to Other Editors</a></h2><!-- RDLabel: "Porting to Other Editors" -->
+<p>`bin/mklanghelp' and `lib/langhelp/*.rb' does not utterly depend on specific editors.
+The task of These files is only to write indexes.
+Writing `Local Variables' section is only related to Emacs.</p>
+<p>If you write the program corresponding to `lib/el4r/emacsruby/langhelp.rb', i.e. implementing all the functions appearing in the index, langhelp will work on other Lisp-based editors.
+Because sexps appearing in the index are not nested, reading the text between () will enable langhelp to work on non-Lisp-based editors.</p>
+<p>If you port langhelp to other editors, I am willing to include your contribution.</p>
+<h2><a name="10" href="#10">10</a> <a name="label:40">Feedbacks</a></h2><!-- RDLabel: "Feedbacks" -->
+<p>If you are trouble with langhelp, please post to the mail form at the end of this page freely.
+I am waiting for better configurations and new language supports.</p>
+<h2><a name="11" href="#11">11</a> <a name="label:41">License</a></h2><!-- RDLabel: "License" -->
+<p>GPL</p>
+<hr />
+<p>
+<a name="foottext:1" id="foottext:1" href="#footmark:1"><sup><small>*1</small></sup></a><small>I currently use Emacs22.</small><br />
+</p>
+</body>
+</html>