Title: Section Table Widget 2.0
A Section Table widget can present the contents of an Article level section in a table format which breaks out sets of tags and entry property data into columns. The table can be sorted by any column by clicking it's column title. Date difference calculations may also be done in a column between any two date formatted entry properties.
This Section Table widget replacing the previous version documented in Support2483 and provided as a plug-in. This new Section Table Widget is shipped with TeamPage versions 5.2.48 and higher; this article refers to the version that first shipped with TeamPage version 5.2.61. The new widget uses new syntax, is selectable from the Insert Widget dialog, and supports the display of entry properties.
As of TeamPage 5.3, the widget supports ID, Entry, and Due Date properties.
As of TeamPage 5.261, the widget supports Space, Assignee, Project, and Milestone properties.
Example of a Section Table:
Below is an example of an article that includes a Section Table widget. The Section Table shows the contents of any section you define in an article, so it can show any cross section of TeamPage content.
I chose to use articles from across my entire server that are tagged To Do and also tagged Idea, Issue, Question or Requirement. I chose this set for this example because many of these are tasks which allows me to show how date based entry properties can be exposed in the Section Table. I could have used a Tasks section as well but, in this case, wanted the "article" style rather than "task" style rendering when articles are expanded in the table view.
You may have noticed that there are image icons with the tags. This is accomplished by associating images with tags in Space Setup | Tags tab - Properties sub-tab.
Copy / Paste from a Section Table & Browser Support
At some point, you may want to copy section table data into an Excel sheet for further analysis and sorting.
Without changing defaults, this is possible from Chrome, Safari and Firefox browsers. You may have to Paste with Matching styles.
If you are copying from Internet Explorer, the paste operation will also copy over the entry body for each row of the table so you end up with 2 rows per record. There is a Plug-in setting that allows you to disable expansion. When you make this change, copying section table content from IE to Excel will work OK.
The setting to Expand/Collapse controls by default - is found in Server Setup | Plugins and per space in Space Setup | Plugins. You can also configure this setting for each Section Table when you insert the widget.
This requires TeamPage 6.x and Section Table widget versions 2.0.12 or higher.
How to Insert a Section and a Section Table
FIrst you have to create an article level section by clicking Edit Sections in the article editor. In the section editor, I created an All Tasks section. I chose to filter by Tag and, when selecting a tag, I chose All Spaces and the To Do tag. Then in the Filter by area, I put in a boolean expression to filter on the Idea, Issue, Requirement OR Question tags. The : character is necessary before each tag. Because I am looking across all spaces in this case, I also had to use the double : and * wildcard to indicate that the tags can be applied from any space. Finally, I selected Volume Full so that, upon expansion of any record in the table, it would show the full content of the article.
Once the section has been created, you have to Insert Widget by clicking the Gear icon in the Article editor's toolbar ribbon. Then choose the Section Table widget which you will find in the More area:
Now, the Widget Options box appears. You choose the section you want and then insert syntax to describe the columns and their attributes. This is just an image. The full syntax for the columns in my example is provided in the Syntax for the Section Table Widget section of this FAQ below.
Note: that the syntax involves the use of the term Labels which is synonymous with the word Tag that you see across the interface.
Now you can click OK and a Widget box will appear in your article. When you post the article, you will see the rendered widget.
Syntax for the Section Table Widget
Here you can see the syntax that I used for this example. Note that the double colon and * are used to look for tags which may belong to any space. These characters are not required if your section is only scoping to a single space, in which case there should only be a single colon before each tag.
Note: that the syntax shown below involves the use of the term Labels which is synonymous with the word Tag that you see across the interface.
It is configured using JSON format.
[
{
title: "Priority",
labels: "::*:p1,::*:p2,::*:p3",
aliases: "1,2,3"
},
{
title: "Type",
labels: "::*:idea,::*:issue,::*:question,::*:requirement",
aliases: "Idea,Issue,Question,Requirement"
},
{
title: "Assignee",
property: "assigned",
format: "user"
},
{
title: "Space",
format: "space"
},
{
title: "Project",
format: "project"
},
{
title: "Milestone",
format: "milestone"
},
{
title: "Start Date",
property: "start",
format: "date",
dateformat: "short"
},
{
title: "Due Date",
format: "duedate",
dateformat: "short"
},
{
title: "Duration",
start-date-property: "start",
end-date-property: "due",
format: "datediff"
},
{
title: "Estimate",
property: "estimate",
format: "property"
},
{
title: "Time Spent",
property: "duration",
format: "property"
}
]
General column attributes
title - The title of the column
format=[label] - The name of a format that should be used to display this column. The following formats are currently supported:
label - displays the labels on the entry
property - displays the value of an entry property
date - displays the value of an entry property as a date - often used with the "start" property for tasks
duedate - a special version of date that will use the date of the milestone for a task with a due date bound to a milestone
datediff - displays the difference between two entry properties that represent dates
user - displays the value of an entry property that corresponds to a list of users - usually used with the "assigned" Property type
owners - displays the name of the people who are designated as "owners" of a project.
space - displays the name of the space of the entry with a link to that space
milestone - displays the name of the milestone of the entry with a link to the milestone
project - displays the name of the project of the entry with a link to the project
id - displays the id of the entry with a link to the entry, e.g. Doc1468
entry - displays the number of the entry in the current space with a link to the entry, e.g. 1468
nowrap - true or false if the table cell should be allowed to wrap to fill multiple lines
Label (Tag) column attributes
labels (tags) - A comma-separated list of labels (tags) that should appear in the column
aliases - A comma-separated list of aliases that will be used for the corresponding label / tag
showicons - true or false if label / tag icons should be displayed
Property column attributes
property - An entry property name for columns that display entry properties
The Format section above details a few property types that go with particular formats (e.g. goal property / project format and assigned property / user format)
Date column attributes
dateformat - The format for the date using Java date format syntax. In the example we used the short dateformat. Another example is MMM dd, yyyy which would display "Mar 17, 2012"
timeformat - The format for the time using Java date format syntax
Datediff column attributes
start-date-property - The entry property with the start date
end-date-property - The entry property with the end date
project - displays the name of the project of the entry with a link to the project - used with the "goal" Property type
