# System Notes

- **Xconf Files**:
  - They define page settings, path actions, and properties that influence dynamic behavior.
  - These files can include permissions, scripts, and styles that are recursively inherited and can be overridden in subdirectories.
  
  **Examples:**
  - Path Action: `<path-action name="ProfileModule.loadUserProfile" />` runs specific Java methods on page requests.
  - Property: `<property name="applicationid">oneliveweb</property>` is used to set a configurable value accessible application-wide.
  - Permission: `<permission name="edit">` specifies access conditions, integrating user groups and properties.
  - Script: `<script id="jquery" src="/oneliveweb/components/javascript/jquery.min.js" />` includes external JavaScript files.
  - Style: `<style id="bootstrap" href="/oneliveweb/components/bootstrap/css/bootstrap.min.css" />` links CSS files for styling.

- **Velocity and Context Usage**:
  - The `/oneliveweb` variable in Velocity templates centralizes application navigation.
  - Use `$context.getPageProperty('propertyName')` to access properties defined in Xconf files.
  - Use `$context.getPageValue('key')` to retrieve objects added through runtime context settings.

- **Plugin.xml Configuration**:
  - This file is essential for defining the components and dependencies, ensuring smooth integration across the platform.

- **Git Integration**:
  - Managed by the `GitModule` alongside other module integrations defined in plugin.xml.

- **Fallback and Inheritance Mechanism**:
  - Supports file path resolution via fallbacks declared in `_site.xconf`, checking `/WEB-INF/base` as a default fallback.
  - Xconf properties, scripts, styles, and path actions use this inheritance.

- **Page Properties**:
  - Defined through `<property>` tags in Xconf, dynamically accessed in code/Velocity.
  - Facilitate configuration across different URL contexts.

- **Permissions**:
  - Declared using `<permission>` tags that define access control, leveraging user profiles and group memberships.

- **Scripts and Styles**:
  - Configured through `<script>` and `<style>` tags in Xconf, allowing you to include necessary JavaScript and CSS files.
  - This provides centralized management of assets loaded with the page, ensuring consistency in application behavior and appearance.

# Coding Standards

- **Variable Naming**:
  - **Method Variables**: Use the prefix `in`.
  - **Class Variables**: Use the prefix `field`.

- **Accessors**:
  - Always use getters and setters for accessing class variables, even within the same class.

- **Access Modifiers**:
  - Use `protected` instead of `private` in classes.

- **Control Structures**:
  - Always use `{}` for `if` statements, regardless of their complexity.

# Modules and Bean Creation

- **Modules**:
  - Act as the entry point for handling web page requests, corresponding directly to path actions.
  - Methods in modules are kept short and delegate to managers or other components for complex operations.
  - You can add new methods to extend capabilities, like `scrapeWebContent` in `GptModule`, for specific tasks such as web scraping.

- **Bean Creation**:
  - Handled by a `ModuleManager` using Spring, avoiding direct instantiation with `new` in Java.

# Extending Functionality

- **Adding New Capabilities**:
  - Extend functionality by creating new methods in existing modules like `GptModule`.
  - Implement functionalities such as web scraping or API integrations to enhance the platform's capabilities.
  - Use appropriate Java libraries (e.g., Jsoup, HttpClient) for external tasks.
  - Ensure the functions are accessible within the framework's request/response lifecycle for utilizing new capabilities effectively.

# Eclipse Code Formatting Rules


- **Braces**:
  - Place braces on a new line for method declarations, blocks, and structures like enums and type declarations.


These guidelines help maintain a consistent and readable codebase. Feel free to let me know if there's more to add or further details to clarify!

These notes are intended to be comprehensive and up-to-date. Incorporate any new information discussed about the platform to ensure clarity and usefulness.