docs/en/PropertyReference.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <?xml-stylesheet type="text/xsl" href="PropertyReference.xsl"?>
   3 <!DOCTYPE properties [
   4 <!--  <!ENTITY % DocBookDTD PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
   5 "/usr/share/sgml/docbook_4.2/docbook.dtd">
   6  %DocBookDTD; -->
   7  <!ELEMENT properties (property*)>
   8
   9  <!ELEMENT property (descr, attributes?, optattributes?,
  10                      seealso?, freestyle?, example? )>
  11  <!ATTLIST property
  12    name CDATA #REQUIRED
  13    id CDATA #REQUIRED
  14    inheritable (Yes|No) "No"
  15    scenario (Yes|No) "No"
  16  >
  17
  18  <!ELEMENT descr (para*)>
  19  <!ELEMENT attributes (attr*)>
  20  <!ELEMENT attr (para*)>
  21  <!ATTLIST attr
  22    name CDATA #REQUIRED
  23    type CDATA #REQUIRED
  24    list (0|1) "0"
  25    optional (0|1) "0"
  26  >
  27
  28  <!ELEMENT optattributes (optattr*)>
  29  <!ELEMENT optattr (#PCDATA)>
  30
  31  <!ELEMENT seealso (also*)>
  32  <!ELEMENT also (#PCDATA)>
  33  <!ELEMENT freestyle (para*)>
  34  <!ELEMENT example (#PCDATA)>
  35
  36  <!ELEMENT para (#PCDATA|varname|link|simplelist|screen)*>
  37  <!ELEMENT varname (#PCDATA)*>
  38  <!ELEMENT link (#PCDATA)>
  39  <!ATTLIST link
  40    linkend CDATA #REQUIRED
  41  >
  42  <!ELEMENT simplelist (member)*>
  43  <!ATTLIST simplelist
  44    type CDATA #REQUIRED
  45    columns CDATA #REQUIRED
  46  >
  47  <!ELEMENT member (#PCDATA|para|varname|link)*>
  48  <!ELEMENT screen (#PCDATA)>
  49
  50   <!ENTITY example_depends SYSTEM
  51    "../../TestSuite/Syntax/Correct/Depends1.tjp">
  52   <!ENTITY example_extend SYSTEM
  53    "../../TestSuite/Syntax/Correct/CustomAttributes.tjp">
  54   <!ENTITY example_limits SYSTEM
  55    "../../TestSuite/Syntax/Correct/Limits-1.tjp">
  56   <!ENTITY example_precedes SYSTEM
  57    "../../TestSuite/Syntax/Correct/Precedes1.tjp">
  58 ]>
  59
  60 <properties>
  61  <property name="The TJP File" id="global_scope">
  62  <descr><para>All TaskJuggler project files should start with the
  63 project property and must contain at least one task definition. To
  64 visualize the results of the scheduling process, at least one of the
  65 reports should be specified.</para></descr>
  66  <optattributes>
  67    <optattr>account</optattr>
  68    <optattr>copyright</optattr>
  69    <optattr>csvaccountreport</optattr>
  70    <optattr>csvresourcereport</optattr>
  71    <optattr>csvtaskreport</optattr>
  72    <optattr>export</optattr>
  73    <optattr>flags_declare</optattr>
  74    <optattr>htmlaccountreport</optattr>
  75    <optattr>htmlresourcereport</optattr>
  76    <optattr>htmlstatusreport</optattr>
  77    <optattr>htmltaskreport</optattr>
  78    <optattr>htmlweeklycalendar</optattr>
  79    <optattr>include</optattr>
  80    <optattr>macro</optattr>
  81    <optattr>maxeffort</optattr>
  82    <optattr>limits</optattr>
  83    <optattr>priority</optattr>
  84    <optattr>projectid</optattr>
  85    <optattr>projectids</optattr>
  86    <optattr>project</optattr>
  87    <optattr>rate</optattr>
  88    <optattr>resource</optattr>
  89    <optattr>shift</optattr>
  90    <optattr>supplement</optattr>
  91    <optattr>task</optattr>
  92    <optattr>vacation_global</optattr>
  93    <optattr>xmlreport</optattr>
  94   </optattributes>
  95  </property>
  96  <property name="account" id="account">
  97   <descr><para>Declares an account. Accounts can be used to calculate costs
  98 of tasks or the whole project. Account declaration may be nested, but
  99 only the top level accounts may have a type attribute specified. An
 100 account that has sub-accounts may not have a <link
 101 linkend="PROPERTY_credit">credit</link> or a <link
 102 linkend="PROPERTY_kotrusid">kotrusid</link>.  sub-accounts inherit
 103 this type.</para></descr>
 104   <attributes>
 105    <attr name="id" type="ID">
 106     <para>Each account must have a unique ID.</para>
 107    </attr>
 108    <attr name="name" type="STRING"/>
 109    <attr name="type" type="ID" optional="1">
 110     <para>The type may be <varname>cost</varname> or
 111 <varname>revenue</varname>.</para></attr>
 112   </attributes>
 113   <optattributes>
 114    <optattr>account</optattr>
 115    <optattr>credit</optattr>
 116    <optattr>kotrusid</optattr>
 117   </optattributes>
 118   <seealso>
 119    <also>csvaccountreport</also>
 120    <also>htmlaccountreport</also>
 121   </seealso>
 122  </property>
 123  <property name="account" id="account_task" inheritable="Yes">
 124   <descr><para>All amounts associated with the task will be credited
 125 to the specified account.</para></descr>
 126   <attributes>
 127    <attr name="accountid" type="ID"/>
 128   </attributes>
 129   <seealso>
 130    <also>account</also>
 131   </seealso>
 132  </property>
 133  <property name="accumulate" id="accumulate" inheritable="No">
 134   <descr><para>If this attribute is specified the values in the calendar
 135 columns are accumulated over the reported interval.</para></descr>
 136  </property>
 137  <property name="allowredefinition" id="allowredefinition" inheritable="No">
 138   <descr><para>If this attribute is specified, redefinitions of task,
 139 resources or accounts are not flagged as errors. The primary use of
 140 this attribute is for projects that are created by merging sub projects
 141 which are again the result of sub project merging. In certain
 142 situations enclosing tasks, accounts or resources can be included in more
 143 than one sub project. This attribute then avoids the error which is
 144 in most other cases a real user error.</para>
 145
 146 <para>In case attributes of the same property must be specified in two
 147 different locations the <link linkend="PROPERTY_supplement">supplement</link>
 148 construct is the recommended way to do this.</para></descr>
 149  </property>
 150  <property name="allocate" id="allocate" inheritable="Yes">
 151   <descr><para>Specify which resources should be allocated to the
 152 task.</para></descr>
 153   <attributes>
 154    <attr name="resource" type="ID"/>
 155   </attributes>
 156   <optattributes>
 157    <optattr>alternative</optattr>
 158    <optattr>load</optattr>
 159    <optattr>mandatory</optattr>
 160    <optattr>persistent</optattr>
 161    <optattr>select</optattr>
 162    <optattr>shift_selection</optattr>
 163   </optattributes>
 164   <seealso>
 165    <also>effort</also>
 166   </seealso>
 167  </property>
 168  <property name="alternative" id="alternative" inheritable="No">
 169   <descr><para>A list of alternative resources for an allocation.</para></descr>
 170   <attributes>
 171    <attr name="resource" type="ID" list="1"/>
 172   </attributes>
 173   <seealso>
 174    <also>select</also>
 175   </seealso>
 176  </property>
 177  <property name="barlabels" id="barlabels" inheritable="No">
 178   <descr><para>Specifies the contense of the Gantt chart like bars in
 179 HTML calendar columns. The default is to show load values.</para></descr>
 180   <attributes>
 181    <attr name="mode" type="ID">
 182     <para>See table below for possible values.</para>
 183    </attr>
 184   </attributes>
 185   <seealso>
 186    <also>columns</also>
 187    <also>showprojectids</also>
 188   </seealso>
 189   <freestyle>
 190    <para><simplelist type="horiz" columns="2">
 191
 192    <member><varname>empty</varname></member>
 193    <member>Do not show any values on calendar bars.</member>
 194
 195    <member><varname>load</varname></member>
 196    <member>Show task or resource load on calendar bars.</member>
 197
 198    </simplelist></para>
 199   </freestyle>
 200  </property>
 201  <property name="booking" id="booking" inheritable="No" scenario="Yes">
 202   <descr><para></para></descr>
 203   <attributes>
 204    <attr name="start" type="DATE"/>
 205    <attr name="end" type="DATE"/>
 206    <attr name="task" type="ID"/>
 207   </attributes>
 208   <optattributes>
 209    <optattr>sloppy</optattr>
 210   </optattributes>
 211   <seealso>
 212    <also>projection</also>
 213   </seealso>
 214  </property>
 215  <property name="caption" id="caption" inheritable="No">
 216   <descr><para>Specifies the caption used for a report table.</para></descr>
 217   <attributes>
 218    <attr name="text" type="STRING"/>
 219   </attributes>
 220   <seealso>
 221    <also>headline</also>
 222    <also>copyright</also>
 223   </seealso>
 224  </property>
 225  <property name="celltext" id="celltext" inheritable="No">
 226   <descr><para>Specifies an alternative text that is used for all
 227 cells of the column. Usually such a text contains a runtime macro,
 228 otherwise all cells of the column will have the same fixed value.</para></descr>
 229   <attributes>
 230    <attr name="text" type="STRING"/>
 231   </attributes>
 232   <seealso>
 233    <also>cellurl</also>
 234   </seealso>
 235  </property>
 236  <property name="cellurl" id="cellurl" inheritable="No">
 237   <descr><para>Specifies an URL that is attached to the cell contense
 238 of the cells of the column in HTML reports.</para></descr>
 239   <attributes>
 240    <attr name="url" type="STRING"/>
 241   </attributes>
 242   <seealso>
 243    <also>celltext</also>
 244   </seealso>
 245  </property>
 246  <property name="columns" id="columns" inheritable="No">
 247   <descr><para>Specifies which columns shell be included in a
 248 report.</para>
 249
 250 <para>All columns support macro expansion. Contrary to the normal
 251 macro expansion, these macros are expanded during the report
 252 generation. So the value of the macro is being changed after each
 253 table cell or table line. Consequently only build in macros can be
 254 used. To protect the macro calls agains expansion during the initial
 255 file processing, the report macros must be prefixed with an additional
 256 <varname>$</varname>.</para></descr>
 257   <attributes>
 258    <attr name="columnid" type="ID" list="1">
 259     <para>See table below for possible values.</para>
 260    </attr>
 261   </attributes>
 262   <optattributes>
 263    <optattr>celltext</optattr>
 264    <optattr>cellurl</optattr>
 265    <optattr>hidecelltext</optattr>
 266    <optattr>hidecellurl</optattr>
 267    <optattr>subtitle</optattr>
 268    <optattr>subtitleurl</optattr>
 269    <optattr>title</optattr>
 270    <optattr>titleurl</optattr>
 271   </optattributes>
 272   <freestyle>
 273    <para><simplelist type="horiz" columns="2">
 274
 275    <member><varname>completed</varname></member>
 276    <member>The percentage the task has been completed already. This is
 277    either the value specified by <link
 278    linkend="PROPERTY_complete">complete</link> or a value computed according
 279    to the current date (or the date specified by <link
 280    linkend="PROPERTY_now">now</link>) and the length, duration or
 281    effort.</member>
 282
 283    <member><varname>cost</varname></member>
 284    <member>The accumulated costs of the task and its sub tasks</member>
 285
 286    <member><varname>criticalness</varname></member>
 287    <member>The criticalness of the task. It is a measure for the
 288    probability that an effort task gets the requested resources
 289    early.</member>
 290
 291    <member><varname>cost</varname></member>
 292    <member>The accumulated costs of the task and its sub tasks</member>
 293
 294    <member><varname>daily</varname></member>
 295    <member>A day-by-day calendar view of the tasks</member>
 296
 297    <member><varname>depends</varname></member>
 298    <member>The task index of the tasks on which this task
 299    depends</member>
 300
 301    <member><varname>duration</varname></member>
 302    <member>The duration of the task</member>
 303
 304    <member><varname>effort</varname></member>
 305    <member>The effort put into the task</member>
 306
 307    <member><varname>end</varname></member>
 308    <member>The end date of a task</member>
 309
 310    <member><varname>endbuffer</varname></member>
 311    <member>The percentage of the endbuffer</member>
 312
 313    <member><varname>endbufferstart</varname></member>
 314    <member>The start time of the end buffer</member>
 315
 316    <member><varname>flags</varname></member>
 317    <member>The list of flags assigned to the task or resource</member>
 318
 319    <member><varname>follows</varname></member>
 320    <member>The task index of the tasks that depend on this task</member>
 321
 322    <member><varname>hierarchindex</varname></member>
 323    <member>The hierarchical index of a task. The index is calculated from the
 324    hierachical structure of the list as well as the start and end dates.
 325    </member>
 326
 327    <member><varname>hierarchno</varname></member>
 328    <member>The hierarchical number of a task. It is based on the order of
 329    declaration.</member>
 330
 331    <member><varname>id</varname></member>
 332    <member>The global ID of a task</member>
 333
 334    <member><varname>index</varname></member>
 335    <member>The index of a task. The index is calculated from the
 336    hierachical structure of the list as well as the start and end dates.
 337    </member>
 338
 339    <member><varname>kotrusid</varname></member>
 340    <member>The KotrRUs ID of the resource</member>
 341
 342    <member><varname>maxeffort</varname></member>
 343    <member>The maximum daily load wanted for the resource</member>
 344
 345    <member><varname>maxend</varname></member>
 346    <member>The latest desired end date</member>
 347
 348    <member><varname>maxstart</varname></member>
 349    <member>The latest desired start date</member>
 350
 351    <member><varname>mineffort</varname></member>
 352    <member>The minimum daily load wanted for the resource</member>
 353
 354    <member><varname>minend</varname></member>
 355    <member>The earliest desired end date</member>
 356
 357    <member><varname>minstart</varname></member>
 358    <member>The earliest desired start date</member>
 359
 360    <member><varname>monthly</varname></member>
 361    <member>A month-by-month calendar view of the tasks</member>
 362
 363    <member><varname>name</varname></member>
 364    <member>The name of a task, resource, or account</member>
 365
 366    <member><varname>no</varname></member>
 367    <member>The task index in the list. It starts with 1 and increases for
 368    every listed item by 1.</member>
 369
 370    <member><varname>note</varname></member>
 371    <member>The description of the task</member>
 372
 373    <member><varname>pathcriticalness</varname></member>
 374    <member>The overall criticalness of the task. It is a measure for the
 375    probability that an effort task gets scheduled as early as
 376    possible. The tasks of the most critical path have the highest path
 377    criticalness.</member>
 378
 379    <member><varname>priority</varname></member>
 380    <member>The scheduling priority</member>
 381
 382    <member><varname>profit</varname></member>
 383    <member>The accumulated profit of the task and its sub tasks</member>
 384
 385    <member><varname>projectid</varname></member>
 386    <member>The project ID of the task</member>
 387
 388    <member><varname>projectids</varname></member>
 389    <member>The project IDs of the projects a resource is allocated to</member>
 390
 391    <member><varname>quarterly</varname></member>
 392    <member>A quarter-by-quarter calendar view of the tasks</member>
 393
 394    <member><varname>rate</varname></member>
 395    <member>The daily rate of the resource</member>
 396
 397    <member><varname>reference</varname></member>
 398    <member>A reference to a URL that contains further information.</member>
 399
 400    <member><varname>resources</varname></member>
 401    <member>The names of the used resources</member>
 402
 403    <member><varname>responsibilies</varname></member>
 404    <member>A list of all tasks indicies for which a resource is
 405    responsible </member>
 406
 407    <member><varname>responsible</varname></member>
 408    <member>The name of the resource responsible for a task</member>
 409
 410    <member><varname>revenue</varname></member>
 411    <member>The accumulated revenue of the task and its sub tasks</member>
 412
 413    <member><varname>scenario</varname></member>
 414    <member>The name of the scenario. This column is helpful when multiple
 415    scenarios are shown in the table. See also <link
 416    linkend="PROPERTY_scenarios">scenarios</link>.</member>
 417
 418    <member><varname>seqno</varname></member>
 419    <member>The task index in the order of declaration. Each
 420    time a task declaration is completed, the sequence number is increased
 421    by 1. </member>
 422
 423    <member><varname>schedule</varname></member>
 424    <member>A detailed schedule of the allocations for the resource.</member>
 425
 426    <member><varname>start</varname></member>
 427    <member>The start date of a task</member>
 428
 429    <member><varname>startbuffer</varname></member>
 430    <member>The percentage of the start buffer</member>
 431
 432    <member><varname>startbufferend</varname></member>
 433    <member>The end time of the start buffer</member>
 434
 435    <member><varname>status</varname></member>
 436    <member>The current status of the task. This is derived from the
 437    current date or the date specified by <link
 438    linkend="PROPERTY_now">now</link> and the degree of completion. The
 439    degree of completion is either computed or has been specified by <link
 440    linkend="PROPERTY_complete">complete</link>.</member>
 441
 442    <member><varname>total</varname></member>
 443    <member>Total accumulated values</member>
 444
 445    <member><varname>weekly</varname></member>
 446    <member>A week-by-week calendar view of the tasks</member>
 447
 448    <member><varname>yearly</varname></member>
 449    <member>A year-by-year calendar view of the tasks</member>
 450
 451    </simplelist></para>
 452 <para>The following macros are supported for normal table cells:</para>
 453
 454 <para><simplelist type="horiz" columns="2">
 455 <member><varname>$${0}</varname></member>
 456 <member>This is the original value of the table cell. This macro is
 457 useful if the user would like to extend the cell text with a fixed
 458 string.</member>
 459
 460 <member><varname>$${accountid}</varname></member>
 461 <member>The ID of the account.</member>
 462
 463 <member><varname>$${resourceid}</varname></member>
 464 <member>The ID of the resource.</member>
 465
 466 <member><varname>$${taskid}</varname></member> <member>the
 467 id of the task.</member>
 468
 469 </simplelist></para>
 470
 471 <para>Additionally the original contense of other cells of the same
 472 report line can be accessed by the column ID. The following columns
 473 are supported:</para>
 474
 475 <para><varname>index, no, hierachindex, hierachno, id,
 476 name</varname></para>
 477
 478 <para>For the title or sub title of the calendar columns
 479 (<varname>daily, weekly, monthly, quarterly, yearly</varname>) the
 480 following macros are supported:</para>
 481
 482 <para><varname>$${day}, $${month}, $${week}, $${quarter},
 483 $${year}</varname>.</para>
 484   </freestyle>
 485  </property>
 486  <property name="complete" id="complete" inheritable="No"
 487 scenario="Yes">
 488   <descr><para>Specifies what percentage of the task is already
 489 completed. This can be useful for project tracking. Reports with
 490 calendar elements may show the completed part of the task in a
 491 different color.</para>
 492
 493 <para>Tasks may not have subtasks if this attribute is used.</para></descr>
 494   <attributes>
 495    <attr name="percent" type="INTEGER">
 496     <para>The value must be between 0 and 100.</para>
 497    </attr>
 498   </attributes>
 499  </property>
 500  <property name="copyright" id="copyright" inheritable="No">
 501   <descr><para>Adds a copyright notice to all subsequently defined
 502 reports. This notice may contain any text. The notice is added at the
 503 bottom of the report.</para></descr>
 504   <attributes>
 505    <attr name="text" type="STRING"/>
 506   </attributes>
 507   <seealso>
 508    <also>headline</also>
 509    <also>caption</also>
 510   </seealso>
 511  </property>
 512  <property name="credit" id="credit">
 513   <descr><para>Credits the specified amount to the account at the
 514 specified date. The description should contain some information about
 515 the reason for the transaction.</para></descr>
 516   <attributes>
 517    <attr name="date" type="DATE"/>
 518    <attr name="description" type="STRING"/>
 519    <attr name="amount" type="REAL"/>
 520   </attributes>
 521  </property>
 522  <property name="csvaccountreport" id="csvaccountreport">
 523   <descr><para>The report lists all specified account values as a comma
 524 separated list. This is usefull to export TaskJuggler data to Office
 525 Suites like OpenOffice.org or KOffice.</para></descr>
 526   <attributes>
 527    <attr name="filename" type="STRING"/>
 528   </attributes>
 529   <optattributes>
 530    <optattr>accumulate</optattr>
 531    <optattr>columns</optattr>
 532    <optattr>end_report</optattr>
 533    <optattr>rollupaccount</optattr>
 534    <optattr>hideaccount</optattr>
 535    <optattr>sortaccounts</optattr>
 536    <optattr>start_report</optattr>
 537   </optattributes>
 538   <seealso>
 539    <also>htmlaccountreport</also>
 540   </seealso>
 541  </property>
 542  <property name="csvresourcereport" id="csvresourcereport" inheritable="No">
 543   <descr><para>The report lists all specified resource values as a
 544 comma separated list. This is usefull to export TaskJuggler data to
 545 Office Suites like OpenOffice.org or KOffice.</para></descr>
 546   <attributes>
 547    <attr name="filename" type="STRING"/>
 548   </attributes>
 549   <optattributes>
 550    <optattr>accumulate</optattr>
 551    <optattr>columns</optattr>
 552    <optattr>end_report</optattr>
 553    <optattr>rollupresource</optattr>
 554    <optattr>hideresource</optattr>
 555    <optattr>sortresources</optattr>
 556    <optattr>start_report</optattr>
 557   </optattributes>
 558   <seealso>
 559    <also>htmlresourcereport</also>
 560   </seealso>
 561  </property>
 562  <property name="csvtaskreport" id="csvtaskreport" inheritable="No">
 563   <descr><para>The report lists all specified task values as a comma
 564 separated list. This is usefull to export TaskJuggler data to Office
 565 Suites like OpenOffice.org or KOffice.</para></descr>
 566   <attributes>
 567    <attr name="filename" type="STRING"/>
 568   </attributes>
 569   <optattributes>
 570    <optattr>accumulate</optattr>
 571    <optattr>columns</optattr>
 572    <optattr>end_report</optattr>
 573    <optattr>rolluptask</optattr>
 574    <optattr>hidetask</optattr>
 575    <optattr>sorttasks</optattr>
 576    <optattr>start_report</optattr>
 577   </optattributes>
 578   <seealso>
 579    <also>htmltaskreport</also>
 580   </seealso>
 581  </property>
 582  <property name="currency" id="currency" inheritable="No">
 583   <descr><para>The default currency unit.</para></descr>
 584   <attributes>
 585    <attr name="text" type="STRING"/>
 586   </attributes>
 587   <seealso>
 588    <also>currencyformat</also>
 589   </seealso>
 590  </property>
 591  <property name="currencyformat" id="currencyformat" inheritable="Yes">
 592   <descr><para>These values specify the default format used for all
 593 currency values. The <varname>negativeprefix</varname> and
 594 <varname>negativesuffix</varname> strings enclose negative currency
 595 values. The <varname>thousandseparator</varname> can be used to make
 596 large numbers more readable. The <varname>fractionseparator</varname>
 597 separates the fractional part from the rest.
 598 <varname>fractiondigits</varname> specifies how many fractional digits
 599 should be shown at a maximum.</para></descr>
 600   <attributes>
 601    <attr name="negativeprefix" type="STRING"/>
 602    <attr name="negativesuffix" type="STRING"/>
 603    <attr name="thousandseparator" type="STRING"/>
 604    <attr name="fractionseparator" type="STRING"/>
 605    <attr name="fractiondigits" type="STRING"/>
 606   </attributes>
 607   <seealso>
 608    <also>currency</also>
 609   </seealso>
 610  </property>
 611  <property name="dailymax" id="dailymax" inheritable="Yes">
 612   <descr><para>Sets the daily limit of a resource usage or a resource
 613 allocation to a task.</para></descr>
 614   <attributes>
 615    <attr name="value" type="REAL"/>
 616    <attr name="unit" type="UNIT"/>
 617   </attributes>
 618   <seealso>
 619    <also>monthlymax</also>
 620    <also>weeklymax</also>
 621   </seealso>
 622  </property>
 623  <property name="dailyworkinghours" id="dailyworkinghours" inheritable="No">
 624   <descr><para>Set the average number of working hours per day. This
 625 is used as the base to convert working hours into working days. This
 626 affects for example the <link linkend="PROPERTY_length">length</link> task
 627 attribute. The default value is 8 hours and should work for most
 628 Western countries.  The value you specify should match the settings
 629 you specified for <link
 630 linkend="PROPERTY_workinghours">workinghours</link>.</para></descr>
 631   <attributes>
 632    <attr name="hours" type="REAL"/>
 633   </attributes>
 634   <seealso>
 635    <also>yearlyworkingdays</also>
 636   </seealso>
 637  </property>
 638  <property name="depends" id="depends" inheritable="No">
 639   <descr><para>Specifies that the task cannot start before the task
 640 with the specified IDs have been finished. If multiple IDs are
 641 specified, they must be separated by commas. IDs must be either global
 642 or relative. A relative ID starts with a number of '!'. Each '!' moves
 643 the scope to the parent task. Global IDs do
 644 not contain '!', but have IDs separated by dots.</para>
 645
 646 <para>By using the 'depends' attribute, the scheduling policy is
 647 automatically set to <varname>asap</varname>. If 'depends' and
 648 'precedes' are used, the last policy counts.</para></descr>
 649   <attributes>
 650    <attr name="task" type="ID" list="1"/>
 651   </attributes>
 652   <seealso>
 653    <also>complete</also>
 654    <also>precedes</also>
 655   </seealso>
 656   <example>&example_depends;</example>
 657  </property>
 658  <property name="disabled" id="disabled" inheritable="No">
 659   <descr><para>Disables the scenario for scheduling.</para></descr>
 660  </property>
 661  <property name="duration" id="duration" inheritable="No">
 662   <descr><para>Specifies the time the task occupies the resources.
 663 This is calender time, not working time. 7d means one week. If
 664 resources are specified they are allocated when available.
 665 Availability of resources has no impact on the duration of the task.
 666 It will always be the specified duration.</para>
 667
 668 <para>Tasks may not have subtasks if this attribute is used.</para></descr>
 669   <attributes>
 670    <attr name="value" type="REAL"/>
 671    <attr name="unit" type="UNIT"/>
 672   </attributes>
 673   <seealso>
 674    <also>effort</also>
 675    <also>length</also>
 676   </seealso>
 677  </property>
 678  <property name="efficiency" id="efficiency" inheritable="Yes">
 679   <descr><para>The efficiency of a resource can be used for two
 680 purposes. First you can use it as a crude way to model a team. A team
 681 of 5 people should have an efficiency of 5.0. Keep in mind that you
 682 cannot track the member of the team individually if you use this
 683 feature. The other use is to model performance variations between your
 684 resources.</para></descr>
 685   <attributes>
 686    <attr name="value" type="REAL"/>
 687   </attributes>
 688   <seealso>
 689    <also>load</also>
 690   </seealso>
 691  </property>
 692  <property name="effort" id="effort" inheritable="No" scenario="Yes">
 693   <descr><para>Specifies the effort needed to complete the task. An
 694 effort of 4d can be done with 2 full-time resources in 2 days. The
 695 task will not finish before the resources have contributed the
 696 specified effort. So the duration of the task will depend on the
 697 availability of the resources.</para>
 698
 699 <para>WARNING: In almost all real world projects effort is not the product
 700 of time and resources. This is only true if the task can be
 701 partitioned without adding any overhead. For more information about
 702 this read "The Mythical Man-Month" by Frederick P. Brooks, Jr.</para>
 703
 704 <para>Tasks may not have subtasks if this attribute is
 705 used.</para></descr>
 706   <attributes>
 707    <attr name="value" type="REAL"/>
 708    <attr name="unit" type="UNIT"/>
 709   </attributes>
 710   <seealso>
 711    <also>duration</also>
 712    <also>length</also>
 713   </seealso>
 714  </property>
 715  <property name="end" id="end_report" inheritable="No">
 716   <descr><para>Specifies the end date of the report. In task reports only
 717 tasks that start before this end date are listed.</para></descr>
 718   <attributes>
 719    <attr name="date" type="DATE"/>
 720   </attributes>
 721   <seealso>
 722    <also>start_report</also>
 723   </seealso>
 724  </property>
 725  <property name="end" id="end_task" inheritable="Yes" scenario="Yes">
 726   <descr><para>The end date of the task</para></descr>
 727   <attributes>
 728    <attr name="date" type="DATE"/>
 729   </attributes>
 730   <seealso>
 731    <also>start_task</also>
 732    <also>maxend</also>
 733    <also>minend</also>
 734    <also>endbuffer</also>
 735   </seealso>
 736  </property>
 737  <property name="endbuffer" id="endbuffer" inheritable="No"
 738 scenario="Yes">
 739   <descr><para>Specifies how much slack time you expect to have at the
 740 end of the task.</para></descr>
 741   <attributes>
 742    <attr name="percent" type="REAL">
 743     <para>Percent slack of the overall effort, duration or length of
 744 the task.</para>
 745    </attr>
 746   </attributes>
 747   <seealso>
 748    <also>duration</also>
 749    <also>effort</also>
 750    <also>length</also>
 751   </seealso>
 752  </property>
 753  <property name="endcredit" id="endcredit" inheritable="No"
 754 scenario="Yes">
 755   <descr><para>Specifies an amount that is credited to the account
 756 specified by the <link linkend="PROPERTY_account_task">account</link> property
 757 at the moment the tasks ends.</para></descr>
 758   <attributes>
 759    <attr name="amount" type="REAL"/>
 760   </attributes>
 761   <seealso>
 762    <also>startcredit</also>
 763   </seealso>
 764  </property>
 765  <property name="export" id="export" inheritable="No">
 766   <descr><para>The export report looks like a regular taskjuggler file
 767 but contains fixed start and end dates for all tasks. The tasks only
 768 have start and end times, their description and their project id
 769 listed. No other attributes are exported unless they are requested
 770 using the <link
 771 linkend="PROPERTY_taskattributes">taskattributes</link> attribute. The
 772 contense also depends on the extension of the file name. If the file
 773 name ends with <varname>.tjp</varname> a complete project with header,
 774 resource and shift definitions is generated. In case it ends with
 775 <varname>.tji</varname> only the tasks and resource allocations are
 776 exported.</para>
 777
 778 <para>If specified the resource usage for the tasks is reported as
 779 well. But only those allocations are listed that belong to tasks
 780 listed in the same export report.</para>
 781
 782 <para>The export report can be used to share certain tasks or
 783 milestones with other projects. When an export report is included the
 784 project IDs of the included tasks must be declared first with the
 785 <link linkend="PROPERTY_projectid">project id property</link>.</para></descr>
 786   <attributes>
 787    <attr name="filename" type="STRING"/>
 788   </attributes>
 789   <optattributes>
 790    <optattr>hideresource</optattr>
 791    <optattr>hidetask</optattr>
 792    <optattr>rollupresource</optattr>
 793    <optattr>rolluptask</optattr>
 794    <optattr>scenarios</optattr>
 795    <optattr>taskattributes</optattr>
 796    <optattr>taskroot</optattr>
 797   </optattributes>
 798   <seealso>
 799    <also>include</also>
 800   </seealso>
 801  </property>
 802  <property name="extend" id="extend" inheritable="No">
 803   <descr><para>Often it is desireable to collect more information in
 804 the project file than is necessary for task scheduling and resource
 805 allocation. To add such information to tasks, resources or accounts
 806 the user can extend these properties with user-defined attributes. The
 807 new attributes can be <varname>text</varname> or
 808 <varname>reference</varname> attributes. Optionally the user can
 809 specify if the attribute value should be inherited from the enclosing
 810 property.</para></descr>
 811   <attributes>
 812    <attr name="property" type="ID">
 813     <para>Possible values are <varname>task</varname>, <varname>
 814 resource</varname> or <varname> account</varname></para>
 815    </attr>
 816   </attributes>
 817   <freestyle>
 818    <para>&lt;type&gt; &lt;id&gt; &lt;name&gt;</para>
 819
 820 <para><simplelist type="horiz" columns="2">
 821 <member>type:</member>
 822 <member>Specifies the type of the user-defined
 823 attribute. <varname>text</varname> is a simple text attribute.
 824 <varname>reference</varname> is an URL to another document.</member>
 825
 826 <member>id:</member>
 827 <member>An user-defined ID that is unique within
 828 the used-defined task attributes. To avoid conflicts with future
 829 built-in attributes, all user defined attributes must start with a
 830 capital letter.</member>
 831
 832 <member>name:</member>
 833 <member>A short description of the attribute. It will be used as
 834 default column header in reports.</member>
 835
 836 </simplelist></para>
 837   </freestyle>
 838   <example>&example_extend;</example>
 839  </property>
 840  <property name="flags" id="flags" inheritable="Yes">
 841   <descr><para>Attach a set of flags. The flags can be used in logical
 842 expressions to filter properties from the reports.</para></descr>
 843   <attributes>
 844    <attr name="flag" type="ID" list="1"/>
 845   </attributes>
 846   <seealso>
 847    <also>flags_declare</also>
 848   </seealso>
 849  </property>
 850  <property name="flags" id="flags_declare" inheritable="No">
 851   <descr><para>Declare a set of flags for later use.</para></descr>
 852   <attributes>
 853    <attr name="flag" type="ID" list="1"/>
 854   </attributes>
 855   <seealso>
 856    <also>flags</also>
 857   </seealso>
 858  </property>
 859  <property name="headline" id="headline" inheritable="No">
 860   <descr><para>Specifies the headline for a report.</para></descr>
 861   <attributes>
 862    <attr name="text" type="STRING"/>
 863   </attributes>
 864   <seealso>
 865    <also>caption</also>
 866    <also>copyright</also>
 867   </seealso>
 868  </property>
 869  <property name="hideaccount" id="hideaccount" inheritable="No">
 870   <descr><para>Do not show accounts that match the specified logical
 871 expression. If the report is sorted in tree mode (default) then
 872 enclosing accounts are listed even if the expression matches the
 873 account.</para></descr>
 874   <attributes>
 875    <attr name="logicalexpression" type="LOGICALEXPRESSION"/>
 876   </attributes>
 877  </property>
 878  <property name="hidecelltext" id="hidecelltext" inheritable="No">
 879   <descr><para>If the expression is true, the cell will be empty.</para></descr>
 880   <attributes>
 881    <attr name="expression" type="LOGICALEXPRESSION"/>
 882   </attributes>
 883   <seealso>
 884    <also>hidecellurl</also>
 885   </seealso>
 886  </property>
 887  <property name="hidecellurl" id="hidecellurl" inheritable="No">
 888   <descr><para>If the expression is true, no URL will be attached to the cell
 889 contense.</para></descr>
 890   <attributes>
 891    <attr name="expression" type="LOGICALEXPRESSION"/>
 892   </attributes>
 893   <seealso>
 894    <also>hidecelltext</also>
 895   </seealso>
 896  </property>
 897  <property name="hideresource" id="hideresource" inheritable="No">
 898   <descr><para>Do not show resources that match the specified logical
 899 expression. If the report is sorted in tree mode (default) then
 900 enclosing resources are listed even if the expression matches the
 901 resource.</para></descr>
 902   <attributes>
 903    <attr name="logicalexpression" type="LOGICALEXPRESSION"/>
 904   </attributes>
 905  </property>
 906  <property name="hidetask" id="hidetask" inheritable="No">
 907   <descr><para>Do not show tasks that match the specified logical
 908 expression. If the report is sorted in tree mode (default) then
 909 enclosing tasks are listed even if the expression matches the
 910 task.</para></descr>
 911   <attributes>
 912    <attr name="logicalexpression" type="LOGICALEXPRESSION"/>
 913   </attributes>
 914  </property>
 915  <property name="htmlaccountreport" id="htmlaccountreport" inheritable="No">
 916   <descr><para>The report lists all specified account values as a HTML
 917 page.</para></descr>
 918   <attributes>
 919   </attributes>
 920   <optattributes>
 921    <optattr>accumulate</optattr>
 922    <optattr>caption</optattr>
 923    <optattr>columns</optattr>
 924    <optattr>end_report</optattr>
 925    <optattr>headline</optattr>
 926    <optattr>hideaccount</optattr>
 927    <optattr>rawhead</optattr>
 928    <optattr>rawstylesheet</optattr>
 929    <optattr>rawtail</optattr>
 930    <optattr>rollupaccount</optattr>
 931    <optattr>scenarios</optattr>
 932    <optattr>shorttimeformat</optattr>
 933    <optattr>sortaccounts</optattr>
 934    <optattr>start_report</optattr>
 935    <optattr>timeformat</optattr>
 936   </optattributes>
 937   <seealso>
 938    <also>csvaccountreport</also>
 939    <also>htmlresourcereport</also>
 940    <also>htmltaskreport</also>
 941   </seealso>
 942  </property>
 943  <property name="htmlresourcereport" id="htmlresourcereport" inheritable="No">
 944   <descr><para>The report lists all resources and their respective
 945 values as a HTML page. The tasks that the resources are allocated to
 946 can be listed as well.</para></descr>
 947   <attributes>
 948   </attributes>
 949   <optattributes>
 950    <optattr>accumulate</optattr>
 951    <optattr>barlabels</optattr>
 952    <optattr>caption</optattr>
 953    <optattr>columns</optattr>
 954    <optattr>end_report</optattr>
 955    <optattr>headline</optattr>
 956    <optattr>hideresource</optattr>
 957    <optattr>hidetask</optattr>
 958    <optattr>loadunit</optattr>
 959    <optattr>rawhead</optattr>
 960    <optattr>rawstylesheet</optattr>
 961    <optattr>rawtail</optattr>
 962    <optattr>rollupresource</optattr>
 963    <optattr>rolluptask</optattr>
 964    <optattr>scenarios</optattr>
 965    <optattr>shorttimeformat</optattr>
 966    <optattr>showprojectids</optattr>
 967    <optattr>sortresources</optattr>
 968    <optattr>sorttasks</optattr>
 969    <optattr>start_report</optattr>
 970    <optattr>timeformat</optattr>
 971   </optattributes>
 972   <seealso>
 973    <also>csvresourcereport</also>
 974    <also>htmlaccountreport</also>
 975    <also>htmltaskreport</also>
 976   </seealso>
 977  </property>
 978  <property name="htmlstatusreport" id="htmlstatusreport" inheritable="No">
 979   <descr><para>Generates a HTML status report. The report consits of 4
 980 tables: Overdue tasks, ongoing tasks, finished tasks and upcoming
 981 tasks. The default reporting interval is 1 week.</para></descr>
 982   <attributes>
 983    <attr name="file" type="STRING"/>
 984   </attributes>
 985   <optattributes>
 986    <optattr>scenarios</optattr>
 987    <optattr>start_report</optattr>
 988    <optattr>end_report</optattr>
 989    <optattr>headline</optattr>
 990    <optattr>caption</optattr>
 991    <optattr>rawhead</optattr>
 992    <optattr>rawstylesheet</optattr>
 993    <optattr>rawtail</optattr>
 994    <optattr>loadunit</optattr>
 995    <optattr>timeformat</optattr>
 996    <optattr>shorttimeformat</optattr>
 997   </optattributes>
 998   <seealso>
 999    <also>htmlaccountreport</also>
1000    <also>htmlresourcereport</also>
1001    <also>htmltaskreport</also>
1002    <also>htmlweeklycalendar</also>
1003   </seealso>
1004  </property>
1005  <property name="htmltaskreport" id="htmltaskreport" inheritable="No">
1006   <descr><para>The report lists all tasks and their respective values
1007 as a HTML page. The resources that are allocated to the tasks can be
1008 listed as well.</para></descr>
1009   <attributes>
1010   </attributes>
1011   <optattributes>
1012    <optattr>accumulate</optattr>
1013    <optattr>barlabels</optattr>
1014    <optattr>caption</optattr>
1015    <optattr>columns</optattr>
1016    <optattr>end_report</optattr>
1017    <optattr>headline</optattr>
1018    <optattr>hideresource</optattr>
1019    <optattr>hidetask</optattr>
1020    <optattr>loadunit</optattr>
1021    <optattr>rawhead</optattr>
1022    <optattr>rawstylesheet</optattr>
1023    <optattr>rawtail</optattr>
1024    <optattr>rollupresource</optattr>
1025    <optattr>rolluptask</optattr>
1026    <optattr>scenarios</optattr>
1027    <optattr>shorttimeformat</optattr>
1028    <optattr>showprojectids</optattr>
1029    <optattr>sortresources</optattr>
1030    <optattr>sorttasks</optattr>
1031    <optattr>start_report</optattr>
1032    <optattr>timeformat</optattr>
1033   </optattributes>
1034   <seealso>
1035    <also>csvtaskreport</also>
1036    <also>htmlaccountreport</also>
1037    <also>htmlresourcereport</also>
1038   </seealso>
1039  </property>
1040  <property name="htmlweeklycalendar" id="htmlweeklycalendar" inheritable="No">
1041   <descr><para>Generates a calendar like HTML report.</para></descr>
1042   <attributes>
1043    <attr name="file" type="STRING"/>
1044   </attributes>
1045   <optattributes>
1046    <optattr>accumulate</optattr>
1047    <optattr>barlabels</optattr>
1048    <optattr>caption</optattr>
1049    <optattr>columns</optattr>
1050    <optattr>end_report</optattr>
1051    <optattr>headline</optattr>
1052    <optattr>hideresource</optattr>
1053    <optattr>hidetask</optattr>
1054    <optattr>loadunit</optattr>
1055    <optattr>rawhead</optattr>
1056    <optattr>rawstylesheet</optattr>
1057    <optattr>rawtail</optattr>
1058    <optattr>rollupresource</optattr>
1059    <optattr>rolluptask</optattr>
1060    <optattr>scenarios</optattr>
1061    <optattr>shorttimeformat</optattr>
1062    <optattr>showprojectids</optattr>
1063    <optattr>sortresources</optattr>
1064    <optattr>sorttasks</optattr>
1065    <optattr>start_report</optattr>
1066    <optattr>timeformat</optattr>
1067   </optattributes>
1068   <seealso>
1069    <also>htmlaccountreport</also>
1070    <also>htmlresourcereport</also>
1071    <also>htmltaskreport</also>
1072    <also>htmlstatusreport</also>
1073   </seealso>
1074  </property>
1075  <property name="include" id="include" inheritable="No">
1076   <descr><para>Includes the specified file name as if its contents
1077 would be written instead of the include property.
1078 <varname>include</varname> commands can be used within global scope or
1079 between property declarations of tasks, resources, and
1080 accounts.</para>
1081
1082 <para>For technical reasons you have to supply the optional pair of
1083 curly brackets if the include is followed immediately by a macro that
1084 is defined within the included file.</para></descr>
1085   <attributes>
1086    <attr name="file" type="STRING"/>
1087   </attributes>
1088   <optattributes>
1089    <optattr>taskprefix</optattr>
1090   </optattributes>
1091   <seealso>
1092    <also>export</also>
1093   </seealso>
1094  </property>
1095  <property name="kotrusid" id="kotrusid" inheritable="Yes">
1096   <descr><para>The KoTrus ID of the account (cost object). This is a
1097 special reserved keyword.</para></descr>
1098   <attributes>
1099     <attr name="id" type="STRING"/>
1100   </attributes>
1101  </property>
1102  <property name="label" id="label" inheritable="No">
1103   <descr><para>Specifies the text for the URL in HTML reports.</para></descr>
1104   <attributes>
1105    <attr name="text" type="STRING"/>
1106   </attributes>
1107  </property>
1108  <property name="length" id="length" inheritable="No" scenario="Yes">
1109   <descr><para>Specifies the time the task occupies the resources.
1110 This is working time, not calender time. 7d means 7 working days, not
1111 one week.  Whether a day is considered a working day or not depends on
1112 the defined <link linkend="PROPERTY_workinghours">working hours</link>
1113 and global <link linkend="PROPERTY_vacation_global">vacations</link>. A task
1114 with a length specification may have resource allocations. Resources
1115 are allocated when they are available. The availability has no impact
1116 on the duration of the task. A day where none of the specified
1117 resources is available is still considered a working day, if there is
1118 no global vacation of or global working time defined.</para>
1119
1120 <para>Tasks may not have subtasks if this attribute is used.</para></descr>
1121   <attributes>
1122    <attr name="value" type="REAL"/>
1123    <attr name="unit" type="UNIT"/>
1124   </attributes>
1125   <seealso>
1126    <also>duration</also>
1127    <also>effort</also>
1128   </seealso>
1129  </property>
1130  <property name="limits" id="limits" inheritable="Yes">
1131   <descr><para>Specifies limits on the usage of a resource in general,
1132 or of the allocation of a resource to a task. This property replaces
1133 the less flexible properties <link
1134 linkend="PROPERTY_maxeffort">maxeffort</link> and <link
1135 linkend="PROPERTY_load">load</link>.</para></descr>
1136   <optattributes>
1137    <optattr>dailymax</optattr>
1138    <optattr>weeklymax</optattr>
1139    <optattr>monthlymax</optattr>
1140   </optattributes>
1141   <example>&example_limits;</example>
1142  </property>
1143  <property name="load" id="load" inheritable="No">
1144   <descr><para>This property has been replaced by <link
1145 linkend="PROPERTY_limits">limits</link>. The further usage of load is
1146 strongly discouraged. It will be dropped from future versions of
1147 TaskJuggler.</para>
1148   <para>Specifies the daily load of a resource for an
1149 allocation. A load of 1.0 (default) means the resource is allocated
1150 for as many hours as specified by <link
1151 linkend="PROPERTY_dailyworkinghours">dailyworkinghours</link>. A load
1152 of 0.5 means half that many hours. This only works if enough working
1153 hours have been specified for the particular day.</para></descr>
1154   <attributes>
1155    <attr name="factor" type="REAL"/>
1156   </attributes>
1157   <seealso>
1158    <also>workinghours</also>
1159    <also>vacation_global</also>
1160   </seealso>
1161  </property>
1162  <property name="loadunit" id="loadunit" inheritable="No">
1163   <descr><para>Specifies the unit in which loads are reported in a
1164 report.</para></descr>
1165   <attributes>
1166    <attr name="unit" type="ID">
1167     <para>See table below for possible values.</para>
1168    </attr>
1169   </attributes>
1170   <seealso>
1171    <also>dailyworkinghours</also>
1172    <also>yearlyworkingdays</also>
1173   </seealso>
1174   <freestyle>
1175    <para><simplelist type="horiz" columns="2">
1176
1177    <member><varname>days</varname></member>
1178    <member>Show load in man or resource-days.</member>
1179
1180    <member><varname>hours</varname></member>
1181    <member>Show load in man resource-hours.</member>
1182
1183    <member><varname>longauto</varname></member>
1184    <member>Show load in the most appropriate unit and show long
1185    unit name.</member>
1186
1187    <member><varname>minutes</varname></member>
1188    <member>Show load in man or resource-minutes.</member>
1189
1190    <member><varname>months</varname></member>
1191    <member>Show load in man or resource-months.</member>
1192
1193    <member><varname>shortauto</varname></member>
1194    <member>Show load in the most appropriate unit and show short
1195    unit name.</member>
1196
1197    <member><varname>weeks</varname></member>
1198    <member>Show load in man or resource-weeks.</member>
1199
1200    <member><varname>years</varname></member>
1201    <member>Show load in man or resource-years.</member>
1202
1203    </simplelist></para>
1204   </freestyle>
1205  </property>
1206  <property name="macro" id="macro" inheritable="No">
1207   <descr><para>Defines a text fragment that can later be inserted by
1208 using the specified ID.</para></descr>
1209   <attributes>
1210    <attr name="id" type="ID"/>
1211   </attributes>
1212   <freestyle>
1213 <para>The body is not optional. It must be enclosed in [ ].
1214 Macros can be declared like this:</para>
1215
1216 <para><screen>
1217 macro FOO [ This text ];
1218 </screen></para>
1219
1220 <para>If later ${FOO} is found in the project file, it is expanded to ' This
1221 text '. Macros may have arguments. Arguments are special macros with
1222 numbers as names. The number specifies the index of the
1223 argument.</para>
1224
1225 <para><screen>
1226 macro FOO [ This ${1} text ]
1227 </screen></para>
1228
1229 <para>will expand to ' This stupid text ' if called as ${FOO
1230 "stupid"}. Macros may call other macros.</para>
1231
1232 <para>Macro IDs should have at least one uppercase
1233 letter as all lowercase letter IDs may be used in a later version for
1234 built-in macros like 'if', 'expr' or 'for'. Macro names can be
1235 prefixed by a questionmark. In this case the macro will expand to
1236 nothing if the macro is not defined. Otherwise the undefined macro
1237 would be flagged with an error message.</para>
1238
1239 <para><screen>
1240 This macro call ${?foo} will expand to nothing if foo is undefined.
1241 </screen></para>
1242   </freestyle>
1243  </property>
1244  <property name="mandatory" id="mandatory" inheritable="No">
1245   <descr><para>Makes a resource allocation mandatory. In this case the
1246 other resource allocations of the task will only be made when the
1247 mandatory resources are available as well.</para></descr>
1248  </property>
1249  <property name="maxeffort" id="maxeffort" inheritable="No">
1250   <descr><para>This property has been replaced by <link
1251 linkend="PROPERTY_limits">limits</link>. The further usage of maxeffort is
1252 strongly discouraged. It will be dropped from future versions of
1253 TaskJuggler.</para>
1254   <para>The daily maximum effort for a resource. Resources will not be
1255 scheduled to be used more than this value. A value of 1.0 means a full
1256 working day. 0.5 means half a working day.</para></descr>
1257   <attributes>
1258    <attr name="workingdays" type="REAL"/>
1259   </attributes>
1260   <seealso>
1261    <also>dailyworkinghours</also>
1262    <also>workinghours</also>
1263   </seealso>
1264  </property>
1265  <property name="maxend" id="maxend" inheritable="Yes" scenario="Yes">
1266   <descr><para>Specifies the maximum wanted end time of the task. The
1267 value is not used during scheduling, but is checked after all tasks
1268 have been scheduled. If the end of the task is later than
1269 the specified value, then an error is reported.</para></descr>
1270   <attributes>
1271    <attr name="date" type="DATE"/>
1272   </attributes>
1273   <seealso>
1274    <also>maxstart</also>
1275    <also>minend</also>
1276    <also>minstart</also>
1277   </seealso>
1278  </property>
1279  <property name="maxstart" id="maxstart" inheritable="Yes"
1280 scenario="Yes">
1281   <descr><para>Specifies the maximum wanted start time of the task.
1282 The value is not used during scheduling, but is checked after all
1283 tasks have been scheduled. If the start of the task is later than
1284 the specified value, then an error is reported.</para></descr>
1285   <attributes>
1286    <attr name="date" type="DATE"/>
1287   </attributes>
1288   <seealso>
1289    <also>maxend</also>
1290    <also>minend</also>
1291    <also>minstart</also>
1292   </seealso>
1293  </property>
1294  <property name="minend" id="minend" inheritable="Yes" scenario="Yes">
1295   <descr><para>Specifies the minimum wanted end time of the task. The
1296 value is not used during scheduling, but is checked after all tasks
1297 have been scheduled. If the end of the task is earlier than
1298 the specified value, then an error is reported.</para></descr>
1299   <attributes>
1300    <attr name="date" type="DATE"/>
1301   </attributes>
1302   <seealso>
1303    <also>maxend</also>
1304    <also>maxstart</also>
1305    <also>minstart</also>
1306   </seealso>
1307  </property>
1308  <property name="minstart" id="minstart" inheritable="Yes"
1309 scenario="Yes">
1310   <descr><para>Specifies the minimum wanted start time of the task.
1311 The value is not used during scheduling, but is checked after all
1312 tasks have been scheduled. If the start of the task is earlier than
1313 the specified value, then an error is reported.</para></descr>
1314   <attributes>
1315    <attr name="date" type="DATE"/>
1316   </attributes>
1317   <seealso>
1318    <also>maxend</also>
1319    <also>maxstart</also>
1320    <also>minend</also>
1321   </seealso>
1322  </property>
1323  <property name="milestone" id="milestone" inheritable="No">
1324   <descr><para>Turns the task into a special task that has no
1325 duration. You may not specify a <link
1326 linkend="PROPERTY_duration">duration</link>, <link
1327 linkend="PROPERTY_length">length</link>, <link
1328 linkend="PROPERTY_effort">effort</link> or subtasks for a milestone
1329 task.</para></descr> </property>
1330  <property name="note" id="note" inheritable="No">
1331   <descr><para>Attach a note to the task. This is usually a more
1332 detailed specification of what the task is about.</para></descr>
1333   <attributes>
1334    <attr name="text" type="STRING"/>
1335   </attributes>
1336   <seealso>
1337    <also>statusnote</also>
1338   </seealso>
1339  </property>
1340  <property name="monthlymax" id="monthlymax" inheritable="Yes">
1341   <descr><para>Sets the monthly limit of a resource usage or a resource
1342 allocation to a task.</para></descr>
1343   <attributes>
1344    <attr name="value" type="REAL"/>
1345    <attr name="unit" type="UNIT"/>
1346   </attributes>
1347   <seealso>
1348    <also>dailymax</also>
1349    <also>weeklymax</also>
1350   </seealso>
1351  </property>
1352  <property name="now" id="now" inheritable="Yes">
1353   <descr><para>Specify the date that TaskJuggler uses for calculation
1354 as current date. If no value is specified, the current value of the
1355 system clock is used.</para></descr> <attributes>
1356    <attr name="date" type="DATE"/>
1357   </attributes>
1358  </property>
1359  <property name="numberformat" id="numberformat" inheritable="Yes">
1360   <descr><para>These values specify the default format used for all
1361 numerical real values. The <varname>negativeprefix</varname> and
1362 <varname>negativesuffix</varname> strings enclose negative currency
1363 values. The <varname>thousandseparator</varname> can be used to make
1364 large numbers more readable. The <varname>fractionseparator</varname>
1365 separates the fractional part from the rest.
1366 <varname>fractiondigits</varname> specifies how many fractional digits
1367 should be shown at a maximum.</para></descr>
1368   <attributes>
1369    <attr name="negativeprefix" type="STRING"/>
1370    <attr name="negativesuffix" type="STRING"/>
1371    <attr name="thousandseparator" type="STRING"/>
1372    <attr name="fractionseparator" type="STRING"/>
1373    <attr name="fractiondigits" type="STRING"/>
1374   </attributes>
1375  </property>
1376  <property name="persistent" id="persistent" inheritable="No">
1377   <descr><para>Specifies that the resource is used for the whole task.
1378 This is usefull when several alternative resources have been
1379 specified. Normaly the selected resource can change after each
1380 timeslot.</para></descr>
1381   <seealso>
1382    <also>alternative</also>
1383   </seealso>
1384  </property>
1385  <property name="priority" id="priority" inheritable="No">
1386   <descr><para>Specifies a priority between 1 and 1000. A task with
1387 higher priority is more likely to get the requested resources.</para>
1388
1389 <para>This attribute is inherited by subtasks if specified prior to
1390 the definition of the subtask.</para></descr>
1391   <attributes>
1392    <attr name="value" type="INTEGER"/>
1393   </attributes>
1394  </property>
1395  <property name="precedes" id="precedes" inheritable="No">
1396   <descr><para>Specifies that the tasks with the specified IDs cannot
1397 start before the task has been finished. If multiple IDs are
1398 specified, they must be separated by commas. IDs must be either global
1399 or relative. A relative ID starts with a number of '!'. Each '!' moves
1400 the scope to the parent task. Global IDs do
1401 not contain '!', but have IDs separated by dots.</para>
1402
1403 <para>By using the 'precedes' attribute, the scheduling policy is
1404 automatically set to <varname>alap</varname>. If both 'precedes' and
1405 'precedes' are used within a task, the last policy
1406 counts.</para></descr>
1407   <attributes>
1408    <attr name="task" type="ID" list="1"/>
1409   </attributes>
1410   <seealso>
1411    <also>complete</also>
1412    <also>depends</also>
1413   </seealso>
1414   <example>&example_precedes;</example>
1415  </property>
1416  <property name="project" id="project" inheritable="No">
1417   <descr><para>The project property is mandatory and should be the
1418 first property in a project file. &lt;id&gt; is the default project
1419 ID used to register resource allocations in a global database.
1420 &lt;name&gt; is the name of the project.  &lt;version&gt; is the
1421 version of the project file. Typically this is the CVS ID.
1422 &lt;start&gt; and &lt;end&gt; define the time frame of the project.
1423 The end may be well after the end of the last task, but must be
1424 specified to terminate the scheduling process.</para></descr>
1425   <attributes>
1426    <attr name="id" type="ID">
1427     <para>The default project ID.</para>
1428    </attr>
1429    <attr name="name" type="STRING">
1430     <para>The name of the project.</para>
1431    </attr>
1432    <attr name="version" type="STRING">
1433     <para>The version of the project file. This could be a revision
1434 number from a revision control system.</para>
1435    </attr>
1436    <attr name="start" type="DATE">
1437     <para>All task must start after this date.</para>
1438    </attr>
1439    <attr name="end" type="DATE">
1440     <para>All task must end before this date.</para>
1441    </attr>
1442   </attributes>
1443   <optattributes>
1444    <optattr>allowredefinition</optattr>
1445    <optattr>currencyformat</optattr>
1446    <optattr>currency</optattr>
1447    <optattr>dailyworkinghours</optattr>
1448    <optattr>extend</optattr>
1449    <optattr>include</optattr>
1450    <optattr>now</optattr>
1451    <optattr>numberformat</optattr>
1452    <optattr>scenario</optattr>
1453    <optattr>shorttimeformat</optattr>
1454    <optattr>timeformat</optattr>
1455    <optattr>timezone</optattr>
1456    <optattr>timingresolution</optattr>
1457    <optattr>weekstartsmonday</optattr>
1458    <optattr>weekstartssunday</optattr>
1459    <optattr>workinghours</optattr>
1460    <optattr>yearlyworkingdays</optattr>
1461   </optattributes>
1462  </property>
1463  <property name="projectid" id="projectid" inheritable="Yes">
1464   <descr><para>At global scope it declares a new project id and
1465 activates it. All subsequent task definitions will inherit this
1466 ID. If used within a task it simply assigns this project ID to the
1467 task. The tasks of a project can have different IDs. This is
1468 particularly helpful if the project is merged from several sub
1469 projects that each have their own ID.</para></descr> <attributes>
1470 <attr name="id" type="ID"/>
1471   </attributes>
1472   <seealso>
1473    <also>project</also>
1474    <also>projectids</also>
1475   </seealso>
1476  </property>
1477  <property name="projectids" id="projectids" inheritable="No">
1478   <descr><para>Declares a list of project IDs.</para></descr>
1479   <attributes>
1480    <attr name="projectid" type="ID" list="1"/>
1481   </attributes>
1482   <seealso>
1483    <also>project</also>
1484    <also>projectid</also>
1485   </seealso>
1486  </property>
1487  <property name="projection" id="projection" inheritable="No">
1488   <descr><para>Enables the projection mode for the scenario. All tasks
1489 will be scheduled taking the manual bookings into account. The
1490 tasks will be extended after the last manual bookings until the
1491 specified effort, length or duration has been reached.</para></descr>
1492   <seealso>
1493    <also>booking</also>
1494   </seealso>
1495  </property>
1496  <property name="rate" id="rate" inheritable="Yes">
1497   <descr><para>Specifies the daily costs of the resource. The amount
1498 are credited to the account specified with the task that makes use of
1499 the resource.</para></descr>
1500   <attributes>
1501    <attr name="value" type="REAL"/>
1502   </attributes>
1503   <seealso>
1504    <also>account</also>
1505    <also>task</also>
1506   </seealso>
1507  </property>
1508  <property name="rawhead" id="rawhead" inheritable="No">
1509   <descr><para>Specifies a section of raw HTML code that will be
1510 inserted at the top of the report.</para></descr>
1511   <attributes>
1512    <attr name="html" type="STRING"/>
1513   </attributes>
1514   <seealso>
1515    <also>rawstylesheet</also>
1516    <also>rawtail</also>
1517   </seealso>
1518  </property>
1519  <property name="rawstylesheet" id="rawstylesheet" inheritable="No">
1520   <descr><para>Specifies a stylesheet for HTML reports.</para></descr>
1521   <attributes>
1522    <attr name="stylesheet" type="STRING"/>
1523   </attributes>
1524  </property>
1525  <property name="rawtail" id="rawtail" inheritable="No">
1526   <descr><para>Specifies a section of raw HTML code that will be
1527 inserted at the bottom of the report.</para></descr>
1528   <attributes>
1529    <attr name="html" type="STRING"/>
1530   </attributes>
1531   <seealso>
1532    <also>rawhead</also>
1533    <also>rawstylesheet</also>
1534   </seealso>
1535  </property>
1536  <property name="reference" id="reference" inheritable="No">
1537   <descr><para>A reference to an external document. If you need more
1538 than one reference, you can create your own URL placeholders.</para></descr>
1539   <attributes>
1540    <attr name="url" type="STRING">
1541     <para>Should be a well formed URL.</para>
1542    </attr>
1543   </attributes>
1544   <optattributes>
1545    <optattr>label</optattr>
1546   </optattributes>
1547   <seealso>
1548    <also>extend</also>
1549   </seealso>
1550  </property>
1551  <property name="resource" id="resource" inheritable="No">
1552   <descr><para>Task use resources to fullfill the specified
1553 efforts.</para></descr> <attributes> <attr name="id" type="ID"/> <attr
1554 name="name" type="STRING"/> </attributes>
1555   <optattributes>
1556    <optattr>booking</optattr>
1557    <optattr>efficiency</optattr>
1558    <optattr>flags</optattr>
1559    <optattr>kotrusid</optattr>
1560    <optattr>maxeffort</optattr>
1561    <optattr>limits</optattr>
1562    <optattr>rate</optattr>
1563    <optattr>resource</optattr>
1564    <optattr>shift_selection</optattr>
1565    <optattr>vacation_resource</optattr>
1566    <optattr>workinghours</optattr>
1567   </optattributes>
1568   <seealso>
1569    <also>task</also>
1570   </seealso>
1571  </property>
1572   <property name="responsible" id="responsible" inheritable="Yes">
1573    <descr><para>The ID of the resource that is responsible for this task.</para></descr>
1574   <attributes>
1575    <attr name="resource" type="ID"/>
1576   </attributes>
1577   <seealso>
1578    <also>resource</also>
1579   </seealso>
1580  </property>
1581  <property name="rollupaccount" id="rollupaccount" inheritable="No">
1582   <descr><para>Do not show sub-accounts of accounts that match the
1583 specified logical expression.</para></descr>
1584   <attributes>
1585    <attr name="logicalexpression" type="LOGICALEXPRESSION"/>
1586   </attributes>
1587   <seealso>
1588    <also>rollupresource</also>
1589    <also>rolluptask</also>
1590   </seealso>
1591  </property>
1592  <property name="rollupresrouce" id="rollupresource" inheritable="No">
1593   <descr><para>Do not show sub-resources of resources that match the
1594 specified logical expression.</para></descr>
1595   <attributes>
1596    <attr name="logicalexpression" type="LOGICALEXPRESSION"/>
1597   </attributes>
1598   <seealso>
1599    <also>rollupaccount</also>
1600    <also>rolluptask</also>
1601   </seealso>
1602  </property>
1603  <property name="rolluptask" id="rolluptask" inheritable="No">
1604   <descr><para>Do not show sub-tasks of tasks that match the
1605 specified logical expression.</para></descr>
1606   <attributes>
1607    <attr name="logicalexpression" type="LOGICALEXPRESSION"/>
1608   </attributes>
1609   <seealso>
1610    <also>rollupaccount</also>
1611    <also>rollupresource</also>
1612   </seealso>
1613  </property>
1614  <property name="scenario" id="scenario" inheritable="No">
1615   <descr><para>Specifies the different project scenarios. A scenario
1616 that is nested into another one inherits all values from the enclosing
1617 scenario except those values that were specified specifically for this
1618 scenario.</para></descr>
1619   <attributes>
1620    <attr name="id" type="ID"/>
1621    <attr name="name" type="STRING"/>
1622   </attributes>
1623   <optattributes>
1624    <optattr>disabled</optattr>
1625    <optattr>projection</optattr>
1626    <optattr>scenario</optattr>
1627   </optattributes>
1628   <seealso>
1629    <also>scenarios</also>
1630   </seealso>
1631  </property>
1632  <property name="scenarios" id="scenarios" inheritable="No">
1633   <descr><para>List of scenarios that should be included in the
1634 report.</para></descr>
1635   <attributes>
1636    <attr name="scenarioid" type="ID" list="1">
1637     <para>The ID of the scenario.</para>
1638    </attr>
1639   </attributes>
1640   <seealso>
1641    <also>scenario</also>
1642   </seealso>
1643  </property>
1644  <property name="scheduled" id="scheduled" inheritable="No"
1645 scenario="Yes">
1646   <descr><para>This is mostly for internal use. It specifies that the
1647 task can be ignored for scheduling in the scenario.</para></descr>
1648  </property>
1649  <property name="scheduling" id="scheduling" inheritable="Yes">
1650   <descr><para>Specifies the scheduling policy for the task. A task
1651 can be scheduled from start to end (As Soon As Possible,
1652 <varname>asap</varname>) or from
1653 end to start (As Late As Possible, <varname>alap</varname>).</para></descr>
1654   <attributes>
1655    <attr name="type" type="ID">
1656     <para>Possible values are <varname>alap</varname> or
1657 <varname>asap</varname>.</para>
1658    </attr>
1659   </attributes>
1660  </property>
1661  <property name="select" id="select" inheritable="No">
1662   <descr><para>The select functions controls which resource is picked
1663 from an allocation and it's alternatives. The selection is
1664 re-evaluated each time the resource used in the previous time slot
1665 becomes unavailable.</para></descr>
1666   <attributes>
1667    <attr name="mode" type="ID">
1668     <para>See table below for possible values.</para>
1669    </attr>
1670   </attributes>
1671   <seealso>
1672    <also>persistent</also>
1673   </seealso>
1674   <freestyle>
1675    <para><simplelist type="horiz" columns="2">
1676
1677    <member><varname>maxloaded</varname></member>
1678    <member>Pick the available resource that has been used the most so
1679    far.</member>
1680
1681    <member><varname>minloaded</varname></member>
1682    <member>Pick the available resource that has been used the least so
1683    far.</member>
1684
1685    <member><varname>minallocated</varname></member>
1686    <member>Pick the resource that has the smallest allocation factor.
1687    The allocation factor is calculated from the various allocations of
1688    the resource across the tasks. This is the default setting.</member>
1689
1690    <member><varname>order</varname></member>
1691    <member>Pick the first available resource from the list.</member>
1692
1693    <member><varname>random</varname></member>
1694    <member>Pick a random resource from the list.</member>
1695
1696    </simplelist></para>
1697   </freestyle>
1698  </property>
1699  <property name="sloppy" id="sloppy" inheritable="No">
1700   <descr><para>Controls how strict TaskJuggler checks booking
1701 intervals for conflicts with vacation and other bookings. In case the
1702 error is surpressed the booking will not overwrite the existing
1703 bookings. It will avoid the already assigned intervals during booking.
1704 </para></descr>
1705   <attributes>
1706    <attr name="value" type="INTEGER">
1707     <para>Number between 0 and 3. 0 (default): period may not contain
1708 any off-duty hours, vacation or other task assignments. 1: period may
1709 contain off-duty hours, but not vacation or other task assignments. 2:
1710 period may contain off-duty hours and vacation, but no other task
1711 assignments. 3: Period may overlap with off-duty hours, vacation or
1712 other task assignments. These are silently skipped.</para>
1713    </attr>
1714   </attributes>
1715  </property>
1716  <property name="shift" id="shift" inheritable="No">
1717   <descr><para>When several resource have the same working hours,
1718 these working hours should be defined as shifts. Each shift must have
1719 a unique ID. Resources can be assigned to shifts for certain
1720 intervals.</para></descr>
1721   <attributes>
1722    <attr name="id" type="ID"/>
1723    <attr name="name" type="STRING"/>
1724   </attributes>
1725   <optattributes>
1726    <optattr>shift</optattr>
1727    <optattr>workinghours</optattr>
1728   </optattributes>
1729   <seealso>
1730    <also>shift_selection</also>
1731   </seealso>
1732  </property>
1733  <property name="shift" id="shift_selection" inheritable="No">
1734   <descr><para>Limites the resource working time or work on a task to
1735 a defined shift during the specified interval. Multiple shifts can be
1736 defined, but shift intervals may not overlap.</para></descr>
1737   <attributes>
1738    <attr name="shiftid" type="ID">
1739     <para>The ID of the selected shift.</para>
1740    </attr>
1741    <attr name="dateinterval" type="DATEINTERVAL" optional="1">
1742     <para>If an interval is specified, no allocations will be made
1743 outside the shift intervals unless other shifts have been selected for
1744 other time intervals. If the interval is omitted, the shift is
1745 assigned for the whole project time frame.</para>
1746    </attr>
1747   </attributes>
1748   <seealso>
1749    <also>shift</also>
1750   </seealso>
1751  </property>
1752  <property name="shorttimeformat" id="shorttimeformat"
1753 inheritable="Yes">
1754   <descr><para>Specifies time format for time short specifications. This is
1755 normal just the hour and minutes.</para></descr>
1756   <attributes>
1757    <attr name="format" type="STRING"/>
1758   </attributes>
1759   <seealso>
1760    <also>timeformat</also>
1761   </seealso>
1762  </property>
1763  <property name="showprojectids" id="showprojectids" inheritable="No">
1764   <descr><para>Specifies that calendar columns in reports should
1765 contain the project ID after the load value.</para></descr>
1766   <seealso>
1767    <also>barlabels</also>
1768    <also>columns</also>
1769   </seealso>
1770  </property>
1771  <property name="sortaccounts" id="sortaccounts" inheritable="No">
1772   <descr><para>Determines how the accounts are sorted in the report. Up to 3
1773 criteria can be specified. If one criteria is not sufficient to sort a
1774 group of accounts, the next criteria will be used to sort the accounts
1775 within this group.</para></descr>
1776   <attributes>
1777    <attr name="criteria" type="SORTINGCRITERIA" list="1">
1778     <para>Possible values are
1779 fullnamedown,
1780 fullnameup,
1781 iddown,
1782 idup,
1783 indexdown,
1784 indexup,
1785 namedown,
1786 nameup,
1787 sequencedown,
1788 sequenceup,
1789 tree
1790    </para>
1791   </attr>
1792   </attributes>
1793  </property>
1794  <property name="sortresources" id="sortresources" inheritable="No">
1795   <descr><para>Determines how the resources are sorted in the report. Up to 3
1796 criteria can be specified. If one criteria is not sufficient to sort a
1797 group of accounts, the next criteria will be used to sort the accounts
1798 within this group.</para></descr>
1799   <attributes>
1800    <attr name="criteria" type="SORTINGCRITERIA" list="1">
1801     <para>Possible values are
1802 fullnamedown,
1803 fullnameup,
1804 iddown,
1805 idup,
1806 indexdown,
1807 indexup,
1808 maxeffortdown,
1809 maxeffortup,
1810 mineffortdown,
1811 mineffortup,
1812 namedown,
1813 nameup,
1814 ratedown,
1815 rateup,
1816 sequencedown,
1817 sequenceup,
1818 tree
1819    </para>
1820   </attr>
1821   </attributes>
1822  </property>
1823  <property name="sorttasks" id="sorttasks" inheritable="No">
1824   <descr><para>Determines how the tasks are sorted in the report. Up to 3
1825 criteria can be specified. If one criteria is not sufficient to sort a
1826 group of accounts, the next criteria will be used to sort the accounts
1827 within this group.</para></descr>
1828   <attributes>
1829    <attr name="criteria" type="SORTINGCRITERIA" list="1">
1830     <para>Possible values are
1831 completeddown,
1832 completedup,
1833 criticalnessdown,
1834 criticalnessup,
1835 enddown,
1836 endup,
1837 fullnamedown,
1838 fullnameup,
1839 iddown,
1840 idup,
1841 indexdown,
1842 indexup,
1843 namedown,
1844 nameup,
1845 pathcriticalnessdown,
1846 pathcriticalnessup,
1847 prioritydown,
1848 priorityup,
1849 responsibledown,
1850 responsibleup,
1851 sequencedown,
1852 sequenceup,
1853 startdown,
1854 startup,
1855 statusdown,
1856 statusup,
1857 tree
1858    </para>
1859   </attr>
1860   </attributes>
1861  </property>
1862  <property name="start" id="start_report" inheritable="No">
1863   <descr><para>Specifies the start date of the report. In task reports only
1864 tasks that end after this end date are listed.</para></descr>
1865   <attributes>
1866    <attr name="date" type="DATE"/>
1867   </attributes>
1868   <seealso>
1869    <also>end_report</also>
1870   </seealso>
1871  </property>
1872  <property name="start" id="start_task" inheritable="Yes"
1873 scenario="Yes">
1874   <descr><para>The start date of the task</para></descr>
1875   <attributes>
1876    <attr name="date" type="DATE"/>
1877   </attributes>
1878   <seealso>
1879    <also>end_task</also>
1880    <also>maxstart</also>
1881    <also>minstart</also>
1882    <also>startbuffer</also>
1883   </seealso>
1884  </property>
1885  <property name="startbuffer" id="startbuffer" inheritable="No"
1886 scenario="Yes">
1887   <descr><para>Specifies how much slack time you expect to have at the
1888 begining of the task.</para></descr>
1889   <attributes>
1890    <attr name="percent" type="REAL">
1891     <para>Percent slack of the overall effort, duration or length of
1892 the task.</para>
1893    </attr>
1894   </attributes>
1895   <seealso>
1896    <also>duration</also>
1897    <also>effort</also>
1898    <also>length</also>
1899   </seealso>
1900  </property>
1901  <property name="startcredit" id="startcredit" inheritable="No"
1902 scenario="Yes">
1903   <descr><para>Specifies an amount that is credited to the account
1904 specified by the <link linkend="PROPERTY_account_task">account</link>
1905 property at the moment the tasks starts.</para></descr>
1906   <attributes>
1907    <attr name="amount" type="REAL"/>
1908   </attributes>
1909   <seealso>
1910    <also>endcredit</also>
1911   </seealso>
1912  </property>
1913  <property name="statusnote" id="statusnote" inheritable="No"
1914 scenario="Yes">
1915   <descr><para>A note that describes the current status of the
1916 task.</para></descr>
1917   <attributes>
1918    <attr name="text" type="STRING"/>
1919   </attributes>
1920   <seealso>
1921    <also>note</also>
1922   </seealso>
1923  </property>
1924  <property name="subtitle" id="subtitle" inheritable="No">
1925   <descr><para>Specifies an alternative subtitle for a report
1926 column.</para></descr> <attributes>
1927    <attr name="text" type="STRING"/>
1928   </attributes>
1929   <seealso>
1930    <also>subtitleurl</also>
1931   </seealso>
1932  </property>
1933  <property name="subtitleurl" id="subtitleurl" inheritable="No">
1934   <descr><para>Specifies an URL that is attached to the column subtitle
1935 of HTML reports.</para></descr>
1936   <attributes>
1937    <attr name="url" type="STRING"/>
1938   </attributes>
1939   <seealso>
1940    <also>subtitle</also>
1941   </seealso>
1942  </property>
1943  <property name="supplement" id="supplement" inheritable="No">
1944   <descr><para>The supplement keyword provides a mechanism to add more
1945 attributes to already defined tasks or resources. The additional
1946 attributes must obey the same rules as in regular task or resource
1947 definitions and must be enclosed by curly braces.</para>
1948
1949 <para>This construct is primarily meant for situations where the
1950 information about a task or resource is split over several files. E.
1951 g. the vacation dates for the resources may be in a separate file that
1952 was generated by some other tool.</para></descr>
1953   <attributes>
1954    <attr name="type" type="ID">
1955     <para>Possible values are <varname>resource</varname> or
1956 <varname>task</varname>.</para>
1957    </attr>
1958   </attributes>
1959   <seealso>
1960    <also>resource</also>
1961    <also>task</also>
1962   </seealso>
1963  </property>
1964  <property name="task" id="task" inheritable="No">
1965   <descr><para>Tasks are the central elements of a project plan. Use
1966 a task to specify which resource should be allocated for how long to
1967 what task.</para></descr>
1968   <attributes>
1969    <attr name="id" type="ID"/>
1970    <attr name="name" type="STRING"/>
1971   </attributes>
1972   <optattributes>
1973    <optattr>account_task</optattr>
1974    <optattr>allocate</optattr>
1975    <optattr>complete</optattr>
1976    <optattr>depends</optattr>
1977    <optattr>duration</optattr>
1978    <optattr>effort</optattr>
1979    <optattr>endbuffer</optattr>
1980    <optattr>endcredit</optattr>
1981    <optattr>end_task</optattr>
1982    <optattr>flags</optattr>
1983    <optattr>length</optattr>
1984    <optattr>maxend</optattr>
1985    <optattr>maxstart</optattr>
1986    <optattr>milestone</optattr>
1987    <optattr>minend</optattr>
1988    <optattr>minstart</optattr>
1989    <optattr>note</optattr>
1990    <optattr>precedes</optattr>
1991    <optattr>priority</optattr>
1992    <optattr>projectid</optattr>
1993    <optattr>reference</optattr>
1994    <optattr>responsible</optattr>
1995    <optattr>scheduled</optattr>
1996    <optattr>scheduling</optattr>
1997    <optattr>shift_selection</optattr>
1998    <optattr>startbuffer</optattr>
1999    <optattr>startcredit</optattr>
2000    <optattr>start_task</optattr>
2001    <optattr>statusnote</optattr>
2002    <optattr>supplement</optattr>
2003    <optattr>task</optattr>
2004   </optattributes>
2005   <seealso>
2006    <also>resource</also>
2007   </seealso>
2008  </property>
2009  <property name="taskattributes" id="taskattributes" inheritable="No">
2010   <descr><para>The list of attribute names specifies which task
2011 attributes should be listed in the report in addition to the ones
2012 exported by default. The following values are supported. They
2013 correspond to the respective attributes of a <link linkend="PROPERTY_task">
2014 task</link>.</para>
2015
2016 <para><varname>complete</varname>, <varname>depends</varname>,
2017 <varname>flags</varname>, <varname>maxend</varname>,
2018 <varname>maxstart</varname>, <varname>minend</varname>,
2019 <varname>minstart</varname>, <varname>note</varname>,
2020 <varname>priority</varname>, <varname>responsible</varname></para>
2021
2022 <para>By specifying the ID of a <link
2023 linkend="PROPERTY_extend">user-defined</link> attribute, these can be
2024 included as well.</para>
2025
2026 <para>A special case the is <varname>all</varname> keyword. If this is
2027 part of the list, all supported task attributes will be included in
2028 the report.     This includes all user-defined task
2029 attributes.</para></descr>
2030   <attributes>
2031    <attr name="attribute" type="ID" list="1"/>
2032   </attributes>
2033  </property>
2034  <property name="taskprefix" id="taskprefix" inheritable="No">
2035   <descr><para>All tasks in the included file are added as sub-tasks of the
2036 task specified by <varname>taskprefix</varname>.</para></descr>
2037   <attributes>
2038    <attr name="prefix" type="STRING"/>
2039   </attributes>
2040   <seealso>
2041    <also>task</also>
2042   </seealso>
2043  </property>
2044  <property name="taskroot" id="taskroot" inheritable="No">
2045   <descr><para>Only tasks below the specified root-level tasks are
2046 exported.  The exported tasks will have the id of the root-level task
2047 stripped from their ID, so that the sub-tasks of the root-level task
2048 become top-level tasks in the exported file.</para></descr>
2049   <attributes>
2050    <attr name="root" type="ID">
2051     <para>ID of a task that specifies the new root level</para>
2052    </attr>
2053   </attributes>
2054  </property>
2055  <property name="timezone" id="timezone" inheritable="No">
2056   <descr><para>Sets the default timezone of the project. All times
2057 that have no time zones specified will be assumed to be in this
2058 timezone. The value must be a string just like those used for the TZ
2059 environment variable. Most Linux systems have a command line utility
2060 called <varname>tzselect</varname> to lookup possible values.</para>
2061
2062 <para>The project start and end time are not affected by this setting. You
2063 have to explicitly state the timezone for those dates or the system
2064 defaults are assumed.</para></descr>
2065   <attributes>
2066    <attr name="zone" type="STRING"/>
2067   </attributes>
2068  </property>
2069  <property name="timeformat" id="timeformat" inheritable="Yes">
2070   <descr><para>Determines how time specifications in reports look like.</para></descr>
2071   <attributes>
2072    <attr name="format" type="STRING">
2073     <para>See table below for possible values.</para>
2074    </attr>
2075   </attributes>
2076   <seealso>
2077    <also>shorttimeformat</also>
2078   </seealso>
2079   <freestyle>
2080 <para>
2081 Ordinary characters placed in the format string are copied to s
2082 without conversion. Conversion specifiers are introduced by  a
2083 `%' character, and are replaced in s as follows:</para>
2084
2085 <para><simplelist type="horiz" columns="2">
2086
2087 <member>%a</member><member>The abbreviated weekday name according to
2088 the  current locale.</member>
2089
2090 <member>%A</member><member>The full weekday name according  to the
2091 current locale.</member>
2092
2093 <member>%b</member><member>The abbreviated month name according to the
2094 current locale.</member>
2095
2096 <member>%B</member><member> The full month name according to
2097 the current locale.</member>
2098
2099 <member>%c</member><member> The preferred date and time
2100 representation for the current locale.</member>
2101
2102 <member>%C</member><member> The century number (year/100) as a 2-digit
2103 integer. (SU)</member>
2104
2105 <member>%d</member><member>The day of the month as a decimal number
2106 (range  01 to 31).</member>
2107
2108 <member>%D</member><member>Equivalent  to  %m/%d/%y.  (Yecch  -  for
2109 Americans only.  Americans should note that in other countries %d/%m/%y
2110 is rather common.  This means that in international context this format is
2111 ambiguous  and should not be used.) (SU)</member>
2112
2113 <member>%e</member><member>Like  %d, the day of the month as a decimal number,
2114 but a leading zero is replaced by a space. (SU)</member>
2115
2116 <member>%E</member><member>Modifier: use alternative format, see
2117 below. (SU)</member>
2118
2119 <member>%F</member><member>Equivalent to %Y-%m-%d (the ISO 8601 date
2120 format). (C99)</member>
2121
2122 <member>%G</member><member>The ISO 8601 year with century as a decimal
2123 number.  The 4-digit year corresponding to the ISO week number  (see
2124 %V). This has the same format and value as %y, except that if the ISO week
2125 number belongs to  the previous or next year, that year is used
2126 instead. (TZ)</member>
2127
2128 <member>%g</member><member>Like %G, but without century, i.e., with a  2-digit
2129 year (00-99). (TZ)</member>
2130
2131 <member>%h</member><member>Equivalent to %b. (SU)</member>
2132
2133 <member>%H</member><member>The  hour as a decimal number using a
2134 24-hour clock (range 00 to 23).</member>
2135
2136 <member>%I</member><member>The hour as a decimal number using a
2137 12-hour  clock (range 01 to 12).</member>
2138
2139 <member>%j</member><member>The  day of the year as a decimal number
2140 (range 001 to 366).</member>
2141
2142 <member>%k</member><member>The hour (24-hour clock) as a decimal
2143 number (range 0 to 23); single digits are preceded by a blank.  (See
2144 also %H.) (TZ)</member>
2145
2146 <member>%l</member><member>The hour (12-hour clock) as a decimal
2147 number (range 1 to 12); single digits are preceded by a blank. (See
2148 also %I.) (TZ)</member>
2149
2150 <member>%m</member><member>The month as a decimal number (range 01 to
2151 12).</member>
2152
2153 <member>%M</member><member>The minute as a decimal number (range 00 to
2154 59).</member>
2155
2156 <member>%n</member><member>A newline character. (SU)</member>
2157
2158 <member>%O</member><member>Modifier: use alternative format, see
2159 below. (SU)</member>
2160
2161 <member>%p</member><member>Either 'AM' or 'PM' according  to  the
2162 given  time value, or the corresponding strings for the
2163 current locale.  Noon is treated as `pm'  and  midnight as
2164 'am'.</member>
2165
2166 <member>%P</member><member>Like  %p but in lowercase: 'am' or 'pm' or
2167 %a corresponding string for the current locale. (GNU)</member>
2168
2169 <member>%r</member><member>The time in a.m. or p.m. notation.   In
2170 the  POSIX locale this is equivalent to '%I:%M:%S %p'. (SU)</member>
2171
2172 <member>%R</member><member>The  time  in  24-hour notation (%H:%M).
2173 (SU) For a version including the seconds, see %T below.</member>
2174
2175 <member>%s</member><member>The number of seconds since the Epoch,
2176 i.e.,  since 1970-01-01 00:00:00 UTC. (TZ)</member>
2177
2178 <member>%S</member><member>The second as a decimal number (range 00 to
2179 61).</member>
2180
2181 <member>%t</member><member>A tab character. (SU)</member>
2182
2183 <member>%T</member><member>The time in 24-hour notation (%H:%M:%S).
2184 (SU)</member>
2185
2186 <member>%u</member><member>The  day  of  the  week as a decimal, range
2187 1 to 7, Monday being 1.  See also %w. (SU)</member>
2188
2189 <member>%U</member><member>The week number of the current year  as  a
2190 decimal number,  range  00  to  53, starting with the first Sunday as
2191 the first day of week 01. See also %V and %W.</member>
2192
2193 <member>%V</member><member>The ISO 8601:1988 week number of the
2194 current year as a decimal number, range 01 to 53, where week 1 is the
2195 first week that has at least 4 days in the current year, and with
2196 Monday as the first day of the week.  See also %U %and %W.
2197 %(SU)</member>
2198
2199 <member>%w</member><member>The  day  of  the  week as a decimal, range
2200 0 to 6, Sunday being 0.  See also %u.</member>
2201
2202 <member>%W</member><member>The week number of the current %year  as  a
2203 decimal number,  range  00  to  53, starting with the first Monday as
2204 the first day of week 01.</member>
2205
2206 <member>%x</member><member>The preferred date representation for  the
2207 current locale without the time.</member>
2208
2209 <member>%X</member><member>The  preferred  time representation for
2210 the current locale without the date.</member>
2211
2212 <member>%y</member><member>The year as a decimal number without
2213 a century (range 00 to 99).</member>
2214
2215 <member>%Y</member><member> The year as a decimal number
2216 including the century.</member>
2217
2218 <member>%z</member><member> The time zone as hour offset from
2219 GMT. Required to emit RFC822-conformant dates (using "%a, %d %%b
2220 %Y %H:%M:%S %%z"). (GNU)</member>
2221
2222 <member>%Z</member><member>The time zone or name or
2223 abbreviation.</member>
2224
2225 <member>%+</member><member>The date and time in date(1) format.
2226 (TZ)</member>
2227
2228 <member>%%</member><member>A literal '%' character.</member>
2229
2230 </simplelist></para>
2231
2232 <para>Some conversion specifiers can be  modified  by preceding them
2233 by  the E or O modifier to indicate that an alternative format
2234 should be used.  If the alternative format  or specification  does
2235 not exist for the current locale, the behavior will be as if the
2236 unmodified conversion specification  were used.  (SU) The Single
2237 Unix Specification mentions %Ec, %EC, %Ex, %%EX, %Ry, %EY, %Od,
2238 %Oe,  %OH, %OI, %Om, %OM, %OS, %Ou, %OU, %OV, %Ow, %OW,
2239 %Oy, where the effect of the O modifier is to use alternative
2240 numeric symbols (say, Roman numerals), and that of the E modifier is
2241 to use a locale-dependent alternative representation.</para>
2242
2243 <para>The documentation of the
2244 <varname>timeformat</varname> attribute has been taken
2245 from the man page of the GNU <varname>strftime</varname>
2246 function.</para>
2247   </freestyle>
2248  </property>
2249  <property name="timingresolution" id="timingresolution" inheritable="No">
2250   <descr><para>Sets the minimum timing resolution. The smaller the
2251 value, the longer the scheduling process lasts and the more memory the
2252 application needs. The default is 1 hour. The smallest value is 5
2253 min.</para>
2254
2255 <para>This value is a pretty fundamental setting of TaskJuggler. It
2256 has a severe impact on memory usage and scheduling performance. You
2257 should set this value to the minimum required resolution. Make sure
2258 that all values that you specify are aligned with the
2259 resolution.</para></descr>
2260   <attributes>
2261    <attr name="value" type="INTEGER"/>
2262    <attr name="unit" type="UNIT"/>
2263   </attributes>
2264  </property>
2265  <property name="title" id="title" inheritable="No">
2266   <descr><para>Specifies an alternative title for a report
2267 column.</para></descr> <attributes>
2268    <attr name="text" type="STRING"/>
2269   </attributes>
2270   <seealso>
2271    <also>titleurl</also>
2272   </seealso>
2273  </property>
2274  <property name="titleurl" id="titleurl" inheritable="No">
2275   <descr><para>Specifies an URL that is attached to the column title
2276 of HTML reports.</para></descr>
2277   <attributes>
2278    <attr name="url" type="STRING"/>
2279   </attributes>
2280   <seealso>
2281    <also>title</also>
2282   </seealso>
2283  </property>
2284  <property name="vacation" id="vacation_global" inheritable="Yes">
2285   <descr><para>Specify a global vacation day. This vacation is
2286 respected by all resources that are defined hereafter.</para></descr>
2287   <attributes>
2288    <attr name="name" type="STRING"/>
2289    <attr name="interval" type="DATEINTERVAL"/>
2290   </attributes>
2291   <seealso>
2292    <also>vacation_resource</also>
2293   </seealso>
2294  </property>
2295  <property name="vacation" id="vacation_resource" inheritable="Yes">
2296   <descr><para>Specify a vacation period for the resource.</para></descr>
2297   <attributes>
2298    <attr name="interval" type="DATEINTERVAL"/>
2299   </attributes>
2300   <seealso>
2301    <also>vacation_global</also>
2302   </seealso>
2303  </property>
2304  <property name="version" id="version" inheritable="No">
2305   <descr><para>Specifies which XML format should be generated.
2306 Currently version 2 is highly recomended.</para></descr>
2307   <attributes>
2308    <attr name="number" type="INTEGER"/>
2309   </attributes>
2310  </property>
2311  <property name="weeklymax" id="weeklymax" inheritable="Yes">
2312   <descr><para>Sets the weekly limit of a resource usage or a resource
2313 allocation to a task.</para></descr>
2314   <attributes>
2315    <attr name="value" type="REAL"/>
2316    <attr name="unit" type="UNIT"/>
2317   </attributes>
2318   <seealso>
2319    <also>dailymax</also>
2320    <also>monthlymax</also>
2321   </seealso>
2322  </property>
2323  <property name="weekstartsmonday" id="weekstartsmonday" inheritable="No">
2324   <descr><para>Specify that you want to base all week calculation on
2325 weeks starting on Monday. This is common in many European countries.</para></descr>
2326   <seealso>
2327    <also>weekstartssunday</also>
2328   </seealso>
2329  </property>
2330  <property name="weekstartssunday" id="weekstartssunday" inheritable="No">
2331   <descr><para>Specify that you want to base all week calculation on
2332 weeks starting on Sunday. This is common in the United States of
2333 America.</para></descr>
2334   <seealso>
2335    <also>weekstartsmonday</also>
2336   </seealso>
2337  </property>
2338  <property name="workinghours" id="workinghours" inheritable="Yes">
2339   <descr><para>The working hours specification limits the availability
2340 of resources to certain time slots of week days.</para></descr>
2341   <attributes>
2342    <attr name="weekday" type="WEEKDAY"/>
2343    <attr name="interval" type="TIMEINTERVAL" list="1"/>
2344   </attributes>
2345   <seealso>
2346    <also>dailyworkinghours</also>
2347    <also>yearlyworkingdays</also>
2348   </seealso>
2349  </property>
2350  <property name="xmlreport" id="xmlreport" inheritable="No">
2351   <descr><para>Generates a XML report. TaskJuggler 2.x has a much
2352 improved XML format. This is not yet the default, but will be in later
2353 versions. So you should always specify which version of the XML format
2354 should be generated.</para></descr>
2355   <attributes>
2356    <attr name="file" type="STRING"/>
2357   </attributes>
2358   <optattributes>
2359    <optattr>hideresource</optattr>
2360    <optattr>hidetask</optattr>
2361    <optattr>rollupresource</optattr>
2362    <optattr>rolluptask</optattr>
2363    <optattr>scenarios</optattr>
2364    <optattr>version</optattr>
2365   </optattributes>
2366  </property>
2367  <property name="yearlyworkingdays" id="yearlyworkingdays" inheritable="No">
2368   <descr><para>Specifies the number of average working days per year.
2369 This should correlate to the specified workinghours and vacation. It
2370 affects the conversion of working hours, working days, working weeks,
2371 working months and working years into each other.</para></descr>
2372   <attributes>
2373    <attr name="days" type="REAL"/>
2374   </attributes>
2375   <seealso>
2376    <also>dailyworkinghours</also>
2377    <also>loadunit</also>
2378    <also>vacation_global</also>
2379    <also>workinghours</also>
2380   </seealso>
2381  </property>
2382 <!--
2383  <property name="" id="" inheritable="No">
2384   <descr><para></para></descr>
2385   <attributes>
2386    <attr name="" type=""/>
2387   </attributes>
2388   <optattributes>
2389    <optattr></optattr>
2390   </optattributes>
2391   <seealso>
2392    <also></also>
2393   </seealso>
2394  </property>
2395 -->
2396 </properties>
2397