topic Re: #include directive in Alfresco Archive

#include directive

nyronian — Tue, 01 May 2007 14:10:37 GMT

I can't, for the life of me, get the #include directive to work within a freemarker "Presentation Template"Does anyone know if it is supported or what the "file name" is supposed to look like. I have tried as many configurations of the filename that I can think of and continually get "FileNotFound"

Re: #include directive

edgar — Wed, 02 May 2007 14:54:32 GMT

Hi,

I can't, for the life of me, get the #include directive to work within a freemarker "Presentation Template"

see this forum thread for more information: http://forums.alfresco.com/viewtopic.php?t=6111&highlight=include and especially this JIRA issue: http://issues.alfresco.com/browse/WCM-399

cheers,

Edgar

Re: #include directive

nyronian — Wed, 02 May 2007 17:48:55 GMT

Thank you for your response Edgar.

I still don't see a way for it to work. The file I am trying to reference is another ftl in the repository.

So let me show you what I am doing….

I have a header.ftl that needs to be included in the top of another ftl file. I can access the header.ftl with the following code:


<#assign header = companyhome.childByNamePath["Data Dictionary/Presentation Templates/RoofHeatTemplates/header.ftl"]  >
‍‍‍

That gives me access to the file node.

I then need to run a

<#include "header.ftl" >‍

in the main ftl file.

It seems that whatever I put in for the path name to the header.ftl, it doesn't find it.

I have tried: ${header.nodeRef}, ${header.url} and ${header.displayPath}, each one gives me an error.

For example ${header.nodeRef} gives the following error:

org.alfresco.error.AlfrescoRuntimeException: Error during template servlet processing: Error during processing of the template 'Error reading included file workspace://SpacesStore/90568487-f768-11db-a73d-7b34ccb063d2/header.ftl'. Please contact your system administrator.
caused by:
org.alfresco.service.cmr.repository.TemplateException: Error during processing of the template 'Error reading included file workspace://SpacesStore/90568487-f768-11db-a73d-7b34ccb063d2/header.ftl'. Please contact your system administrator.
caused by:
freemarker.template.TemplateException: Error reading included file workspace://SpacesStore/90568487-f768-11db-a73d-7b34ccb063d2/header.ftl
caused by:
java.io.FileNotFoundException: Template workspace://SpacesStore/90568487-f768-11db-a73d-7b34ccb063d2/header.ftl not found.‍‍‍‍‍‍‍

The unit test only show the included templets sitting in the filesystem, not in the repository. Also, I am not using the AVM, just strictly alfrescos web-client Template Processor.

Thanks again.

Re: #include directive

mikef — Thu, 03 May 2007 11:38:48 GMT

Here's an example of how to do it:

<#assign FTLfilename = "readme.ftl"/>
<#include space.childByNamePath["${FTLfilename}"].nodeRef>

In this case the readme.ftl is obviously in the current space context.

Re: #include directive

nyronian — Thu, 03 May 2007 15:35:21 GMT

PERFECT!!! Thank you so much!

I was doing a screwed up syntax of:

<#assign FLTFile= companyhome.childByNamePath["file.ftl"] >
<#include "${FLTFile.nodeRef}" >

instead of the proper syntax of:

<#include FLTFile.nodeRef >

Re: #include directive

edgar — Thu, 03 May 2007 21:08:38 GMT

Hi,

Can I also use constructs like companyhome.childByNamePath in my XSL templates? If so: is there an example of this somewhere?

The Template Guide seems to be geared towards Freemarker instead of XSLT?

cheers,

Edgar

Re: #include directive

kevinr — Fri, 04 May 2007 12:52:37 GMT

No, the model available in XSL is very different to the rich freemarker model - however we are working towards a common model.

Thanks,

Kevin

Re: #include directive

nyronian — Fri, 03 Aug 2007 15:06:40 GMT

Is it just me or is managing the Freemarker data model and transformations SO much simpler and more flexible than XSLT? I am tasking myself to see if I can duplicate what I am doing in Freemarker to XSLT and I don't see ways to do things like the default model information shown at

http://wiki.alfresco.com/wiki/Template_Guide_For_Alfresco_1.4_and_2.0#Default_Model

Are there ways to make companyhome, userhome, person, args, session, etc. etc. available in an xstl transformation? More over, what about the items in the TemplateNode class and the ability to add our own HashMaps and beans that become available on the model.

