blob: 0722c155d6d5a8aa1c0c0ae14f77407aff8b7c85 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) ????-2008 - INRIA
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
*
-->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="edit" xml:lang="en">
<refnamediv>
<refname>edit</refname>
<refpurpose>function editing</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>edit(functionname[,linenumber])</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<variablelist>
<varlistentry>
<term>functionname</term>
<listitem>
<para>character string</para>
</listitem>
</varlistentry>
<varlistentry>
<term>linenumber</term>
<listitem>
<para>integer</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
If <literal>functionname</literal> is the name of a defined scilab function
<literal>edit(functionname)</literal> try to open the associated file
<literal>functionname.sci</literal>.
</para>
<para>
If <literal>functionname</literal> is the name of a undefined scilab function
<literal>edit(functionname)</literal> create a <literal>functionname.sci</literal> file in
the current directory.
</para>
<para>
If <literal>functionname</literal> is not a valid macro or function name
<literal>edit(functionname)</literal> opens the file with file name equal to
<literal>functionname</literal>.
</para>
<para>
If <literal>linenumber</literal> is given, the file is opened at this line relatively to the definition of the macro named as the file itself. If the macro definition is not found, the file is opened at line given by <literal>linenumber</literal>.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
//open editor with text of this function
edit('edit')
//open editor for a new function
edit('myfunction')
//open the file bar.sci in TMPDIR directory
edit(fullfile(TMPDIR+'bar.sci'))
// open the file test_run.sci at line 123
// relatively to the definition of test_run()
edit('test_run', 123)
]]></programlisting>
</refsection>
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="manedit">manedit</link>
</member>
<member>
<link linkend="names">names</link>
</member>
<member>
<link linkend="editor">editor</link>
</member>
</simplelist>
</refsection>
</refentry>
|
