<?xml version="1.0" encoding="utf-8" standalone="no" ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" >

<book>

<title>Samurai Graph Users Manual</title>



<chapter>
	<title>Introduction</title>
	<para>
	Samurai Graph is a highly functional and user-friendly graph plotter.
	It can plot a graph from the scalar or vector type 2-dimensional data.
	Moreover, users can add various kinds of objects into the graph:
	Labels, timing lines, symbols of significant difference and symbols of axis breaking.
	Users can move, resize, and change the various objects by intuitive mouse operation.
	</para>
	<para>
	This users manual gives the minimal information to use this application.
	Advanced usage will be given in other documents.
	</para>
</chapter>



<chapter>

	<title>Make a Data File</title>

	<para>
	It is possible to use CSV format text files as data files.
	There are four acceptable data types as 2-dimensional data: Scalar XY, multiple XY, sampling XY and vector XY.
	Explanation of the file format of each data type is given as follows.
	</para>

	<section>
		<title>Scalar XY</title>
		<para>
		This type of data consists of the pairs of X and Y values.
		Samurai Graph can draw lines, symbols and bars for this type of data.
		Together with error values and strings in data, it can draw error bars and tick labels additionally.
		As scalar XY data, there are four possible formats given as follows.
		</para>

		<section>
			<title>Two columns of numeric values.</title>
			<para>
			They are regarded as X values and Y values, respectively.

					(X)		(Y)

					0.0		0.2
					0.1		0.4
					0.2		0.5
					 :		 :
					1.0		0.1
			</para>
		</section>

		<section>
			<title>Four columns of numeric values.</title>
			<para>
			They are regarded as X values, Y values, the lower and the upper error values, respectively.

					(X)		(Y)		(Lower Error Value)		(Upper Error Value)

					0.0		0.2				-0.08					0.12
					0.1		0.4				-0.05					0.09
					0.2		0.5				-0.10					0.12
					 :		 :				  :						  :
					1.0		0.1				-0.10					0.13
			</para>
		</section>

		<section>
			<title>Two columns of numeric values and one column of strings.</title>
			<para>
			They are regarded as X values, Y values and strings for the tick labels, respectively.

					(X)		(Y)		(String)

					0.0		0.2		  "A0"
					0.1		0.4		  "B1"
					0.2		0.5		  "C2"
					 :		 :		    :
					1.0		0.1		  "K10"
			</para>
		</section>

		<section>
			<title>Four columns of numeric values and one column of strings.</title>
			<para>
			They are regarded as X values, Y values, the lower and the upper error values
			and strings for the tick labels, respectively.

					(X)		(Y)		(Lower Error Value)		(Upper Error Value)		(String)

					0.0		0.2				-0.08					0.12			  "A0"
					0.1		0.4				-0.05					0.09			  "B1"
					0.2		0.5				-0.10					0.12			  "C2"
					 :		 :				  :						  :				    :
					1.0		0.1				-0.10					0.13			  "K10"
			</para>
		</section>

	</section>


	<section>
		<title>Multiple XY</title>
		<para>
		The multiple scalar type XY data.
		For this type of data, this plotter can draw lines, symbols and bars.
		The input data must consists of columns of numeric values more than one.
		Values in the first row are regarded as X values, and others are regarded as multiple Y values.

				(X)		(Y1)	(Y2)	(Y3)	...

				0.0		0.2		-0.2	-1.1	...
				0.1		0.4		0.0		-0.5	...
				0.2		0.2		0.25	-0.4	...
				 :		 :		 :		  :		 :
				1.0		0.3		0.45	-0.1	...
		</para>
	</section>


	<section>
		<title>Sampling XY</title>
		<para>
		This data format is similar to the multiple XY format except that a column for X values does not exist.
		The input data must consists of columns of numeric values, and they are regarded as multiple Y values.
		The X values are generated automatically by the sampling rate entered into the wizard dialog
		when users add this data to the figure.
		The interval is equal to the reciprocal number of the sampling rate, and the number of the X values
		is equal to that of the Y values.

				(Y1)	(Y2)	(Y3)	...

				0.2		-0.2	-1.1	...
				0.4		0.0		-0.5	...
				0.2		0.25	-0.4	...
				 :		 :		  :		 :
				0.3		0.45	-0.1	...
		</para>
	</section>


	<section>
		<title>Vector XY</title>

		<para>
		This type of data consists of the set of vectors.
		Samurai Graph can draw a vector diagram for this type of data.
		The input data must consists of four columns of numbers.
		Values in the first two rows are regarded as X and Y coordinate of the starting point of the vectors.
		For the third and the fourth rows, users can select their meaning by the wizard dialog when users add
		this data.
		</para>

		<section>
			<title>The third values and the fourth value are regarded as the magnitude and the angle
			of each vector in polar coordinate.</title>

			<para>
			Angle values must be given in units of radian.

			(X Coordinate)		(Y Coordinate)		(Magnitude)		(Angle)

				0.0					0.0					12.1			0.0
				1.0					0.0					15.0			0.785398163
				0.0					1.0					14.5			1.57079633
				1.0					1.0					11.8			2.35619449
				 :					 :					 :				 :
				9.0					9.0					16.3			3.14159265

			</para>
		</section>


		<section>
			<title>The third and the fourth values are regarded as the X and Y components of each vector.</title>

			<para>

			(X Coordinate)		(Y Coordinate)		(X Component)		(Y Component)

				0.0					0.0					10.5				3.0
				1.0					0.0					7.6					6.5
				0.0					1.0					4.3					9.4
				1.0					1.0					11.8				1.2
				 :					 :					 :					 :
				9.0					9.0					2.3					13.4

			</para>

		</section>

	</section>

	<section>
		<title></title>
		<para>
		Note
		 1. Strings in input data must be written between two double quotation marks.
		 2. Values in each row must be separated by spaces, tabs or commas.
		</para>
	</section>

