Create a page with Document-generated Navigation
This page contains information on how to create a page with Document-generated Navigation.
-
Create a Headline and Introduction for the Page
The first thing to build for a Document List page is a General Content component with the headline and introductory text, highlighted in red below. Below are the steps for creating this component:
- In the 020 section, navigate to the folder where you want the components for the Document-generated Navigation page to reside.
- Create a new component and complete the following fields:
- Name: enter a name for the component here
- Schema: select General Content
- Title: enter the headline for your Document-generated Navigation page here.
- Content: enter the introductory text that will go at the top of your page. This is a rich-text field, so you can add other elements like images, links, etc.
Create the Document List 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: leave the default option in place, this feature does not apply to Document-generated Navigation pages.
- Right Column: leave the default option in place, this feature does not apply to Document-generated Navigation pages.
- Items per page: leave the default option in place, this feature does not apply to Document-generated Navigation pages.
- Document fields to display in output: leave the default option in place, this feature does not apply to Document-generated Navigation pages.
- Default sort field: leave the default option in place, this feature does not apply to Document-generated Navigation pages.
- Default sort direction: leave the default option in place, this feature does not apply to Document-generated Navigation pages.
Create the Document List page
- In the 050 section, navigate to (or create) the structure group where the Document List page will reside.
- Create a new page.
- Fill in the Name, File Name, Page Display Name, Dublin Core Title, and Dublin Core Description fields.
- For the Page Template field, uncheck "Inherit from Parent." Then, in the drop-down menu for the field, select one of the following:
- Document Page - Topic A-Z Navigation - selecting this will result in a Document Page with left navigation arranged alphabetically by Topic.
- Document Page - Topic Navigation - selecting this will result in a Document Page with left navigation arranged alphabetically by Topic, with the option to create expandable categories.
- Document Page - Type Navigation - selecting this will result in a Document Page with left navigation arranged alphabetically by Type.
- Click the Design tab.
- Click the Add button:
- Navigate to the General Content component you created in step 1, select it, apply the Page Introduction component template, and insert it into the page.
- Navigate to the Document List component you created in step 2, select it and apply the Document List - No Thumbnail - No Filter component template and insert it into the page.
- Close the Insert Component Presentation pop-up window.
- Save and Close your Document List page.
Create a folder for Document components
- In the 020 section, navigate to the folder where your Document List component (created in step 2) resides.
- In that folder, create a new sub-folder with the following settings:
- Name: we recommend something like "Documents"
- Linked Schema: Document
- Save and Close the new folder.
Create Document components
In the folder that you created in step 5, now you will create Document components to populate your Document-generated Navigation page. Create one or more Document components using the following instructions:
-
Name: enter a name for your component. You may wish to establish a naming convention for your document components, so that it is easier to organize and find individual documents.
- Schema: select Document
- Title: enter the title of your document here.
- Link to Document: choose from one of the two options:
- Internal link to components (has priority over external links): use this if you are going to link to document within your website. You can select files such as PDFs, Word docs, Excel docs, PowerPoints, images, etc. or you can select a component included in a published page. Click on the Browse Folder icon
, located at the end of the field. In the pop-up that appears, navigate to the document you wish to link to and double-click it. This will insert a link to the document.
- External link to a web page or file: use this if you are going to link to a document or page on another website. Enter the full URL for the document, such as https://www.google.com
- Internal link to components (has priority over external links): use this if you are going to link to document within your website. You can select files such as PDFs, Word docs, Excel docs, PowerPoints, images, etc. or you can select a component included in a published page. Click on the Browse Folder icon
- Short Description: enter a short 2 - 3 sentence summary of the document.
- Thumbnail image: this field does not apply to Document-generated Navigation pages and can be skipped.
- Date: this field is optional. Enter a date by clicking the little calendar icon
to the right of the field. A pop-up will appear, which allows you to navigate through a calendar and select a date. The Time field is in 24 hour time, so to enter a time like 2:00 pm, you will need to enter 14:00:00. The date you select does not affect when the document is published.
- File size in KB: this field is optional. Enter the document's file size in KB, such as 1024
- Author: this field is optional. From the drop-down, select an author for your document. If you need to add the author, click the green plus sign
at the end of the row. In the new tab that opens, enter the author's name in the Value field and then Save and Close the tab. The author's name will now appear in the Author drop-down and you can select it.
- Type: this field is required for Document-generated Navigation pages using the Type Navigation. The Type field is used to identify the document type, which can be a broader categories such as agency website, subsite, or internal website. Or it can be used to classify more specific items such as Commerce Department website, Education Department website, Public Utilities Commission website, etc. You can create your own type categories as needed. You can select, or create new, tags by clicking the browse folder icon
. You can assign more than one Type to a document by clicking the green plus icon
.
- Topic: this field is for Document-generated Navigation pages using either the Topic A-Z Navigation or the Topic Navigation (the latter allows Topic tags to be sub-categorized and used as an expandable/collapsible navigation). The Topic field is used to categorize the content of the document, such as Arts, Education, Employment, Environment, Health, etc. You can create your own topic categories as needed. You can select, or create new, topics by clicking the browse folder icon
. You can assign more than one Topic to a document by clicking the green plus icon
.
For more information about how the fields in a document component render on Document List pages, please refer to the Document component information page.
Publish Document components
When you've completed all the steps above, then all you need to do next is publish your Documents.
In the 050 section, navigate to the Document components you built in step 6, right-click on one (or more) and select Publishing > Publish.
Select the site you wish to publish to and click Publish. This will send the Documents to the publishing queue.
Once your documents have published, they will appear on the Document-generated Navigation page you created and published in steps 3 and 4.
Publish the Document-generated Navigation Page
When you've completed all the steps above, then all you need to do next is publish your Document-generated Navigation page.
Navigate to the Document-generated Navigation page you built in step 3, right-click on it and select Publishing > Publish.
Select the site you wish to publish to and click Publish. This will send the Document-generated Navigation page to the publishing queue.
We also recommend republishing the navigation at this point, so that it picks up the new page.
Tips for Maintaining this Page
Once your page has been published, removing and adding keywords works differently than other dynamically-generated Tridion pages. Below are tips to help you keep your page in good working order.
-
To add a keyword to the left navigation
- Add the keyword to the Categories and Keywords > Document Topic section of your website
- Add the keyword to the document(s) that will use it
- Republish the document(s)
- Republish the page(s) that have the left navigation the keyword should appear in.
- Refresh the page(s) to make sure the keyword is showing up.
To remove a keyword from the left navgiation
- Remove the keyword from the document(s) that use it.
- Delete the keyword from the Categories and Keywords > Document Topic section of your website.
- Republish the page(s) that displayed the keyword in their left navigation. That will remove the keyword from those pages.
Technical Specifications
Below are the components and component templates accepted in the Document Page - Topic A-Z Navigation, Document Page - Topic Navigation, and Document Page - Type Navigation templates.
Component Type Accepted Component Templates Min/Max General Content - Page Introduction
- Page Introduction - Feature Image (black text bar)
- Page Introduction - Feature Image (white text bar)
- Page Introduction - Jumbo Feature Image (black text bar)
- Page Introduction - Jumbo Feature Image (white text bar)
0-1 Document List - Document List - No Thumbnail - No Filter
0-1