The TaskJuggler User Manual

Project Management beyond Gantt Chart Drawing


<< text (extend) << Table Of Contents >> timeformat >>


Keyword textreport

Purpose
This report consists of 5 RichText sections, a header, a center section with a left and right margin and a footer. The sections may contain the output of other defined reports.
Syntax textreport [<id>] <name> [{ <attributes> }]
Arguments id [ID]
An optional ID. If you ever want to reference this property, you must specify your own unique ID. If no ID is specified one will be automatically generated. These IDs may become visible in reports, but may change at any time. You may never rely on automatically generated IDs.
name [STRING]

The name of the report. This will be the base name for generated output files. The suffix will depend on the specified formats. It will also be used in navigation bars.

By default, report definitions do not generate any files. With more complex projects, most report definitions will be used to describe elements of composed reports. If you want to generate a file from this report, you must specify the list of formats that you want to generate. The report name will then be used as a base name to create the file. The suffix will be appended based on the generated format.

Reports have a local name space. All IDs and file names must be unique within the reports that belong to the same enclosing report. To reference a report for inclusion into another report, you need to specify the full report ID. This is composed of the report ID, prefixed by a dot-separated list of all parent report IDs.

Context accountreport, export, properties, resourcereport, taskreport, textreport, tracereport

Attributes Name Scen. spec. Inh. fm. Global Inh. fm. Parent
accountreport
accountroot x
auxdir (report) x x
balance
caption x
center x
columns x
currencyformat
end (report) x x
epilog x
export
flags (report) x
footer x
formats x
header x
headline x
height
hideaccount
hidejournalentry
hideresource
hidetask
journalattributes
journalmode
left x
loadunit
numberformat
opennodes
period (report)
prolog x
purge
rawhtmlhead
resourcereport
resourceroot x
right x
rollupaccount
rollupresource
rolluptask
scenarios x
selfcontained x
sortaccounts
sortjournalentries
sortresources
sorttasks
start (report) x x
taskreport
taskroot x
textreport
timeformat
timezone (report) x x
title x
tracereport
width x

project "Test" 2011-12-11 +1m

task "Foo"

textreport frame "textreport" {
  taskreport r1 ""
  taskreport r2 ""

  formats html
  header -8<-
  This is the header
  ----
  ->8-
  left "<[report id='frame.r1']>"
  center "Center"
  right "<[report id='frame.r2']>"
  footer -8<-
  ----
  This is the footer
  ->8-
}


<< text (extend) << Table Of Contents >> timeformat >>


Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 by Chris Schlaeger <cs@taskjuggler.org>.TaskJuggler is a trademark of Chris Schlaeger.