MN.IT SERVICES TECHNICAL DESIGN SPECIFICATIONS

Technical Design Specifications

Tridion 2013 Re-Architecture: Document Lists

Version 1.3 DRAFT

Release 0

1/29/2015

Table of Contents

Table of Contents 2

Overview 3

Requirements 3

1. Fields 3

2. Functional Requirements Summary 3

3. Accessibility Requirements 4

4. Authoring requirements: 4

5. Issues / Questions 4

6. Schema Documentation 4

7. Form Layout 5

Component Templates 6

8. Document List – Standard 6

8.1. Functional Requirements 6

9. Document List - Archive 7

10. Document List – Custom 8

Document History

Date / Issue# / Description / Author /
8/28/14 / 1.0 / Original Version / Steve Klaus
11/3/14 / 1.1 / Revised based on feedback from Dev Team, added section 8-10 – Document List component templates / Steve Klaus
1/21/15 / 1.2 / Revised based on feedback from Advisory Team / Steve Klaus
1/29/15 / 1.3 / Removed references to underlying technology, added Document List Configuration component, modified section 8 – Document List Standard / Steve Klaus

Overview

Document lists will consist of binary files including but not limited to PDFs and Microsoft Office files. This is a dynamic list, and can be selected, sorted, and filtered in multiple ways based on metadata stored in a Tridion component. The document will open when a user clicks on a specific document title.

Requirements

1.  Fields

1.1.  Document List Item (schema for dynamic document lists)

1.1.1. Document (link to external document) *

1.1.2. Content Type (i.e. Article, Brief, Report, etc. as defined by users)

1.1.3. Document List Identifier (to identify which lists to show in)

1.1.4. Embedded Dublin Core metadata schema. Required fields:

1.1.4.1.  Title *

1.1.4.2.  Description (Short description) *

1.1.4.3.  Subject (Keywords) *

1.2.  Multimedia Document (schema for linking to individual documents in static pages)

1.2.1. Document (link to document stored in Tridion) *

1.2.2. Content Type (i.e. Article, Brief, Report, etc. as defined by users)

1.2.3. Embedded Dublin Core metadata schema. Required fields:

1.2.3.1.  Title *

1.2.3.2.  Description (Short description) *

1.2.3.3.  Subject (Keywords) *

1.3.  Document List Configuration (schema to configure dynamic document lists)

1.3.1. Document List Identifier

1.3.2. Document List Title

Note: Josh will complete this section based on functional requirements.

2.  Functional Requirements Summary

2.1.  Date displayed in document lists will pull from the first populated field below:

2.1.1. DC:Published or other date

2.1.2. DC:Modified date

2.1.3. DC:Creation date

2.1.4. Tridion:Modified

2.1.5. Tridion:Created

2.2.  If populated, DC:Creator will be used as Author text and will link to all documents by same author.

2.3.  Tags (Keywords) will be used to filter the document list.

2.4.  Must support mobile devices with different screen sizes.

2.5.  Will display 10 documents per page by default.

2.6.  Drop pagination for scrolling on mobile devices.

2.7.  Option to display Icon, Thumbnail, (or possibly snapshot) on the Document List page.

2.8.  Archives, Filters, Sorting, and Search are optional within a document list.

2.9.  All Documents must be discoverable by search. (Documents may reside in Tridion or a static server.)

3.  Accessibility Requirements

3.1.  Documents must be accessible.

4.  Authoring requirements:

4.1.  Document List Configuration component must be part of the page assembly.

4.2.  Authors will need to create keywords in Tridion for Content Type and Subject.

4.3.  Best practice: if displaying Thumbnail images in the document list, all images should be same size and shape (w x h).

4.4.  If used, Thumbnails must have the same name as the document filename.

5.  Issues / Questions

5.1.  Will there be a Tridion Component, or will we just use metadata in the source documents?

5.1.1.  We will use a Tridion component based on one of the above schemas depending on the use of the documents

6.  Schema Documentation

Name / Document List Item
Description / Used for dynamic document links
Schema Type / Component Schema
Root Element name / Content
XML Namespace / uuid:4c5c356c-58e7-4fed-9bb4-b8c3e9513a18
Description / XML Name / Field Type / Req. / MV / Properties
Document / Link / Y / N / Links to external documents
Content Type / Text / N / N / Uses Keywords
Document List Identifier / Y / Uses Keywords
Dublin Core metadata / Embedded schema / Y / N / First 3 fields required
Metadata
Name / Document
Description / Used for documents stored in Tridion and used in static pages.
Schema Type / Component Schema
Root Element name / Content
XML Namespace / uuid:4c5c356c-58e7-4fed-9bb4-b8c3e9513a18
Description / XML Name / Field Type / Req. / MV / Properties
Document / Link / Y / N / Link to Tridion MM document
Content Type / Text / N / N / Uses Keywords
Dublin Core metadata / Embedded schema / Y / N / First 3 fields required
Metadata
Name / Document List Configuration
Description / Used to configure a specific document list
Schema Type / Component Schema
Root Element name / Content
XML Namespace / uuid:4c5c356c-58e7-4fed-9bb4-b8c3e9513a18
Description / XML Name / Field Type / Req. / MV / Properties
Document List Identifier / Text / Y / N / Uses Keywords
Document List Title / Text / Y / N
Show Search Box / List / N / N / Checkbox
Metadata

Note: Josh will complete this schema definition based on functional requirements.

7.  Form Layout

N/A

Component Templates

The following component templates will be used to present the content in web pages.

8.  Document List – Standard

1.  Document List Title
2.  Sort by date or Document Title
3.  Document Filters (see criteria below)
4.  Thumbnail or Icon
5.  DC:Title / 6.  DC:Description
7.  Date = 8.1.2. below
8.  Author = DC:Creator)
9.  URL and file size

8.1. Functional Requirements

8.1.1. Document List Configuration component will be in page assembly to control the following:

8.1.1.1.  Document List Title (from Configuration component)

8.1.1.2.  Sort criteria - Sort by Date or Document Title

8.1.1.3.  Filter criteria

8.1.1.3.1.  Content type – Based on Content Type field in schema, could be “PDF, Word, Excel, etc.” or “Article, Brief, Report, etc.” from controlled vocabulary

8.1.1.3.2.  Topics (based on DC:Subject from controlled vocabulary)

8.1.1.3.3.  Date

8.1.1.3.3.1.  All Time

8.1.1.3.3.2.  Today

8.1.1.3.3.3.  This Week

8.1.1.3.3.4.  This Month

8.1.1.3.3.5.  This Year

8.1.1.3.3.6.  Custom

8.1.2. Date displayed in document lists will pull from the first populated field below:

8.1.2.1.  DC:Published or other date

8.1.2.2.  DC:Modified date

8.1.2.3.  DC:Creation date

8.1.2.4.  Tridion:Modified

8.1.2.5.  Tridion:Created

8.1.3. If populated, DC:Creator will be used as Author text and will link to all documents by same author.

9.  Document List - Archive

10. Document List – Custom

Note: Enhancements to the Standard Document List defined in 8 above may eliminate the need to create custom lists like this one.

8