Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
ardiextra:ardi_user_content_framework [2024/12/19 22:10]
optrix
ardiextra:ardi_user_content_framework [2025/03/16 22:42] (current)
optrix
Line 7: Line 7:
 ===The Base Folder=== ===The Base Folder===
  
-In any UCF-based addon, you add new items (be they reports, displays or API functions), you'll have a **base folder**.+In any UCF-based addon, you will have a **base folder**.
  
-Normally, this will be found in your ARDI [[site folder]], along side all of your media-files and settings. +Normally, this will be found in your ARDI [[ardiadminguide:site folder]], along side all of your media-files and settings. 
  
 The actual folder name will vary depending on the addon, but you'll find a couple of examples below... The actual folder name will vary depending on the addon, but you'll find a couple of examples below...
Line 55: Line 55:
 ===Content=== ===Content===
  
-You'll also find the required content files in this folder. This varies depending on the addon - Infographics will usually require a Javascript file called //generate.js//, reports will have a Python script called //report.py//.+Along-side the **info** file, put the content itself. This type of content varies depending on the addon - Infographics will usually require a Javascript file called //generate.js//, reports will have a Python script called //report.py//.
  
 ===Why Use This System=== ===Why Use This System===
Line 71: Line 71:
    * Content is compatible with a wide variety of version-management tools,    * Content is compatible with a wide variety of version-management tools,
    * The folder location can be overridden, allowing you to share a common set of content on network drives or cloud-synced storage.    * The folder location can be overridden, allowing you to share a common set of content on network drives or cloud-synced storage.
 +   * Content can often be developed off-server and only copied onto the server when it's published.