</chapter>



<chapter>
	<title>Add data to the figure</title>

	<para>
	Users add data to the figures and plot a graph.
	There are two ways to add data.
	</para>

	<section>
		<title>Drag and drop</title>
		<para>
			1. Drag and drop the data file into the Samurai Graph window.
			2. A wizard dialog is displayed. Select the data type and press the OK button.
		</para>
	</section>

	<section>
		<title>Tool bar / Menu bar</title>
		<para>
			1. Press the button on a tool bar to add data, or execute the command [File]-[Draw Graph] in the menu bar.
			2. Wizard dialogs are displayed successively.
				2.1 Select figure ID number and press the Next button.
				2.2 Choose a data file and press the Next button.
				2.3 Select the data type and press the OK button.
		</para>
	</section>

	<section>
	<title></title>
	<para>
	Note
	 1. When the data are added, Samurai Graph classifies input data into available data types
		and prompts users to select the data type using a wizard dialog, in which only the acceptable types
		are selectable.
	 2. If the file is dropped onto the point out of figures or a figure with the ID of the user selected
		does not exist, a new figure is created automatically.
	 3. The legend of data in the figure is automatically generated at the first addition of the data.
		It is also automatically updated with each addition, removal of data and the change of the appearance of data.
	</para>
	</section>

</chapter>



<chapter>
	<title>Use Various Types of Symbols</title>

	<para>
	Users can use various kinds of symbols: labels, timing lines, symbols of significant difference
	and symbols of axis breaking.
	</para>

	<section>
	<title>Add Symbols</title>

		<para>

		Users can add symbols using toggle buttons on the tool bar.

		1. Press one of the toggle buttons on the tool bar.
		   The mouse cursor changes to the crosshair type.
		2. Press the figure to which you want to add the symbol.
		3. Do as follows for each symbol type:

		Labels
			1. Enter a string into the text field. If it consists of the spaces, a new label is not added.
			2. Press the Enter key or press the mouse button on any point in the window pane out of the text field.
			3. A new label is added to the figure.

		Symbols for significant difference / Symbols for axis breaking
			When you release the mouse button, a new symbol is added to figure at the location of the mouse cursor.

		Timing lines
			1. Press and release the mouse button on one of the axis line.
			2. A new timing line is added to the axis.

			Note: If the mouse is released at the points deviate from the axis line, a new timing line is not added.

		</para>

	</section>

	<section>
	<title>Remove Symbols</title>

	<para>

		1. Click the symbol with the right mouse button, show the pop-up menu.
		2. Execute the command to remove the symbol.

		Note
			For the labels, users can show the pop-up menu by clicking the edge of the text field.

	</para>

	</section>

</chapter>


<chapter>
	<title>Mouse Operations to the Figure</title>

<para>

	It is possible to move or resize the figures by mouse operations.
</para>

	<section>
	<title>Select</title>
<para>
		Press the mouse button in the rectangle of the figure.
		The figure is selected and anchors are displayed on the edges of the rectangle.
		Holding down the Ctrl key or the Shift key, multiple selection of figures is possible.
</para>
	</section>

	<section>
	<title>Move</title>
<para>
		1. Select figures you wants to move, and press one of them.
		   The mouse cursor changes to the the move type.
		2. Drag the mouse to the direction which you want to move them.

		If the mouse is pressed on any objects in ( the legend, the label, scale lines, etc. ),
		successive mouse drag affects not the figure but the pressed objects.
</para>
	</section>

	<section>
	<title>Resize</title>
<para>
		1. Select a figure you want to resize.
		2. Put the mouse cursor onto the anchors: The mouse cursor changes to resize type.
		3. Press and drag the mouse to the direction which you want to resize it.

		If you drag the anchors on four corners of the figure while holding down the Shift key,
		you can resize the figure keeping the horizontal to vertical ratio.
