Documentation > Word Export Plugin > Word GUI

Word GUI

The word plugin GUI is located in two parts in the program one part in the configuration and one part under export.

The complete Word Export plugin consist of the following windows :

• Export Window



Path to Export Window.

• Configuration Window

  

  Path to Configuration Window.

  • Word Export Project window
    • Table Window
      
  • Custom Property Position selection Window
    • Custom Properties Window
    • Custom Property Window

Export Window

Export Window

1. Start Date

Task starting

2. End Date

the end date

3. Project

The word export project After Clicking “Ok” in this window one or more word documents will be created in the folder Indicated in the project.

Back To Top

Configuration Window

Configuration Window

1. Word Export Project List

List of all the word export projects.

2. Wizard

Will bring you to the wizard wich will helps you in a step to step base to make a new project.

3. New

will bring you to the Word Export Project window where you can insert the variables for the new word export project.

4. Edit

will bring you to the Word Export Project window where you can change the variables of the selected project.

5. Delete

Delete the selected Word Export Project.

6. Custom Properties.

will bring to the Custom Property Position selection Window where you can add, delete and edit the custom properties.

Back To Top

Word Export Project Window

Word Export Project Window

1. Name

The name of the Word Export Project.

2. Export Type
   Determines what kind of documents will be generated and how many. There are the following 5 types:
   1. Overview

   this will produce one overview document named overview.doc

   2. SingleProject

   this will produce one project document from the selected project, the document name will be in the form : project name + “.doc”.

   3. AllProjects

   this will produce project document for each of the projects, the documents names will be in the form project name + “.doc”.

   4. SingleTaskCategory

   this will produce a single document from the selected task category, the document name will be in the form project name + task category name + “.doc”

   5. AllTaskCategories

   this will produce a document for each of the Task Categories, the document names will be in the form project name + task category name + “.doc”.

3. template file

the word document that serves as a template to base the document on this file must be of a “.doc” type. Read here how to make a template file.

4. export location

The location where the output document/documents are put.

5. Edit task table
6. Edit task Category table
7. Edit project table

These options will bring you to the Table Window where you can edit the table.

Back To Top

Table Window

Table Window

1. Show Titles

Determines if the title on the top of the table is visible. If this is checked the titles of the columns will be visible when exported into a word document.

2. Used Property List

In this list all the columns are listed that will appear in the table. The Top property will appear to the left in the table and the bottom will appear on the right.

3. Available Property List

This is a list of all the properties that can be inserted into the table.

4. Add (<–) button

This will add the selected Available Property in the “Available Property List” to the “Used Property List”.

5. delete (–>) button

This will delete the selected Used Property from the “Used Property list”.

6. move up ( /\ ) button

This will move the selected used property one place up in the “Used Property list”.

7. move down ( \/ ) button

This will move the selected used property one place down in the “Used Property list”

All the three 3 tables are edited in a similar window the used properties are displayed in the left column and the available properties in the right column. The order of the available property’s is also significant the topmost property will become the leftmost column in the final table inside the word documents

Back To Top

Custom property Position Window

Custom properties Position Window

1. Edit task custom properties

Will bring you to the Custom Properties Window where the properties at the task position can be edited.

2. Edit task category custom properties

Will bring you to the  Custom Properties Window where the properties at the task category position can be edited.

3. Edit project custom properties

Will bring you to the Custom Properties Window where the properties at the project position can be edited.

4. Edit general custom properties

Will bring you to the Custom Properties Window where the properties at the general position can be edited.

Back To Top

Custom Properties Window

Custom properties Window

1. Custom Property List

A list of the Custom Properties.

2. Add Button

This will open up the Custom Property Window where the values can be inserted off the

3. Edit Button

This will bring up the Custom Property Window with the property selected in the Custom Property List.

4. Delete Button

Deletes the Custom Property selected in the Custom Property List.

Back To Top

Custom Property Window

Custom property list Window

1. Display name

The name of the property , this value will be displayed at the top of a table and thorough out the configuration.

2. Display type One off the following types that determines the final value of this property is displayed in the word document:
   1. default

   The variable is displayed as plain text.

   2. hourmin

   Displays the value in a format “hh:mm”. where “hh” eqauls the number of hours en “mm” the number of minutes. The value is a value in minutes so if the value is 70 it’s displayed as “1:10”.

   3. currency

   Displays the value as a number with a precision of 2.

3. command name

The name that you have to use in a word template or table to indicate that this property value must be displayed at that position.

4. Select the type that this property is, currently there are 3 types:
   1. integer

   A whole number. see here for more info http://msdn.microsoft.com/en-us/library/5kzh1b5w(VS.80).aspx

   2. double

   A number with a precision of 15 digits. http://msdn.microsoft.com/en-us/library/678hzkk9(VS.71).aspx

   3. calculation

   A calculation, currently the following operations are possible Plus(+),Minus(-), Multiplication (*) and Division(/).

5. value

the value to put in your display. If the calculation type is used this is the place where the formula should be placed. For Example “( #tasktimespend# * 3)”. Look here for a list of the standard variables you can use in your calculation.

Back To Top