I am new to XSLT transformations but I am looking and looking for a way to make these items available to an XLST transformation and I beleive I am missing something. As popular as it is, I can't beleive there is no way to do this. The Freemarker manual describes very clearly and simply how to do it, I can find no such things for the XSLT model. Is there a keyword or term they use I am missing.

I did look at the XSLTRenderingEngine class in alfresco and see an invokeMethod class but I don't see examples anywhere on how to use it. Is there where you put all these custom methods?

Sorry to ramble on for what may be a simple question, if anyone can simply point me in the right direction, I can figure it out….

Thanks!

Re: #include directive

davidc — Mon, 06 Aug 2007 09:45:15 GMT

Are you saying that XSLT is easier and more flexible than Freemarker?

Re: #include directive

nyronian — Mon, 06 Aug 2007 14:51:29 GMT

No, I am saying I understand Freemarker and how to expose all this extra data to it, but I do not see how to do it in XSLT. In Freemarker, you simply tie a bean to the data model and it is available in the transformation. Very simple. But I would like to figure out how to expose beans in XSLT i.e. args, company_home, the TemplateNode class, my own Beans, etc. etc. I assume XSLT can do the same things, that is, somehow tie a javabean and expose it in the data model. Am I right?

I have been looking through quite a bit of XSLT information and it is not clear to me how to do it. Maybe they have a completly different concept?

Re: #include directive

davidc — Tue, 07 Aug 2007 10:02:08 GMT

XSLT transforms XML documents. So, it's not natural to provide arbitrary Javabeans as source data.

Potentially, custom XSLT functions could be implemented and registered to perform this kind of binding, but this is really outside of XSLT's natural support.

All I can suggest is to search the web to see if folks have attempted the same. It's not an area I'm too familiar with.

Re: #include directive

jeff — Fri, 13 Jun 2008 21:01:58 GMT

Hi folks,

We are running 2.2 and I am now having problems with the freemarker include directive. After many many tries and incarnations of trying to include a file, I've resorted to the most simple form I know. Here is a snippet of the FTL file:

<#assign FTLfilename = "navglobal01.ftl"/>
<#include "${FTLfilename}">

However, after editing the desired asset I get the following error:

Please correct the errors below then click Finish.

* error regenerating rendition using freemarker-include-file.ftl: freemarker.template.TemplateException: Error reading included file navglobal01.ftl

navglobal01.ftl resides in the same directory as the file including it, I'd prefer it to be in an /includes folder of it's own, but I am making this as simple as possible to begin with and I still can't get it to work.

Any ideas?

Thanks!

Re: #include directive

tommorris — Sat, 14 Jun 2008 06:30:01 GMT

Is that the complete message?
Sometimes the stacktrace in the error log/console has more useful info as to the cause of the problem.

Re: #include directive

nyronian — Mon, 16 Jun 2008 14:44:28 GMT

Here is an example of how to use an include. Keep in mind that you are working out of a repository.

<#– Displays the contents of readme.html and/or the evaluated readme.ftl if they exist in the current space. –>
 
<#assign htmlFilename = "readme.html"/>
<#assign ftlFilename = "readme.ftl"/>
 
<#if space?exists>
    <#if space.childByNamePath["${htmlFilename}"]?exists>
        ${space.childByNamePath[htmlFilename].content}
    </#if>
    <#if space.childByNamePath["${ftlFilename}"]?exists>
        <#include space.childByNamePath["${ftlFilename}"].nodeRef> 
    </#if>
</#if>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: #include directive

jeff — Thu, 19 Jun 2008 14:54:28 GMT

So I tried your suggestion and received this error after clicking next while editing a document:

Please correct the errors below then click Finish.

* error regenerating rendition using freemarker-include-file.ftl: freemarker.core.NonStringException: Error on line 44, column 11 in freemarker_template Expecting a string, date or number here, Expression space.childByNamePath[htmlFilename].content is instead a freemarker.ext.dom.NodeListModel

while using this in the ftl template:

<#assign ftlFilename = "navglobal01.ftl"/>
<#assign htmlFilename = "navglobal01.htm"/>

<#if space?exists>
    <#if space.childByNamePath["${htmlFilename}"]?exists>
        ${space.childByNamePath[htmlFilename].content}
    </#if>
    <#if space.childByNamePath["${ftlFilename}"]?exists>
        <#include space.childByNamePath["${ftlFilename}"].nodeRef>
    </#if>
