Recent changes to Home

Home modified by Dimitry Prihodko

Dimitry Prihodko — Sun, 24 Nov 2013 06:20:34 -0000

--- v10
+++ v11
@@ -16,7 +16,7 @@

 Then click "Save settings" button (the one with a green tick). The project will be calculated within 2 seconds.

-Pay units and rates are set for each project individually. Without it you can still view the statistics.
+Pay units and rates are set for each project individually. If pay units and rates are not set, you can not view statistics.

 **NOTE:** If your rate varies depending on match %, you cannot use OTStats to get accurate financial information. But you can still use it to track your overall statistics.

Home modified by Kos Ivantsov

Kos Ivantsov — Sat, 23 Nov 2013 09:56:11 -0000

--- v9
+++ v10
@@ -21,7 +21,7 @@
 **NOTE:** If your rate varies depending on match %, you cannot use OTStats to get accurate financial information. But you can still use it to track your overall statistics.

 ##Changing settings
-To change settings for a project, you need to press "Unlock" button first. Once new settings are typed in, you need to apply them (the button with a green tick). Without unlocking settings your changes will immediately revert to their previous saved state.  
+To change settings for a project, you need to press "Unlock" button first. Once new settings are typed in, you need to apply them (the button with a green tick). Without unlocking your changed settings will immediately revert to their previous saved state.  

 ##Timer
 You can see how much you get done over a period of time (within one session). To do so, press Timer button (the one with a watch). Result will be printed in a lower part of the window.

Home modified by Kos Ivantsov

Kos Ivantsov — Sat, 23 Nov 2013 09:55:09 -0000

--- v8
+++ v9
@@ -3,6 +3,7 @@
 OTStats is a single binary that doesn't have additional components and doesn't need to be installed per se. On GNU/Linux though it's required to make the file executable. It also may be worth it to put it somewhere in $PATH, for instance, in **/usr/local/bin** or **~/bin** (the latter may not be in the $PATH).

 #General Usage Information
