---
title: "List"
canonical: "https://support.appfire.com/space/CLSL/655889865/List"
format: markdown
---
> Macro (aura-html)
Generates a checklist for a subset of pages.
The rows are child pages of a given parent page and the displayed rows can be filtered by label.
The default list header name is the title of the current page. A name can be added for each list macro.
In **Edit 'List' Macro** dialogue box, the columns can be content labels.
On the published page, column headings are the label name.
The column checks can be set/un-set for the pages, an excerpt or a text. Checking a label for a page in the list will amend the page label.
### Defining columns using other list macros
The columns of the list can also be defined using the following macros:
- [list-label](https://appfire.atlassian.net/wiki/spaces/CLSL/pages/656578375)
- [list-input](https://appfire.atlassian.net/wiki/spaces/CLSL/pages/656676649)
- [list-wikiinput](https://appfire.atlassian.net/wiki/spaces/CLSL/pages/655988417)
- [list-select](https://appfire.atlassian.net/wiki/spaces/CLSL/pages/656676955)
- [list-excerpt](https://appfire.atlassian.net/wiki/spaces/CLSL/pages/656578668)
- [list-include](https://appfire.atlassian.net/wiki/spaces/CLSL/pages/655890375)
- [list-wiki](https://appfire.atlassian.net/wiki/spaces/CLSL/pages/655890100)
- [list-metadata](https://appfire.atlassian.net/wiki/spaces/CLSL/pages/656677291)
For example, using the [list-label](https://appfire.atlassian.net/wiki/spaces/CLSL/pages/656578375)` `macro to define the columns of the checklist allows you to specify the column heading in the displayed list rather than simply these being the label name.
See [Examples 1, 2 and 3](https://appfire.atlassian.net/wiki/spaces/CLSL/pages/656579417).
### Parameters
| parameter | Mandatory? | Default | Description | Comment |
| --- | --- | --- | --- | --- |
| use Comala Boards | no | true | Requires [Comala Boards](https://appfire.atlassian.net/wiki/spaces/CBCSL) to be installed. From version 1.6 onwards, Comala Lists integrate seamlessly with the [Comala Boards](https://appfire.atlassian.net/wiki/spaces/CBCSL) app that allows you to visually create and manage your pages, projects, and tasks through boards and lists. | Have a look at how the Comala Lists [integrates with Comala Boards](https://appfire.atlassian.net/wiki/spaces/CBCSL). |
| `name` | no | current page's name | The name of the checklist | |
| `space key` | no | | The space to reduce the query to, when using `label` only and no `parent. `If not set, the current space key will be used | Not available with Comala Boards. |
| `parent` | no | | The parent page, if not set, and there is no `label` set either, then the page containing the checklist will be used as such | |
| `filter label` | no | | The label the selected pages must have | |
| `children depth` | no | `0` | Depth of the search for children (`'0'` for no limit) | Not available with Comala Boards. |
| `child pages only` | no | `false` | Whether or not parent-children are to be included | Not available with Comala Boards. |
| `checklist labels` | no | | A comma-separated list of labels to be used to 'check' the pages. Use instead the [{list-label}](https://appfire.atlassian.net/wiki/spaces/CLSL/pages/656578375) macro | |
| `sort` | no | `name` | How the table should be sorted: `name` to sort by name, `created` to sort by page creation date, or `modified` to sort by last modification date | |
| `CSS class` | no | `grid` | The style sheet (CSS) class to use for the table | |
| `excerpt column heading` | no | | The heading for the excerpt column | |
| `comments column heading` | no | | The heading for a column to be used for comments (stored as metadata) | |
| Include page link column | no | `true` | Whether or not to include a link to the pages as the first column of the table | |
| Debug | no | false | If true, the list will be rendered as a Comala Boards List and as a Comala List. | Only available with Comala Boards. |
| [Back to Comala Lists User Guide](https://appfire.atlassian.net/wiki/pages/createpage.action?spaceKey=clsl&title=User%20Guide&linkCreation=true&fromPageId=655889865) |
| --- |
| ### **[list macro examples](https://appfire.atlassian.net/wiki/spaces/CLSL/pages/656579417)** |