[DOCU-298] Resources loading Created: 23/Jul/12  Updated: 03/Nov/15

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

Type: Task Priority: Neutral
Reporter: Antti Hietala Assignee: Gavan Stockdale
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:

 Description   

Describe how resources are loaded and how to refer to them.

  • Explain the resources loading mechanism. The same mechanism is used for template loading. 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 forum thread.

Put this information in the Resources module and cross-link from where you think users would look for it.

Useful threads:


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