emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Yann Hodique <yann.hodique@gmail.com>
To: emacs-orgmode@gnu.org
Cc: Yann Hodique <yann.hodique@gmail.com>
Subject: [PATCH v2 10/11] org-taskjuggler: update doc to reflect latest changes
Date: Wed, 15 Aug 2012 21:11:56 +0200	[thread overview]
Message-ID: <1345057917-69300-12-git-send-email-yann.hodique@gmail.com> (raw)
In-Reply-To: <1345057917-69300-1-git-send-email-yann.hodique@gmail.com>
In-Reply-To: <1344164044-15059-1-git-send-email-yann.hodique@gmail.com>

---
 doc/org.texi | 48 ++++++++++++++++++++++++++++++------------------
 1 file changed, 30 insertions(+), 18 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 3fdb4ac..0f8b0d9 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -11898,9 +11898,9 @@ nodes of a document or strictly follow the order of the nodes in the
 document.
 
 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
-a optionally tree that defines the resources for this project.  It then
-creates a TaskJuggler file based on these trees and the attributes defined in
-all the nodes.
+optionally trees that define the resources and reports for this project.
+It then creates a TaskJuggler file based on these trees and the attributes
+defined in all the nodes.
 
 @subsection TaskJuggler export commands
 
@@ -11909,7 +11909,8 @@ all the nodes.
 Export as a TaskJuggler file.
 
 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
-Export as a TaskJuggler file and then open the file with TaskJugglerUI.
+Export as a TaskJuggler file and then open the file with TaskJugglerUI (only
+for TaskJugglerUI 2.x).
 @end table
 
 @subsection Tasks
@@ -11947,15 +11948,17 @@ time.
 
 @subsection Export of properties
 
-The exporter also takes TODO state information into consideration, i.e.@: if a
-task is marked as done it will have the corresponding attribute in
-TaskJuggler (@samp{complete 100}).  Also it will export any property on a task
-resource or resource node which is known to TaskJuggler, such as
-@samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
-@samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
-@samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
-@samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
-@samp{scheduling}, etc for tasks.
+The exporter also takes TODO state information into consideration, i.e.@: if
+a task is marked as done it will have the corresponding attribute in
+TaskJuggler (@samp{complete 100}).  Scheduling information is also taken into
+account to set start/end dates for tasks.
+
+The exporter will also export any property on a task resource or resource
+node which is known to TaskJuggler, such as @samp{limits}, @samp{vacation},
+@samp{shift}, @samp{booking}, @samp{efficiency}, @samp{journalentry},
+@samp{rate} for resources or @samp{account}, @samp{start}, @samp{note},
+@samp{duration}, @samp{end}, @samp{journalentry}, @samp{milestone},
+@samp{reference}, @samp{responsible}, @samp{scheduling}, etc for tasks.
 
 @subsection Dependencies
 
@@ -12001,11 +12004,20 @@ examples should illustrate this:
 @vindex org-export-taskjuggler-default-reports
 TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource
 allocation, etc).  The user defines what kind of reports should be generated
-for a project in the TaskJuggler file.  The exporter will automatically insert
-some default reports in the file.  These defaults are defined in
-@code{org-export-taskjuggler-default-reports}.  They can be modified using
-customize along with a number of other options.  For a more complete list, see
-@kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
+for a project in the TaskJuggler file.  By default, the exporter will
+automatically insert some pre-set reports in the file.  These defaults are
+defined in @code{org-export-taskjuggler-default-reports}.  They can be
+modified using customize along with a number of other options.  For a more
+complete list, see @kbd{M-x customize-group @key{RET} org-export-taskjuggler
+@key{RET}}.
+
+Alternately, the user can tag a tree with
+@code{org-export-taskjuggler-report-tag}, and define reports in sub-nodes,
+similarly to what is done with tasks or resources.  The properties used for
+report generation are defined in
+@code{org-export-taskjuggler-valid-report-attributes}. In addition, a special
+property named @samp{report-kind} is used to define the kind of report one
+wants to generate (by default, a @samp{taskreport}).
 
 For more information and examples see the Org-taskjuggler tutorial at
 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
-- 
1.7.11.4

  parent reply	other threads:[~2012-08-15 19:12 UTC|newest]

