commands.docbook 6.07 KB
Newer Older
1
<chapter id="commands">
2 3
<title>Command Reference</title> 

Burkhard Lück's avatar
Burkhard Lück committed
4 5 6 7 8 9 10 11 12
<sect1 id="menu">
<title>Menu Items</title>

<para>Apart from the common &kde; menus described in the <ulink url="help:/fundamentals/ui.html#menus">Menu</ulink> 
chapter of the &kde; Fundamentals documentation &kmplot; has these application specific menu entries:
</para>

<sect2 id="a-file-menu">
	<title>The File Menu</title>
David Saxton's avatar
David Saxton committed
13 14 15 16 17 18 19
	<variablelist>
		
		<varlistentry>
			<term>
				<menuchoice>
					<guimenu>File</guimenu>
					<guimenuitem>Export...</guimenuitem></menuchoice></term>
Burkhard Lück's avatar
Burkhard Lück committed
20
			<listitem><para><action>Exports</action> the plotted graphs to an image file in all formats supported by &kde;.</para></listitem>
David Saxton's avatar
David Saxton committed
21 22 23
		</varlistentry>
		
	</variablelist>
Burkhard Lück's avatar
Burkhard Lück committed
24
</sect2>
Philip Rodrigues's avatar
 
Philip Rodrigues committed
25

Burkhard Lück's avatar
Burkhard Lück committed
26 27
<sect2 id="a-edit-menu">
	<title>The Edit Menu</title>
David Saxton's avatar
David Saxton committed
28 29 30 31 32 33 34 35 36
	<variablelist>
		<varlistentry>
			<term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Constants...</guimenuitem>
				</menuchoice></term>
			<listitem><para>Displays the <guilabel>Constants</guilabel> dialog box. See <xref linkend="constants-config"/>.
				</para>
			</listitem>
		</varlistentry>
	</variablelist>
Burkhard Lück's avatar
Burkhard Lück committed
37
</sect2>
38

Burkhard Lück's avatar
Burkhard Lück committed
39 40
<sect2 id="a-view-menu">
	<title>The View Menu</title>
David Saxton's avatar
David Saxton committed
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
	<para>The first three items in the menu are related to zooming.</para>
	
	<variablelist>
		<varlistentry>
			<term>
				<menuchoice>
					<shortcut>
						<keycombo action="simul">&Ctrl;<keycap>1</keycap></keycombo>
					</shortcut>
					<guimenu>View</guimenu>
					<guimenuitem>Zoom In</guimenuitem>
				</menuchoice>
			</term>
			<listitem>
				<para>This tool can be operator in two different manners. To zoom in on a point on the graph, click on it. To zoom in on a specific section of the graph, hold and drag the mouse to form a rectangle, which will be the new axes ranges when the mouse button is released.</para>
			</listitem>
		</varlistentry>
		
		<varlistentry>
			<term>
				<menuchoice>
					<shortcut>
						<keycombo action="simul">&Ctrl;<keycap>2</keycap></keycombo>
					</shortcut>
					<guimenu>View</guimenu>
					<guimenuitem>Zoom Out</guimenuitem>
				</menuchoice>
			</term>
			<listitem>
				<para>The tool can also be used in two different manners. To zoom out and center on a point, click on that point. To fit the existing view into a rectangle, hold and drag the mouse to form that rectangle.</para></listitem>
		</varlistentry>
		
		<varlistentry>
			<term>
				<menuchoice>
76
					<guimenu>View</guimenu>
David Saxton's avatar
David Saxton committed
77 78 79 80 81 82 83
					<guimenuitem>Fit Widget to Trigonometric Functions</guimenuitem>
				</menuchoice>
			</term>
			<listitem><para>The scale will be adapted to trigonometric functions. This works both for radians and degrees.</para></listitem>
		</varlistentry>
		
		<varlistentry>
84
			<term><menuchoice><guimenu>View</guimenu><guimenuitem>Reset View</guimenuitem>
David Saxton's avatar
David Saxton committed
85
				</menuchoice></term>
86
			<listitem><para>Resets the view.
David Saxton's avatar
David Saxton committed
87 88 89 90 91
				</para>
			</listitem>
		</varlistentry>
		
		<varlistentry>
92
			<term><menuchoice><guimenu>View</guimenu><guimenuitem>Coordinate System...</guimenuitem>
David Saxton's avatar
David Saxton committed
93
				</menuchoice></term>
94
			<listitem><para>Displays the <guilabel>Coordinate System</guilabel> dialog box. See <xref linkend="coords-config"/>.
David Saxton's avatar
David Saxton committed
95 96 97 98 99
				</para>
			</listitem>
		</varlistentry>
		
		<varlistentry>
100 101
			<term><menuchoice><guimenu>View</guimenu>
					<guimenuitem>Show Sliders</guimenuitem>
David Saxton's avatar
David Saxton committed
102
				</menuchoice></term>
103
			<listitem>
