<!-- 
RSS generated by JIRA (9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b) at Mon Feb 12 01:08:03 CET 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>Magnolia - Issue tracker</title>
    <link>https://jira.magnolia-cms.com</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-uk</language>    <build-info>
        <version>9.4.2</version>
        <build-number>940002</build-number>
        <build-date>19-01-2023</build-date>
    </build-info>


<item>
            <title>[DOCU-323] Provide documentation for @area freemarker directive</title>
                <link>https://jira.magnolia-cms.com/browse/DOCU-323</link>
                <project id="10190" key="DOCU">Documentation</project>
                    <description>&lt;p&gt;One of the largest changes in Magnolia 4.5 is the concept of areas being brought down to the level of configuration, and the accompanying &quot;@area&quot; freemarker directive.&lt;/p&gt;

&lt;p&gt;After thorough googling and searching in your documentation, I could not find any information on the &quot;@area&quot; directive, only one article about blossom.&lt;/p&gt;

&lt;p&gt;Please provide documentation about the &quot;@area&quot; freemarker directive, it&apos;s missing badly...&lt;/p&gt;</description>
                <environment></environment>
        <key id="25580">DOCU-323</key>
            <summary>Provide documentation for @area freemarker directive</summary>
                <type id="4" iconUrl="https://jira.magnolia-cms.com/secure/viewavatar?size=xsmall&amp;avatarId=10890&amp;avatarType=issuetype">Improvement</type>
                                            <priority id="3" iconUrl="https://jira.magnolia-cms.com/images/icons/priorities/major.svg">Major</priority>
                        <status id="6" iconUrl="https://jira.magnolia-cms.com/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="-1">Unresolved</resolution>
                                        <assignee username="ruths">Ruth Stocks</assignee>
                                    <reporter username="jfrantzius">Joerg von Frantzius</reporter>
                        <labels>
                    </labels>
                <created>Wed, 19 Sep 2012 09:58:12 +0200</created>
                <updated>Tue, 3 Nov 2015 14:40:18 +0100</updated>
                                                                                <due></due>
                            <votes>0</votes>
                                    <watches>1</watches>
                                                                                                                <comments>
                            <comment id="51399" author="jfrantzius" created="Thu, 20 Sep 2012 11:59:23 +0200"  >&lt;p&gt;So far the only way of finding information about it is to look into the STK FTL templates. One example to be found there is:&lt;/p&gt;
&lt;div class=&quot;preformatted panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;preformattedContent panelContent&quot;&gt;
&lt;pre&gt;[@cms.area name=&quot;logo&quot; content=content/]
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;
&lt;p&gt;As for the semantics of this, the only information available is in the sourcecode of &lt;tt&gt;info.magnolia.templating.freemarker.AreaDirective&lt;/tt&gt;. In particular, it is very hard to understand what the &quot;content&quot; attribute&apos;s meaning is.&lt;/p&gt;</comment>
                            <comment id="51596" author="ahietala" created="Wed, 26 Sep 2012 16:00:03 +0200"  >&lt;p&gt;The &lt;tt&gt;content&lt;/tt&gt; attribute tells a script which content node it should operate on. Scripts typically operate on the &quot;current&quot; content node. For a page-level script the current node is the page, for an area-level script the current node is the area, and for a component-level script the current node is the component. However, there are cases where you want the script to operate on a different content. This is where the &lt;tt&gt;content&lt;/tt&gt; attribute comes handy.&lt;/p&gt;

&lt;p&gt;For example, the &lt;tt&gt;intro&lt;/tt&gt; area has no content of its own. It doesn&apos;t contain any components either since it is of type &lt;tt&gt;noComponent&lt;/tt&gt;. Instead, the area operates on the page content. It edits and renders the page title and abstract. We achieve this using the &lt;tt&gt;content&lt;/tt&gt; attribute.&lt;/p&gt;

&lt;p&gt;In the main.ftl script we tell the main area &quot;hey &lt;tt&gt;main&lt;/tt&gt; area, you should operate on the current content node, which is the page because I am a page-level script&quot;.&lt;/p&gt;

&lt;div class=&quot;code panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;codeHeader panelHeader&quot; style=&quot;border-bottom-width: 1px;&quot;&gt;&lt;b&gt;/templating-kit/pages/main.ftl&lt;/b&gt;&lt;/div&gt;&lt;div class=&quot;codeContent panelContent&quot;&gt;
&lt;pre class=&quot;code-xml&quot;&gt;&lt;span class=&quot;code-tag&quot;&gt;&amp;lt;div id=&lt;span class=&quot;code-quote&quot;&gt;&quot;wrapper-3&quot;&lt;/span&gt;&amp;gt;&lt;/span&gt;
    [@cms.area name=&lt;span class=&quot;code-quote&quot;&gt;&quot;platform&quot;&lt;/span&gt;/]
    [@cms.area name=&lt;span class=&quot;code-quote&quot;&gt;&quot;main&quot;&lt;/span&gt; content=content/]
    [@cms.area name=&lt;span class=&quot;code-quote&quot;&gt;&quot;extras&quot;&lt;/span&gt;/]
