OSDN Git Service

update documents
[stew/Stew4.git] / MANUAL.md
index c598eaf..b65cfcb 100644 (file)
--- a/MANUAL.md
+++ b/MANUAL.md
@@ -1,6 +1,6 @@
 % Stew4 User Manual
 %
-% version 4.1
+% version 4.2
 
 
 ## What Is Stew ?
@@ -33,7 +33,9 @@ For details, see [How To Use - Configuration Of "Connector"](#configuration-of-c
 ### Other
 
 For more information, see the project site.
-<http://stew.sourceforge.jp/>  
+
+- <http://stew.sourceforge.jp/>
+- <http://argius.github.io/Stew4/>
 
 
 ## Installation
@@ -76,6 +78,7 @@ In CUI mode, to start edit tool, specifies --edit option.
 
     # command line
     $ stew --edit
+
     # running stew
     > --edit
 
@@ -232,7 +235,7 @@ By defauts, it displays JRE, OS and Locale.
     > ?
     JRE : ...
     OS : ...
-    Locale : ja_JP
+    Locale : en_UK
     > ? java.version user.timezone zzz
     java.version=[1.6.0_##]
     user.timezone=[Europe/London]
@@ -295,9 +298,10 @@ This command executes the SQL read from specified file.
 When If a parameter is specified, executes file content as SQL,
 otherwise, two or more parameters, imports the file as data file.
 The file format is automatically selected by file extension.
- *. .csv : CSV format
- *. .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd)
- *. otherwise: TSV format
+
+ * .csv : CSV format
+ * .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd)
+ * otherwise: TSV format
 
 (implementation detail: this is basically same as import command,
                         executes as not batch but executes by record)
@@ -309,9 +313,10 @@ The file format is automatically selected by file extension.
 
 This command imports from file as data file.
 The file format is automatically selected by file extension.
- *. .csv : CSV format
- *. .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd)
- *. otherwise: TSV format
+
+ * .csv : CSV format
+ * .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd)
+ * otherwise: TSV format
 
 (implementation detail: this is basically same as load command,
                         but uses Statement#addBatch.)
@@ -321,10 +326,11 @@ The file format is automatically selected by file extension.
 
 This command exports result of command to the specified file.
 The file format is automatically selected by file extension.
- *. .htm,html : HTML format
- *. .csv : CSV format
- *. .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd)
- *. others: TSV format
+
+ * .htm,html : HTML format
+ * .csv : CSV format
+ * .xml : XML format (definition: src/net/argius/stew/io/stew-table.dtd)
+ * others: TSV format
 
 
 ### time - Measures time to execute SQL
@@ -401,8 +407,8 @@ This supporses to specify primary keys and file extension.
     Downloaded. (size=18bytes, file=./emp/USA/145.txt)
     Selected 42 records.
 
-When data exist a record, specified <data-column>,
-saves file to <root-dir> as file name.
+When data exist a record, specified &lt;data-column&gt;,
+saves file to &lt;root-dir&gt; as file name.
 
 Saving file already exists or no permission to write file,
 the process will abort immediately.
@@ -417,9 +423,9 @@ This command registers a data file to the column that specified by place-holder.
 
 ### wait - Waits for specified interval
 
-    > wait seconds()
+    > wait seconds
 
-This command waits for the interval that specified number of seconds.
+This command waits for the interval that specified number (mixed decimal) of seconds.
 It may be useful for executing multiple commands.
 
 
@@ -437,7 +443,7 @@ A window has "Input/Output Area", "Result Set Table", "Database Info Tree", "Mai
 By default, the database info tree, the status bar and the find pane" are hidden.
 
 
-### Input/Output Area
+### Input/Output Area ( text area )
 
 The I/O area is similar to CUI interface.
 
@@ -449,6 +455,12 @@ The I/O area is similar to CUI interface.
 ... Context menus for this component has the standard commands.
 
 
+### Paste Paths Into The Text Area Via DnD \<new feature in version 4.2\>
+
+When you drag and drop from file manager into the text area, the paths of these files will be pasted to the text area.
+It also allows plural files.
+
+
 ### Result Set Table
 
 The result set table displays command results, usually query results from database.
@@ -535,20 +547,20 @@ Copy Full Name
 :   This command copies the full qualified name of selected nodes as text into the clipboard.
 
 Refresh
-:   This command ... 
+:   This command ...
 
 Generate WHERE Phrase
-:   This command generates a WHERE phrase consisting selected tables and columns ... 
+:   This command generates a WHERE phrase consisting selected tables and columns ...
     selected same name, generate ...
 
 Generate SELECT Statement (with WHERE)
 :   This command generates a SELECT statement with "WHERE" keyword.
 
 Generate UPDATE Statement (with WHERE)
-:   This command ... 
+:   This command ...
 
 Generate INSERT Statement
-:   This command ... 
+:   This command ...
 
 Jump To Column By Name
 :   This command ... the name of selected node. Jump to the column which has the same name in current result table if found it.
@@ -630,9 +642,9 @@ This command finds out a specific string from selected component.
 ...
 
 
-### Edit - Toggle focus (G) Ctrl-G
+### Edit - Toggle focus (G) Ctrl-G \<improved feature in version 4.2\>
 
-This command toggles focus between the result set table and the input/output area in a current window.
+This command toggles focus between the database info tree, the the result set table and the input/output area in a current window.
 
 ### Edit - Clear Message (M)
 
@@ -714,6 +726,11 @@ This command rotates command histories backward.
 This command rotates command histories forward.
 
 
+### Command - Show All Histories(A) \<new feature in version 4.2\>
+
+This command shows all command histories and paste a choosen commmand.
+
+
 ### Command - Rollback (R)
 
 This command displays confirm dialog and click "OK" to rollback.
@@ -746,7 +763,7 @@ When the window which command is running, is not active, "Post-Proccess" is invo
 There are following modes:
 
  * None(N): Does nothing.
- * Focus(F): Focuses window. 
+ * Focus(F): Focuses window.
  * Shake(S): Shakes window.
  * Blink(B): Blinks window.