apropos function is now available with new Java help browser
[scilab.git] / scilab / modules / helptools / macros / help.sci
1
2 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3 // Copyright (C) 2008 - INRIA - Vincent COUVERT
4 //
5 // This file must be used under the terms of the CeCILL.
6 // This source file is licensed as described in the file COPYING, which
7 // you should have received as part of this distribution.  The terms
8 // are also available at
9 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
10
11 function help(key)
12
13 if (fileinfo('SCI/modules/helptools/help') <> []) then
14   
15   if getscilabmode() <> "NWNI" then
16     
17     // No input argument: launch help browser
18     if argn(2)==0 then
19       global %helps
20       helpbrowser(%helps(:,1), getlanguage());
21       return
22     end
23     
24     // Search a function name
25     key=stripblanks(key)
26     
27     if or(part(key,1)==['(',')','[',']','{','}','%','''','""',':','*','/', ...
28             '\','.','<','>','&','^','|','~','+','-']) then
29       key="symbols";
30     end
31   
32     global %helps
33     helpbrowser(%helps(:,1), key, getlanguage(), %f);
34     
35     // If the function name does not exists then full-text search is done (See Java code)
36     
37   else
38
39     error(msprintf(gettext("%s: The help browser is disabled in %s mode.\n"), "help", getscilabmode()));
40   
41   end
42 else
43
44   error(msprintf(gettext("%s: help module is not installed.\n"), "help"));
45
46 end
47
48 endfunction
49
50
51
52
53
54
55
56
57