&lt;span class=&quot;code-tag&quot;&gt;&amp;lt;/div&amp;gt;&lt;/span&gt;
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;In the &lt;tt&gt;mainArea&lt;/tt&gt; area script we again pass the same instruction down to the &lt;tt&gt;intro&lt;/tt&gt; area: &quot;hey &lt;tt&gt;intro&lt;/tt&gt; area, you should operate on the current content node which is (still) the page&quot;.&lt;/p&gt;

&lt;div class=&quot;code panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;codeHeader panelHeader&quot; style=&quot;border-bottom-width: 1px;&quot;&gt;&lt;b&gt;/templating-kit/pages/section/mainArea.ftl&lt;/b&gt;&lt;/div&gt;&lt;div class=&quot;codeContent panelContent&quot;&gt;
&lt;pre class=&quot;code-xml&quot;&gt;&lt;span class=&quot;code-tag&quot;&gt;&amp;lt;div id=&lt;span class=&quot;code-quote&quot;&gt;&quot;main&quot;&lt;/span&gt; role=&lt;span class=&quot;code-quote&quot;&gt;&quot;main&quot;&lt;/span&gt;&amp;gt;&lt;/span&gt;
    [@cms.area name=&lt;span class=&quot;code-quote&quot;&gt;&quot;breadcrumb&quot;&lt;/span&gt; content=content/]
    [@cms.area name=&lt;span class=&quot;code-quote&quot;&gt;&quot;intro&quot;&lt;/span&gt; content=content/]
    [@cms.area name=&lt;span class=&quot;code-quote&quot;&gt;&quot;opener&quot;&lt;/span&gt;/]
    [@cms.area name=&lt;span class=&quot;code-quote&quot;&gt;&quot;content&quot;&lt;/span&gt;/]
&lt;span class=&quot;code-tag&quot;&gt;&amp;lt;/div&amp;gt;&lt;/span&gt;&lt;span class=&quot;code-tag&quot;&gt;&lt;span class=&quot;code-comment&quot;&gt;&amp;lt;!-- end main --&amp;gt;&lt;/span&gt;&lt;/span&gt;
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;Now the &lt;tt&gt;intro&lt;/tt&gt; area edits page content. While the &lt;tt&gt;intro&lt;/tt&gt; area resides inside the &lt;tt&gt;main&lt;/tt&gt; area div on the page, the title and the abstract really belong to the page. They are the page&apos;s properties, not the area&apos;s. So it makes sense to store those properties under the page node in the content structure.&lt;/p&gt;

&lt;p&gt;&lt;span class=&quot;image-wrap&quot; style=&quot;&quot;&gt;&lt;img src=&quot;https://jira.magnolia-cms.com/secure/attachment/17032/17032_page-level-properties.png&quot; style=&quot;border: 0px solid black&quot; /&gt;&lt;/span&gt;&lt;/p&gt;

&lt;p&gt;We will include this in our areas documentation. A basic area property reference is available in &lt;a href=&quot;http://documentation.magnolia-cms.com/reference/areas.html&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;http://documentation.magnolia-cms.com/reference/areas.html&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="53568" author="jfrantzius" created="Wed, 21 Nov 2012 16:59:04 +0100"  >&lt;p&gt;Hi Antti,&lt;/p&gt;

&lt;p&gt;thanks for the explanation here in the ticket. Did you per chance include this in the official documentation somewhere?&lt;/p&gt;

&lt;p&gt;Also, talking about &lt;span class=&quot;error&quot;&gt;&amp;#91;http://documentation.magnolia-cms.com/reference/areas.html|the basic area property reference&amp;#93;&lt;/span&gt;, is there any difference between omitting &quot;availableComponents&quot; node in an area definition and giving it the type &quot;noComponent&quot;?&lt;/p&gt;

&lt;p&gt;Or, the other way round, what happens when you both give it the type &quot;noComponent&quot; and list some &quot;availableComponents&quot;? &lt;/p&gt;</comment>
                            <comment id="54059" author="ahietala" created="Fri, 30 Nov 2012 09:17:31 +0100"  >&lt;p&gt;Hi J&#246;rg, &lt;/p&gt;

