Templates System

The Superdesk Publisher templates system has its own git repository, at: https://github.com/SuperdeskWebPublisher/templates-system

• Rendering pages with Twig
• Creating a page templates
• Creating custom templates
  • Setting error pages from theme
  • Testing error pages during theme development
• Properties
• Templates features
  • Custom Twig tags
    • gimme
    • gimmelist
  • How to work with gimmelist pagination?
  • How to work with Meta objects
  • Stringy twig extensions
  • Redirects
    • redirect
    • notFound
• Handling Articles
  • Listing Articles
  • Fetching first article url (when it’s changed after slug or route change)
• Handling Related Articles
  • Listing a collection of Related Articles
• Handling Article Media
  • Listing Article Media
    • Article Media
    • Image Renditions
    • Feature Media
• Handling Article Authors
  • Listing a Single Article’s Author
  • Listing a collection of Article’s Authors
• Handling Article Slideshows
  • Listing a Single Article’s Slideshow
  • Listing a collection of Article’s Slideshows
  • Listing all Article’s Slideshows Items
  • Listing all Article’s Slideshows and its Items
  • Listing a Single Slideshow and its Items by Name
• Handling Routes
  • Listing a Single Route
  • Listing a Routes Collection
• Handling Content List Items
  • Listing Content List Items
    • Content List
    • Content List Items
• Keywords
  • List a Single Keyword
• Template Caching
  • Strategies
  • Content list blocks caching
• How to implement Search using ElasticSearch?
  • Create a new Route
  • Create a template file
  • Available search criteria:
• Tips

Templates inheritance

Default template name for route and articles in Publisher is article.html.twig.

Inheritance overview:

> article.html.twig
    > Route custom template
        > Article custom template

If route is collection type then it can have declared two default templates:

• default_template used for rendering Route content (eg. /sport).
• default_articles_template used for rendering content attached to this route (eg. /sport/usain-bolt-fastest-man-in-theo-world).

Note

When route default_template property is set but not default_articles_template, then Web Publisher will load all articles attached to this route with template chosen in default_template (not with article.html.twig).

If content have assigned custom template then it will always override other already set templates.

How to change the Route/Article template name?

You can change default template name values for article and route either in routes management, or with API calls (providing it on resource create or resource update calls).

Example resource update calls:

article:

curl -X "PATCH" -d "article[template_name]=new_template_name.html.twig" -H "Content-type:\ application/x-www-form-urlencoded" /api/v1/content/articles/features

route:

curl -X "PATCH" -d "route[template_name]=custom_route_template.html.twig" -H "Content-type:\ application/x-www-form-urlencoded" /api/v1/content/routes/news