📘 XCL documentation

This documentation provides information about The XOOPSCube Legacy Project and XCL Web Application Platform.

Intended Audiences : 👥 This information is intended for administrators, developers and designers.

Note

The folder structure of the Markdown files provides links to edit directly on the GitHub repository.

📦 API Documentation XCL v2.5.x

📦 API XCube Core Documentation

Visualize the minimal XCube core

Given the limited number of files and their apparent roles, the Mermaid schema is relatively simple
but can still illustrate the basic flow and dependencies.

graph LR
    subgraph "XCube Core (html/core)"
        bootstrap --> PathDefs((Path Definitions))
        bootstrap --> Autoloader((Autoloader))
        bootstrap --> CoreFuncs((Core Functions))
        bootstrap --> XRoot((XCube_Root))
        bootstrap --> Request((Initial Request Handling))

        XRoot --> Registry((Core Object Registry))
        Registry -- provides access to --> Controller((XCube_Controller))
        Registry -- provides access to --> Module((XCube_Module))
        Registry -- provides access to --> Theme((XCube_Theme))
        Registry -- provides access to --> Language((XCube_Language))

        Controller --> Dispatch((Module Dispatching))
        Controller --> Render((Theme Rendering))

        Module --> Logic((Module Logic))
        Theme --> UI((User Interface Rendering))
        Language --> Locale((Text Localization))

        functions --> Utils((Utility Functions))
        Utils -- used by --> CoreComponents((Various Components))
    end

Loading

Templates

Templates are easy to identify. The folder name or the file name starts with _underscore

• _coverpage.md
• _navbar.md
• _sidebar.md

Features

• Iconify
• Mermaid
• Prism
• Theme dark/light
• xLayout Helper
• zoom-image

Installation

Install locally by running:

Todo : install project

Contribute

• Be awesome
• Make things faster
• Write Tutorials
• Share Tips and code samples

Issue Tracker: https://github.com/xoopscube/documentation/issues
Source Code: https://github.com/xoopscube/documentation

Support

If you are having issues or if you have suggestions, please let us know. Report any issue or suggestion to project GitHub tracker.

License

The project is licensed under the MIT license.

---

Big Thanks

JetBrains is an active participant in the Open Source community.
Big thanks to the JetBrains Team for supporting XOOPSCube Project ^_^/

---

  —///////////////////////—

When you know who you are, you know what to do, you know what story to tell, and the stories that you want to hear and see. We share the essential knowledge and understanding of “open source” necessary to create tools that encourage creativity and free speech.

"Learn everything you can.
Try everything that comes along.
Look at everything there is to see.
Search, experiment, make mistakes, fail, stand up.
Turn religious, turn conservative, turn radical.
And then forget all about it and find your way to create."