Thread overview: 51+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-08-05 10:53 [PATCH 00/10] Takjuggler exporter improvements Yann Hodique
2012-08-05 10:53 ` [PATCH 01/10] org-taskjuggler: make task and resource properties customizable Yann Hodique
2012-08-05 10:53 ` [PATCH 02/10] org-taskjuggler: properly install local variables at export time Yann Hodique
2012-08-05 10:53 ` [PATCH 03/10] org-taskjuggler: make use of org properties Yann Hodique
2012-08-05 10:53 ` [PATCH 04/10] org-taskjuggler: task with end-only is also a milestone (deadline) Yann Hodique
2012-08-05 10:53 ` [PATCH 05/10] org-taskjuggler: introduce a global header, for early macros Yann Hodique
2012-08-05 10:54 ` [PATCH 06/10] org-taskjuggler: use project end date, if specified Yann Hodique
2012-08-05 10:54 ` [PATCH 07/10] org-taskjuggler: make project umbrella task optional Yann Hodique
2012-08-10  5:30   ` Christian Egli
2012-08-12  8:03     ` Yann Hodique
2012-08-12 21:36       ` Simon Thum
2012-08-12 21:56         ` Bastien
2012-08-14  2:39       ` Christian Egli
2012-08-14  7:43         ` Bastien
2012-08-05 10:54 ` [PATCH 08/10] org-taskjuggler: disambiguate "headline", as it's also a valid taskjuggler property Yann Hodique
2012-08-05 10:54 ` [PATCH 09/10] org-taskjuggler: allow reports definition from within the org file Yann Hodique
2012-08-05 10:54 ` [PATCH 10/10] org-taskjuggler: update doc to reflect latest changes Yann Hodique
2012-08-05 17:29 ` [PATCH 00/10] Takjuggler exporter improvements Bastien
2012-08-05 20:02   ` Yann Hodique
2012-08-06  8:15   ` Bastien
2012-08-10  5:25 ` Christian Egli
2012-08-15 19:11 ` [PATCH v2 00/11] " Yann Hodique
2012-08-15 19:11   ` [PATCH 04/10] org-taskjuggler: task with end-only is also a milestone (deadline) Yann Hodique
2012-08-16  7:48   ` [PATCH v2 00/11] Takjuggler exporter improvements Bastien
2012-08-16 18:37     ` Yann Hodique
2012-08-19  7:27       ` Bastien
2012-08-16 19:01   ` [PATCH v3 00/11] Taskjuggler " Yann Hodique
2012-08-16 19:01     ` [PATCH v3 01/11] org-taskjuggler.el: Make task and resource properties customizable Yann Hodique
2012-08-16 19:02     ` [PATCH v3 02/11] org-taskjuggler.el: Properly install local variables at export time Yann Hodique
2012-08-16 19:02     ` [PATCH v3 03/11] org-taskjuggler.el: Make use of org properties Yann Hodique
2012-08-16 19:02     ` [PATCH v3 04/11] org-taskjuggler.el: Fix milestone definition Yann Hodique
2012-08-16 19:02     ` [PATCH v3 05/11] org-taskjuggler.el: Introduce a global header, for early macros Yann Hodique
2012-08-16 19:02     ` [PATCH v3 06/11] org-taskjuggler.el: Use project end date, if specified Yann Hodique
2012-08-16 19:02     ` [PATCH v3 07/11] org-taskjuggler.el: Make project umbrella task optional Yann Hodique
2012-08-16 19:02     ` [PATCH v3 08/11] org-taskjuggler.el: Disambiguate "headline", as it's a valid attribute Yann Hodique
2012-08-16 19:02     ` [PATCH v3 09/11] org-taskjuggler.el: Allow reports definition from within the org file Yann Hodique
2012-08-16 19:02     ` [PATCH v3 10/11] org-taskjuggler.el: Update doc to reflect latest changes Yann Hodique
2012-08-16 19:02     ` [PATCH v3 11/11] org-taskjuggler.el: Make taskjuggler compatible with org-publish Yann Hodique
2012-08-26  7:55     ` [PATCH v3 00/11] Taskjuggler exporter improvements Bastien
2012-09-25 13:53       ` Christian Egli
2012-08-15 19:11 ` [PATCH v2 01/11] org-taskjuggler: make task and resource properties customizable Yann Hodique
2012-08-15 19:11 ` [PATCH v2 02/11] org-taskjuggler: properly install local variables at export time Yann Hodique
2012-08-15 19:11 ` [PATCH v2 03/11] org-taskjuggler: make use of org properties Yann Hodique
2012-08-15 19:11 ` [PATCH v2 04/11] org-taskjuggler: fix milestone definition Yann Hodique
2012-08-15 19:11 ` [PATCH v2 05/11] org-taskjuggler: introduce a global header, for early macros Yann Hodique
2012-08-15 19:11 ` [PATCH v2 06/11] org-taskjuggler: use project end date, if specified Yann Hodique
2012-08-15 19:11 ` [PATCH v2 07/11] org-taskjuggler: make project umbrella task optional Yann Hodique
2012-08-15 19:11 ` [PATCH v2 08/11] org-taskjuggler: disambiguate "headline", as it's also a valid property Yann Hodique
2012-08-15 19:11 ` [PATCH v2 09/11] org-taskjuggler: allow reports definition from within the org file Yann Hodique
2012-08-15 19:11 ` Yann Hodique [this message]
2012-08-15 19:11 ` [PATCH v2 11/11] org-taskjuggler: make taskjuggler compatible with org-publish Yann Hodique

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1345057917-69300-12-git-send-email-yann.hodique@gmail.com \
    --to=yann.hodique@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --subject='Re: [PATCH v2 10/11] org-taskjuggler: update doc to reflect latest changes' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).