+##Initial Settings
 Before starting to use OTStats, you have to select "Path to directory with your OmegaT projects" by pressing button on the right from the field (it's right under Unique and Spaces checkboxes).
 When a new project is selected, it has no project data.

@@ -17,7 +18,10 @@

 Pay units and rates are set for each project individually. Without it you can still view the statistics.

-**NOTE:** If your rate varies depending on match %, you cannot use OTStats to get accurate financial information. But you can still use it to track your overall statistics. 
+**NOTE:** If your rate varies depending on match %, you cannot use OTStats to get accurate financial information. But you can still use it to track your overall statistics.
+
+##Changing settings
+To change settings for a project, you need to press "Unlock" button first. Once new settings are typed in, you need to apply them (the button with a green tick). Without unlocking settings your changes will immediately revert to their previous saved state.  

 ##Timer
 You can see how much you get done over a period of time (within one session). To do so, press Timer button (the one with a watch). Result will be printed in a lower part of the window.

Home modified by Kos Ivantsov

Kos Ivantsov — Fri, 22 Nov 2013 20:36:25 -0000

Home modified by Kos Ivantsov

Kos Ivantsov — Fri, 22 Nov 2013 20:32:45 -0000

--- v6
+++ v7
@@ -41,4 +41,4 @@
 ##Project settings
 Information about project's pay units and rates is stored in each projects folder in a file named **omegat/statsini.txt**
 ##Reports
-OTStats is capable of writing reports that can be used for invoices. There are two buttons: "Report" and "Append report". The reports are tab-delimited UTF-8 encoded .txt files (even if extension may make you think otherwise).
+OTStats is capable of writing reports that can be used for invoices. There are two buttons: "Report" and "Append report". The reports are semicolon-delimited UTF-8 encoded csv files (even if extension may make you think otherwise).

Home modified by Kos Ivantsov

Kos Ivantsov — Fri, 22 Nov 2013 20:31:19 -0000

--- v5
+++ v6
@@ -1,3 +1,4 @@
+[TOC]
 #Installing OTStats
 OTStats is a single binary that doesn't have additional components and doesn't need to be installed per se. On GNU/Linux though it's required to make the file executable. It also may be worth it to put it somewhere in $PATH, for instance, in **/usr/local/bin** or **~/bin** (the latter may not be in the $PATH).

Home modified by Kos Ivantsov

Kos Ivantsov — Fri, 22 Nov 2013 20:28:29 -0000

--- v4
+++ v5
@@ -1,8 +1,43 @@
 #Installing OTStats
-OTStats is a single binary that doesn't have additional components and doesn't need to be installed per se. On GNU/Linux though it's required to make the file executable. It also may be worth it to put it somewhere in $PATH, for instance, in /usr/local/bin or ~/bin (the latter may not be in the $PATH).
-#Using OTStats
+OTStats is a single binary that doesn't have additional components and doesn't need to be installed per se. On GNU/Linux though it's required to make the file executable. It also may be worth it to put it somewhere in $PATH, for instance, in **/usr/local/bin** or **~/bin** (the latter may not be in the $PATH).

+#General Usage Information
+Before starting to use OTStats, you have to select "Path to directory with your OmegaT projects" by pressing button on the right from the field (it's right under Unique and Spaces checkboxes).
+When a new project is selected, it has no project data.
+
+Unlock settings (button with a lock), type in number and select units you are being paid for (Amount per _ _ _ Characters/Segments/Words), set amount and select currency.
+
+***
+For instance, if you are paid $10.00  for 1800 characters with spaces, you tick "Spaces", type in "1800" at "Amount per", select "Characters" from the dropdown list, then type "10", and either type in "USD" or select it from the dropdown list.
+
+*** 
+
+Then click "Save settings" button (the one with a green tick). The project will be calculated within 2 seconds.
+
+Pay units and rates are set for each project individually. Without it you can still view the statistics.
+
+**NOTE:** If your rate varies depending on match %, you cannot use OTStats to get accurate financial information. But you can still use it to track your overall statistics. 
+
+##Timer
+You can see how much you get done over a period of time (within one session). To do so, press Timer button (the one with a watch). Result will be printed in a lower part of the window.
+
+##Update frequency
+In order to obtain best performance of OTStats, your OmegaT Auto Save Project setting should be set to 10 seconds. OmegaT updates its statistics on each save, and OTStats reads and shows only what OmegaT produces.
+
+#Running OTStats
 ##Running OTStats from OmegaT
 One can run OTStats from the running instance of OmegaT. In order to do that, run_statistics.groovy script is needed.
+
 Download the script and put it to OmegaT scripts folder.
 If OTStats binary was put somewhere not in the $PATH, edit the second line of the script so that it specifies full path to the OTStats binary. When the script is invoked, OTStats will open with the current OmegaT project.
+
+##Running OTStats as a stand-alone application
+You can run OTStats on its own with or without OmegaT running simultaneously. To have the program show the statistics, you need to select the folder where your projects are found (i.e., not the OmegaT project folder, but its parent folder).
+
+#Settings and Reports
+##Program's settings
+The program's only setting is the path where your OmegaT projects are found. It's stored in **$HOME/.OTStats/root.ini**
+##Project settings
+Information about project's pay units and rates is stored in each projects folder in a file named **omegat/statsini.txt**
+##Reports
+OTStats is capable of writing reports that can be used for invoices. There are two buttons: "Report" and "Append report". The reports are tab-delimited UTF-8 encoded .txt files (even if extension may make you think otherwise).

Home modified by Kos Ivantsov

Kos Ivantsov — Fri, 22 Nov 2013 19:37:10 -0000

--- v3
+++ v4
@@ -1,2 +1,8 @@
+#Installing OTStats
+OTStats is a single binary that doesn't have additional components and doesn't need to be installed per se. On GNU/Linux though it's required to make the file executable. It also may be worth it to put it somewhere in $PATH, for instance, in /usr/local/bin or ~/bin (the latter may not be in the $PATH).
 #Using OTStats
-[Running OTStats from OmegaT](https://sourceforge.net/p/otstats/wiki/Start%20OTStats%20from%20OmegaT/)
+
+##Running OTStats from OmegaT
+One can run OTStats from the running instance of OmegaT. In order to do that, run_statistics.groovy script is needed.
+Download the script and put it to OmegaT scripts folder.
+If OTStats binary was put somewhere not in the $PATH, edit the second line of the script so that it specifies full path to the OTStats binary. When the script is invoked, OTStats will open with the current OmegaT project.

Discussion for Home page

Dimitry Prihodko — Fri, 22 Nov 2013 11:08:33 -0000

Select «Path to directory with your OmegaT projects» by pressing button on the right from the field
When a new project is selected, it has no project data. Unlock settings, type in number, select units you are being paid for (Amount per _ _ _ Characters/Segments/Words), set amount and select currency. Then click «Save settings button». The project will be calculated within 2 seconds.
PLEASE NOTE: in order to obtain best performance, Your OmegaT Auto Save Project setting should be set to 10 seconds.
This application can run from OmegaT directly due to Kos Ivantsov's script. Just download it to “Scripts” in your OmegaT folder and start the script after you have opened or created a project.

Home modified by Kos Ivantsov

Kos Ivantsov — Fri, 22 Nov 2013 10:25:14 -0000

--- v2
+++ v3
@@ -1 +1,2 @@
+#Using OTStats
 [Running OTStats from OmegaT](https://sourceforge.net/p/otstats/wiki/Start%20OTStats%20from%20OmegaT/)