This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository jtimer. See http://git.chorem.org/jtimer.git commit d30e4b4787def6ab1431fe99f54f4f9a9e1586b9 Author: Eric Chatellier <chatellier@codelutin.com> Date: Wed Feb 24 13:42:02 2016 +0100 Keep only en site. Update site with configuration --- pom.xml | 15 ++-- src/site/en/rst/contribute/i18n.rst | 64 ------------- src/site/en/rst/devel/fileformat.rst | 124 -------------------------- src/site/en/rst/devel/index.rst | 54 ----------- src/site/en/rst/devel/roadmap.rst | 56 ------------ src/site/en/rst/devel/saf.rst | 124 -------------------------- src/site/en/rst/index.rst.vm | 66 -------------- src/site/en/rst/screenshots.rst | 51 ----------- src/site/rst/configuration.rst | 61 +++++++++++++ src/site/rst/contribute/i18n.rst | 30 +++---- src/site/rst/devel/fileformat.rst | 46 +++++----- src/site/{en => }/rst/devel/idledetection.rst | 5 +- src/site/rst/devel/index.rst | 28 +++--- src/site/rst/devel/roadmap.rst | 29 +++--- src/site/rst/devel/saf.rst | 22 +++-- src/site/rst/index.rst.vm | 56 ++++++------ src/site/rst/screenshots.rst | 28 +++--- src/site/site_en.xml | 13 ++- src/site/site_fr.xml | 97 -------------------- 19 files changed, 196 insertions(+), 773 deletions(-) diff --git a/pom.xml b/pom.xml index 4601e82..3699787 100644 --- a/pom.xml +++ b/pom.xml @@ -92,8 +92,8 @@ <!-- license to use --> <license.licenseName>gpl_v3</license.licenseName> - <!--Multilanguage maven-site --> - <locales>fr,en</locales> + <!-- maven-site locales --> + <locales>en</locales> <jnaVersion>4.2.1</jnaVersion> @@ -248,12 +248,6 @@ </configuration> </plugin> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>cobertura-maven-plugin</artifactId> - <version>${coberturaPluginVersion}</version> - </plugin> - </plugins> </reporting> @@ -333,6 +327,11 @@ <artifactId>freemarker</artifactId> <version>2.3.23</version> </dependency> + <dependency> + <groupId>com.googlecode.json-simple</groupId> + <artifactId>json-simple</artifactId> + <version>1.1.1</version> + </dependency> <!-- commons-xxx lib --> diff --git a/src/site/en/rst/contribute/i18n.rst b/src/site/en/rst/contribute/i18n.rst deleted file mode 100644 index 7aebdd9..0000000 --- a/src/site/en/rst/contribute/i18n.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. - -.. * #%L -.. * jTimer -.. * %% -.. * Copyright (C) 2007 - 2011 CodeLutin, Chatellier Eric -.. * %% -.. * This program is free software: you can redistribute it and/or modify -.. * it under the terms of the GNU General Public License as -.. * published by the Free Software Foundation, either version 3 of the -.. * License, or (at your option) any later version. -.. * -.. * This program is distributed in the hope that it will be useful, -.. * but WITHOUT ANY WARRANTY; without even the implied warranty of -.. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.. * GNU General Public License for more details. -.. * -.. * You should have received a copy of the GNU General Public -.. * License along with this program. If not, see -.. * <http://www.gnu.org/licenses/gpl-3.0.html>. -.. * #L% -.. - - -I18N -==== - -Presentation ------------- -Internationalization is build on properties files used by -`Swing Application Framework`_. - -Problem -------- -Actually, translations are dispersed in multiples files (one per interface), -which can make contribution a little bit harder. - -Place ------ -Translation files are located in followinf folder : -``src/main/resources/org/chorem/jtimer`` - -For example, the class ``org.chorem.jtimer.JTimer`` has two resources files : -Par exemple, la classe ``org.chorem.jtimer.JTimer`` dispose des fichiers de ressources : - -* ``src/main/resources/org/chorem/jtimer/resources/Jtimer.properties`` (en) -* ``src/main/resources/org/chorem/jtimer/resources/Jtimer_fr.properties`` (fr) -* etc... - -Complete list -------------- -Complete list of file to transalte to add another language is: - -* ``resources/JTimer.properties`` -* ``ui/tasks/resources/RunTaskJob.properties`` -* ``ui/alert/resources/AlertEditor.properties`` -* ``ui/treetable/resources/ProjectsAndTasksTable.properties`` -* ``ui/treetable/dnd/resources/TimerTaskTransferHandler.properties`` -* ``ui/report/resources/ReportView.properties`` -* ``ui/resources/TimerTaskEditor.properties`` -* ``ui/resources/StatusBar.properties`` -* ``ui/resources/HelpFrame.properties`` -* ``ui/ws/resources/SwingConnectionInformationHandler.properties`` -* ``ui/systray/resources/SystrayManager.properties`` - -.. _Swing Application Framework: https://appframework.dev.java.net/ diff --git a/src/site/en/rst/devel/fileformat.rst b/src/site/en/rst/devel/fileformat.rst deleted file mode 100644 index b80c8c5..0000000 --- a/src/site/en/rst/devel/fileformat.rst +++ /dev/null @@ -1,124 +0,0 @@ -.. - -.. * #%L -.. * jTimer -.. * %% -.. * Copyright (C) 2007 - 2011 CodeLutin, Chatellier Eric -.. * %% -.. * This program is free software: you can redistribute it and/or modify -.. * it under the terms of the GNU General Public License as -.. * published by the Free Software Foundation, either version 3 of the -.. * License, or (at your option) any later version. -.. * -.. * This program is distributed in the hope that it will be useful, -.. * but WITHOUT ANY WARRANTY; without even the implied warranty of -.. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.. * GNU General Public License for more details. -.. * -.. * You should have received a copy of the GNU General Public -.. * License along with this program. If not, see -.. * <http://www.gnu.org/licenses/gpl-3.0.html>. -.. * #L% -.. - - -File format -=========== - -File format used in jTimer 1.2.0 is gTimer 1.2 file format. -Since 1.3.0, jTimer add new features that gTimer can't handle. - - -Project -------- - -**Extension :** .project - -**Format :** - -:: - - Format: <file format> - Name: <project name> - Created: <creation timestamp> - Options: <project option> - -**Example :** 2.project - -:: - - Format: 1.2 - Name: jTImer - Created: 2147483647 - Options: 0 - -Task ----- - -**Extension :** .task - -**Format :** - -:: - - Format: <file format> - Name: <task name> - Created: <creation timestamp> - Options: <task option> - Project: <parent project> - Data: - <dateyyyyMMdd timeinseconds> - -**Example :** 6.task - -:: - - Format: 1.2 - Name: Interact with chorem services - Created: 2147483647 - Options: 0 - Project: 2 - Data: - 20070625 23848 - 20070626 22127 - 20070627 23032 - -Notes ------ - -**Extension :** .ann - -**Format :** - -:: - - <timestamp texte> - -**Note:** x.ann note is linked to x.task task. - -**Example :** 7.ann - -:: - - 1228950001 First note - 1228950002 Second note - -Alerts ------- - -**Extension :** .alert - -**Format :** - -:: - - <alert type> <duration> - -**Note:** x.alert alert is linked to x.task task. - -Alerts are not defined in 1.2 gTimer file format. - -**Example :** 7.alert - -:: - - reachdailytime 3600 - reachtotaltime 7200 diff --git a/src/site/en/rst/devel/index.rst b/src/site/en/rst/devel/index.rst deleted file mode 100644 index 193244b..0000000 --- a/src/site/en/rst/devel/index.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. - -.. * #%L -.. * jTimer -.. * %% -.. * Copyright (C) 2007 - 2011 CodeLutin, Chatellier Eric -.. * %% -.. * This program is free software: you can redistribute it and/or modify -.. * it under the terms of the GNU General Public License as -.. * published by the Free Software Foundation, either version 3 of the -.. * License, or (at your option) any later version. -.. * -.. * This program is distributed in the hope that it will be useful, -.. * but WITHOUT ANY WARRANTY; without even the implied warranty of -.. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.. * GNU General Public License for more details. -.. * -.. * You should have received a copy of the GNU General Public -.. * License along with this program. If not, see -.. * <http://www.gnu.org/licenses/gpl-3.0.html>. -.. * #L% -.. - - -Developer -========= - -Technologies ------------- - -Swing Application Framework -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -jTimer is build according to JSR-296_ which define -swing application lifecycle. He is build on reference -implementation : Swing Application Framework_. - - -Swingx -~~~~~~ - -jTimer use Swingx_ additional components set. - - -Java Native Access -~~~~~~~~~~~~~~~~~~ - -Pur java, idle detection seems to be impossible. -So, this application use JNA_ to access those -informations. - - -.. _JSR-296 : http://jcp.org/en/jsr/detail?id=296 -.. _Swing Application Framework : https://appframework.dev.java.net/ -.. _Swingx : https://swingx.dev.java.net/ -.. _JNA: https://jna.dev.java.net/ diff --git a/src/site/en/rst/devel/roadmap.rst b/src/site/en/rst/devel/roadmap.rst deleted file mode 100644 index 8040ae5..0000000 --- a/src/site/en/rst/devel/roadmap.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. - -.. * #%L -.. * jTimer -.. * %% -.. * Copyright (C) 2007 - 2012 CodeLutin, Chatellier Eric -.. * %% -.. * This program is free software: you can redistribute it and/or modify -.. * it under the terms of the GNU General Public License as -.. * published by the Free Software Foundation, either version 3 of the -.. * License, or (at your option) any later version. -.. * -.. * This program is distributed in the hope that it will be useful, -.. * but WITHOUT ANY WARRANTY; without even the implied warranty of -.. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.. * GNU General Public License for more details. -.. * -.. * You should have received a copy of the GNU General Public -.. * License along with this program. If not, see -.. * <http://www.gnu.org/licenses/gpl-3.0.html>. -.. * #L% -.. - - -Roadmap -======= - -Version 1.4 ------------ -* Time tracking algorithm refactoring -* Switch to Better swing application framework (bsaf) - -Version 1.3 ------------ -* Add alert on tasks - -Version 1.2 ------------ -* Refactoring -* Report frame complete (tree) - -Version 1.1 ------------ -* Add report generation - -Version 1.0 ------------ -* Initial release (gtimer compatible) - -TODO -==== - -- Add languages (I18N), for now, supported languages are: - - - English (EN) - - French (FR) - -- Add MAC OS JNA system info diff --git a/src/site/en/rst/devel/saf.rst b/src/site/en/rst/devel/saf.rst deleted file mode 100644 index 8c31373..0000000 --- a/src/site/en/rst/devel/saf.rst +++ /dev/null @@ -1,124 +0,0 @@ -.. - -.. * #%L -.. * jTimer -.. * %% -.. * Copyright (C) 2007 - 2011 CodeLutin, Chatellier Eric -.. * %% -.. * This program is free software: you can redistribute it and/or modify -.. * it under the terms of the GNU General Public License as -.. * published by the Free Software Foundation, either version 3 of the -.. * License, or (at your option) any later version. -.. * -.. * This program is distributed in the hope that it will be useful, -.. * but WITHOUT ANY WARRANTY; without even the implied warranty of -.. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.. * GNU General Public License for more details. -.. * -.. * You should have received a copy of the GNU General Public -.. * License along with this program. If not, see -.. * <http://www.gnu.org/licenses/gpl-3.0.html>. -.. * #L% -.. - - -Swing application framework -=========================== - -Here are examples of Swing codes based on `Swing Application Framework`_. - -Actions -------- - -File org.chorem.jtimer.test.SafTest1.java: - -:: - - public void SafTest1 extends SingleFrameApplication { - - public JButton helloWorldButton; - - public static void main(String[] args) { - launch(SafTest1.class, args); - } - - @Action - public void helloWorld() { - System.out.prinln("Hello world"); - } - - @Override - public void initialize() { - helloWorldButton = new JButton(); - helloWorldButton.setAction(getAction("helloWorld"); - } - - @Override - public void ready() { - show(helloWorldButton); - } - } - -File org/chorem/jtimer/test/resources/SafTest1.properties: - -:: - - Application.title = Test 1 - Application.id = saftest1 - - helloWorld.Action.text=Say hello - helloWorld.Action.shortDescription=Click me to say hello - - -I18N ----- - -To translate previous example, in french for example, just create a properties -file suffixed by the locale containing translated strings. - -File org/chorem/jtimer/test/resources/SafTest1_fr.properties: - -:: - - helloWorld.Action.text=Dit bonjour - helloWorld.Action.shortDescription=Cliquer pour dire bonjour ! - - -Bindings --------- - -We can how bind some properties to swing elements. This bindings have to be set -in action annotation, this properties concern all element bind on this action. - -File org.chorem.jtimer.test.SafTest2.java: - -:: - - public void SafTest2 extends SingleFrameApplication { - - public JButton helloWorldButton; - - public static void main(String[] args) { - launch(SafTest1.class, args); - } - - public boolean isActive() { - return false; - } - - @Action(enabledProperty="active") - public void helloWorld() { - System.out.prinln("Hello world"); - } - - @Override - public void initialize() { - helloWorldButton = new JButton(); - helloWorldButton.setAction(getAction("helloWorld"); - } - - @Override - public void ready() { - show(helloWorldButton); - } - } - -.. _Swing Application Framework: https://appframework.dev.java.net/ diff --git a/src/site/en/rst/index.rst.vm b/src/site/en/rst/index.rst.vm deleted file mode 100644 index 4453d22..0000000 --- a/src/site/en/rst/index.rst.vm +++ /dev/null @@ -1,66 +0,0 @@ -.. - -.. * #%L -.. * jTimer -.. * -.. * $Id$ -.. * $HeadURL$ -.. * %% -.. * Copyright (C) 2007 - 2012 CodeLutin, Chatellier Eric -.. * %% -.. * This program is free software: you can redistribute it and/or modify -.. * it under the terms of the GNU General Public License as -.. * published by the Free Software Foundation, either version 3 of the -.. * License, or (at your option) any later version. -.. * -.. * This program is distributed in the hope that it will be useful, -.. * but WITHOUT ANY WARRANTY; without even the implied warranty of -.. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.. * GNU General Public License for more details. -.. * -.. * You should have received a copy of the GNU General Public -.. * License along with this program. If not, see -.. * <http://www.gnu.org/licenses/gpl-3.0.html>. -.. * #L% -.. - - -Presentation -============ - -jTimer is a time tracking tool for projects activities. It also can -generate activities reports. - -Features --------- - * Time spent on projects/tasks - * Idle detection - * Reports generation - * Add notes on tasks - * Alerts setup - * Internationalization (i18n) - * gTimer file format compliant - -Environment ------------ -jTimer is Java based. You need to install JRE 6 environment to use it. - -`Download Java`_. - -Start ------ - -Since version 1.4.3, you can directly use jTimer without install it by hand, -using the webstart technology. - -`Start jTimer via webstart`_. - -For more information, go to page `jnlp documentation`_. - -Links ------ - * gTimer_. - -.. _Download Java: http://java.sun.com/javase/downloads/index.jsp -.. _gTimer: http://www.k5n.us/gtimer.php -.. _known issue: http://list.chorem.org/pipermail/jtimer-devel/2010-October/000017.html -.. _Start jTimer via webstart: ../jnlp/${jnlpFileName} -.. _jnlp documentation: jnlp-report.html \ No newline at end of file diff --git a/src/site/en/rst/screenshots.rst b/src/site/en/rst/screenshots.rst deleted file mode 100644 index 494c7bf..0000000 --- a/src/site/en/rst/screenshots.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. - -.. * #%L -.. * jTimer -.. * %% -.. * Copyright (C) 2007 - 2012 CodeLutin, Chatellier Eric -.. * %% -.. * This program is free software: you can redistribute it and/or modify -.. * it under the terms of the GNU General Public License as -.. * published by the Free Software Foundation, either version 3 of the -.. * License, or (at your option) any later version. -.. * -.. * This program is distributed in the hope that it will be useful, -.. * but WITHOUT ANY WARRANTY; without even the implied warranty of -.. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.. * GNU General Public License for more details. -.. * -.. * You should have received a copy of the GNU General Public -.. * License along with this program. If not, see -.. * <http://www.gnu.org/licenses/gpl-3.0.html>. -.. * #L% -.. - - -Screenshots -=========== - -jTimer main screenshots (taken from version 1.4.0). - -Main view ---------- - -.. image:: ../images/screen/jtimer.jpg - -Reports -------- - -.. image:: ../images/screen/jtimerreport.jpg - -Idle detection --------------- - -.. image:: ../images/screen/jtimeridle.jpg - -Alerts ------- - -.. image:: ../images/screen/jtimeralert.jpg - -System tray ------------ - -.. image:: ../images/screen/jtimersystray.jpg diff --git a/src/site/rst/configuration.rst b/src/site/rst/configuration.rst new file mode 100644 index 0000000..c9c28b9 --- /dev/null +++ b/src/site/rst/configuration.rst @@ -0,0 +1,61 @@ +.. - +.. * #%L +.. * jTimer +.. * %% +.. * Copyright (C) 2007 - 2016 CodeLutin, Chatellier Eric +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU General Public License as +.. * published by the Free Software Foundation, either version 3 of the +.. * License, or (at your option) any later version. +.. * +.. * This program is distributed in the hope that it will be useful, +.. * but WITHOUT ANY WARRANTY; without even the implied warranty of +.. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.. * GNU General Public License for more details. +.. * +.. * You should have received a copy of the GNU General Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/gpl-3.0.html>. +.. * #L% +.. - + +Configuration +============= + +As of jTimer 1.5, application does not contains (yet) a configuration UI. But, by editing jtimer +configuration file, it is possible to enable some features. + +File +---- +The location of jTimer configuration file depend on your system. + + * window: ``%APPDATA%\jtimer.properties`` or ``%USER_HOME%%\Application Data\jtimer.properties`` + * mac os: ``${userHome}/Library/Application Support/jtimer.properties`` + * linux: ``${userHome}/.config/jtimer.properties`` + +Idle time +--------- +Default idle time is ``300`` seconds (5 minutes). It is possible to modify this time using:: + + jtimer.io.saver.autosavedelay=300 + +Task template +------------- +jTimer can create a task using subtask template. You can specify template, as json format, using cofiguration option:: + + jtimer.ui.task.templates={"template name 1":[{"name":"dev", "tasks":[{"name":"E1"},{"name":"E2"}]},{"name":"ano", "tasks":[{"name":"A1"}]},{"name":"admin", "tasks":[{"name":"database", "tasks":[{"name":"sub database task1"},{"name":"sub database task2"}]}]},{"name":"meetings"},{"name":"releases"}]} + +This will create following hierachy version is:: + + dev: + E1: + E2: + ano: + A1: + admin: + database: + sub database task1: + sub database task2: + meetings: + releases: diff --git a/src/site/rst/contribute/i18n.rst b/src/site/rst/contribute/i18n.rst index 811d464..bcfb45f 100644 --- a/src/site/rst/contribute/i18n.rst +++ b/src/site/rst/contribute/i18n.rst @@ -2,7 +2,7 @@ .. * #%L .. * jTimer .. * %% -.. * Copyright (C) 2007 - 2011 CodeLutin, Chatellier Eric +.. * Copyright (C) 2007 - 2016 CodeLutin, Chatellier Eric .. * %% .. * This program is free software: you can redistribute it and/or modify .. * it under the terms of the GNU General Public License as @@ -23,31 +23,31 @@ I18N ==== -Présentation +Presentation ------------ -L'internationnalisation est basé sur l'utilisation de fichiers de propriétés -utilisé par `Swing Application Framework`_. +Internationalization is build on properties files used by +`Swing Application Framework`_. -Problème --------- -Actuellement, la traduction est dispersée dans plusieurs fichiers -(un par interface) ce qui rend la contribution peut être un peut -plus difficile. +Problem +------- +Actually, translations are dispersed in multiples files (one per interface), +which can make contribution a little bit harder. -Emplacement ------------ -Les fichiers de traduction sont situés dans le dossier +Place +----- +Translation files are located in followinf folder : ``src/main/resources/org/chorem/jtimer`` +For example, the class ``org.chorem.jtimer.JTimer`` has two resources files : Par exemple, la classe ``org.chorem.jtimer.JTimer`` dispose des fichiers de ressources : * ``src/main/resources/org/chorem/jtimer/resources/Jtimer.properties`` (en) * ``src/main/resources/org/chorem/jtimer/resources/Jtimer_fr.properties`` (fr) * etc... -Liste complète --------------- -La liste des fichiers à traduire est la suivante : +Complete list +------------- +Complete list of file to transalte to add another language is: * ``resources/JTimer.properties`` * ``ui/tasks/resources/RunTaskJob.properties`` diff --git a/src/site/rst/devel/fileformat.rst b/src/site/rst/devel/fileformat.rst index 7fedaa7..9146112 100644 --- a/src/site/rst/devel/fileformat.rst +++ b/src/site/rst/devel/fileformat.rst @@ -2,7 +2,7 @@ .. * #%L .. * jTimer .. * %% -.. * Copyright (C) 2007 - 2011 CodeLutin, Chatellier Eric +.. * Copyright (C) 2007 - 2016 CodeLutin, Chatellier Eric .. * %% .. * This program is free software: you can redistribute it and/or modify .. * it under the terms of the GNU General Public License as @@ -20,15 +20,15 @@ .. * #L% .. - -Format de fichier -================= +File format +=========== -Le format de fichier dans jTimer 1.2.0 est le format 1.2 de gTimer. -Depuis jTimer 1.3.0, quelques additions de fichiers ont été effectées que -gTimer ne saura pas traiter. +File format used in jTimer 1.2.0 is gTimer 1.2 file format. +Since 1.3.0, jTimer add new features that gTimer can't handle. -Projet ------- + +Project +------- **Extension :** .project @@ -41,7 +41,7 @@ Projet Created: <creation timestamp> Options: <project option> -**Exemple :** 2.project +**Example :** 2.project :: @@ -50,8 +50,8 @@ Projet Created: 2147483647 Options: 0 -Tâche ------ +Task +---- **Extension :** .task @@ -67,7 +67,7 @@ Tâche Data: <dateyyyyMMdd timeinseconds> -**Exemple :** 6.task +**Example :** 6.task :: @@ -81,8 +81,8 @@ Tâche 20070626 22127 20070627 23032 -Annotations ------------ +Notes +----- **Extension :** .ann @@ -90,19 +90,19 @@ Annotations :: - <timestamp> <texte> + <timestamp texte> -**Note:** La note x.ann est associée à la tâche x.task. +**Note:** x.ann note is linked to x.task task. -**Exemple :** 7.ann +**Example :** 7.ann :: 1228950001 First note 1228950002 Second note -Alertes -------- +Alerts +------ **Extension :** .alert @@ -110,13 +110,13 @@ Alertes :: - <alert type> <durée> + <alert type> <duration> -**Note:** L'alerte x.alert est associée à la tâche x.task. +**Note:** x.alert alert is linked to x.task task. -Les alertes ne sont pas défini dans le format 1.2 de gTimer. +Alerts are not defined in 1.2 gTimer file format. -**Exemple :** 7.alert +**Example :** 7.alert :: diff --git a/src/site/en/rst/devel/idledetection.rst b/src/site/rst/devel/idledetection.rst similarity index 97% rename from src/site/en/rst/devel/idledetection.rst rename to src/site/rst/devel/idledetection.rst index 654b999..004fa28 100644 --- a/src/site/en/rst/devel/idledetection.rst +++ b/src/site/rst/devel/idledetection.rst @@ -2,7 +2,7 @@ .. * #%L .. * jTimer .. * %% -.. * Copyright (C) 2007 - 2012 CodeLutin +.. * Copyright (C) 2007 - 2016 CodeLutin .. * %% .. * This program is free software: you can redistribute it and/or modify .. * it under the terms of the GNU General Public License as @@ -39,11 +39,14 @@ The time tracking algorithm is mainly based on "start task timestamp" and So the algorithm work as it: * init start timestamp * loop iteration each 1000 ms until user stop task + * try to detect hibernation (previous idle tracking > 5min) * try to detect idle (user idle time = 5min) + * publish time to listener (UI) * display idle resume dialog (block time tracking) * remember idle time () * resume task + * publish current time to listener (UI) * mark task as stopped diff --git a/src/site/rst/devel/index.rst b/src/site/rst/devel/index.rst index 4dcbcc6..0498a7d 100644 --- a/src/site/rst/devel/index.rst +++ b/src/site/rst/devel/index.rst @@ -2,7 +2,7 @@ .. * #%L .. * jTimer .. * %% -.. * Copyright (C) 2007 - 2011 CodeLutin, Chatellier Eric +.. * Copyright (C) 2007 - 2016 CodeLutin, Chatellier Eric .. * %% .. * This program is free software: you can redistribute it and/or modify .. * it under the terms of the GNU General Public License as @@ -20,8 +20,8 @@ .. * #L% .. - -Developpeur -=========== +Developer +========= Technologies ------------ @@ -29,26 +29,26 @@ Technologies Swing Application Framework ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -jTimer respecte la JSR-296_ qui défini le cycle de vie des -application swing. Il est implenté sur l'implementation -de référence de cette JSR : `Swing Application Framework`_. +jTimer is build according to JSR-296_ which define +swing application lifecycle. He is build on reference +implementation : `Swing Application Framework`_. + Swingx ~~~~~~ -jTimer utilise aussi de componsant swing additionnels -inclut dans le projet Swingx_. +jTimer use Swingx_ additional components set. Java Native Access ~~~~~~~~~~~~~~~~~~ -La détection du temps d'inactivité se révélant impossible -à faire en pur Java, ce programme utilise donc JNA_ pour -accéder nativement à ces informations. +Pur java, idle detection seems to be impossible. +So, this application use JNA_ to access those +informations. -.. _JSR-296: http://jcp.org/en/jsr/detail?id=296 -.. _Swing Application Framework: https://appframework.dev.java.net/ -.. _Swingx: https://swingx.dev.java.net/ +.. _JSR-296 : http://jcp.org/en/jsr/detail?id=296 +.. _Swing Application Framework : https://appframework.dev.java.net/ +.. _Swingx : https://swingx.dev.java.net/ .. _JNA: https://jna.dev.java.net/ diff --git a/src/site/rst/devel/roadmap.rst b/src/site/rst/devel/roadmap.rst index bf92ffd..136e286 100644 --- a/src/site/rst/devel/roadmap.rst +++ b/src/site/rst/devel/roadmap.rst @@ -2,7 +2,7 @@ .. * #%L .. * jTimer .. * %% -.. * Copyright (C) 2007 - 2011 CodeLutin, Chatellier Eric +.. * Copyright (C) 2007 - 2016 CodeLutin, Chatellier Eric .. * %% .. * This program is free software: you can redistribute it and/or modify .. * it under the terms of the GNU General Public License as @@ -25,32 +25,33 @@ Roadmap Version 1.4 ----------- -* Modification de l'algorithme de timing des taches -* Utilisation de Better Swing Application framework (bsaf) +* Time tracking algorithm refactoring +* Switch to Better swing application framework (bsaf) +* Add MAC OS JNA system info Version 1.3 ----------- -* Ajout d'alarme sur les tâches +* Add alert on tasks Version 1.2 ----------- -* Fusion de tâches * Refactoring -* Fenêtre de génération de rapport completement implémentée +* Report frame complete (tree) Version 1.1 ----------- -* Ajout de la génération des rapports +* Add report generation Version 1.0 ----------- -* Première version (compatible avec gtimer) +* Initial release (gtimer compatible) -À faire -======= +TODO +==== + +- Add languages (I18N), for now, supported languages are: + + - English (EN) + - French (FR) -- Ajouter des langues (I18N), la liste des langues actuellement supportées est : - - Anglais (en) - - Français (fr) -- Ajout des informations systèmes (JNA) pour MAC OS diff --git a/src/site/rst/devel/saf.rst b/src/site/rst/devel/saf.rst index 527d8e2..12e2cad 100644 --- a/src/site/rst/devel/saf.rst +++ b/src/site/rst/devel/saf.rst @@ -2,7 +2,7 @@ .. * #%L .. * jTimer .. * %% -.. * Copyright (C) 2007 - 2011 CodeLutin, Chatellier Eric +.. * Copyright (C) 2007 - 2016 CodeLutin, Chatellier Eric .. * %% .. * This program is free software: you can redistribute it and/or modify .. * it under the terms of the GNU General Public License as @@ -23,12 +23,12 @@ Swing application framework =========================== -Voici des exemples de codes Swing basés sur `Swing Application Framework`_. +Here are examples of Swing codes based on `Swing Application Framework`_. Actions ------- -Fichier org.chorem.jtimer.test.SafTest1.java: +File org.chorem.jtimer.test.SafTest1.java: :: @@ -57,7 +57,7 @@ Fichier org.chorem.jtimer.test.SafTest1.java: } } -Fichier org/chorem/jtimer/test/resources/SafTest1.properties: +File org/chorem/jtimer/test/resources/SafTest1.properties: :: @@ -71,11 +71,10 @@ Fichier org/chorem/jtimer/test/resources/SafTest1.properties: I18N ---- -Pour traduire l'exemple précédent en français par exemple, il suffit -de créer un fichier de properties suffixé par la locale contenant les -intitulé traduit. +To translate previous example, in french for example, just create a properties +file suffixed by the locale containing translated strings. -Fichier org/chorem/jtimer/test/resources/SafTest1_fr.properties: +File org/chorem/jtimer/test/resources/SafTest1_fr.properties: :: @@ -86,11 +85,10 @@ Fichier org/chorem/jtimer/test/resources/SafTest1_fr.properties: Bindings -------- -On peut aussi ajouter des propiétés d'activation des elements swings. -Ces proprietes ce renseigne sur l'action, et concernent tous les -éléments utilisant l'action. +We can how bind some properties to swing elements. This bindings have to be set +in action annotation, this properties concern all element bind on this action. -Fichier org.chorem.jtimer.test.SafTest2.java: +File org.chorem.jtimer.test.SafTest2.java: :: diff --git a/src/site/rst/index.rst.vm b/src/site/rst/index.rst.vm index 63cfb50..136dc66 100644 --- a/src/site/rst/index.rst.vm +++ b/src/site/rst/index.rst.vm @@ -5,7 +5,7 @@ .. * $Id$ .. * $HeadURL$ .. * %% -.. * Copyright (C) 2007 - 2012 CodeLutin, Chatellier Eric +.. * Copyright (C) 2007 - 2016 CodeLutin, Chatellier Eric .. * %% .. * This program is free software: you can redistribute it and/or modify .. * it under the terms of the GNU General Public License as @@ -23,45 +23,43 @@ .. * #L% .. - -Présentation +Presentation ============ -jTimer est un outil de suivit de temps passé sur des projets. Il permet -également de générer des rapports d'activité. +jTimer is a time tracking tool for projects activities. It also can +generate activities reports. -Fonctionnalités ---------------- - * Gestion du temps passé sur les projets/tâches - * Gestion de l'inactivité - * Génération de rapports - * Ajout de notes sur les tâches - * Mise en place d'alertes - * Internationalisation (i18n) - * Compatibilité avec gTimer +Features +-------- + * Time spent on projects/tasks + * Idle detection + * Reports generation + * Add notes on tasks + * Alerts setup + * Internationalization (i18n) + * `gTimer`_ file format compliant -Environnement -------------- -jTimer est developpé dans le language Java. Vous devez disposer d'un -environnement JRE 6 pour l'utiliser. +Environment +----------- +jTimer is Java based. You need to install JRE 8 environment to use it. -`Telecharger Java`_. +`Download Java`_. -Utiliser --------- +Start +----- -Depuis la version 1.4.3, il est possible de démarrer jTimer sans avoir à -l'installer manuellement en utilisant la technologie webstart. +Since version 1.4.3, you can directly use jTimer without install it by hand, +using the webstart technology. -`Démarrer jTimer via webstart`_. +`Start jTimer via webstart`_. -Pour plus d'information, aller sur la page de `documentation jnlp`_. +For more information, go to page `jnlp documentation`_. -Liens +Links ----- * gTimer_. -.. _Telecharger Java: http://java.sun.com/javase/downloads/index.jsp +.. _Download Java: http://java.sun.com/javase/downloads/index.jsp .. _gTimer: http://www.k5n.us/gtimer.php -.. _bug connu: http://list.chorem.org/pipermail/jtimer-devel/2010-October/000017.html -.. _Démarrer jTimer via webstart: jnlp/${jnlpFileName} -.. _documentation jnlp: jnlp-report.html \ No newline at end of file +.. _Start jTimer via webstart: ../jnlp/${jnlpFileName} +.. _jnlp documentation: jnlp-report.html \ No newline at end of file diff --git a/src/site/rst/screenshots.rst b/src/site/rst/screenshots.rst index dfefb99..d25c717 100644 --- a/src/site/rst/screenshots.rst +++ b/src/site/rst/screenshots.rst @@ -2,7 +2,7 @@ .. * #%L .. * jTimer .. * %% -.. * Copyright (C) 2007 - 2012 CodeLutin, Chatellier Eric +.. * Copyright (C) 2007 - 2016 CodeLutin, Chatellier Eric .. * %% .. * This program is free software: you can redistribute it and/or modify .. * it under the terms of the GNU General Public License as @@ -20,32 +20,32 @@ .. * #L% .. - -Copies d'écran -============== +Screenshots +=========== -Principales captures d'écrans de jTimer (effectuées avec jTimer 1.4.0). +jTimer main screenshots (taken from version 1.4.0). -Vue principale --------------- +Main view +--------- .. image:: images/screen/jtimer.jpg -Rapports --------- +Reports +------- .. image:: images/screen/jtimerreport.jpg -Détection de l'inactivité -------------------------- +Idle detection +-------------- .. image:: images/screen/jtimeridle.jpg -Alertes -------- +Alerts +------ .. image:: images/screen/jtimeralert.jpg -Zone de notification --------------------- +System tray +----------- .. image:: images/screen/jtimersystray.jpg diff --git a/src/site/site_en.xml b/src/site/site_en.xml index e05ecb4..f5f7cd7 100644 --- a/src/site/site_en.xml +++ b/src/site/site_en.xml @@ -3,7 +3,7 @@ #%L jTimer %% - Copyright (C) 2007 - 2012 CodeLutin, Chatellier Eric + Copyright (C) 2007 - 2016 CodeLutin, Chatellier Eric %% This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as @@ -21,9 +21,9 @@ #L% --> <project name="${project.name}" - xmlns="http://maven.apache.org/DECORATION/1.4.0" + xmlns="http://maven.apache.org/DECORATION/1.7.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/DECORATION/1.4.0 http://maven.apache.org/xsd/decoration-1.4.0.xsd"> + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.7.0 http://maven.apache.org/xsd/decoration-1.7.0.xsd"> <custom> <fluidoSkin> @@ -35,7 +35,7 @@ </custom> <bannerLeft> - <src>../images/jtimer-logo-orange-little.jpg</src> + <src>images/jtimer-logo-orange-little.jpg</src> <href>/index.html</href> <alt>jTimer logo</alt> </bannerLeft> @@ -56,8 +56,6 @@ <body> <links> - <item name="Français" href="../index.html"/> - <item name="English" href="index.html"/> <item name="nuiton.org" href="https://forge.nuiton.org"/> <item name="chorem.org" href="https://forge.chorem.org"/> <item name="CodeLutin" href="https://codelutin.com"/> @@ -74,10 +72,11 @@ <item name="Screenshots" href="screenshots.html"/> <item name="Download" href="https://forge.chorem.org/projects/jtimer/files"/> <item name="Start (using webstart)" href="../jnlp/${project.jnlpFileName}"/> + <item name="Configuration" href="configuration.html"/> <item name="Release Notes" href="changes-report.html"/> </menu> - <menu name="Contibute" inherit="top"> + <menu name="Contribute" inherit="top"> <item name="Forge" href="https://forge.chorem.org/projects/jtimer"/> <item name="Bug tracker" href="https://forge.chorem.org/projects/jtimer/issues"/> <item name="I18N" href="contribute/i18n.html"/> diff --git a/src/site/site_fr.xml b/src/site/site_fr.xml deleted file mode 100644 index 63d01f0..0000000 --- a/src/site/site_fr.xml +++ /dev/null @@ -1,97 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - #%L - jTimer - %% - Copyright (C) 2007 - 2012 CodeLutin, Chatellier Eric - %% - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as - published by the Free Software Foundation, either version 3 of the - License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public - License along with this program. If not, see - <http://www.gnu.org/licenses/gpl-3.0.html>. - #L% - --> -<project name="${project.name}" - xmlns="http://maven.apache.org/DECORATION/1.4.0" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/DECORATION/1.4.0 http://maven.apache.org/xsd/decoration-1.4.0.xsd"> - - <custom> - <fluidoSkin> - <topBarIcon> - <name>jTimer</name> - <href>index.html</href> - </topBarIcon> - </fluidoSkin> - </custom> - - <bannerLeft> - <src>images/jtimer-logo-orange-little.jpg</src> - <href>/index.html</href> - <alt>jTimer logo</alt> - </bannerLeft> - - <bannerRight> - <src>http://www.codelutin.com/images/lutinorange-codelutin.png</src> - <href>http://www.codelutin.com</href> - </bannerRight> - - <poweredBy> - <logo href="http://maven.apache.org" name="Maven" img="${siteCommonResourcesUrl}/images/logos/maven-feather.png"/> - <logo href="http://docutils.sourceforge.net/rst.html" - name="ReStructuredText" img="${siteCommonResourcesUrl}/images/logos/restructuredtext-logo.png"/> - <logo href="http://maven-site.nuiton.org/jrst" name="JRst" - img="${siteCommonResourcesUrl}/images/logos/jrst-logo.png"/> - </poweredBy> - - <body> - - <links> - <item name="Français" href="index.html"/> - <item name="English" href="en/index.html"/> - <item name="nuiton.org" href="https://forge.nuiton.org"/> - <item name="chorem.org" href="https://forge.chorem.org"/> - <item name="CodeLutin" href="https://codelutin.com"/> - <item name="Libre-Entreprise" href="http://www.libre-entreprise.org/"/> - </links> - - <breadcrumbs> - <item name="${project.name}" href="${project.url}/index.html"/> - <item name="${project.version}" href="${project.url}/v/${siteDeployClassifier}/index.html"/> - </breadcrumbs> - - <menu name="Utilisateurs" inherit="top"> - <item name="Accueil" href="index.html"/> - <item name="Copies d'écran" href="screenshots.html"/> - <item name="Téléchargement" href="https://forge.chorem.org/projects/jtimer/files"/> - <item name="Démarrer (via webstart)" href="./jnlp/${project.jnlpFileName}"/> - <item name="Notes de version" href="changes-report.html"/> - </menu> - - <menu name="Contribuer" inherit="top"> - <item name="Forge" href="https://forge.chorem.org/projects/jtimer"/> - <item name="Bug tracker" href="https://forge.chorem.org/projects/jtimer/issues"/> - <item name="I18N" href="contribute/i18n.html"/> - </menu> - - <menu name="Développeur" inherit="top"> - <item name="Roadmap" href="devel/roadmap.html"/> - <item name="Fonctionnement" href="devel/index.html"> - <item name="Framework swing" href="devel/saf.html"/> - <item name="Format de fichier" href="devel/fileformat.html"/> - </item> - </menu> - - <menu ref="reports"/> - - </body> -</project> -- To stop receiving notification emails like this one, please contact chorem.org SCM administrator <admin+scm@chorem.org>.