[DOCU-319] Home category in ETK template availability documentation Created: 14/Sep/12  Updated: 06/Nov/12  Resolved: 06/Nov/12

Status: Closed
Project: Documentation
Component/s: content
Affects Version/s: short term
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Joerg von Frantzius Assignee: Ruth Stocks
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

http://documentation.magnolia-cms.com/modules/etk.html#Availability
Says that "home can be assigned only once". This could either mean the category can be assigned only to one template, or the template can only be assigned to a single page. Both seems wrong, because in the next bullet point it says:

home, section and functional can only be assigned to a page whose parent page is home, section or functional

It would be good if this could be clarified in the documentation.



 Comments   
Comment by Antti Hietala [ 17/Sep/12 ]

Regarding the statement "home can be assigned only once", the second interpretation is correct. A template whose category is home can only be assigned to one page within a site. This page must be the root node of the site. However, you can configure multiple template definitions which all have category home. For example, you might want to create different home page layouts such as stkHome, stkHomeWithoutStage or stkHomeWithExtras and switch between them. Revise doc to make this clear.

info.magnolia.module.templatingkit.sites.TemplateAvailability enforces that a template whose category is home can only be used on the site once:

//if home category was already used it should be no longer available
if(category.equals(TemplateCategory.HOME) && TemplateCategoryUtil.findParentWithTemplateCategory(node, TemplateCategory.HOME) != null){
    return false;
}

The statement "home, section and functional can only be assigned to a page whose parent page is home, section or functional" is also ambiguous.

  • Remove home from the first part of the statement. A template whose category is home can only be assigned to the root node. The root has no parents.
  • Add the feature category.
  • The statement should read "A template whose category is section or functional can only be assigned to a page whose parent page has category home, section, functional or feature."
Comment by Antti Hietala [ 06/Nov/12 ]

Activated to http://documentation.magnolia-cms.com/templates/stk/template-definitions.html#Categoriesandsubcategories

Generated at Mon Feb 12 01:08:00 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.