</para>
	</section>

</chapter>



<chapter>
<title>Remove / Move the Added Data</title>

<para>
	Click the data with the left mouse button: The symbols of selecting is shown around the data.
	Holding down the Ctrl key or the Shift key, multiple selection of data is possible.
	By selecting the data, users can change the order of data and remove the selected data.
</para>

	<section>
	<title>Remove Selected Data</title>
<para>
		Execute the menu command [Edit]-[Remove Data] in the menu bar.
</para>
	</section>

	<section>
	<title>Move to Front/Back the Selected Data</title>
<para>
		Execute the menu command [Edit]-[Move Data to Front] or [Edit]-[Move Data to Back] in the menu bar.
</para>
	</section>

</chapter>



<chapter>
<title>Change the Name of Data</title>
<para>
	Click the mouse button on the name of data in the legend, and the text field appears.
	Modify and press the Enter key.
</para>
</chapter>



<chapter>
<title>Move the Legend</title>
<para>
	Press the legend with the mouse button and drag the mouse.
</para>
</chapter>



<chapter>
<title>Mouse Operation to the Axis</title>

<para>
	It is possible to change the scale by the mouse operation.
	Do as follows to change the scale:
</para>

	<section>
	<title>Using scale numbers</title>
<para>
		1. Press a scale number.
		2. Drag the number horizontally for horizontal axes, or vertically for vertical axes.
		3. You can broaden out or narrow the axis range fixing the minimum value.
</para>
	</section>

	<section>
	<title>Using scale lines</title>
<para>
		1. Press a scale line.
		2. Drag the scale line horizontally for horizontal axes, or vertically for vertical axes.
		3. You can translate the axis range.
</para>
	</section>

</chapter>



<chapter>
<title>Mouse Operations to the Symbols</title>

	<section>
	<title>Move</title>
<para>
		Press the label or symbol with the mouse button and drag the mouse.
</para>
	</section>

	<section>
	<title>Edit the string of labels or the string of the symbols of significant difference</title>
<para>
		Click the label or the string of the symbols of significant difference with the mouse button.
		The text field appears and you can edit the string.
		After edited, press Enter key or press any point in the window pane out of the text field.
		The change is committed.
</para>
	</section>

</chapter>



<chapter>
<title>Set various properties of objects by the property dialog</title>
<para>
	In this plotter, objects have its property dialog.
	Double-click the object which you want to set the properties, and the property dialog is displayed.
	Set values and press OK button.
</para>
</chapter>



<chapter>
<title>Export Graphic into Image File</title>
<para>
	Users can export graphics of the graph into a image file.

	1. Execute the menu command in the menu bar, [File]-[Export], or press the export button in the tool bar.
	2. The preview dialog is displayed which shows graphic clipped by the paper in th window.
	3. Set the type, file path and properties of the image file by the export dialog.
	4. Press the OK button on the export dialog.
</para>
</chapter>



<chapter>
<title>Use a Property File</title>
<para>
	Users can save the properties of the graph into a file and reuse it.
</para>

	<section>
	<title>Save</title>
<para>
		1. Execute one of the following actions.
			<itemizedlist>
				<listitem>
					<para>Execute the menu command in the menu bar, [File]-[Save Property].</para>
				</listitem>
				<listitem>
					<para>Press the save-property button in the tool bar.</para>
				</listitem>
				<listitem>
					<para>Hit Ctrl-S.</para>
				</listitem>
			</itemizedlist>
		2. Set the file path by file chooser.
</para>
	</section>

	<section>
	<title>Load</title>
<para>
		1. Execute one of the following actions.
			<itemizedlist>
				<listitem>
					<para>Execute the menu command in the menu bar, [File]-[Load Property].</para>
				</listitem>
				<listitem>
					<para>Press the load-property button in the tool bar.</para>
				</listitem>
				<listitem>
					<para>Hit Ctrl-O.</para>
				</listitem>
			</itemizedlist>


		2. Wizard dialogs are shown in the following order.
			2.1 Choose a property file to use.
			2.2 Choose data files.

		3. A new window which reflects the property file is created and displayed.
</para>
	</section>

</chapter>



<chapter>
<title>Undo/Redo the Change</title>
<para>
	There are two possible ways.
	<itemizedlist>
		<listitem>
			<para>Execute the menu command in the menu bar, [Edit]-[Undo] to undo, or [Edit]-[Redo] to redo.</para>
		</listitem>
		<listitem>
			<para>Hit Ctrl+Z to undo, or Ctrl+Y to redo.</para>
		</listitem>
	</itemizedlist>
</para>
</chapter>



<chapter>
<title>Exit</title>
<para>
	There are two possible ways.
		a. Execute the menu command [File]-[Exit].
		b. Close all displayed windows.
</para>
</chapter>


</book>
