diff --git a/doc/contexthelp.docbook b/doc/contexthelp.docbook
index a0bd5018..36df0b57 100644
--- a/doc/contexthelp.docbook
+++ b/doc/contexthelp.docbook
@@ -1,8 +1,8 @@
Context HelpMany functions and views have help and hints that can be displayed with the What's This function.
- You can activate it with the menu entry HelpWhatsThis or keboard shortcut &Shift;F1.
+ You can activate it with the menu entry HelpWhatsThis or keyboard shortcut &Shift;F1.
In dialogs it is activated by pressing the ? in the dialogs title bar.
diff --git a/doc/creatingodtreporttemplates.docbook b/doc/creatingodtreporttemplates.docbook
index b489e539..2b02e215 100644
--- a/doc/creatingodtreporttemplates.docbook
+++ b/doc/creatingodtreporttemplates.docbook
@@ -1,1267 +1,1267 @@
Creating ODT Report TemplatesDescriptionOpen Document Text report templates are regular ODT files that can be designed using any ODT word processor like Calligra Words or LibreOffice Writer. The technique used is to use user field variables to hold references to the information that shall be fetched from the project. The variables are called User Fields in Writer and can be found under InsertFieldMore FieldsVariablesUser Fields. In Words they are called Custom Variables and can be found under Text Editing dockerVariableCustom.
The easiest way to create a new report template is to modify an existing one as all user fields are defined.
User Field VariablesVariablesThe variables are used to enable the generator to extract data from the project.
A variable can be a reference to a single data field, a reference to table data or a reference to chart data.
Single Data FieldA single data field variable has the following format:
data group name.property = property identifierwhere:
data group name can be tr, project or schedule (see below).property makes the user field name unique.property identity identifies the property in the data group.Table DataA table in a report template consists of a variable to specify the data table to use.
The variable name must start with table (⪚ tableTasks) and the variable value must be the name of the data table (⪚ tasks).
Immediately after the variable, a table must be inserted and columns filled with user field variables that specify which properties to fetch from the table specified above. These variables must have names that start with the name of the table variable above.
These variables have the following format:
- tableTasks.property = property identifer
+ tableTasks.property = property identifierwhere:
property makes the user field name unique.
- property identity identifies the property in the data group.
+ property identifier identifies the property in the data group.Chart DataA chart in a report template consists of a variable to specify the data to use in the chart.
The variable name must start with chart (⪚ chartBudgetCost) and the variable value specifies the data group and values to populate the chart.
The variable has the following format (note the semicolons):
name = data group; values=comma separated list of data properties;
where:
name must start with chart (⪚ chartBudgetCost)data group
- property identity identifies the property in the data group.
+ comma separated list of data properties identifies the properties in the data group.E.g.:
chartBudget = project; values=bcws cost, bcwp cost, acwp cost;
Translated LabelsTranslated labels enable us to produce general report templates that can be used in different languages.
Variable NameVariable Valuetr.projectProjecttr.managerManagertr.scheduleScheduletr.bcwsBCWStr.bcwpBCWPtr.acwpACWPtr.spiSPItr.cpiCPIProject ValuesShows values from the main project.
Variable NameVariable ValueDescriptionproject.nameNameThe name of the projectproject.managerManagerThe name of the project managerproject.bcwscostBCWS CostCost based Budgeted Cost of Work Scheduledproject.bcwpcostBCWP CostCost based Budgeted Cost of Work Performedproject.acwpcostACWP CostCost based Actual Cost of Work Performedproject.spicostSPI CostCost based Schedule Performance Indexproject.cpicostCPI CostCost based Cost Performance Indexproject.bcwseffortBCWS EffortEffort based Budgeted Cost of Work Scheduledproject.bcwpeffortBCWP EffortEffort based Budgeted Cost of Work Performedproject.acwpeffortACWP EffortEffort based Actual Cost of Work Performedproject.spieffortSPI EffortEffort based Schedule Performance Indexproject.cpieffortCPI EffortEffort based Cost Performance IndexSchedule ValuesShows values from the current schedule.
Variable NameVariable ValueDescriptionschedule.nameNameThe name of the scheduleschedule.stateStateScheduling stateschedule.directionNameScheduling directionschedule.overbookingOverbookingOverbookingschedule.distributionDistributionDistributionschedule.plannedstartPlanned StartPlanned Startschedule.plannedfinishPlanned FinishPlanned Finishschedule.schedulerSchedulerSchedulerschedule.granularityGranularityGranularityschedule.modeModeScheduling mode (Auto or Manual)TablesSupported table types:
taskstaskstatusschedulesprojectsTo create a table, place a variable just before a table in your template file. The variable name identifies the table and must start with table, ⪚ tableTaskStatus.
The value of the variable is used to point to the data to be fetched and must be one of the supported tables listed above, ⪚ taskstatus.
You then put variables inside the table cells with name and value from the table below.
Note that the schedules table supports the values described in Schedule Values above.
The projects, tasks and taskstatus tables supports the following values:
Variable NameVariable ValueDescriptiontable name.nameNameThe name of the task or projecttable name.wbscodeWBS Codetable name.typeTypeType of tasktable name.responsibleResponsibletable name.allocationAllocationtable name.estimatetypeEstimate Typetable name.calendarCalendartable name.estimateEstimateMost likely estimatetable name.optimisticOptimisticOptimistic ratiotable name.pessimisticPessimisticPessimistic ratiotable name.riskRiskEstimate uncertaintytable name.constraintConstraintType of time constrainttable name.constraintstartConstraint StartConstraint start timetable name.constraintendConstraint EndConstraint finish timetable name.runingaccountRunning AccountAccount for running coststable name.startupaccountStartup AccountAccount for startup costtable name.startupcostStartup CostThe cost incurred at startup of the tasktable name.shutdownaccountShutdown Account
- Accoutn for shutdown cost
+ Account for shutdown costtable name.shutdowncostShutdown CostThe cost incurred at shutdown of the tasktable name.descriptionDescriptionTask descriptiontable name.expectedExpectedCalculated most likely estimatetable name.optimisticOptimisticCalculated optimistic estimatetable name.pessimisticPessimisticCalculated pessimistic estimatetable name.starttimeStart Time
- Shceduled start time
+ Scheduled start timetable name.endtimeEnd TimeScheduled finish timetable name.durationDurationScheduled durationtable name.earlystartEarly StartEarliest possible starttable name.earlyfinishEarly FinishEarliest possible finishtable name.latestartLate StartLatest possible starttable name.latefinishLate FinishLatest possible finishtable name.positivefloatPositive Floattable name.freefloatFree Floattable name.negativefloatNegative Floattable name.startfloatStart Floattable name.finishfloatFinish Floattable name.assignamentsAssignmentsResource assignmentstable name.varianceestVariance (Est)Calculated estimate variancetable name.variancedurVariance (Dur)Calculated duration variancetable name.optimisticdurOptimistic (Dur)Calculated optimistic durationtable name.pessimisticdurPessimistic (Dur)Calculated pessimistic durationtable name.statusStatusTask status as shown in Task Status Viewtable name.completion% CompletedTask completiontable name.plannedeffortPlanned EffortPlanned efforttable name.actualeffortActual EffortActual efforttable name.remaningeffortRemaining EffortRemaining efforttable name.plannedcostPlanned CostPlanned costtable name.actualcostActual CostActual costtable name.actualstartActual StartActual starttable name.startedStartedtable name.actualfinishActual FinishActual finishtable name.finishedFinishedtable name.schedulingstatusScheduling StatusScheduling statustable name.bcwsBCWSBudgeted Cost of Work Scheduled (cost based)table name.bcwpBCWPBudgeted Cost of Work Performed (cost based)table name.acwpACWPActual Cost of Work Performed (cost based)table name.spiSPISchedule Performance Indextable name.criticalCriticalTask is criticaltable name.criticalpathCritical PathTask is in critical pathtable name.notscheduledNot ScheduledNot interestingtable name.assignmentmissingAssignment MissingNot interestingtable name.resourceoverbookedResource OverbookedNot interestingtable name.resourceunavailableResource UnavailableNot interestingtable name.constrainterrorConstraints ErrorNot interestingtable name.effortnotmetEffort Not MetNot interestingtable name.schedulingerrorScheduling ErrorNot interestingtable name.levelNode level,LevelNot interestingtable name.statusnoteStatus NoteNote: Not implementedtable name.ownerOwnerMust not be used, and are not very interestingtable name.statusStatusMust not be used, and are not very interestingtable name.timeTimeMust not be used, and are not very interestingChartUse by placing a variable with name chartX (X=some text to make the variable name unique) with a value project before the chart that shall be used.
The variable has this format:
Variable: Name: chartX (X=some text) Value: project; values=data;where data is a comma separated list of values to be include in the chart.
Possible data values are:
bcws effort Budgeted cost of work scheduled, effort based.bcwp effort Budgeted cost of work performed, effort based.acwp effort Actual cost of work performed, effort based.spi effort Schedule performance index, effort based.cpi effort Cost performance index, effort based.bcws cost Budgeted cost of work scheduled, cost based.bcwp cost Budgeted cost of work performed, cost based.acwp cost Actual cost of work performed, cost based.spi cost Schedule performance index, cost based.cpi cost Cost performance index, cost based.The charts you create in your template must have the same (or more) number of columns as the number of values you specify in your variable.
Example:
Variable name: chart1 Value: project; values=bcws cost,bcwp cost, acwp cost;Note that you cannot mix effort- and cost-based values. If you want to show both, create two charts.
GanttNot supported.