Burkhard Lück's avatar
Burkhard Lück committed
104 105 106
				<para><action>Toggles</action> the visibility of the slider dialog. 
				In the dialog move a slider to change the parameter of the function plot connected to it.</para>
				<para>Enable this on the Function tab and select one of the sliders to change the parameter value dynamically. The values vary from 0 (left) to 10 (right) by default, but can be changed in the slider dialog.</para>
107
				<para>For a small tutorial see <ulink url="http://userbase.kde.org/KmPlot/Using_Sliders">Using Sliders</ulink>.</para>
Burkhard Lück's avatar
Burkhard Lück committed
108 109
				<!--http://forum.kde.org/viewtopic.php?f=21&t=90183 kmplot slider examples
				KmPlot supports only one parameter. Feature request on bugs.kde.org: https://bugs.kde.org/show_bug.cgi?id=139097-->
David Saxton's avatar
David Saxton committed
110 111
			</listitem>
		</varlistentry>
112
		
David Saxton's avatar
David Saxton committed
113
	</variablelist>
Burkhard Lück's avatar
Burkhard Lück committed
114
</sect2>
115

Burkhard Lück's avatar
Burkhard Lück committed
116 117
<sect2 id="a-tools-menu">
	<title>The Tools Menu</title>
David Saxton's avatar
David Saxton committed
118 119 120 121 122 123 124
	
	<para>This menu contains some tools for the functions that can be useful:</para>
	
	<variablelist>
		
		<varlistentry>
			<term><menuchoice><guimenu>Tools</guimenu>
125
					<guimenuitem>Calculator</guimenuitem>
David Saxton's avatar
David Saxton committed
126 127
				</menuchoice></term>
			<listitem>
128
				<para>Opens the <guilabel>Calculator</guilabel> dialog.</para>
David Saxton's avatar
David Saxton committed
129 130 131 132 133
			</listitem>
		</varlistentry>
		
		<varlistentry>
			<term><menuchoice><guimenu>Tools</guimenu>
134
					<guimenuitem>Plot Area...</guimenuitem>
David Saxton's avatar
David Saxton committed
135 136
				</menuchoice></term>
			<listitem>
Burkhard Lück's avatar
Burkhard Lück committed
137 138 139
				<para>Select a graph and the values of the horizontal axis in the new dialog that appears.
					Calculates the integral and draws the area between the graph and the horizontal axis in the 
					range of the selected values in the color of the graph.</para>
David Saxton's avatar
David Saxton committed
140 141 142 143 144
			</listitem>
		</varlistentry>
		
		<varlistentry>
			<term><menuchoice><guimenu>Tools</guimenu>
145
					<guimenuitem>Find Minimum...</guimenuitem>
David Saxton's avatar
David Saxton committed
146 147
				</menuchoice></term>
			<listitem>
148
				<para>Find the minimum value of the graph in a specified range.</para>
David Saxton's avatar
David Saxton committed
149 150 151 152 153
			</listitem>
		</varlistentry>
		
		<varlistentry>
			<term><menuchoice><guimenu>Tools</guimenu>
154
					<guimenuitem>Find Maximum...</guimenuitem>
David Saxton's avatar
David Saxton committed
155 156
				</menuchoice></term>
			<listitem>
157
				<para>Find the maximum value of the graph in a specified range.</para>
David Saxton's avatar
David Saxton committed
158 159 160 161
			</listitem>
		</varlistentry>
		
	</variablelist>
Burkhard Lück's avatar
Burkhard Lück committed
162
</sect2>
Philip Rodrigues's avatar
 
Philip Rodrigues committed
163

Burkhard Lück's avatar
Burkhard Lück committed
164 165
<sect2 id="a-help-menu">
	<title>The Help Menu</title>
David Saxton's avatar
David Saxton committed
166
	
Burkhard Lück's avatar
Burkhard Lück committed
167
	<para>&kmplot; has a standard &kde; <guimenu>Help</guimenu> with one addition:</para>
David Saxton's avatar
David Saxton committed
168 169 170 171 172 173 174
	
	<variablelist>
		<varlistentry>
			<term><menuchoice><guimenu>Help</guimenu>
					<guimenuitem>Predefined Math Functions...</guimenuitem>
				</menuchoice></term>
			<listitem>
175
				<para>Opens this handbook with a list of the predefined function names and constants
David Saxton's avatar
David Saxton committed
176 177 178 179 180
					that &kmplot; knows.</para>
			</listitem>
		</varlistentry>
	</variablelist>
	
Burkhard Lück's avatar
Burkhard Lück committed
181
</sect2>
182
</sect1>
Philip Rodrigues's avatar
 
Philip Rodrigues committed
183

184

185
</chapter>
Philip Rodrigues's avatar
 
Philip Rodrigues committed
186 187 188 189 190 191 192 193 194 195
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
sgml-parent-document:("index.docbook" "BOOK" "CHAPTER")
End:
-->