Document List components
Document List components are the foundation for building a Document List page, configuring how the page looks and which documents are displayed.
The Component
-
Below are the fields that make up the Document List component, and tips for completing them:
Name: enter a name for your file
- Schema: select Document List
- Document List: select the Document List keyword. You can only select one keyword, because this is the keyword that you will use to associate individual documents with the page that this Document List component is inserted into.
If your Document List keyword has already been created, then you can select it from the drop-down menu. If you need to create a new Document List keyword, click the green plus icon. This will open a pop-up window where you can create a new keyword. After saving and closing the new keyword, it will appear in the drop-down list for this field and you will be able to select it.
- Sort Columns: this field is optional. Select Date, Title, or both. When you select either option, it will add a sorting feature to the right column of the Document List (default view) page or the Document List (no thumbnails) page. This feature does not appear on any other Document page, so you can skip this field for a Document highlights (static) page or any Document-generated Navigation pages.
- Right Column: check the box for each item that you want to display on your Document List page. These features only work with the Document List (default view) page or the Document List (no thumbnails) page, and can be skipped for all other page types.
- Type: if selected, a Type column will appear on the right side of the Document List page. In this column, all Types that have been used in published documents will appear in a list. Users can click the name of a Type to see just the documents that have been assigned to that Type.
- Topic: if selected, a Topic column will appear on the right side of the Document List page. In this column, all Topics that have been used in published documents will appear in a list. Users can click the name of a Topic to see just the documents that have been assigned to that Topic.
- Page Navigation: this generates the page navigation that appears at the bottom of a list of documents. Generally, we recommend enabling this feature.
- Archives: if selected, an Archive column will appear on the right side of the Document List page. This column compiles published documents and categorizes them by year and then by month. When a user clicks on a specific month in this column, they will see only the documents published during that month.
- Search: if selected, a search box will appear at the top of the right column of the Document List page. This allows users to search within the document list.
- Items per page: select the number of documents to appear on the page. The options are 1, 2, 3, 4, 5, 10, 15, 20, 25, 50, and 100.
- Document fields to display in output: check the box for each item that you want to display on your Document List page.
- Title: this field should always be selected.
- Description: if selected, the document's short description will appear on your page. We highly recommend selecting this.
- Date: if selected, the date will appear underneath each document. This feature only works on the Document List (no thumbnails) and Document List (datagrid) pages.
- File Size: if selected, the file size will appear underneath each document. This feature only works on the Document List (no thumbnails) and Document List (datagrid) pages.
- Author: if selected, the author will appear underneath each document. This feature only works on the Document List (no thumbnails) and Document List (datagrid) pages.
- Type: if selected, the document Type(s) will appear on the page. This feature only works on the Document List (datagrid) pages.
- Topic: if selected, the document Topic(s) will appear on the page. This feature only works on the Document List (datagrid) pages.
- Path: if selected, the path will appear underneath each document. This feature only works on the Document List (no thumbnails) page.
- Default sort field: your options are Title, Description, Date, Size, and Author. The option you choose will affect the sort order of the documents on the page. For example, if you select Title, then the documents will sort by the contents of the Title field.
- Default sort direction: your options are ascending and descending. The option you choose will affect the sort order of the documents on the page, along with what you selected for the Default Sort Field (#8). For example, if you opt to select ascending for this field and also selected Title for the default sort field (#8), then the default sort order for your documents will be A to Z by title.
Component Templates
-
Document List (default view)
The default Document List component template allows the page creator to control which elements appear on the page, and how they appear. This is what a Document List page looks like with the Document List component template applied, and with all the features (described above) enabled within the Document List component:
Below is a picture of the same page with all the features highlighted, including:
- Sort Columns (#4): this section allows users to sort the document list by Date (newest first or oldest first) or by Title (A-Z or Z-A).
- Type (#5.a): this column lists Type categories that have been assigned to documents in the document list. Users can click a Type and view only the documents included in that specific Type.
- Topic (#5.b): this column lists Topic categories that have been assigned to documents in the document list. Users can click a Topic and view only the documents included in that specific Topic.
- Page Navigation (#5.c): the page navigation is auto-generated when this feature is selected, and includes links for clicking forward and backward through multiple pages of documents.
- Archives (#5.d): this section allows users to filter to, and view, all documents posted within the specific month of a specific year.
- Search (#5.e): this field allows for users to search within the document list (not the entire website).
- Items per page (#6): this determines how many documents appear on each document list page.
- Default sort field (#8): this is 1 of 2 fields that determines how documents are organized on the page, and the options are Title, Description, Date, Size, and Author. In the example below, the articles are sorted by title.
- Default sort direction (#9): this is the 2nd field that determines how documents are organized on the page, and the options are either Ascending or Descending. In the example below, the sort order is descending, so the articles are arranged alphabetically from Z - A. This field works in conjunction with #8, so in the example below, the Title fields are in reverse alphabetical order.
If desired, the creator of the page can uncheck certain features in the Document List component to remove those features from the published page. For example, if the Type and Topics boxes were unchecked in the Document List component, the Type and Topics sections would disappear from the right column. This is true for any feature located in the Right Column field (#5).
Document List - Datagrid
The Document List - Datagrid component template allows the page creator to control which elements appear on the page, and how they appear. This is what a Document List page looks like with the Document List - Datagrid component template applied, and with all the features enabled within the Document List component:
Below is a picture of the same page with the document list component features highlighted that you can control, including:
- Items per page (#6): select the number of documents that appear on each view of the datagrid
- Title (#7.a): this should always be selected, and it will display the title of the document.
- Description (#7.b): if selected, the description will appear for each document.
- Date (#7.c): if selected, the date will appear for each document.
- Author (#7.e): if selected, the author will appear for each document.
- Type (#7.f): if selected, the type(s) will appear for each document.
- Topic (#7.g): if selected, the topic(s) will appear for each document.
Document List - No Thumbnails
The Document List - No Thumbnails component template allows the page creator to control which elements appear on the page, and how they appear. This is what a Document List page looks like with the Document List - No Thumbnails component template applied, and with all the features enabled within the Document List component:
Below is a picture of the same page with all the features highlighted, including:
- Sort Columns (#4): this section allows users to sort the document list by Date (newest first or oldest first) or by Title (A-Z or Z-A).
- Type (#5.a): this column lists Type categories that have been assigned to documents in the document list. Users can click a Type and view only the documents included in that specific Type.
- Topic (#5.b): this column lists Topic categories that have been assigned to documents in the document list. Users can click a Topic and view only the documents included in that specific Topic.
- Page Navigation (#5.c): the page navigation is auto-generated when this feature is selected, and includes links for clicking forward and backward through multiple pages of documents.
- Archives (#5.d): this section allows users to filter to, and view, all documents posted within the specific month of a specific year.
- Search (#5.e): this field allows for users to search within the document list (not the entire website).
- Items per page (#6): this determines how many documents appear on each document list page.
- Default sort field (#8): this is 1 of 2 fields that determines how documents are organized on the page, and the options are Title, Description, Date, Size, and Author. In the example below, the articles are sorted by title.
- Default sort direction (#9): this is the 2nd field that determines how documents are organized on the page, and the options are either Ascending or Descending. In the example below, the sort order is descending, so the articles are arranged alphabetically from Z - A. This field works in conjunction with #8, so in the example below, the Title fields are in reverse alphabetical order.
If desired, the creator of the page can uncheck certain features in the Document LIst component to remove those features from the published page. For example, if the Type and Topics boxes were unchecked in the Document List component, the Type and Topics sections would disappear from the right column. This is true for any feature located in the Right Column field (#5).
Additionally, for the No Thumbnails view, you can opt to display the following data alongside each article:
- Title (#7.a): this will show regardless of whether the box is checked or not.
- Description (#7.b): if selected, the document's short description will appear under each article.
- Date (#7.c): if selected, the document's date will appear under each article.
- File Size (#7.d): if selected, the document's file size will appear under each article.
- Author (#7.e): if selected, the document's author will appear under each article.
- Path (#7.h): if selected, the document's path (or URL) will appear under each article.
Document List - No Thumbnail - No Filter
The Document List - No Thumbnail - No Filter component template is only used with the Document-generated Navigation pages. Below are examples of what the Document List - No Thumbnail - No Filter component template looks like when applied to the 3 document-generated navigation page templates.
In the Document List component, the Document List keyword field (#3) is the foundation for creating the left navigation on the page. However, the remainder of the fields in the Document List component do not impact the display of the page, which is why the images below have no markups on them.
Topic A - Z Navigation
Topic Navigation
Type Navigation