Sample content for a static content mashup scenario

DXA provides sample SDL Tridion Sites Content Manager assets for use in a static content mashup implementation.In a static content mashup, an Editor working in Tridion Sites must classify the Keywords while adding Components to a page, and these values determine the selection of related technical content from Tridion Docs.

The following diagram shows the various sample Content Manager items that DXA provides for a static content mashup:

The following table summarizes the various Content Manager items that DXA provides for use in a static content mashup:

Publication and locationSample items
100 Master

\ 100 Master \ Categories and Keywords

Predefined Categories and Keywords that can be used to drive a Content Mashup. DXA provides the following sample default Categories:
Product Release Name
Category that contains Keywords to indicate a particular release of a product.
DXA provides one example Keyword value: Model 2018
When used for content mashup, the Keyword maps to a publication-level metadata field in Tridion Docs.
Product Family Name
Category that contains Keywords to indicate a product family (a logical grouping of products).
DXA provides three example Keyword values: City Bicycle, Red Bicycle and White Bicycle
When used for content mashup, the Keyword maps to a publication-level metadata field in Tridion Docs.
Content Reference Type
Category that contains Keywords to indicate the type of technical content.
DXA provides a number of sample Keyword values.
When used for content mashup, the Keyword maps to a topic-level field in Tridion Docs, where topics have been tagged with matching content types.

\ 100 Master \ Building Blocks \ Modules \ TridionDocsMashup \ Admin

TridionDocsMashup
Component that defines general configuration for content mashups (both static and dynamic)
As installed, the Component includes links to the following:
  • Schema: Module Configuration
  • URL configuration Component: TridionDocsMashup URL Configuration Configuration
  • HTML Design configuration Component: \100 Master\Building Blocks\Settings\TridionDocsMashup\Site Manager\TridionDocsMashup HTML Design Configuration
TridionDocsMashup HTML Design

ZIP file containing the HTML design files that are used by the TridionDocsMashup Configuration.

TridionDocsMashup URL Configuration
Component that configures the URLs that are used for requesting SDL Tridion Docs content.
Enables you to independently configure URL prefixes for the following:
  • Binaries – A prefix added to the URLs for binary resources (such as PDFs and images) that appear within topics when the topics are embedded and shown on the Page.

    The default prefix is: /docsmashup

    The URL resolves to the following format: http://DXAWEBSITEURL/docmashup/BINARYURL

    Where:

    • DXAWEBSITEURL is the host and URL of your DXA website.
    • BINARYURL is the URL of the binary resource.
  • Topics – A prefix added to the URLs for topics that appear as links on a Page.

    The default is an empty value, which means that your SDL Tridion Docs website is configured on the same host and with the same URL as the DXA website.

    If the SDL Tridion Docs website is installed on different host and using different URL, then specify that URL here, using the format //mydocs.website.com.

\ 100 Master \ Building Blocks \ Modules \ TridionDocsMashup \ Admin \ Schemas

TridionDocsMashup URL Configuration
Schema for the Component with the same name
This Schema defines the fields that the Component uses to specify URL prefixes.

\ 100 Master \ Building Blocks \ Modules \ TridionDocsMashup \ Editor \ Schemas

Tridion Docs Static Widget
A sample Schema that enables Editors to select Keywords to indicate the technical content they want to use on their page
Publication.FMBPRODUCTRELEASENAME.Version
Defines a drop-down list field that gives Editors a choice of Keywords to select a particular release, or version, of a product. DXA defines these Keywords in Category "Product Release Name."
This field maps to a publication-level metadata field in SDL Tridion Docs.
Publication.FMBPRODUCTFAMILYNAME.Logical
Defines a drop-down list field that gives Editors a choice of Keywords to select the product family. DXA defines these Keywords in the Category "Product Family Name."
This field maps to a publication-level metadata field in SDL Tridion Docs.
Item.FMBCONTENTREFTYPE.Logical
Defines a drop-down list field that gives Editors a choice of Keywords to select the type of technical content. DXA provides a number of sample types.
This field maps to a topic-level field in SDL Tridion Docs, where topics have been tagged with matching content types.
DisplayContentAs
Defines a radio button that enables Editors to select whether the technical content will be included on the Page as inline text or as one more links to the content (rendered in a separate web application).
MaxNumberOfItemsToShow
Defines a numeric field that enables Editors to limit the number of topics (or links) that should appear on the page in the event there are multiple matching topics.
Bicycle
Component Schema for a sample product, a bicycle.
Both the dynamic and static content mashup models use this same sample Schema.
The Schema includes fields that map to publication-level or topic-level metadata fields in Tridion Docs. These fields apply only to the dynamic mashup model. The fields are not relevant to how the static mashup works, and so they are simply ignored.
\ Page Schemas
Subfolder containing Page schemas for the content mashup
\ Region Schemas
Subfolder containing Region schemas for the content mashup

\ 100 Master \ Building Blocks \ Modules \ TridionDocsMashup \ Editor \ Templates

Bicycle Page With Static Region
Page Template for use with the static content mashup and linked to:
  • Schema: Bicycle Page With Static Widget
  • Page View Name: GeneralPage
Bicycle
Component Template for a sample product, linked to:
  • Component Schema: Bicycle
  • Entity View Model: TridionDocsMashup:Bicycle
Tridion Docs Static Widget
Component Template that is linked to the Schema of the same name.
  • Controller = TridionDocsMashup:TridionDocsMashup
  • Entity View Name = TridionDocsMashup:StaticWidget
  • HTML Classes = tridiondocsmashup

\ 100 Master \ Building Blocks \ Settings \ TridionDocsMashup \ Site Manager

TridionDocsMashup HTML Design Configuration
Component that provides resources for the HTML design, which in this case is by linking to a Multimedia Component \100 Master\Building Blocks\Modules\TridionDocsMashup\Admin (packaged in a ZIP file).
110 DXA Site Type

\ 110 DXA Site Type \ Building Blocks \ Modules Content \ TridionDocsMashup \ Content \ _Cloneable Content

Tridion Docs Static Widget
A sample Component that serves as the prototype (through cloning) when Editors create new Components based on the associated Content Type
Based on a Schema by the same name.
200 Example Content

\ 200 Example Content \ Building Blocks \ Modules Content \ TridionDocsMashup\Content \ Products \ Bicycles

Red Bicycle Product
An example Component that demonstrate a static content mashup scenario where an Editor specifies the Keywords that should be used when creating a Component based on the Tridion Docs Static Widget Schema.
400 Example Site

\ 400 Example Site \ Home \ 030 Products

001 Red Bicycle
An example Page that demonstrate a static content mashup scenario
Based on Page Template: Bicycle Page with Static Region
Contains two Regions:
  • Bicycle with Component Red Bicycle
  • Tridion Docs Related Topics with Component Tridion Docs Static Widget
000 Product Catalogue
An sample top-level Page for the example Product catalogue, displayed when the user select PRODUCTS from the main navigation.
Based on Page Template: Content Page