Resources loading
-----------------
Key: DOCU-298
URL: http://jira.magnolia-cms.com/browse/DOCU-298
Project: Documentation
Issue Type: Task
Security Level: Public
Components: content
Reporter: Antti Hietala
Assignee: Gavan Stockdale
Describe how resources are loaded and how to refer to them.
* Explain the resources loading mechanism. The same mechanism is used for
[template
loading|http://documentation.magnolia-cms.com/templates/templating-4-4/stk/templating.html#LoadingTemplateScripts].
There are three places where the system looks for resources. It looks for them
in a particular order. The order is the same for templates are resources. What
are the folder naming conventions? Should resources be placed in a particular
folder?
* Users typically ask about resource loading when they want to override a
default resource file in the module JAR with their own file. Given the three
places and the loading order above, explain where they can put the custom
resource file during developing and testing so the system loads it instead of
the default one in the module JAR. Where should they put the resources file in
production so the file is version controlled?
* How do you refer to resources? This becomes relevant when you want to
generate links to resource files, for example in a Freemarker template script.
Explain the difference between {{/resources}} and {{/.resources}} based on
[resources, templates and module
JARS|http://forum.magnolia-cms.com/forum/thread.html?threadId=c21af67e-b198-41ad-af6c-6e4754d93dc1]
forum thread.
Put this information in the [Resources
module|http://documentation.magnolia-cms.com/modules/resources.html] and
cross-link from where you think users would look for it.
Useful threads:
* [resource file loading by initialising of
modules|http://forum.magnolia-cms.com/forum/thread.html?threadId=942a9cfc-7c29-4ac6-b62a-4d48b83032d8]
- how to bypass a resource in the repository
* [CSS / JS resources served from
filesystem|http://forum.magnolia-cms.com/forum/thread.html?threadId=31954c5a-1a74-4f0e-a62e-3a0c388930f7]
- typical question
* [resources, templates and module
JARS|http://forum.magnolia-cms.com/forum/thread.html?threadId=c21af67e-b198-41ad-af6c-6e4754d93dc1]
- notation when building links
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.magnolia-cms.com/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
----------------------------------------------------------------
For list details, see: http://www.magnolia-cms.com/community/mailing-lists.html
Alternatively, use our forums: http://forum.magnolia-cms.com/
To unsubscribe, E-mail to: <[email protected]>
----------------------------------------------------------------
