Page Attributes

Page attributes are defined in YAML blocks of code at the beginning of a page. The values of some attributes are taken from parent pages if they are not defined on a page.

• title - The title of the page. If it is not set, the Zim page title is used.
• metaTitle - Explicitly set the the HTML head title. If it is not set the title is used as metaTitle. This attribute is rarely used.
• menu - Set the string that will be displayed in the menu. If menu is not set the page will not appear in the menu. See menu.
• weight - Set the order of an item in the generated menu. See menu.
• publish - When set to 'true' the page will be published. When set to 'false' the final page will not be generated. The publish attribute is inherited from parent pages if it is not defined. The attributes publishDate and unpublishDate may override the value of publish when publish is 'true'.
• draft - When set to 'true' the page is a draft and will not be published. The final page will not be generated. The publish attribute is inherited from parent pages if it is not defined.
• createDate - The date when a page was created. If it is not set explicitly the Zim page attribute will be used.
• expireDate - The date when a page will become old. This can be used in news and blogs to remove the page from lists of latest items.
• publishDate - The date when a page should be published. The final page will not be generated before this date. Creation date is used if this is not set. The publishDate attribute is inherited from parent pages if it is not defined.
• unpublishDate - The date after which a page will not be published any more. The final page will not be generated after this date. The unpublishDate attribute is inherited from parent pages if it is not defined.
• type - The type of the page. A custom page processor will be selected for a page type if was registered. Custom template and CSS flie will be selected for a page type if it exists unless they are explicitly defined for the page. See page-type.
• template - The filename without extension of the custom template and CSS file to be used to generate the page.
• childType - The page type for descendant pages that do not explicitly define type.
• lang - The language of the page. This affects the translation of variables gathered during the template processing phase. The lang attribute is inherited from parent pages if it is not defined. If no parent has the lang attribute set, the default language is obtained from the configuration.