&lt;p&gt;I did a quick test. Doesn&apos;t look like there is any difference. Setting &lt;tt&gt;type=noComponent&lt;/tt&gt; has the same effect as omitting the &lt;tt&gt;availableComponents&lt;/tt&gt; node:&lt;/p&gt;
&lt;ul&gt;
	&lt;li&gt;If the area has no components and you do either of the above, the system does not render the area bar.&lt;/li&gt;
	&lt;li&gt;If the area already has a component and you do either of the above, the system does not render the area but it renders the component and the component is editable.&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;Information about the &lt;tt&gt;content&lt;/tt&gt; attribute was added here. &lt;a href=&quot;http://documentation.magnolia-cms.com/templates/stk/template-scripts.html#Directives&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;http://documentation.magnolia-cms.com/templates/stk/template-scripts.html#Directives&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                    <attachments>
                            <attachment id="17032" name="page-level-properties.png" size="101086" author="ahietala" created="Wed, 26 Sep 2012 16:00:19 +0200"/>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                            <customfield id="customfield_14166" key="com.okapya.jira.checklist:checklist">
                        <customfieldname>Acceptance criteria</customfieldname>
                        <customfieldvalues>
                            
        <checklist>
        <![CDATA[
                            




                
                                    <div class="o-completion" style="display: flex; flex-shrink: 0;"><span  class="aui-lozenge aui-lozenge-complete" style="font-size: 12px; font-weight: normal; display: flex; flex-direction: row; align-items: center;" ><span style="padding-right: 4px; vertical-align: middle;"><svg width="15" height="15" viewBox="0 0 15 15" xmlns="http://www.w3.org/2000/svg" fill="white"><path clip-rule="evenodd" d="m10.41037,3.42544l-7.86501,0c-0.72395,0 -1.31084,0.58688 -1.31084,1.31084l0,7.86508c0,0.7239 0.58689,1.3108 1.31084,1.3108l7.86501,0c0.724,0 1.3109,-0.5869 1.3109,-1.3108l0,-7.86508c0,-0.72396 -0.5869,-1.31084 -1.3109,-1.31084zm-7.86501,-0.65542c-1.08593,0 -1.96626,0.88032 -1.96626,1.96626l0,7.86508c0,1.0859 0.88033,1.9662 1.96626,1.9662l7.86501,0c1.086,0 1.9663,-0.8803 1.9663,-1.9662l0,-7.86508c0,-1.08594 -0.8803,-1.96626 -1.9663,-1.96626l-7.86501,0z" fill-rule="evenodd"/><path d="m5.09049,10.18526l-1.82767,-1.82766l-0.78479,0.78479l2.61246,2.61246l5.38758,-5.38754l-0.78483,-0.78479l-4.60275,4.60274z"/></svg></span><span>Empty</span></span></div>
                        ]]>
    </checklist>


                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                <customfield id="customfield_10111" key="com.atlassian.jira.toolkit:reporterdomain">
                        <customfieldname>Company</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>aperto.de</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_10031" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>Date of First Response</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Wed, 26 Sep 2012 16:00:03 +0200</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_12730" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_14151" key="com.atlassian.jira.toolkit:message">
                        <customfieldname>Docu info</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_10061" key="com.atlassian.jira.toolkit:lastusercommented">
                        <customfieldname>Last comm is not jira-dev</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>false</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10071" key="com.atlassian.jira.toolkit:lastupdaterorcommenter">
                        <customfieldname>Last participant</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>mmuehlebach</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_13136" key="com.atlassian.jira.toolkit:LastCommentDate">
                        <customfieldname>Last public comment date</customfieldname>
                        <customfieldvalues>
                            11 years, 12 weeks, 2 days ago
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10020" key="com.atlassian.jira.toolkit:attachments">
                        <customfieldname>Number of attachments</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10150" key="com.atlassian.jira.toolkit:comments">
                        <customfieldname>Number of comments</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>4.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10011" key="com.atlassian.jira.toolkit:participants">
                        <customfieldname>Participants</customfieldname>
                        <customfieldvalues>
                                        <customfieldvalue>ahietala</customfieldvalue>
            <customfieldvalue>jfrantzius</customfieldvalue>
            <customfieldvalue>ruths</customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                <customfield id="customfield_10833" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0|i03t8v:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10244" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>22348</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                        <customfield id="customfield_10054" key="com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield">
                        <customfieldname>Reporter&apos;s SLA</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Partner-MI-PA&lt;br/&gt;
</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                <customfield id="customfield_14145" key="com.intenso.jira.issue-templates:issue-templates-customfield">
                        <customfieldname>Template</customfieldname>
                        <customfieldvalues>
                            


                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_15131" key="com.onresolve.jira.groovy.groovyrunner:scripted-field">
                        <customfieldname>Time in Discovery</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    </customfields>
    </item>
</channel>
</rss>