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