</#if>‍‍‍‍‍‍‍‍‍‍‍

Is it that "space" needs to be instantiated ?

thanks,

Re: #include directive

jeff — Thu, 03 Jul 2008 17:53:14 GMT

Here's an example of how to do it:

<#assign FTLfilename = "readme.ftl"/>
<#include space.childByNamePath["${FTLfilename}"].nodeRef>

In this case the readme.ftl is obviously in the current space context.

So I tried the above syntax for a freemarker include directive and got the following error:

Please correct the errors below then click Finish.

* Error generating rendition using freemarker-include-file.ftl: freemarker.core.NonStringException: Error on line 41, column 11 in freemarker_template
* Expecting a string, date or number here, Expression space.childByNamePath["${FTLfilename}"].nodeRef is instead a freemarker.ext.dom.NodeListModel

I am using Alfresco 2.2, does anyone have any ideas as to how to solve this problem?

Re: #include directive

alr — Wed, 03 Sep 2008 15:42:46 GMT

Here is an example of how to use an include. Keep in mind that you are working out of a repository.

<#– Displays the contents of readme.html and/or the evaluated readme.ftl if they exist in the current space. –>
 
<#assign htmlFilename = "readme.html"/>
<#assign ftlFilename = "readme.ftl"/>
 
<#if space?exists>
    <#if space.childByNamePath["${htmlFilename}"]?exists>
        ${space.childByNamePath[htmlFilename].content}
    </#if>
    <#if space.childByNamePath["${ftlFilename}"]?exists>
        <#include space.childByNamePath["${ftlFilename}"].nodeRef> 
    </#if>
</#if>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍

I am just tryint to to something like that in a webscript. This is some shortened dummy code, showing the problem



<#function loadNodeID nodeID>
   <#list companyhome.childrenByLuceneSearch["ID:workspace\\:\\/\\/SpacesStore\\/" + nodeID] as node>
      <#return node>
   </#list>
</#function>

<#assign freeMarkerTemplate = loadNodeID(freeMarkerTemplateID)>
${freeMarkerTemplate.nodeRef}<p>

<#include freeMarkerTemplate.nodeRef>
‍‍‍‍‍‍‍‍‍‍‍‍‍

While the nodeRef holds perfectly valid content, which is accessible via freeMarkerTemplate.content - I cannot use the include directive without getting this error:


Message:   Error during processing of the template 'Error reading included file workspace://SpacesStore/52d1a9e5-bc4a-4ef3-826d-229fa1fa209a'. Please contact your system administrator.
    
Exception:   java.io.FileNotFoundException - Template workspace://SpacesStore/52d1a9e5-bc4a-4ef3-826d-229fa1fa209a not found.
‍‍‍‍‍

How can the file not be found if it is there as I can read out of it? I am using Alfresco Labs v3… do I need to specify another path? I mean, the readme.html/readme.ftl example does not really look different to me.

Thanks for any help.

–Alexander

Re: #include directive

alr — Thu, 04 Sep 2008 10:08:31 GMT

Hello,

me again, some more information.

Stupid question: Is it possible, that you can only #include other freemarker templates if they are inside the "Web Scripts" Directory?

I had a web script in /Data Dictionary/Web Scripts/renderTemplate/ which used one of the below include directives (before that I always placed test.ftl into the right directory).

[Works] <#include "test.ftl">
[Works] <#include "../test.ftl">
[NOT WORKING] <#include "../../test.ftl">

The last one did not work, as it gave me the "File not found" error, though it was psyically definately at the right place (I was only out of the Web Scripts directory).

So, the new question is, how do I load templates inside of webscripts, which are placed in User Homes (though the readme exactly does exactly that or am I wrong)?

Thanks for any hints.

–Alexander

Re: #include directive

lee — Wed, 11 Feb 2009 16:16:19 GMT

Hello,

Did you ever find a solution for this?

I'm having a similar problem with the following code:

<#assign ftlFile = companyhome.nodeByReference["${nodeRef}"].nodeRef>
<#include ftlFile>‍‍

I'm getting file not found errors, though if I test the ftlFile variable (ie. without the include but just doing: ${ftlFile.content} for example, I can see the freemarker content that I want).

Here's the error:

