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
92
93
94
95
96
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--Converted with LaTeX2HTML 2008 (1.71)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Preset Values</TITLE>
<META NAME="description" CONTENT="Preset Values">
<META NAME="keywords" CONTENT="mma-plugins">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
<META NAME="Generator" CONTENT="LaTeX2HTML v2008">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="mma-plugins.css">
<LINK REL="next" HREF="node4.html">
<LINK REL="previous" HREF="node2.html">
<LINK REL="up" HREF="mma-plugins.html">
<LINK REL="next" HREF="node4.html">
</HEAD>
<BODY bgcolor="#ffffff">
<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html49"
HREF="node4.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html47"
HREF="mma-plugins.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html41"
HREF="node2.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html50"
HREF="node4.html">Returning Values</A>
<B> Up:</B> <A NAME="tex2html48"
HREF="mma-plugins.html">Plugins</A>
<B> Previous:</B> <A NAME="tex2html42"
HREF="node2.html">Entry Points</A>
<BR>
<BR></DIV>
<!--End of Navigation Panel-->
<H1><A NAME="SECTION00300000000000000000">
Preset Values</A>
</H1>
<P>
When a plugin is initialized the dictionary <SPAN CLASS="textbf">PlugInName</SPAN> is
created in plugin module's namespace. It contains the following items:
<P>
<DL COMPACT>
<DT></DT>
<DD><PRE>
'name' - the name of the plugin. The case of the containing
directory is preserved
'dir' - the name of the directory containing the plugin. For
example: /home/bob/MMA/plugins
'path' - a complete path entry to the plugin. For example:
/home/bob/MMA/plugins/hello/plugin.py
'cmd' - the registered command name. For example, @HELLO
</PRE>
</DD>
</DL>
<P>
You can access any of these values in your module using the notation:
<P>
<DL COMPACT>
<DT></DT>
<DD><PRE>
zz = plugInName['name']
</PRE>
</DD>
</DL>
<P>
<BR><HR>
<ADDRESS>
Bob van der Poel
2016-06-11
</ADDRESS>
</BODY>
</HTML>
|