Exception:   java.io.FileNotFoundException - Template workspace://SpacesStore/ec02892c-9cfa-410c-b6f4-b8b3a6f1ce2d not found.
    
   freemarker.template.Configuration.getTemplate(Configuration.java:489)
   freemarker.core.Environment.getTemplateForInclusion(Environment.java:1357)
   freemarker.core.Include.accept(Include.java:143)
   freemarker.core.Environment.visit(Environment.java:196)
   freemarker.core.MixedContent.accept(MixedContent.java:92)
   freemarker.core.Environment.visit(Environment.java:196)
   freemarker.core.Environment.process(Environment.java:176)
   freemarker.template.Template.process(Template.java:232)
   org.alfresco.repo.template.FreeMarkerProcessor.process(FreeMarkerProcessor.java:201)
   org.alfresco.web.scripts.AbstractWebScript.renderTemplate(AbstractWebScript.java:396)
   org.alfresco.web.scripts.DeclarativeWebScript.renderFormatTemplate(DeclarativeWebScript.java:268)
   org.alfresco.web.scripts.DeclarativeWebScript.execute(DeclarativeWebScript.java:174)
   org.alfresco.web.scripts.WebScriptRuntime.wrappedExecute(WebScriptRuntime.java:364)
   org.alfresco.web.scripts.WebScriptRuntime$1.execute(WebScriptRuntime.java:330)
   org.alfresco.repo.transaction.RetryingTransactionHelper.doInTransaction(RetryingTransactionHelper.java:294)
   org.alfresco.repo.transaction.RetryingTransactionHelper.doInTransaction(RetryingTransactionHelper.java:209)
   org.alfresco.web.scripts.WebScriptRuntime.transactionedExecute(WebScriptRuntime.java:341)
   org.alfresco.web.scripts.WebScriptRuntime.authenticatedExecute(WebScriptRuntime.java:284)
   org.alfresco.web.scripts.WebScriptRuntime.executeScript(WebScriptRuntime.java:150)
   org.alfresco.web.scripts.WebScriptServlet.service(WebScriptServlet.java:109)
   javax.servlet.http.HttpServlet.service(HttpServlet.java:729)
   org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:269)
   org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:188)
   org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:213)
   org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:172)
   org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:127)
   org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:117)
   org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:108)
   org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:174)
   org.apache.coyote.http11.Http11Processor.process(Http11Processor.java:875)
   org.apache.coyote.http11.Http11BaseProtocol$Http11ConnectionHandler.processConnection(Http11BaseProtocol.java:665)
   org.apache.tomcat.util.net.PoolTcpEndpoint.processSocket(PoolTcpEndpoint.java:528)
   org.apache.tomcat.util.net.LeaderFollowerWorkerThread.runIt(LeaderFollowerWorkerThread.java:81)
   org.apache.tomcat.util.threads.ThreadPool$ControlRunnable.run(ThreadPool.java:689)
   java.lang.Thread.run(Thread.java:595) ‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

The file is definitely there because if I remove the include line and enter: ${ftlFile.content} I get the expected freemarker content.

I've searched all through these forums but it doesn't appear that there's an answer…. I'm using a webscript to display some html content but the ftl template to use can vary depending on a number of variables (this is the ${nodeRef} variable. Do the templates to be included need to be in a specific place? Or can I call them from any location in the repository? And if so, how?

Any help would be great. Thanks Lee

Re: #include directive

stevewickii — Wed, 29 Apr 2009 01:49:53 GMT

Is this functionality available in Alfresco Community 2.9.0B build 683?

For example: <#include companyhome.childByNamePath("Data Dictionary/Web Scripts/examples/test.html.ftl").nodeRef>

I am using a webscript to process a freemarker template and write the content to a file node in alfresco. The <#include> directive resolves to a valid nodeRef, but it throws a FileNotFoundException saying that the NodeRef cannot be found.

Here's what I'm getting for a response…

Message: Failed to execute script 'workspace://SpacesStore//Company Home/Data Dictionary/Web Scripts/examples/publish.get.js': Failed to execute script 'workspace://SpacesStore//Company Home/Data Dictionary/Web Scripts/examples/publish.get.js': Wrapped org.alfresco.service.cmr.repository.TemplateException: Error during processing of the template 'Error reading included file workspace://SpacesStore/d1aa3ac7-a8ee-11dd-8d11-3d772ddcae37'. Please contact your system administrator. (AlfrescoScript#20)

Exception: java.io.FileNotFoundException - Template workspace://SpacesStore/d1aa3ac7-a8ee-11dd-8d11-3d772ddcae37 not found.