diff --git a/docs/guides/installation/index.html b/docs/guides/installation/index.html new file mode 100644 index 000000000..433a67882 --- /dev/null +++ b/docs/guides/installation/index.html @@ -0,0 +1,115 @@ + + + + + Installation Guide | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Installation Guide

+ + +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/marketplace/index.html b/docs/guides/marketplace/index.html new file mode 100644 index 000000000..a0d2b2081 --- /dev/null +++ b/docs/guides/marketplace/index.html @@ -0,0 +1,151 @@ + + + + + Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Oqtane Marketplace

+ +

Introduction

+

The Oqtane Marketplace is a central hub where users and developers can discover, +share, and distribute themes, modules, and translations for the Oqtane framework. +Whether you're a developer looking to showcase your creations +or a user seeking new features and enhancements for your Oqtane-based application, +the Marketplace provides a convenient platform to meet your needs.

+
    +

  1. Using the Oqtane Marketplace
    +Learn how to navigate the Oqtane Marketplace, +find and install themes and modules, and explore the available offerings. +This guide will walk you through the process of discovering +and utilizing resources from the Marketplace to enhance your Oqtane experience.

    +
    2. +

  2. Submitting Contributions
    +Are you a developer interested in sharing your themes, modules, +or translations with the Oqtane community? +This manual provides detailed instructions on how to prepare +and submit your contributions to the Oqtane Marketplace, +making them accessible to users worldwide.

    +
    3. +

  3. Monetization Options
    +Discover opportunities for monetization within the Oqtane Marketplace. +Whether you're interested in offering commercial products +or exploring sponsorship and advertising options, +this guide outlines various strategies for monetizing +your contributions to the Oqtane ecosystem.

    +
    4. +

  4. Troubleshooting
    +Encountering issues while using the Oqtane Marketplace? +This troubleshooting guide offers solutions to common problems +and helps you resolve issues related to theme and module installation, +compatibility, and other Marketplace functionalities.

    +
    5. +
+

Explore the Oqtane Marketplace and unleash the full potential +of your Oqtane-based applications today!

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/marketplace/monetization.html b/docs/guides/marketplace/monetization.html new file mode 100644 index 000000000..a23df13e1 --- /dev/null +++ b/docs/guides/marketplace/monetization.html @@ -0,0 +1,132 @@ + + + + + Monetization Options in the Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Monetization Options in the Oqtane Marketplace

+ +

Overview

+

The Oqtane Marketplace offers various opportunities for developers to monetize their contributions, including themes, modules, and translations. Whether you're looking to generate revenue from your creations or support your development efforts, the Marketplace provides several monetization options to suit your needs.

+

Pricing Models

+

Explore different pricing models available in the Oqtane Marketplace, including free, freemium, subscription-based, and one-time purchase options. Learn how to choose the right pricing model for your products and maximize your revenue potential.

+

Licensing and Usage Rights

+

Understand the licensing and usage rights associated with products listed on the Oqtane Marketplace. From open-source licenses to commercial licenses, this section provides guidance on selecting the appropriate licensing model for your themes, modules, or translations.

+

Payment Processing

+

Learn about the payment processing options available for commercial products in the Oqtane Marketplace. Whether you prefer to use integrated payment gateways or manage transactions independently, this section covers the steps involved in setting up payment processing for your products.

+

Sponsorship and Advertising

+

Explore opportunities for sponsorship and advertising within the Oqtane Marketplace. From promoting your products to sponsoring specific features or sections of the Marketplace, this section discusses how to leverage sponsorship and advertising to increase visibility and reach a wider audience.

+

Analytics and Reporting

+

Gain insights into the performance of your products in the Oqtane Marketplace through analytics and reporting tools. Learn how to track key metrics such as downloads, revenue, and user engagement to optimize your monetization strategies and drive growth.

+

Support and Maintenance Services

+

Discover the value of offering support and maintenance services for your products listed on the Oqtane Marketplace. From providing timely updates and bug fixes to offering premium support packages, this section explores ways to enhance the customer experience and build long-term relationships with users.

+

Promotional Strategies

+

Develop effective promotional strategies to increase awareness and sales of your products in the Oqtane Marketplace. Whether through targeted marketing campaigns, cross-promotions with other developers, or participation in community events, this section offers practical tips for promoting your monetized offerings.

+

By leveraging the monetization options available in the Oqtane Marketplace, you can turn your passion for development into a sustainable source of income while contributing to the growth and success of the Oqtane ecosystem.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/marketplace/submitting-contributions.html b/docs/guides/marketplace/submitting-contributions.html new file mode 100644 index 000000000..7d981b3ed --- /dev/null +++ b/docs/guides/marketplace/submitting-contributions.html @@ -0,0 +1,132 @@ + + + + + Submitting Contributions to the Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Submitting Contributions to the Oqtane Marketplace

+ +

Overview

+

This manual provides detailed instructions for developers interested in contributing themes, modules, and translations to the Oqtane Marketplace. By sharing your creations with the Oqtane community, you can make your work accessible to users worldwide and contribute to the growth of the ecosystem.

+

Preparing Your Contributions

+

Before submitting your themes, modules, or translations to the Marketplace, it's essential to ensure they meet certain standards and requirements. This section outlines the steps you need to take to prepare your contributions for submission.

+

Submitting Themes

+

Themes play a crucial role in defining the appearance and user experience of Oqtane-based applications. Learn how to package and submit your themes to the Marketplace, making them available for users to enhance the visual aesthetics of their sites.

+

Submitting Modules

+

Modules provide additional functionality and features to Oqtane applications. This section guides you through the process of packaging and submitting your modules to the Marketplace, enabling users to extend the capabilities of their applications.

+

Submitting Translations

+

Translating applications into different languages enhances accessibility and usability for users worldwide. Discover how to prepare and submit your translations to the Marketplace, allowing users to customize their applications to suit their linguistic preferences.

+

Review Process

+

Once you've submitted your contributions to the Marketplace, they will undergo a review process to ensure quality and compatibility. This section provides an overview of the review process and what to expect during the evaluation of your submissions.

+

Making Updates

+

After your contributions are live on the Marketplace, you may need to make updates or revisions based on user feedback or changes in Oqtane's framework. Learn how to manage and update your submissions to provide the best possible experience for users.

+

Promoting Your Contributions

+

Promoting your themes, modules, and translations can help increase visibility and adoption within the Oqtane community. Discover strategies for effectively promoting your contributions and reaching a broader audience of users.

+

By following the guidelines outlined in this manual, you can contribute to the growth and development of the Oqtane ecosystem while showcasing your talents and expertise to the community.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/marketplace/using-oqtane-marketplace.html b/docs/guides/marketplace/using-oqtane-marketplace.html new file mode 100644 index 000000000..a542cc5e3 --- /dev/null +++ b/docs/guides/marketplace/using-oqtane-marketplace.html @@ -0,0 +1,124 @@ + + + + + Using The Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Using The Oqtane Marketplace

+ +

Overview

+

This manual will guide you through the process of using the Marketplace to enhance your Oqtane-based applications with themes, modules, and translations.

+

To get started, navigate to the Module Management administration page to use the Oqtane Marketplace from the Administration Dashboard of your Oqtane site. From there, you can browse, install, and manage various resources to customize and extend your applications.

+

Browsing and Discovering

+

The Marketplace offers a vast selection of themes, modules, and translations for you to explore. Learn how to navigate the Marketplace and discover new resources for your Oqtane applications.

+

Installing Resources

+

Once you've found the themes, modules, or translations you need, it's time to install them on your Oqtane site. This section will walk you through the installation process, ensuring that you can quickly and easily add new features to your applications.

+

Managing Installed Resources

+

After installing resources from the Marketplace, you may need to manage them from time to time. Whether you want to enable, disable, or uninstall a resource, this section will show you how to effectively manage your installed themes, modules, and translations.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/modules/creating-a-module.html b/docs/guides/modules/creating-a-module.html new file mode 100644 index 000000000..9b21cccfc --- /dev/null +++ b/docs/guides/modules/creating-a-module.html @@ -0,0 +1,145 @@ + + + + + Creating a Module | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Creating a Module

+ +

Learn how to create custom modules for Oqtane to extend its functionality and add new features to your applications.

+

Overview

+

Creating a module in Oqtane involves several steps, including setting up the project, defining module components, implementing functionality, and testing the module in different environments.

+

Getting Started

+

To create a module for Oqtane, follow these steps:

+
    +
  1. Use the Oqtane Administration Dashboard > Module Management Create Module button to scaffold a new module project.
    2. +
  2. Navigate to the project which will be located in the root folder of the Oqtane.Framework folder.
    3. +
  3. Open the solution file in another instance of Visual Studio and build the project.
    4. +
  4. Restart your Oqtane.Server Visual Studio application used to create the module.
    5. +
  5. Implement module components, including views, services, and controllers.
    6. +
  6. Define module configuration settings and permissions.
    7. +
  7. Test the module locally to ensure that it behaves as expected.
    8. +
  8. Package the module for distribution and installation on other Oqtane sites.
    9. +
+

Development Process

+

The module development process typically involves:

+
    +
  • Project setup and configuration
    • +
  • Component implementation and integration
    • +
  • Testing and debugging
    • +
  • Documentation and packaging
    • +
+

Best Practices

+
    +
  • Follow the Oqtane module development guidelines and coding standards.
    • +
  • Use dependency injection for managing dependencies and promoting modularity.
    • +
  • Utilize Oqtane services and APIs for interacting with the platform and accessing data.
    • +
  • Test your module in different environments to ensure compatibility and stability.
    • +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/modules/customizing-module-appearance.html b/docs/guides/modules/customizing-module-appearance.html new file mode 100644 index 000000000..370616717 --- /dev/null +++ b/docs/guides/modules/customizing-module-appearance.html @@ -0,0 +1,139 @@ + + + + + Customizing Module Appearance | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Customizing Module Appearance

+ +

Discover how to customize the appearance and styling of modules in Oqtane to match your site's design and branding.

+

Overview

+

Modules in Oqtane can be customized to align with your site's visual identity and user experience goals. By applying custom styles and design elements, you can enhance the look and feel of individual modules and create a cohesive user interface across your site.

+

Styling Options

+

To customize the appearance of modules in Oqtane, consider the following options:

+
    +
  • CSS stylesheets: Apply custom styles to module elements using CSS.
    • +
  • Theme integration: Integrate modules with your site's theme to ensure consistency in design and branding.
    • +
  • Bootstrap components: Utilize Bootstrap components and utilities for responsive and accessible design.
    • +
+

Implementation

+

To implement custom styling for modules in Oqtane, follow these steps:

+
    +
  1. Identify the module components and elements you want to customize.
    2. +
  2. Create CSS stylesheets or modify existing styles to achieve the desired appearance.
    3. +
  3. Apply the styles to the module components using class names or CSS selectors.
    4. +
  4. Test the custom styles across different devices and browsers to ensure compatibility and responsiveness.
    5. +
+

Best Practices

+
    +
  • Use modular CSS styles to facilitate maintenance and scalability.
    • +
  • Leverage Oqtane's theming capabilities to ensure consistent design across modules and pages.
    • +
  • Test custom styles in various scenarios to identify potential issues and ensure a seamless user experience.
    • +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/modules/index.html b/docs/guides/modules/index.html new file mode 100644 index 000000000..6f93af8ee --- /dev/null +++ b/docs/guides/modules/index.html @@ -0,0 +1,115 @@ + + + + + Module Development Guides | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Module Development Guides

+ + +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/modules/module-deployment.html b/docs/guides/modules/module-deployment.html new file mode 100644 index 000000000..f8e745535 --- /dev/null +++ b/docs/guides/modules/module-deployment.html @@ -0,0 +1,142 @@ + + + + + Module Deployment | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Module Deployment

+ +

Once you've developed and tested your module, it's time to deploy it to your Oqtane site. Deployment involves installing the module on your site and configuring it to meet your specific requirements.

+

Installing the Module

+

To install a module on your Oqtane site, follow these steps:

+
    +

  1. Access Module Management: Navigate to the Module Management section in the Administration Dashboard of your Oqtane site.

    +
    2. +

  2. Upload Module Package: Click on the "Upload Module" button and select the module package file (*.oqp) from your local machine.

    +
    3. +

  3. Install Module: Once the module package is uploaded, click on the "Install" button to initiate the installation process.

    +
    4. +

  4. Confirmation: After installation, you'll receive a confirmation message indicating that the module was installed successfully.

    +
    5. +
+

Activating the Module

+

Modules in Oqtane are typically activated automatically upon installation. However, if needed, you can adjust module permissions to control access to the module's features.

+

Configuring the Module

+

After installation, you may need to configure the module settings to suit your specific requirements. This can include setting up permissions, defining custom settings, or integrating the module with other components of your site.

+

Best Practices

+
    +

  • Testing: Before deploying the module to a production environment, thoroughly test it in a development or staging environment to ensure that it functions as expected.

    +
    • +

  • Documentation: Provide clear and comprehensive documentation for your module to help users understand its features and how to use them effectively.

    +
    • +

  • Version Control: Use version control systems like Git to manage the development and deployment of your module, allowing for easy tracking of changes and collaboration with other developers.

    +
    • +
+

By following these best practices, you can effectively deploy modules to your Oqtane site and enhance its functionality with custom features and capabilities.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/modules/module-development.html b/docs/guides/modules/module-development.html new file mode 100644 index 000000000..807801a61 --- /dev/null +++ b/docs/guides/modules/module-development.html @@ -0,0 +1,140 @@ + + + + + Module Development Basics | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Module Development Basics

+ +

This manual provides an introduction to module development in Oqtane, covering fundamental concepts and best practices.

+

Overview

+

Module development in Oqtane involves creating custom components that extend the platform's functionality. Whether you're building a simple module to display content or a complex module with advanced features, understanding the basics of module development is essential.

+

Getting Started

+

To begin developing modules for Oqtane, you'll need:

+
    +
  • A working knowledge of ASP.NET Core
    • +
  • Familiarity with client-side web development technologies (HTML, CSS, JavaScript)
    • +
  • Visual Studio or a similar IDE for .NET development
    • +
  • The Oqtane CLI for scaffolding new module projects
    • +
+

Key Concepts

+
    +
  • Module architecture and structure
    • +
  • Dependency injection
    • +
  • Module lifecycle events
    • +
  • Data access and storage
    • +
  • User interface components and interactions
    • +
+

Best Practices

+
    +
  • Follow the Oqtane module development guidelines and coding standards.
    • +
  • Test your modules thoroughly in different environments to ensure compatibility and stability.
    • +
  • Document your code and provide clear instructions for module installation and usage.
    • +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/modules/module-installation.html b/docs/guides/modules/module-installation.html new file mode 100644 index 000000000..3e3f25c60 --- /dev/null +++ b/docs/guides/modules/module-installation.html @@ -0,0 +1,132 @@ + + + + + Installing Modules | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Installing Modules

+ +

Learn how to install modules on your Oqtane site to extend its functionality and add new features.

+

Overview

+

To install modules on your Oqtane site, follow these steps:

+
    +
  1. Navigate to the Module Management section in the Administration Dashboard.
    2. +
  2. Click on the "Install Module" button.
    3. +
  3. Select the module package file (.nupkg) from your local system.
    4. +
  4. Click "Upload" to install the module.
    5. +
+

Installation Process

+
    +
  1. Navigate to the Module Management section in the Administration Dashboard.
    2. +
  2. Click on the "Install Module" button.
    3. +
  3. Browse your local system and select the module package file (.nupkg).
    4. +
  4. Click "Upload" to initiate the installation process.
    5. +
  5. Once the module is successfully installed, you'll see it listed in the Module Management section.
    6. +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/modules/modules.html b/docs/guides/modules/modules.html new file mode 100644 index 000000000..b9c487fc9 --- /dev/null +++ b/docs/guides/modules/modules.html @@ -0,0 +1,135 @@ + + + + + Modules | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Modules

+ +

Welcome to the Modules section of the Oqtane documentation. Here you'll find detailed guides on working with modules in your Oqtane-based applications. Whether you're adding new functionality, configuring existing modules, or troubleshooting issues, this section provides comprehensive resources to assist you.

+

What is a Module?

+

A module is a reusable, plug-and-play piece of functionality. It's a way to extend the functionality of the framework with whatever functionality you desire. Examples of modules could be photo galleries, blogs, rotators, forms, and so on. There can be multiple modules on a page and even multiple instances of the same module on a page. It's very common to see multiple HTML modules on a single page. +When you install Oqtane, the platform ships with a base set of modules already installed in the system. There are too many that come with the solution out of the box to list here, but suffice it to say that all modules needed for basic functionality within a website come with the solution. More modules can also be downloaded for use or modules that you can created can be uploaded.

+

installing-modules +installing-modules-2

+

Modules on Pages

+

Modules are placed onto pages in locations called “panes”. These panes are defined by the theme's designer. These themes dictates the overall look and feel of your site and is usually created by a front-end designer. Panes can span the full width of the page or be positioned in a column fashion. It may be helpful to think of panes as windows in the design of the site where you can drop in modules. You can move modules around the panes by using the content editor.

+

This is an example of a content pane.

+

content-pane

+

Topics

+
    +
  • Adding Modules: Learn how to add new modules to your Oqtane site to extend its functionality.
    • +
  • Working With Modules: Explore various tasks and operations related to managing installed modules on your site.
    • +
  • Installing Modules: Step-by-step instructions for installing modules on your Oqtane site.
    • +
  • Configurating Modules: Customize and configure module settings to suit your specific requirements.
    • +
  • Troubleshooting Modules: Troubleshooting tips and solutions for common issues encountered with modules.
    • +
  • Developing Modules: Resources and guidelines for developing custom modules for Oqtane.
    • +
+

Feel free to explore each topic to find the information you need to effectively work with modules in your Oqtane applications.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/themes/assets/placeholder.html b/docs/guides/themes/assets/placeholder.html new file mode 100644 index 000000000..560b16ef7 --- /dev/null +++ b/docs/guides/themes/assets/placeholder.html @@ -0,0 +1,114 @@ + + + + + | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/themes/index-old.html b/docs/guides/themes/index-old.html new file mode 100644 index 000000000..75ccccbce --- /dev/null +++ b/docs/guides/themes/index-old.html @@ -0,0 +1,126 @@ + + + + + | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ +

Overview

+

Get an overview of the themes section and its contents.

+

Theme Management

+

Explore theme management options, including installation, configuration, and troubleshooting.

+

Installation

+

Learn how to install themes on your Oqtane site to customize its appearance and enhance user experience.

+

Configuration

+

Explore the various configuration options available for themes in Oqtane and customize their settings to meet your specific requirements.

+

Troubleshooting

+

Encountering issues with theme installation or configuration? This section provides troubleshooting tips and solutions to common problems.

+

Developing Themes

+

Learn how to develop custom themes for your Oqtane site.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/themes/theme-configuration.html b/docs/guides/themes/theme-configuration.html new file mode 100644 index 000000000..3816a4932 --- /dev/null +++ b/docs/guides/themes/theme-configuration.html @@ -0,0 +1,152 @@ + + + + + Theme Configuration | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Theme Configuration

+ +

Overview

+

This manual provides guidance on configuring themes in Oqtane to customize their appearance and behavior according to your preferences.

+

To access theme configuration settings, navigate to the Theme Management section in the Administration Dashboard of your Oqtane site. You can find this section by following these steps:

+
    +
  1. Go to the Control Panel in the Administration Dashboard.
    2. +
  2. Select "Theme Management" from the menu to access the theme configuration page.
    3. +
+

From there, you can adjust various options and settings to tailor the theme to your needs.

+

Customization Options

+

Themes in Oqtane offer a range of customization options, including:

+
    +
  • Color schemes
    • +
  • Fonts and typography
    • +
  • Layout and design elements
    • +
  • Navigation menus
    • +
  • Widget placement and configuration
    • +
+

Step-by-Step Guide

+
    +
  1. Navigate to the Administration Dashboard of your Oqtane site.
    2. +
  2. Click on "Theme Management" to access the theme configuration page.
    3. +
  3. Select the theme you want to configure from the list of installed themes.
    4. +
  4. Explore the available customization options and settings.
    5. +
  5. Make adjustments as desired to customize the theme to your liking.
    6. +
  6. Save your changes to apply the configuration settings to the selected theme.
    7. +
+

Best Practices

+
    +
  • Experiment with different configuration options to find the look and feel that best suits your site.
    • +
  • Regularly review and update theme configuration settings to keep your site's design fresh and relevant.
    • +
  • Test the theme after making configuration changes to ensure that everything displays correctly and functions as expected.
    • +
+

By following these guidelines, you can effectively configure themes in Oqtane to create visually appealing and user-friendly websites.

+

Site Settings

+

To configure themes at the site level, navigate to the "Site Settings" section in the Control Panel's Administration Dashboard. Here, you can access theme configuration settings and customize the appearance of your entire site.

+

Page Management

+

To configure themes at the page level, access the "Page Management" section in the Control Panel. Click the "Edit" button next to the page you want to configure, and then navigate to the Appearance Configuration section. Here, you can customize the appearance of individual pages using theme-specific settings.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/themes/theme-development.html b/docs/guides/themes/theme-development.html new file mode 100644 index 000000000..568059c8c --- /dev/null +++ b/docs/guides/themes/theme-development.html @@ -0,0 +1,143 @@ + + + + + Developing Themes | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Developing Themes

+ +

Overview

+

This manual serves as a guide for developers who want to create custom themes for the Oqtane framework. Whether you're looking to customize the appearance of your own site or contribute themes to the Oqtane Marketplace, this guide will help you get started with theme development.

+

Getting Started

+

To begin developing themes for Oqtane, you'll need a basic understanding of HTML, CSS, and JavaScript. Familiarity with Razor syntax and Blazor components is also beneficial, as Oqtane themes are built using these technologies.

+

Theme Structure

+

Oqtane themes follow a modular structure and consist of various components, including:

+
    +
  • Layouts: Define the overall structure and design of the theme.
    • +
  • Views: Render content and components within the theme layout.
    • +
  • Stylesheets: Define the visual appearance and styling of theme elements.
    • +
  • JavaScript: Add interactivity and dynamic behavior to the theme.
    • +
+

Theme Development Tools

+

Several tools and resources are available to aid in theme development for Oqtane, including:

+
    +
  • Visual Studio: A lightweight and versatile code editor with support for HTML, CSS, and JavaScript. Visit Visual Studio for more information.
    • +
  • Visual Studio Code: A lightweight and versatile code editor with support for HTML, CSS, and JavaScript. Visit Visual Studio Code for more information.
    • +
  • Browser Developer Tools: Built-in tools for debugging and inspecting elements in web browsers (F12).
    • +
+

Best Practices

+

When developing themes for Oqtane, consider the following best practices:

+
    +
  • Keep your theme code modular, organized, and well-documented.
    • +
  • Optimize your theme assets (HTML, CSS, JavaScript) for performance and accessibility.
    • +
  • Test your theme across different browsers and devices to ensure compatibility and responsiveness.
    • +
  • Stay up to date with Oqtane updates and conventions to leverage the latest features and improvements.
    • +
+

By following these guidelines and best practices, you can create high-quality themes for Oqtane that enhance the visual appeal and usability of your applications.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/themes/theme-installation.html b/docs/guides/themes/theme-installation.html new file mode 100644 index 000000000..d99ead4ea --- /dev/null +++ b/docs/guides/themes/theme-installation.html @@ -0,0 +1,134 @@ + + + + + Theme Installation | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Theme Installation

+ +

Overview

+

This manual will guide you through the process of installing themes on your Oqtane site to customize its appearance and enhance user experience.

+

To get started, navigate to the Theme Management section in the Administration Dashboard of your Oqtane site. From there, you can browse and install themes from the available options.

+

Step-by-Step Guide

+
    +
  1. Navigate to the Administration Dashboard of your Oqtane site.
    2. +
  2. Click on "Theme Management" to access the theme installation page.
    3. +
  3. Browse the available themes and select the one you want to install.
    4. +
  4. Click on the "Install" button next to the chosen theme.
    5. +
  5. Follow any prompts or instructions provided to complete the installation process.
    6. +
  6. Once the installation is complete, the theme will be available for use on your Oqtane site.
    7. +
+

Additional Considerations

+
    +
  • Ensure that the theme you choose is compatible with your Oqtane site version.
    • +
  • Check for any dependencies or additional requirements specified by the theme developer.
    • +
  • Test the theme after installation to ensure that it displays correctly and functions as expected.
    • +
+

By following these steps, you can easily install themes on your Oqtane site and customize its appearance to suit your needs.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/themes/theme-management.html b/docs/guides/themes/theme-management.html new file mode 100644 index 000000000..49bcd0905 --- /dev/null +++ b/docs/guides/themes/theme-management.html @@ -0,0 +1,121 @@ + + + + + Theme Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Theme Management

+ +

Installation

+

Learn how to install themes on your Oqtane site to customize its appearance and enhance user experience.

+

Configuration

+

Explore the various configuration options available for themes in Oqtane and customize their settings to meet your specific requirements.

+

Troubleshooting

+

Encountering issues with theme installation or configuration? This section provides troubleshooting tips and solutions to common problems.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/troubleshooting/index.html b/docs/guides/troubleshooting/index.html new file mode 100644 index 000000000..aa16b1216 --- /dev/null +++ b/docs/guides/troubleshooting/index.html @@ -0,0 +1,151 @@ + + + + + Troubleshooting Guide | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Troubleshooting Guide

+ +

Introduction

+

This document provides troubleshooting tips for common issues encountered in the Oqtane Framework.

+

What is the Oqtane Troubleshooting Guide?

+

The Oqtane Troubleshooting Guide aims to assist users in resolving common problems related to login issues, user registration, system upgrades, and more. It serves as a comprehensive resource for both administrators and users facing challenges within the Oqtane Framework.

+

Next Steps

+

Read about:

+ +

Tasks to Complete

+

The following topics should be covered to enhance the troubleshooting guide:

+
    +
  1. Common login issues and their resolutions.
    2. +
  2. Registration verification steps and user management.
    3. +
  3. Best practices for maintaining SSL certificates.
    4. +
  4. Guidance on handling SMTP issues.
    5. +
  5. Common problems during upgrades and their resolutions.
    6. +
  6. Migration Troubleshooting: Steps for migrating environments, such as from development to production or server-to-server.
    7. +
  7. Data loss or corruption issues during migrations.
    8. +
  8. Troubleshooting installation failures and checking system requirements.
    9. +
  9. Resolving configuration issues post-installation.
    10. +
  10. Identifying and addressing performance bottlenecks.
    11. +
  11. Managing dependencies and troubleshooting related issues.
    12. +
  12. Troubleshooting user permissions and role management.
    13. +
  13. Common database-related problems and recovery steps.
    14. +
  14. Enabling and configuring logging for troubleshooting.
    15. +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/troubleshooting/troubleshooting-installations.html b/docs/guides/troubleshooting/troubleshooting-installations.html new file mode 100644 index 000000000..109e7636f --- /dev/null +++ b/docs/guides/troubleshooting/troubleshooting-installations.html @@ -0,0 +1,152 @@ + + + + + Installation Troubleshooting | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Installation Troubleshooting

+ +
+

Overview

+

Encountering issues during the installation process can be frustrating, but with the right troubleshooting steps, you can overcome common obstacles and successfully set up Oqtane. Below are some common troubleshooting tips for both Windows and Linux installations:

+
+

Windows Installation Troubleshooting

+

Windows Logo

+
    +

  • Check Prerequisites: Ensure that all prerequisites, such as .NET Framework, IIS, or SQL Server, are installed correctly and meet the minimum version requirements specified in the Oqtane documentation.

    +
    • +

  • Permissions: Verify that you have sufficient permissions to install and configure Oqtane. Running installation processes with administrative privileges can help resolve permission-related issues.

    +
    • +

  • Firewall and Antivirus: Temporarily disable firewall or antivirus software during the installation process, as they may interfere with file downloads or server connections.

    +
    • +

  • Error Logs: Check error logs generated during the installation process for any specific error messages or exceptions. These logs can provide valuable insights into the root cause of installation failures.

    +
    • +
+
+

Linux Installation Troubleshooting

+

Linux Logo

+
    +

  • Package Dependencies: Ensure that all required dependencies, such as Mono, Apache, MySQL, or PostgreSQL, are installed and configured correctly on your Linux system. Use package managers like apt or yum to install missing dependencies.

    +
    • +

  • File Permissions: Check file and directory permissions to ensure that the installation directory and relevant files are accessible by the installation process. Adjust permissions using chmod or chown commands as needed.

    +
    • +

  • Service Status: Verify the status of Apache or other web servers, as well as database services like MySQL or PostgreSQL, to ensure they are running properly. Restart services if necessary to resolve any issues.

    +
    • +

  • SELinux: If SELinux is enabled on your Linux system, it may restrict certain operations during the installation process. Temporarily disable SELinux or adjust its policies to allow necessary operations for Oqtane installation.

    +
    • +
+
+

Additional Resources

+

For further assistance and discussions on installation troubleshooting, you can explore the Oqtane Framework GitHub repository and review existing issues and discussions related to installation problems. Engaging with the community and seeking help from experienced users and developers can often provide valuable insights and solutions to resolve installation issues.

+ +

← Back to Installation Home

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/troubleshooting/troubleshooting-login-issues.html b/docs/guides/troubleshooting/troubleshooting-login-issues.html new file mode 100644 index 000000000..6a817892b --- /dev/null +++ b/docs/guides/troubleshooting/troubleshooting-login-issues.html @@ -0,0 +1,153 @@ + + + + + Troubleshooting Login Issues | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Troubleshooting Login Issues

+ +

Issue: Unable to log into a production website.

+

Potential Cause: An expired or improperly configured SSL certificate, or cookie issues.

+

Resolution Steps:

+
    +

  1. Check SSL Certificate:

    +
      +
    • Verify if the SSL certificate for the website is expired. You can check this by clicking on the padlock icon in the browser's address bar, which will display certificate details.
      • +
    • If the certificate is expired, you will need to renew it through your certificate authority (CA).
      • +
    +
    2. +

  2. Validate SSL Configuration:

    +
      +
    • Ensure that the SSL certificate is correctly installed and configured on the web server. Misconfigurations can lead to failed login attempts.
      • +
    • Use online tools (like SSL Labs) to test the SSL configuration and identify any issues.
      • +
    +
    3. +

  3. Update Certificate:

    +
      +
    • If the certificate is not properly set up, re-install or configure the certificate as per the guidelines provided by your CA or hosting provider.
      • +
    +
    4. +

  4. Refresh the Page:

    +
      +
    • Refresh the login page to ensure that any changes to cookies are reflected. This helps prevent logging in with an old cookie name that may no longer be valid. Use the following quick keys based on your browser: +
        +
      • Google Chrome / Firefox / Edge: F5 or Ctrl + R
        • +
      • Safari (macOS): Command + R
        • +
      • Internet Explorer: F5 or Ctrl + F5 (to refresh and bypass cache)
        • +
      +
      • +
    +
    5. +

  5. Test Login Again:

    +
      +
    • After resolving any SSL or cookie issues, attempt to log in to the website again.
      • +
    +
    6. +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/troubleshooting/troubleshooting-marketplace.html b/docs/guides/troubleshooting/troubleshooting-marketplace.html new file mode 100644 index 000000000..5cc156d89 --- /dev/null +++ b/docs/guides/troubleshooting/troubleshooting-marketplace.html @@ -0,0 +1,147 @@ + + + + + Troubleshooting in the Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Troubleshooting in the Oqtane Marketplace

+ +

Overview

+

Encountering issues while using the Oqtane Marketplace? This troubleshooting guide offers solutions to common problems and helps you resolve issues related to theme and module installation, compatibility, and other Marketplace functionalities.

+

Common Issues and Solutions

+

Learn about common issues that users may encounter when using the Oqtane Marketplace and how to troubleshoot them effectively. From installation errors to compatibility issues, this section provides step-by-step solutions to help you resolve issues quickly and get back to using the Marketplace.

+

Issue 1: Theme or Module Installation Error

+

Solution:

+

If you encounter an error while installing a theme or module from the Marketplace, follow these steps to troubleshoot the issue:

+
    +
  1. Check the error message for any specific details or error codes.
    2. +
  2. Ensure that your Oqtane site is running on a compatible version of the framework.
    3. +
  3. Verify that you have sufficient permissions to install themes or modules on your Oqtane site.
    4. +
  4. If the issue persists, try reinstalling the theme or module from the Marketplace.
    5. +
+

Issue 2: Compatibility Problems

+

Solution:

+

If you experience compatibility issues between themes, modules, or translations installed from the Marketplace and your Oqtane site, consider the following solutions:

+
    +
  1. Check the compatibility requirements specified by the theme or module developer.
    2. +
  2. Update your Oqtane site to the latest version to ensure compatibility with the latest themes and modules.
    3. +
  3. Contact the developer or support team for assistance if compatibility issues persist.
    4. +
+

Issue 3: Marketplace Navigation Problems

+

Solution:

+

If you encounter navigation problems or difficulties accessing certain sections of the Oqtane Marketplace, try the following troubleshooting steps:

+
    +
  1. Clear your browser cache and cookies to ensure that you have the latest version of the Marketplace interface.
    2. +
  2. Verify that your internet connection is stable and not experiencing any disruptions.
    3. +
  3. If the issue persists, try accessing the Marketplace from a different web browser or device to isolate the problem.
    4. +
+

Reporting Issues

+

If you encounter an issue that is not covered in this troubleshooting guide or need further assistance, you can report the problem to the Oqtane support team for investigation and resolution. Provide detailed information about the issue, including any error messages or screenshots, to help expedite the troubleshooting process.

+

By following the troubleshooting steps outlined in this guide and reporting any unresolved issues to the Oqtane support team, you can ensure a smooth and hassle-free experience while using the Oqtane Marketplace.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/troubleshooting/troubleshooting-modules.html b/docs/guides/troubleshooting/troubleshooting-modules.html new file mode 100644 index 000000000..bfaaafceb --- /dev/null +++ b/docs/guides/troubleshooting/troubleshooting-modules.html @@ -0,0 +1,132 @@ + + + + + Troubleshooting Modules | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Troubleshooting Modules

+ +

Encountering issues with module installation or configuration? Here are some common problems and solutions:

+

Common Issues

+

Module Not Installing

+

If you're having trouble installing a module, ensure that you have the correct module package and that it is compatible with your version of Oqtane. Also, check for any errors in the installation process.

+

Module Not Functioning Properly

+

If a module is not working as expected, verify that it is configured correctly and that any required dependencies are installed. Check the Oqtane logs for error messages or warnings that may indicate the cause of the issue.

+

Error Messages

+

If you encounter error messages during module installation or configuration, note down the error message and any accompanying details. Search for solutions online or consult the Oqtane community forums for assistance.

+

Troubleshooting Steps

+
    +
  1. Check Compatibility: Ensure that the module is compatible with your version of Oqtane and any other installed modules or themes.
    2. +
  2. Review Configuration: Double-check the module configuration settings to ensure that everything is configured correctly.
    3. +
  3. Inspect Logs: Look for error messages or warnings in the Oqtane log files, located in the /Logs directory of your Oqtane installation.
    4. +
  4. Update Dependencies: Make sure that all dependencies required by the module are up-to-date and installed correctly.
    5. +
  5. Contact Support: If you're unable to resolve the issue on your own, reach out to the module developer or the Oqtane community for assistance.
    6. +
+

By following these troubleshooting steps, you should be able to diagnose and resolve most module-related issues on your Oqtane site.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/troubleshooting/troubleshooting-themes.html b/docs/guides/troubleshooting/troubleshooting-themes.html new file mode 100644 index 000000000..c691b869f --- /dev/null +++ b/docs/guides/troubleshooting/troubleshooting-themes.html @@ -0,0 +1,137 @@ + + + + + Troubleshooting | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Troubleshooting

+ +

Encountering issues with theme installation or configuration? Here are some common problems and solutions:

+

Common Issues

+

Theme Not Installing

+

If you're having trouble installing a theme, ensure that you have the correct theme package and that it is compatible with your version of Oqtane. Also, check for any errors in the installation process.

+

Theme Appearance Not Changing

+

If you've installed a theme but don't see any changes on your site, try clearing your browser cache and refreshing the page. Additionally, check if the theme is activated and configured correctly in the Theme Management section.

+

Error Messages

+

If you encounter error messages during theme installation or configuration, note down the error message and any accompanying details. Search for solutions online or consult the Oqtane community forums for assistance.

+

Troubleshooting Steps

+
    +

  1. Check Compatibility: Ensure that the theme is compatible with your version of Oqtane and any other installed modules or themes.

    +
    2. +

  2. Review Configuration: Double-check the theme configuration settings to ensure that everything is configured correctly.

    +
    3. +

  3. Inspect Logs: Look for error messages or warnings in the Oqtane log files, located in the /Logs directory of your Oqtane installation.

    +
    4. +

  4. Update Dependencies: Make sure that all dependencies required by the theme are up-to-date and installed correctly.

    +
    5. +

  5. Contact Support: If you're unable to resolve the issue on your own, reach out to the theme developer or the Oqtane community for assistance.

    +
    6. +
+

By following these troubleshooting steps, you should be able to diagnose and resolve most theme-related issues on your Oqtane site.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/guides/troubleshooting/troubleshooting-user-registration-email-verification.html b/docs/guides/troubleshooting/troubleshooting-user-registration-email-verification.html new file mode 100644 index 000000000..22b0f0be2 --- /dev/null +++ b/docs/guides/troubleshooting/troubleshooting-user-registration-email-verification.html @@ -0,0 +1,145 @@ + + + + + Troubleshooting User Registration Email Verification | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Troubleshooting User Registration Email Verification

+ +

Issue: A user registers but is unable to verify their account.

+

Potential Cause: SMTP server issues or email lost in junk mail.

+

Resolution Steps:

+
    +

  1. Manually Update Email Confirmation:

    +
      +
    • If you know the user and trust their registration, you can manually update the EmailConfirmed field in the AspNetUsers database to true. This will allow the user to log in without verifying their email address.
      • +
    • Execute an SQL command similar to the following: +
      UPDATE AspNetUsers SET EmailConfirmed = `True` WHERE Email = 'user@example.com';
+
      +
      • +
    • Replace user@example.com with the actual email address of the user.
      • +
    +
    2. +

  2. Check Email Configuration:

    +
      +
    • Ensure that your SMTP server is correctly configured. Check the SMTP settings in your application to confirm that emails can be sent.
      • +
    +
    3. +

  3. Consider Deleting the User:

    +
      +
    • If the SMTP issue has been resolved, you may consider deleting the user and asking them to register again. This can help ensure that the user receives the verification email correctly.
      • +
    +
    4. +

  4. Feature Request:

    +
      +
    • A feature request to add an administrative function for confirming the email addresses of self-registered users has been made. You can track the progress of this request here. If accepted and a contribution is made, this feature may be included in version 6.0.0 or later.
      • +
    +
    5. +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ + + + diff --git a/docs/index.html b/docs/index.html index 3040dde48..9b06b67f6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,9 +2,9 @@ - Oqtane Documentation 5.1.2 | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + Oqtane Documentation 5.2.4 | Oqtane Docs - APIs and more for the Modular Blazor Application Framework - + @@ -84,7 +84,7 @@
Table of Contents
-

Oqtane Documentation 5.1.2

+

Oqtane Documentation 5.2.4

Oqtane is the Modular Application Framework for Blazor

diff --git a/docs/index.json b/docs/index.json index f975707a5..f30451dfa 100644 --- a/docs/index.json +++ b/docs/index.json @@ -2084,6 +2084,66 @@ "title": "Guides WIP | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Guides WIP This will probably become a main entry point to guide users through more complex topics. Note This is a quick thing to get people started. This contents may be moved elsewhere Current Guides 👉 Select from the menu External Guides / Valuable Articles Some helpful articles that are not part of the official documentation. Oqtane Official Blog BlazorHelpWebsite.com: Configuring The Blazor Oqtane Blog Module BlazorHelpWebsite.com: Creating a Custom Distribution of Blazor Oqtane Using Site Templates BlazorHelpWebsite.com: Oqtane Deploy to Azure BlazorHelpWebsite.com: Installing Blazor Oqtane BlazorHelpWebsite.com: Oqtane Module Creator BlazorHelpWebsite.com: What is Blazor Oqtane?" }, + "guides/installation/index.html": { + "href": "guides/installation/index.html", + "title": "Installation Guide | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Installation Guide" + }, + "guides/marketplace/index.html": { + "href": "guides/marketplace/index.html", + "title": "Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Oqtane Marketplace Introduction The Oqtane Marketplace is a central hub where users and developers can discover, share, and distribute themes, modules, and translations for the Oqtane framework. Whether you're a developer looking to showcase your creations or a user seeking new features and enhancements for your Oqtane-based application, the Marketplace provides a convenient platform to meet your needs. Using the Oqtane Marketplace Learn how to navigate the Oqtane Marketplace, find and install themes and modules, and explore the available offerings. This guide will walk you through the process of discovering and utilizing resources from the Marketplace to enhance your Oqtane experience. Submitting Contributions Are you a developer interested in sharing your themes, modules, or translations with the Oqtane community? This manual provides detailed instructions on how to prepare and submit your contributions to the Oqtane Marketplace, making them accessible to users worldwide. Monetization Options Discover opportunities for monetization within the Oqtane Marketplace. Whether you're interested in offering commercial products or exploring sponsorship and advertising options, this guide outlines various strategies for monetizing your contributions to the Oqtane ecosystem. Troubleshooting Encountering issues while using the Oqtane Marketplace? This troubleshooting guide offers solutions to common problems and helps you resolve issues related to theme and module installation, compatibility, and other Marketplace functionalities. Explore the Oqtane Marketplace and unleash the full potential of your Oqtane-based applications today!" + }, + "guides/marketplace/monetization.html": { + "href": "guides/marketplace/monetization.html", + "title": "Monetization Options in the Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Monetization Options in the Oqtane Marketplace Overview The Oqtane Marketplace offers various opportunities for developers to monetize their contributions, including themes, modules, and translations. Whether you're looking to generate revenue from your creations or support your development efforts, the Marketplace provides several monetization options to suit your needs. Pricing Models Explore different pricing models available in the Oqtane Marketplace, including free, freemium, subscription-based, and one-time purchase options. Learn how to choose the right pricing model for your products and maximize your revenue potential. Licensing and Usage Rights Understand the licensing and usage rights associated with products listed on the Oqtane Marketplace. From open-source licenses to commercial licenses, this section provides guidance on selecting the appropriate licensing model for your themes, modules, or translations. Payment Processing Learn about the payment processing options available for commercial products in the Oqtane Marketplace. Whether you prefer to use integrated payment gateways or manage transactions independently, this section covers the steps involved in setting up payment processing for your products. Sponsorship and Advertising Explore opportunities for sponsorship and advertising within the Oqtane Marketplace. From promoting your products to sponsoring specific features or sections of the Marketplace, this section discusses how to leverage sponsorship and advertising to increase visibility and reach a wider audience. Analytics and Reporting Gain insights into the performance of your products in the Oqtane Marketplace through analytics and reporting tools. Learn how to track key metrics such as downloads, revenue, and user engagement to optimize your monetization strategies and drive growth. Support and Maintenance Services Discover the value of offering support and maintenance services for your products listed on the Oqtane Marketplace. From providing timely updates and bug fixes to offering premium support packages, this section explores ways to enhance the customer experience and build long-term relationships with users. Promotional Strategies Develop effective promotional strategies to increase awareness and sales of your products in the Oqtane Marketplace. Whether through targeted marketing campaigns, cross-promotions with other developers, or participation in community events, this section offers practical tips for promoting your monetized offerings. By leveraging the monetization options available in the Oqtane Marketplace, you can turn your passion for development into a sustainable source of income while contributing to the growth and success of the Oqtane ecosystem." + }, + "guides/marketplace/submitting-contributions.html": { + "href": "guides/marketplace/submitting-contributions.html", + "title": "Submitting Contributions to the Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Submitting Contributions to the Oqtane Marketplace Overview This manual provides detailed instructions for developers interested in contributing themes, modules, and translations to the Oqtane Marketplace. By sharing your creations with the Oqtane community, you can make your work accessible to users worldwide and contribute to the growth of the ecosystem. Preparing Your Contributions Before submitting your themes, modules, or translations to the Marketplace, it's essential to ensure they meet certain standards and requirements. This section outlines the steps you need to take to prepare your contributions for submission. Submitting Themes Themes play a crucial role in defining the appearance and user experience of Oqtane-based applications. Learn how to package and submit your themes to the Marketplace, making them available for users to enhance the visual aesthetics of their sites. Submitting Modules Modules provide additional functionality and features to Oqtane applications. This section guides you through the process of packaging and submitting your modules to the Marketplace, enabling users to extend the capabilities of their applications. Submitting Translations Translating applications into different languages enhances accessibility and usability for users worldwide. Discover how to prepare and submit your translations to the Marketplace, allowing users to customize their applications to suit their linguistic preferences. Review Process Once you've submitted your contributions to the Marketplace, they will undergo a review process to ensure quality and compatibility. This section provides an overview of the review process and what to expect during the evaluation of your submissions. Making Updates After your contributions are live on the Marketplace, you may need to make updates or revisions based on user feedback or changes in Oqtane's framework. Learn how to manage and update your submissions to provide the best possible experience for users. Promoting Your Contributions Promoting your themes, modules, and translations can help increase visibility and adoption within the Oqtane community. Discover strategies for effectively promoting your contributions and reaching a broader audience of users. By following the guidelines outlined in this manual, you can contribute to the growth and development of the Oqtane ecosystem while showcasing your talents and expertise to the community." + }, + "guides/marketplace/using-oqtane-marketplace.html": { + "href": "guides/marketplace/using-oqtane-marketplace.html", + "title": "Using The Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Using The Oqtane Marketplace Overview This manual will guide you through the process of using the Marketplace to enhance your Oqtane-based applications with themes, modules, and translations. To get started, navigate to the Module Management administration page to use the Oqtane Marketplace from the Administration Dashboard of your Oqtane site. From there, you can browse, install, and manage various resources to customize and extend your applications. Browsing and Discovering The Marketplace offers a vast selection of themes, modules, and translations for you to explore. Learn how to navigate the Marketplace and discover new resources for your Oqtane applications. Installing Resources Once you've found the themes, modules, or translations you need, it's time to install them on your Oqtane site. This section will walk you through the installation process, ensuring that you can quickly and easily add new features to your applications. Managing Installed Resources After installing resources from the Marketplace, you may need to manage them from time to time. Whether you want to enable, disable, or uninstall a resource, this section will show you how to effectively manage your installed themes, modules, and translations." + }, + "guides/modules/creating-a-module.html": { + "href": "guides/modules/creating-a-module.html", + "title": "Creating a Module | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Creating a Module Learn how to create custom modules for Oqtane to extend its functionality and add new features to your applications. Overview Creating a module in Oqtane involves several steps, including setting up the project, defining module components, implementing functionality, and testing the module in different environments. Getting Started To create a module for Oqtane, follow these steps: Use the Oqtane Administration Dashboard > Module Management Create Module button to scaffold a new module project. Navigate to the project which will be located in the root folder of the Oqtane.Framework folder. Open the solution file in another instance of Visual Studio and build the project. Restart your Oqtane.Server Visual Studio application used to create the module. Implement module components, including views, services, and controllers. Define module configuration settings and permissions. Test the module locally to ensure that it behaves as expected. Package the module for distribution and installation on other Oqtane sites. Development Process The module development process typically involves: Project setup and configuration Component implementation and integration Testing and debugging Documentation and packaging Best Practices Follow the Oqtane module development guidelines and coding standards. Use dependency injection for managing dependencies and promoting modularity. Utilize Oqtane services and APIs for interacting with the platform and accessing data. Test your module in different environments to ensure compatibility and stability." + }, + "guides/modules/customizing-module-appearance.html": { + "href": "guides/modules/customizing-module-appearance.html", + "title": "Customizing Module Appearance | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Customizing Module Appearance Discover how to customize the appearance and styling of modules in Oqtane to match your site's design and branding. Overview Modules in Oqtane can be customized to align with your site's visual identity and user experience goals. By applying custom styles and design elements, you can enhance the look and feel of individual modules and create a cohesive user interface across your site. Styling Options To customize the appearance of modules in Oqtane, consider the following options: CSS stylesheets: Apply custom styles to module elements using CSS. Theme integration: Integrate modules with your site's theme to ensure consistency in design and branding. Bootstrap components: Utilize Bootstrap components and utilities for responsive and accessible design. Implementation To implement custom styling for modules in Oqtane, follow these steps: Identify the module components and elements you want to customize. Create CSS stylesheets or modify existing styles to achieve the desired appearance. Apply the styles to the module components using class names or CSS selectors. Test the custom styles across different devices and browsers to ensure compatibility and responsiveness. Best Practices Use modular CSS styles to facilitate maintenance and scalability. Leverage Oqtane's theming capabilities to ensure consistent design across modules and pages. Test custom styles in various scenarios to identify potential issues and ensure a seamless user experience." + }, + "guides/modules/index.html": { + "href": "guides/modules/index.html", + "title": "Module Development Guides | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Module Development Guides" + }, + "guides/modules/module-deployment.html": { + "href": "guides/modules/module-deployment.html", + "title": "Module Deployment | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Module Deployment Once you've developed and tested your module, it's time to deploy it to your Oqtane site. Deployment involves installing the module on your site and configuring it to meet your specific requirements. Installing the Module To install a module on your Oqtane site, follow these steps: Access Module Management: Navigate to the Module Management section in the Administration Dashboard of your Oqtane site. Upload Module Package: Click on the \"Upload Module\" button and select the module package file (*.oqp) from your local machine. Install Module: Once the module package is uploaded, click on the \"Install\" button to initiate the installation process. Confirmation: After installation, you'll receive a confirmation message indicating that the module was installed successfully. Activating the Module Modules in Oqtane are typically activated automatically upon installation. However, if needed, you can adjust module permissions to control access to the module's features. Configuring the Module After installation, you may need to configure the module settings to suit your specific requirements. This can include setting up permissions, defining custom settings, or integrating the module with other components of your site. Best Practices Testing: Before deploying the module to a production environment, thoroughly test it in a development or staging environment to ensure that it functions as expected. Documentation: Provide clear and comprehensive documentation for your module to help users understand its features and how to use them effectively. Version Control: Use version control systems like Git to manage the development and deployment of your module, allowing for easy tracking of changes and collaboration with other developers. By following these best practices, you can effectively deploy modules to your Oqtane site and enhance its functionality with custom features and capabilities." + }, + "guides/modules/module-development.html": { + "href": "guides/modules/module-development.html", + "title": "Module Development Basics | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Module Development Basics This manual provides an introduction to module development in Oqtane, covering fundamental concepts and best practices. Overview Module development in Oqtane involves creating custom components that extend the platform's functionality. Whether you're building a simple module to display content or a complex module with advanced features, understanding the basics of module development is essential. Getting Started To begin developing modules for Oqtane, you'll need: A working knowledge of ASP.NET Core Familiarity with client-side web development technologies (HTML, CSS, JavaScript) Visual Studio or a similar IDE for .NET development The Oqtane CLI for scaffolding new module projects Key Concepts Module architecture and structure Dependency injection Module lifecycle events Data access and storage User interface components and interactions Best Practices Follow the Oqtane module development guidelines and coding standards. Test your modules thoroughly in different environments to ensure compatibility and stability. Document your code and provide clear instructions for module installation and usage." + }, + "guides/modules/module-installation.html": { + "href": "guides/modules/module-installation.html", + "title": "Installing Modules | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Installing Modules Learn how to install modules on your Oqtane site to extend its functionality and add new features. Overview To install modules on your Oqtane site, follow these steps: Navigate to the Module Management section in the Administration Dashboard. Click on the \"Install Module\" button. Select the module package file (.nupkg) from your local system. Click \"Upload\" to install the module. Installation Process Navigate to the Module Management section in the Administration Dashboard. Click on the \"Install Module\" button. Browse your local system and select the module package file (.nupkg). Click \"Upload\" to initiate the installation process. Once the module is successfully installed, you'll see it listed in the Module Management section." + }, + "guides/modules/modules.html": { + "href": "guides/modules/modules.html", + "title": "Modules | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Modules Welcome to the Modules section of the Oqtane documentation. Here you'll find detailed guides on working with modules in your Oqtane-based applications. Whether you're adding new functionality, configuring existing modules, or troubleshooting issues, this section provides comprehensive resources to assist you. What is a Module? A module is a reusable, plug-and-play piece of functionality. It's a way to extend the functionality of the framework with whatever functionality you desire. Examples of modules could be photo galleries, blogs, rotators, forms, and so on. There can be multiple modules on a page and even multiple instances of the same module on a page. It's very common to see multiple HTML modules on a single page. When you install Oqtane, the platform ships with a base set of modules already installed in the system. There are too many that come with the solution out of the box to list here, but suffice it to say that all modules needed for basic functionality within a website come with the solution. More modules can also be downloaded for use or modules that you can created can be uploaded. Modules on Pages Modules are placed onto pages in locations called “panes”. These panes are defined by the theme's designer. These themes dictates the overall look and feel of your site and is usually created by a front-end designer. Panes can span the full width of the page or be positioned in a column fashion. It may be helpful to think of panes as windows in the design of the site where you can drop in modules. You can move modules around the panes by using the content editor. This is an example of a content pane. Topics Adding Modules: Learn how to add new modules to your Oqtane site to extend its functionality. Working With Modules: Explore various tasks and operations related to managing installed modules on your site. Installing Modules: Step-by-step instructions for installing modules on your Oqtane site. Configurating Modules: Customize and configure module settings to suit your specific requirements. Troubleshooting Modules: Troubleshooting tips and solutions for common issues encountered with modules. Developing Modules: Resources and guidelines for developing custom modules for Oqtane. Feel free to explore each topic to find the information you need to effectively work with modules in your Oqtane applications." + }, "guides/render/index.html": { "href": "guides/render/index.html", "title": "| Oqtane Docs - APIs and more for the Modular Blazor Application Framework", @@ -2094,11 +2154,21 @@ "title": "Oqtane Roadmap and History | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Oqtane Roadmap and History This page provides an overview of the Oqtane roadmap and history. It includes the current version, upcoming features, and the history of Oqtane. Roadmap This project is open source, and therefore is a work in progress... Backlog (TBD) 🔳 Azure Autoscale support (ie. web farm) 🔳 Folder Providers 🔳 Generative AI Integration Current Priorities 🔳 SSR Stabilization Release History Oqtane 5 (.net 8, SSR) Oqtane 5.1.1 (Apr 16, 2024) ✅ Stabilization improvements Oqtane 5.1.0 (Mar 27, 2024) Release Announcement Oqtane 5.1 ✅ Migration to the new unified Blazor approach in .NET 8 (ie. blazor.web.js) ✅ Static Server Rendering (SSR) support Oqtane 5.0.2 (Jan 25, 2024) ✅ Stabilization improvements Oqtane 5.0.1 (Dec 21, 2023) ✅ Stabilization improvements Oqtane 5.0.0 (Nov 16, 2023) Release Announcement Oqtane 5.0 ✅ Migration to .NET 8 Oqtane 4 (.net 7) Oqtane 4.0.6 (Oct 16, 2023) ✅ Stabilization improvements Oqtane 4.0.5 (Sep 26, 2023) ✅ Stabilization improvements Oqtane 4.0.4 (Sep 25, 2023) ✅ Stabilization improvements ✅ User Import Oqtane 4.0.3 (Aug 29, 2023) ✅ Stabilization improvements Oqtane 4.0.2 (Aug 9, 2023) ✅ Stabilization improvements Oqtane 4.0.1 (Jul 18, 2023) ✅ Stabilization improvements Oqtane 4.0.0 (Jun 26, 2023) Release Announcement Oqtane 4.0 ✅ Migration to .NET 7 ✅ Improved JavaScript, CSS, and Meta support ✅ Optimized Client Assembly Loading ✅ Routable Modules (ie. declarative configuration) ✅ Site Template improvements ✅ IEventSubscriber interface Oqtane 3 (.net 6, MAUI) Oqtane 3.4.3 (May 3, 2023) ✅ Stabilization improvements Oqtane 3.4.2 (Mar 29, 2023) ✅ Stabilization improvements Oqtane 3.4.1 (Mar 13, 2023) ✅ Stabilization improvements Oqtane 3.4.0 (Mar 12, 2023) Release Announcement Oqtane 3.4 ✅ Permissions performance optimization ✅ Connection string management improvements ✅ XML site map generator ✅ OIDC integration with User Profiles Oqtane 3.3.1 (Jan 14, 2023) ✅ Stabilization improvements Oqtane 3.3.0 (Jan 12, 2023) Release Announcement Oqtane 3.3 ✅ Dynamic Authorization Policies ✅ Entity-Level Permissions ✅ Extended Module Permissions Oqtane 3.2.1 (Oct 17, 2022) ✅ Stabilization improvements ✅ Server Event System Oqtane 3.2.0 (Sep 13, 2022) Release Announcement Oqtane 3.2 ✅ .NET MAUI / Blazor Hybrid support ✅ Upgrade to Bootstrap 5.2 Oqtane 3.1.3 (Jun 27, 2022) ✅ Stabilization improvements Oqtane 3.1.2 (May 14, 2022) ✅ Stabilization improvements Oqtane 3.1.1 (May 3, 2022) ✅ Stabilization improvements Oqtane 3.1.0 (Apr 5, 2022) Release Announcement Oqtane 3.1 ✅ User account lockout support ✅ Two factor authentication support ✅ Per-site configuration of password complexity, lockout criteria ✅ External login support via OAuth2 / OpenID Connect ✅ Support for Single Sign On (SSO) via OpenID Connect ✅ External client support via Jwt tokens ✅ Downstream API support via Jwt tokens ✅ CSS resource hierarchy support ✅ Site structure/content migration ✅ Event log notifications ✅ 404 page handling ✅ Property change component notifications ✅ Support for ES6 JavaScript modules Oqtane 3.0.3 ( Feb 15, 2022) ✅ Url fragment and anchor navigation support ✅ Meta tag support in page head ✅ Html/Text content versioning support Oqtane 3.0.2 ( Jan 16, 2022) ✅ Default alias specification, auto alias registration, redirect logic ✅ Improvements to visitor tracking and url mapping ✅ Scheduler enhancements for stop/start, weekly and one-time jobs ✅ Purge job for daily housekeeping of event log and visitors ✅ Granular security filtering for Settings Oqtane 3.0.1 ( Dec 12, 2021 ) ✅ Url mapping for broken links, content migration ✅ Visitor tracking for usage insights, personalization ✅ User experience improvements in Page and Module management Oqtane 3.0.0 ( Nov 11, 2021 ) Release Announcement Oqtane 3.0 ✅ Migration to .NET 6 ✅ Blazor hosting model flexibility per site ✅ Blazor WebAssembly prerendering support Oqtane 2 Oqtane 2.3.1 ( Sep 27, 2021 ) ✅ Complete UI migration to Bootstrap 5 and HTML5 form validation ✅ Improve module/theme installation and add support for commercial extensions ✅ Replace System.Drawing with ImageSharp ✅ Image resizing service Oqtane 2.2.0 ( Jul 6, 2021 ) Release Announcement Oqtane 2.2 ✅ Bootstrap 5 Upgrade ✅ Package Service integration ✅ Default and Shared Resource File inclusion ✅ Startup Error logging ✅ API Controller Validation and Logging Oqtane 2.1.0 ( Jun 4, 2021 ) Release Announcement Oqtane 2.1 ✅ Cross Platform Database Support ( ie. LocalDB, SQL Server, SQLite, MySQL, PostgreSQL ) - see #964 ✅ Utilize EF Core Migrations - see #964 ✅ Public Content Folder support ✅ Multi-tenant Infrastructure improvements ✅ User Authorization optimization ✅ Consolidation of Package Management ✅ Blazor Server Pre-rendering ✅ Translation Package installation support Oqtane 2.0.2 ( Apr 19, 2021 ) ✅ Assorted fixes and user experience improvements Oqtane 2.0.1 ( Feb 27, 2021 ) ✅ Complete Static Localization of Admin UI Oqtane 2.0.0 ( Nov 11, 2020 ) Release Announcement Oqtane 2.0 ✅ Migration to .NET 5 ✅ Static Localization ( ie. labels, help text, etc.. ) ✅ Improved JavaScript Reference Support ✅ Performance Optimizations ✅ Developer Productivity Enhancements Oqtane 1 Oqtane 1.0.0 ( May 19, 2020 ) Release Announcement Oqtane 1.0 ✅ Migration to .NET Core 3.2 ✅ Multi-Tenant ( Shared Database & Isolated Database ) ✅ Modular Architecture ✅ Headless API with Swagger Support ✅ Dynamic Page Compositing Model / Site & Page Management ✅ Authentication / User Management / Profile Management ✅ Authorization / Roles Management / Granular Permissions ✅ Dynamic Routing ✅ Extensibility via Custom Modules ✅ Extensibility via Custom Themes ✅ Event Logging / Audit Trail ✅ Folder / File Management ✅ Recycle Bin ✅ Scheduled Jobs ( Background Processing ) ✅ Notifications / Email Delivery ✅ Seamless Upgrade Experience ✅ Progressive Web Application Support ✅ JavaScript Lazy Loading ✅ Dynamic CSS/Lazy Loading Proof of Concept Oqtane POC ( May 9, 2019 ) Release Announcement Oqtane POC ✅ Initial public release on GitHub ✅ .NET Core 3.0" }, + "guides/themes/assets/placeholder.html": { + "href": "guides/themes/assets/placeholder.html", + "title": "| Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "" + }, "guides/themes/generator/index.html": { "href": "guides/themes/generator/index.html", "title": "Oqtane Themes Generator | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Oqtane Themes Generator Brief tutorial how to use the built-in Themes Generator. Oqtane helps you get started with themes by providing a built-in Themes generator. It will create a Visual Studio solution for you, containing all the necessary parts to start customizing your own theme. Start the Generator In your Oqtane site, go to /admin/themes to see the Themes management: Click on \"Create Theme\" and fill in the wizard as follows: Owner Name should be your company name or similar. It will be used in the Namespace of the generated code. Theme Name will be the technical name of the theme. It too will be used in the Namespace of your generated code. Template is meant to select from various templates, but as of now there is only one. Framework Reference is to decide what Oqtane (not .net Framework) your Theme will target, but as of now you can always only select the current framework running on your Oqtane. Location is where the generated code will be placed. It is best practice to put this side-by side to your Oqtane solution. Once you click on Create Theme you will see: Continue in Visual Studio The generator created this folder with a visual studio solution beside your Oqtane Framework folder: Next, open the solution file in that folder: You will now see 3 solutions according to best-practices: Build/Rebuild the Package Solution Build the Package solution to compile and copy the files to the Oqtane installation. Then start/restart Oqtane - see how to restart Oqtane. You should now see your new theme in the /system/themes section: You're all set That's it - you can start building / customizing your own theme now. Remember to read more about: Oqtane Extensions Building Extensions" }, + "guides/themes/index-old.html": { + "href": "guides/themes/index-old.html", + "title": "| Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Overview Get an overview of the themes section and its contents. Theme Management Explore theme management options, including installation, configuration, and troubleshooting. Installation Learn how to install themes on your Oqtane site to customize its appearance and enhance user experience. Configuration Explore the various configuration options available for themes in Oqtane and customize their settings to meet your specific requirements. Troubleshooting Encountering issues with theme installation or configuration? This section provides troubleshooting tips and solutions to common problems. Developing Themes Learn how to develop custom themes for your Oqtane site." + }, "guides/themes/index.html": { "href": "guides/themes/index.html", "title": "Oqtane Themes Guide | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", @@ -2124,115 +2194,215 @@ "title": "Themes Guide - Parts of a Theme | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Themes Guide - Parts of a Theme Oqtane themes - when installed - consist of the following core parts: A DLL file that contains the compiled Blazor components. JS and CSS files in wwwroot/Themes/[your-theme-name]." }, + "guides/themes/theme-configuration.html": { + "href": "guides/themes/theme-configuration.html", + "title": "Theme Configuration | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Theme Configuration Overview This manual provides guidance on configuring themes in Oqtane to customize their appearance and behavior according to your preferences. To access theme configuration settings, navigate to the Theme Management section in the Administration Dashboard of your Oqtane site. You can find this section by following these steps: Go to the Control Panel in the Administration Dashboard. Select \"Theme Management\" from the menu to access the theme configuration page. From there, you can adjust various options and settings to tailor the theme to your needs. Customization Options Themes in Oqtane offer a range of customization options, including: Color schemes Fonts and typography Layout and design elements Navigation menus Widget placement and configuration Step-by-Step Guide Navigate to the Administration Dashboard of your Oqtane site. Click on \"Theme Management\" to access the theme configuration page. Select the theme you want to configure from the list of installed themes. Explore the available customization options and settings. Make adjustments as desired to customize the theme to your liking. Save your changes to apply the configuration settings to the selected theme. Best Practices Experiment with different configuration options to find the look and feel that best suits your site. Regularly review and update theme configuration settings to keep your site's design fresh and relevant. Test the theme after making configuration changes to ensure that everything displays correctly and functions as expected. By following these guidelines, you can effectively configure themes in Oqtane to create visually appealing and user-friendly websites. Site Settings To configure themes at the site level, navigate to the \"Site Settings\" section in the Control Panel's Administration Dashboard. Here, you can access theme configuration settings and customize the appearance of your entire site. Page Management To configure themes at the page level, access the \"Page Management\" section in the Control Panel. Click the \"Edit\" button next to the page you want to configure, and then navigate to the Appearance Configuration section. Here, you can customize the appearance of individual pages using theme-specific settings." + }, + "guides/themes/theme-development.html": { + "href": "guides/themes/theme-development.html", + "title": "Developing Themes | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Developing Themes Overview This manual serves as a guide for developers who want to create custom themes for the Oqtane framework. Whether you're looking to customize the appearance of your own site or contribute themes to the Oqtane Marketplace, this guide will help you get started with theme development. Getting Started To begin developing themes for Oqtane, you'll need a basic understanding of HTML, CSS, and JavaScript. Familiarity with Razor syntax and Blazor components is also beneficial, as Oqtane themes are built using these technologies. Theme Structure Oqtane themes follow a modular structure and consist of various components, including: Layouts: Define the overall structure and design of the theme. Views: Render content and components within the theme layout. Stylesheets: Define the visual appearance and styling of theme elements. JavaScript: Add interactivity and dynamic behavior to the theme. Theme Development Tools Several tools and resources are available to aid in theme development for Oqtane, including: Visual Studio: A lightweight and versatile code editor with support for HTML, CSS, and JavaScript. Visit Visual Studio for more information. Visual Studio Code: A lightweight and versatile code editor with support for HTML, CSS, and JavaScript. Visit Visual Studio Code for more information. Browser Developer Tools: Built-in tools for debugging and inspecting elements in web browsers (F12). Best Practices When developing themes for Oqtane, consider the following best practices: Keep your theme code modular, organized, and well-documented. Optimize your theme assets (HTML, CSS, JavaScript) for performance and accessibility. Test your theme across different browsers and devices to ensure compatibility and responsiveness. Stay up to date with Oqtane updates and conventions to leverage the latest features and improvements. By following these guidelines and best practices, you can create high-quality themes for Oqtane that enhance the visual appeal and usability of your applications." + }, + "guides/themes/theme-installation.html": { + "href": "guides/themes/theme-installation.html", + "title": "Theme Installation | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Theme Installation Overview This manual will guide you through the process of installing themes on your Oqtane site to customize its appearance and enhance user experience. To get started, navigate to the Theme Management section in the Administration Dashboard of your Oqtane site. From there, you can browse and install themes from the available options. Step-by-Step Guide Navigate to the Administration Dashboard of your Oqtane site. Click on \"Theme Management\" to access the theme installation page. Browse the available themes and select the one you want to install. Click on the \"Install\" button next to the chosen theme. Follow any prompts or instructions provided to complete the installation process. Once the installation is complete, the theme will be available for use on your Oqtane site. Additional Considerations Ensure that the theme you choose is compatible with your Oqtane site version. Check for any dependencies or additional requirements specified by the theme developer. Test the theme after installation to ensure that it displays correctly and functions as expected. By following these steps, you can easily install themes on your Oqtane site and customize its appearance to suit your needs." + }, + "guides/themes/theme-management.html": { + "href": "guides/themes/theme-management.html", + "title": "Theme Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Theme Management Installation Learn how to install themes on your Oqtane site to customize its appearance and enhance user experience. Configuration Explore the various configuration options available for themes in Oqtane and customize their settings to meet your specific requirements. Troubleshooting Encountering issues with theme installation or configuration? This section provides troubleshooting tips and solutions to common problems." + }, + "guides/troubleshooting/index.html": { + "href": "guides/troubleshooting/index.html", + "title": "Troubleshooting Guide | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Troubleshooting Guide Introduction This document provides troubleshooting tips for common issues encountered in the Oqtane Framework. What is the Oqtane Troubleshooting Guide? The Oqtane Troubleshooting Guide aims to assist users in resolving common problems related to login issues, user registration, system upgrades, and more. It serves as a comprehensive resource for both administrators and users facing challenges within the Oqtane Framework. Next Steps Read about: Troubleshooting Login Issues Troubleshooting User Registration Email Verification Installation Troubleshooting Instructions for resolving installation problems and verifying system requirements. Marketplace Troubleshooting Solutions for common challenges encountered in the Oqtane Marketplace. Modules Troubleshooting Guidance on resolving issues with module installation, compatibility, and functionality. Themes Troubleshooting Tips for addressing layout, styling, and rendering issues in Oqtane themes. Tasks to Complete The following topics should be covered to enhance the troubleshooting guide: Common login issues and their resolutions. Registration verification steps and user management. Best practices for maintaining SSL certificates. Guidance on handling SMTP issues. Common problems during upgrades and their resolutions. Migration Troubleshooting: Steps for migrating environments, such as from development to production or server-to-server. Data loss or corruption issues during migrations. Troubleshooting installation failures and checking system requirements. Resolving configuration issues post-installation. Identifying and addressing performance bottlenecks. Managing dependencies and troubleshooting related issues. Troubleshooting user permissions and role management. Common database-related problems and recovery steps. Enabling and configuring logging for troubleshooting." + }, + "guides/troubleshooting/troubleshooting-installations.html": { + "href": "guides/troubleshooting/troubleshooting-installations.html", + "title": "Installation Troubleshooting | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Installation Troubleshooting Overview Encountering issues during the installation process can be frustrating, but with the right troubleshooting steps, you can overcome common obstacles and successfully set up Oqtane. Below are some common troubleshooting tips for both Windows and Linux installations: Windows Installation Troubleshooting Check Prerequisites: Ensure that all prerequisites, such as .NET Framework, IIS, or SQL Server, are installed correctly and meet the minimum version requirements specified in the Oqtane documentation. Permissions: Verify that you have sufficient permissions to install and configure Oqtane. Running installation processes with administrative privileges can help resolve permission-related issues. Firewall and Antivirus: Temporarily disable firewall or antivirus software during the installation process, as they may interfere with file downloads or server connections. Error Logs: Check error logs generated during the installation process for any specific error messages or exceptions. These logs can provide valuable insights into the root cause of installation failures. Linux Installation Troubleshooting Package Dependencies: Ensure that all required dependencies, such as Mono, Apache, MySQL, or PostgreSQL, are installed and configured correctly on your Linux system. Use package managers like apt or yum to install missing dependencies. File Permissions: Check file and directory permissions to ensure that the installation directory and relevant files are accessible by the installation process. Adjust permissions using chmod or chown commands as needed. Service Status: Verify the status of Apache or other web servers, as well as database services like MySQL or PostgreSQL, to ensure they are running properly. Restart services if necessary to resolve any issues. SELinux: If SELinux is enabled on your Linux system, it may restrict certain operations during the installation process. Temporarily disable SELinux or adjust its policies to allow necessary operations for Oqtane installation. Additional Resources For further assistance and discussions on installation troubleshooting, you can explore the Oqtane Framework GitHub repository and review existing issues and discussions related to installation problems. Engaging with the community and seeking help from experienced users and developers can often provide valuable insights and solutions to resolve installation issues. Oqtane Supported Databases Oqtane Installation Resources ← Back to Installation Home" + }, + "guides/troubleshooting/troubleshooting-login-issues.html": { + "href": "guides/troubleshooting/troubleshooting-login-issues.html", + "title": "Troubleshooting Login Issues | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Troubleshooting Login Issues Issue: Unable to log into a production website. Potential Cause: An expired or improperly configured SSL certificate, or cookie issues. Resolution Steps: Check SSL Certificate: Verify if the SSL certificate for the website is expired. You can check this by clicking on the padlock icon in the browser's address bar, which will display certificate details. If the certificate is expired, you will need to renew it through your certificate authority (CA). Validate SSL Configuration: Ensure that the SSL certificate is correctly installed and configured on the web server. Misconfigurations can lead to failed login attempts. Use online tools (like SSL Labs) to test the SSL configuration and identify any issues. Update Certificate: If the certificate is not properly set up, re-install or configure the certificate as per the guidelines provided by your CA or hosting provider. Refresh the Page: Refresh the login page to ensure that any changes to cookies are reflected. This helps prevent logging in with an old cookie name that may no longer be valid. Use the following quick keys based on your browser: Google Chrome / Firefox / Edge: F5 or Ctrl + R Safari (macOS): Command + R Internet Explorer: F5 or Ctrl + F5 (to refresh and bypass cache) Test Login Again: After resolving any SSL or cookie issues, attempt to log in to the website again." + }, + "guides/troubleshooting/troubleshooting-marketplace.html": { + "href": "guides/troubleshooting/troubleshooting-marketplace.html", + "title": "Troubleshooting in the Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Troubleshooting in the Oqtane Marketplace Overview Encountering issues while using the Oqtane Marketplace? This troubleshooting guide offers solutions to common problems and helps you resolve issues related to theme and module installation, compatibility, and other Marketplace functionalities. Common Issues and Solutions Learn about common issues that users may encounter when using the Oqtane Marketplace and how to troubleshoot them effectively. From installation errors to compatibility issues, this section provides step-by-step solutions to help you resolve issues quickly and get back to using the Marketplace. Issue 1: Theme or Module Installation Error Solution: If you encounter an error while installing a theme or module from the Marketplace, follow these steps to troubleshoot the issue: Check the error message for any specific details or error codes. Ensure that your Oqtane site is running on a compatible version of the framework. Verify that you have sufficient permissions to install themes or modules on your Oqtane site. If the issue persists, try reinstalling the theme or module from the Marketplace. Issue 2: Compatibility Problems Solution: If you experience compatibility issues between themes, modules, or translations installed from the Marketplace and your Oqtane site, consider the following solutions: Check the compatibility requirements specified by the theme or module developer. Update your Oqtane site to the latest version to ensure compatibility with the latest themes and modules. Contact the developer or support team for assistance if compatibility issues persist. Issue 3: Marketplace Navigation Problems Solution: If you encounter navigation problems or difficulties accessing certain sections of the Oqtane Marketplace, try the following troubleshooting steps: Clear your browser cache and cookies to ensure that you have the latest version of the Marketplace interface. Verify that your internet connection is stable and not experiencing any disruptions. If the issue persists, try accessing the Marketplace from a different web browser or device to isolate the problem. Reporting Issues If you encounter an issue that is not covered in this troubleshooting guide or need further assistance, you can report the problem to the Oqtane support team for investigation and resolution. Provide detailed information about the issue, including any error messages or screenshots, to help expedite the troubleshooting process. By following the troubleshooting steps outlined in this guide and reporting any unresolved issues to the Oqtane support team, you can ensure a smooth and hassle-free experience while using the Oqtane Marketplace." + }, + "guides/troubleshooting/troubleshooting-modules.html": { + "href": "guides/troubleshooting/troubleshooting-modules.html", + "title": "Troubleshooting Modules | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Troubleshooting Modules Encountering issues with module installation or configuration? Here are some common problems and solutions: Common Issues Module Not Installing If you're having trouble installing a module, ensure that you have the correct module package and that it is compatible with your version of Oqtane. Also, check for any errors in the installation process. Module Not Functioning Properly If a module is not working as expected, verify that it is configured correctly and that any required dependencies are installed. Check the Oqtane logs for error messages or warnings that may indicate the cause of the issue. Error Messages If you encounter error messages during module installation or configuration, note down the error message and any accompanying details. Search for solutions online or consult the Oqtane community forums for assistance. Troubleshooting Steps Check Compatibility: Ensure that the module is compatible with your version of Oqtane and any other installed modules or themes. Review Configuration: Double-check the module configuration settings to ensure that everything is configured correctly. Inspect Logs: Look for error messages or warnings in the Oqtane log files, located in the /Logs directory of your Oqtane installation. Update Dependencies: Make sure that all dependencies required by the module are up-to-date and installed correctly. Contact Support: If you're unable to resolve the issue on your own, reach out to the module developer or the Oqtane community for assistance. By following these troubleshooting steps, you should be able to diagnose and resolve most module-related issues on your Oqtane site." + }, + "guides/troubleshooting/troubleshooting-themes.html": { + "href": "guides/troubleshooting/troubleshooting-themes.html", + "title": "Troubleshooting | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Troubleshooting Encountering issues with theme installation or configuration? Here are some common problems and solutions: Common Issues Theme Not Installing If you're having trouble installing a theme, ensure that you have the correct theme package and that it is compatible with your version of Oqtane. Also, check for any errors in the installation process. Theme Appearance Not Changing If you've installed a theme but don't see any changes on your site, try clearing your browser cache and refreshing the page. Additionally, check if the theme is activated and configured correctly in the Theme Management section. Error Messages If you encounter error messages during theme installation or configuration, note down the error message and any accompanying details. Search for solutions online or consult the Oqtane community forums for assistance. Troubleshooting Steps Check Compatibility: Ensure that the theme is compatible with your version of Oqtane and any other installed modules or themes. Review Configuration: Double-check the theme configuration settings to ensure that everything is configured correctly. Inspect Logs: Look for error messages or warnings in the Oqtane log files, located in the /Logs directory of your Oqtane installation. Update Dependencies: Make sure that all dependencies required by the theme are up-to-date and installed correctly. Contact Support: If you're unable to resolve the issue on your own, reach out to the theme developer or the Oqtane community for assistance. By following these troubleshooting steps, you should be able to diagnose and resolve most theme-related issues on your Oqtane site." + }, + "guides/troubleshooting/troubleshooting-user-registration-email-verification.html": { + "href": "guides/troubleshooting/troubleshooting-user-registration-email-verification.html", + "title": "Troubleshooting User Registration Email Verification | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Troubleshooting User Registration Email Verification Issue: A user registers but is unable to verify their account. Potential Cause: SMTP server issues or email lost in junk mail. Resolution Steps: Manually Update Email Confirmation: If you know the user and trust their registration, you can manually update the EmailConfirmed field in the AspNetUsers database to true. This will allow the user to log in without verifying their email address. Execute an SQL command similar to the following: UPDATE AspNetUsers SET EmailConfirmed = `True` WHERE Email = 'user@example.com'; Replace user@example.com with the actual email address of the user. Check Email Configuration: Ensure that your SMTP server is correctly configured. Check the SMTP settings in your application to confirm that emails can be sent. Consider Deleting the User: If the SMTP issue has been resolved, you may consider deleting the user and asking them to register again. This can help ensure that the user receives the verification email correctly. Feature Request: A feature request to add an administrative function for confirming the email addresses of self-registered users has been made. You can track the progress of this request here. If accepted and a contribution is made, this feature may be included in version 6.0.0 or later." + }, "index.html": { "href": "index.html", - "title": "Oqtane Documentation 5.1.2 | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Oqtane Documentation 5.1.2 Oqtane is the Modular Application Framework for Blazor Modern, Flexible, and Open Source - running on .net 8.0! Documentation Contents In Guides you'll find background infos etc. The Administration Manuals is WIP In the API Documentation you'll find all the APIs To work on the docs, better read up on how the docs work Join Our Community For more interactive discussions and community support, join us on Discord! Happy documenting!" + "title": "Oqtane Documentation 5.2.4 | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Oqtane Documentation 5.2.4 Oqtane is the Modular Application Framework for Blazor Modern, Flexible, and Open Source - running on .net 8.0! Documentation Contents In Guides you'll find background infos etc. The Administration Manuals is WIP In the API Documentation you'll find all the APIs To work on the docs, better read up on how the docs work Join Our Community For more interactive discussions and community support, join us on Discord! Happy documenting!" }, - "manuals/admin/admin-dashboard/file-management.html": { - "href": "manuals/admin/admin-dashboard/file-management.html", + "manuals/admin/admin-management/file-management.html": { + "href": "manuals/admin/admin-management/file-management.html", "title": "File Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "File Management Nearly everything you could need to do with files and folders in Oqtane can be done from this view. You have the ability to upload, edit, and delete files and folders. You can also control where files are stored and what permissions should be applied to which folders. Folder permissions specified by roles allow you to determine who can see folders and files and who is allowed to modify the contents of a folder. The options provided by the file manager are: A drop down menu to select the file in which you what your view to placed in. Edit Folder: Lets you change the parent of the folder, the name of the folder, and the permissions for what roles are able to see and access the folder and its files. Add Folder: Allows you to create a new folder with the ability to choose a name, parent folder, and permissions to access. Upload Files: This is the feature that allows for user to upload files like images from their local system to a folder in Oqtane and allows for files to downloaded from Oqtane to their local system." }, - "manuals/admin/admin-dashboard/index.html": { - "href": "manuals/admin/admin-dashboard/index.html", - "title": "Admin Dashboard | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Admin Dashboard The admin dashboard has a variety of different tools for administrators to use in order to better manage their website and to add a great amount of functionality to the website. By selecting the gear icon in the top right of a page while being on an administrator account, then selecting the admin dashboard option at the top of the control panel, which will bring up a menu with a variety of options that can be selected. The default options in the dashboard that Oqtane offers for an administrator to use are: Site Settings: Which provides a variety of settings to be able to modify and personalize your website with more information in the site settings. Page Management: Which provides a list of all pages on your website and provides the ability to to manipulate them in a variety of ways with more info on page management. User Management: Which allows for the additional and modification of user accounts with more info on user management. Profile Management: Which lets you specify what informational fields are available for a user to both optionally have and must have on their account with more info on profile management. Role Management: Which specifies what type of security group the user's account belongs in like giving an account administrative rights, with more info on role management. File Management: Which allows the uploading of files like images to be inserted into pages with more info on file management. Recycle Bin: Which allows for the restoration or full deletion of pages that were previously deleted with more info on recycle bin. If you want to add new options to the admin dashboard, then that can be done by creating a new page either in the control panel or in the admin dashboard's page management and specifying that you want \"Admin\" as the parent of the new page." + "manuals/admin/admin-management/index.html": { + "href": "manuals/admin/admin-management/index.html", + "title": "Admin Management Introduction | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Admin Management Introduction The admin dashboard has a variety of different tools for administrators to use in order to better manage their website and to add a great amount of functionality to the website. By selecting the gear icon in the top right of a page while being on an administrator account, then selecting the admin dashboard option at the top of the control panel, which will bring up a menu with a variety of options that can be selected. The default options in the dashboard that Oqtane offers for an administrator to use are: Site Settings: Which provides a variety of settings to be able to modify and personalize your website with more information in the site settings. Page Management: Which provides a list of all pages on your website and provides the ability to to manipulate them in a variety of ways with more info on page management. User Management: Which allows for the additional and modification of user accounts with more info on user management. Profile Management: Which lets you specify what informational fields are available for a user to both optionally have and must have on their account with more info on profile management. Role Management: Which specifies what type of security group the user's account belongs in like giving an account administrative rights, with more info on role management. File Management: Which allows the uploading of files like images to be inserted into pages with more info on file management. Recycle Bin: Which allows for the restoration or full deletion of pages that were previously deleted with more info on recycle bin. If you want to add new options to the admin dashboard, then that can be done by creating a new page either in the control panel or in the admin dashboard's page management and specifying that you want \"Admin\" as the parent of the new page." + }, + "manuals/admin/admin-management/language-management.html": { + "href": "manuals/admin/admin-management/language-management.html", + "title": "Language Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Language Management This document describes the Language Management module, settings, and configuration for administrators to manage language resources effectively across their Oqtane site. Overview The Language Management feature allows administrators to manage translations for their site, ensuring that the site content is available in multiple languages, enhancing accessibility and user experience. Control Panel Walkthrough Accessing the Language Management Feature Click the control panel icon to access additional settings. In the control panel, select the button to open the admin dashboard. In the admin dashboard, click on the Language Management icon to configure your language resources. Configuring Language Management Once in the Language Management settings, administrators can view and manage language resources. Main Index Page The Language Management main index page displays all installed languages. The list includes the name of each language, along with options to edit or delete (except for the default English language). Adding a Language Use the Add Language button to open a popup modal for adding a new language. In the popup, select the language by name and set it as default using the Yes/No dropdown options. Searching Languages The search feature allows administrators to filter through installed languages, which is particularly helpful when many languages are available. Reviewing and Editing Languages To edit an existing language, click the Edit button next to the desired language. This will open the edit popup, where you can modify the language settings. You can set the language as default using the Yes/No dropdown option. To delete a language, click the Delete button next to the language. Note that the default English language cannot be deleted. Conclusion The Language Management module in Oqtane provides an effective way for administrators to manage language resources and translations. By leveraging the features outlined in this manual, site administrators can enhance user experience and ensure their content is accessible in multiple languages." }, - "manuals/admin/admin-dashboard/page-management.html": { - "href": "manuals/admin/admin-dashboard/page-management.html", + "manuals/admin/admin-management/page-management.html": { + "href": "manuals/admin/admin-management/page-management.html", "title": "Page Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Page Management Pretty much every website starts out as one thing first and foremost: a collection of pages that constitute a web presence. Each page will have a purpose (we hope) and serve it well. As you have seen after the default installation of Oqtane, you are even given a home page to work with on the first load of your new site. Your next step might be to create additional pages, such as About Us, Contact Us, and more. As your site continues to become successful and grows to meet the needs of your customers and other visitors, you will undoubtedly begin to have more and more pages on your site. You'll have so many that at some point you will need to manage them from a centralized location. In other cases, you might have pages that are hidden from the menu and are not easily accessible. This is where the Page Management feature comes in to allow for a larger overview of the pages on your website, with all pages on your website viewable in a list format. These pages can be manipulated in the page manager by being able to add, edit, and delete pages. Add The add feature adds a new page to your website and brings up the page management window, which allows you to specify the settings, appearance, and permissions for the page you are adding. The fields which exist in the page management window are the: Settings Name: Which specifies the name that will be displayed in the navigation bar. Parent: Which will specify the page that this page will be underneath, meaning that the added page will be put to the right of the page specified in the navigation bar at the top. Insert: Specify where the name for the page will appear in the navigation bar, by saying where the page should appear among all of the children of the parent that has been selected. Navigation: Say whether you want the page to be displayed to users that fit within the permissions, or if you want the page to be hidden to everyone but administrators which can be useful while editing a page. URL Path: The url is what is put in the web page's address, for example if the url path is set to page1 then the address might be www.website/page1.com. If no URL path is specified then the URL will by default be set to be the same as the name field above. Redirect: Input a URL that is the same as the URL path of another page in the site that user will be sent to, remember that if no URL path is specified for another page then the name will be used. If this feature is implemented then you will not be able stay on the page to use the control panel's page manager, so you will need to edit or delete page's with this feature. Appearance Title: The name that is displayed on the web page's tab. Theme: The theme that the web page will take on. In the admin dashboard's theme management feature you can see more information on these theme and import new themes to be used. Default Container: Choose the layout of modules for the page, like hw the titles typically displayed above the modules will be. Icon: Input a favicon address or other icon address to include an icon beside the name of your page. Personalizable: This feature gives a page that is unique to every individual and allows them to add modules and edit the content of the page, so only the individual can see what they put onto the page. Permissions View: This is what allows different users to see certain pages and any users that are within certain roles, that can be specified in the admin dashboard's role management feature will be able to see or not see the page depending on what you have checked the box for the role they fit into. Edit: This allows users that fit into the specified roles to be able to edit pages using the content editor. Specific Users: The permissions tab also has the ability for you to enter a specific username and allow for you to set custom permissions for any specific users that you want. Edit The edit feature shares all of the same features as the add feature, allowing you to change the settings, appearances, and permissions of any page, with the insert feature being replaced by the move feature. The edit feature also shows you when a page was created and when the page was last edited at the bottom of the page management window. Delete The delete feature will delete the page that you are currently on and you can recover the page or fully delete the page in the admin dashboard's recycle bin." }, - "manuals/admin/admin-dashboard/profile-management.html": { - "href": "manuals/admin/admin-dashboard/profile-management.html", + "manuals/admin/admin-management/profile-management.html": { + "href": "manuals/admin/admin-management/profile-management.html", "title": "Profile Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Profile Management The profile manager exposes one of the more powerful and under-appreciated features that Oqtane has to offer. The profile manager expose to you a few features, but the primary feature is the profile editor, which allows you to customize completely the profile fields that a user account has in nearly every way possible. This is the backbone of all of the user profile features in Oqtane. The Oqtane profile manager allows for a user to specify more things about themselves than the typical information from a basic user account. Fields from the profile can be made to be required upon making an account such as making a name or address a required field. The profile page has an add profile button at the top of its page which includes: Name: The name of the profile item as it would be accessible in the database. Title: The title of the field displayed to the user. Description: Enter a description for the profile that will be what shows up for the help icon for the field. Category: The name for a grouping of fields such as the name or address headings that are by default included in the profile tab above their respective groupings of fields. Order: Choose the spot where in the list of profile fields that this one will appear with 0 being the first position. Lenth: The maximum length that can be input into this field, with a 0 for unlimited length. Default Value: The value that will be put into this field if the user doesn't enter anything into it. Options: Has the ability to create a list of items that can be selected and is enter by a list with commas in between the items (a,b,c). Required?: Specify whether or not the field is required upon the creation of a new account. Private: Specify whether it should be seen by regular user or should just been seen by administrators. There is also the option to edit or delete any of the fields that have already been created with edit and delete buttons on each item in the list of profile fields." }, - "manuals/admin/admin-dashboard/recycle-bin.html": { - "href": "manuals/admin/admin-dashboard/recycle-bin.html", + "manuals/admin/admin-management/recycle-bin.html": { + "href": "manuals/admin/admin-management/recycle-bin.html", "title": "Recycle Bin | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Recycle Bin The Recycle Bin is a very useful and often overlooked feature of Oqtane, especially for new users. Oftentimes, a newly designated administrator for a site will simply assume that when something is deleted, it is gone. The next logical step would probably be to re-create the content that was just deleted. This could lead to frustrations with Oqtane. The Recycle Bin allows you to restore the content in most cases, which can save you time and frustration. The Recycle Bin has two types of objects that can be restored, Pages and Modules. When you delete a page or a module, it will show up in the respective list. You can switch which list you're looking at by clicking the tabs at the top of the page. Clicking retore on one of the pages or modules will allow you to restore the selected item to their original place in your site. The recycle bin feature has two options, restore and delete. With the restore button, the page or module is restored to its original location. The delete button permanently deletes the page from your website and you will cause it be removed permanently." }, - "manuals/admin/admin-dashboard/role-management.html": { - "href": "manuals/admin/admin-dashboard/role-management.html", + "manuals/admin/admin-management/role-management.html": { + "href": "manuals/admin/admin-management/role-management.html", "title": "Role Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Role Management Security Roles in Oqtane are nothing more than a grouping of one or more users for a purpose. That purpose is up to you. The purpose could be to see exclusive content in a specific area of the site or on specific pages in the site. It could also be to have the ability to edit content on one or more pages or to create content in a specific module, like a blog. We could go on and on. Just remember that Security Roles can be used for content targeting, editing, and hiding sections of your site. Security Roles work the same as most permissions-based systems, such as Windows. You first create a Security Role if it doesn't already exist to create a grouping of users. Then, you add one or more people to that group. Once you do that minimal setup, you can apply that group to various capabilities, permissions, and features. Permissions are set when creating or editing pages and modules by selecting which roles can edit or view them. At the top of the page is the add role button that allows for the addition of a new group you want to make, with a name, description, and saying if it should be automatically assigned to users. You can edit, delete, and manage users in each role except for the default administrator and registered users roles which you cannot edit or delete, you can only manage their users. When adding a user into a role, there are fields for effective date and expiry date, which determines when a user will be added to a roles and how long they will be inside of a role." }, - "manuals/admin/admin-dashboard/site-settings.html": { - "href": "manuals/admin/admin-dashboard/site-settings.html", + "manuals/admin/admin-management/search-settings.html": { + "href": "manuals/admin/admin-management/search-settings.html", + "title": "Search Manual | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Search Manual This document describes the Search module, settings, and configuration for administrators to set up effective search functionality across their Oqtane site. Overview The Search feature allows users to locate relevant content quickly across the site. Through scheduled indexing, the Search service keeps the content index updated. The following sections cover search settings, scheduling, and customization options for the administrator. Search Settings Administrators can configure the Search module through Host > Search Settings. Below are explanations for each setting: Setting Description Search Provider Specifies the provider responsible for indexing and retrieving search results. Example: DatabaseSearchProvider. Enabled Toggles the search feature on or off. When set to Yes, the site content is regularly indexed, and search queries return up-to-date results. Last Indexed Displays the last date and time the site was indexed. This helps administrators know the freshness of indexed data in search results. Ignore Pages A list of pages excluded from indexing. Prevents certain content from appearing in search results, e.g., pages with sensitive or irrelevant content. Ignore Entities Specifies types of entities to exclude from indexing, such as Modules or Users. Word Length Defines the minimum character length for words indexed in search results. Only words meeting or exceeding this length will be indexed. Ignore Words Commonly ignored words in search queries (e.g., \"and,\" \"the\"). This list helps refine search results by avoiding indexing or returning results for these words. Search Components Search.resx File The .resx file includes localization data for search terms and placeholders in the search UI. Examples include: Search Search Configuring Search in Oqtane This guide provides a step-by-step walkthrough for configuring the search functionality in Oqtane. 1. Accessing the Search Feature in the Default Theme To get started, locate the search feature in the navigation bar of the default theme. 2. Opening the Control Panel Next, click the control panel icon to access additional settings. 3. Navigating to the Admin Dashboard In the control panel, select the button to open the admin dashboard, where you can manage various site settings. 4. Accessing Search Settings Finally, in the admin dashboard, click on the search settings icon to configure your search options. Configuring Search Settings Once in the search settings, you can adjust various parameters to customize how the search operates on your site. Using the Reindex Button After configuring your search settings, you may need to reindex your content to ensure that the latest changes take effect. Reindex Button Description The Reindex button initiates the process of scanning your site's content and updating the search index accordingly. This is essential after making changes to your site's content, structure, or search settings. How to Use the Reindex Button Navigate to the search settings page as described in the previous sections. Locate the Reindex button on the settings page. Click the Reindex button to start the indexing process. Note: Depending on the amount of content on your site, the reindexing process may take some time. You will receive a notification once the process is complete." + }, + "manuals/admin/admin-management/site-settings.html": { + "href": "manuals/admin/admin-management/site-settings.html", "title": "Site Settings | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Site Settings The Site Settings feature contains a large number of settings that you can use to perform high-level administrative configuration for your site. The Settings mostly contains set-it-and-forget it options that should be managed once when you build your site. Some of these settings include the default look and feel for new pages created on your site, your site logo, and default metadata for pages. The main parts of the settings are basic settings, SMTP configuration, and progressive web app configuration. Basic Settings Basic Settings mostly contains set-it-and-forget it options that should be managed once when you build your site. Name: What you want to call the website. Tenant: The name of the database you wan the site to use. Aliases: The name that will appear for the sites URL. Logo: The logo that will appear in the navigation bar. Favicon: Enter a favicon address or another icon address to have a default icon to appear beside each page in the navigation bar. Default Theme: Choose a default theme tht will give a different color scheme and structure. Default Layout: Choose how many columns a page has by default. Default Container: Choose if you want titles to appear about each module by default. Allow User Registration: Should users be able to create their own accounts or should only administrators be able to create accounts. Is Deleted: Select whether you want to delete this site. SMTP Server (Secure Mail Transfer Protocol) The Oqtane instance sends outbound email for a variety of reasons, from the host or site admin or in the form of password reminders, event notifications, newsletters, or other business-specific use cases. A valid SMTP server is required for this to work; you should consult your network administrator for the appropriate credentials to use in a production configuration. Most non-Exchange Server SMTP hosts will require “Basic” authentication and a valid username/password combination. Some will also require that SSL be enabled. Host: Enter the host name for the server. Port: Enter the port number that the server is on. SSL Enabled: Specify yes or no if the SMTP server has an SSL certificate. Username: Enter the username for the SMTP server you are accessing. Password: Enter the password for the SMTP server you are accessing. Progressive Web Application Settings Is Enabled: Choose whether or not you want the site to be set up as a progressive web application. App Icon: Select a PNG image that is 192 X 192 pixels which will be the app icon for your application. Splash Icon: Select a PNG image that is 512 X 512 pixels which will appear on the screen while the application is loading." }, - "manuals/admin/admin-dashboard/user-management.html": { - "href": "manuals/admin/admin-dashboard/user-management.html", + "manuals/admin/admin-management/url-mappings.html": { + "href": "manuals/admin/admin-management/url-mappings.html", + "title": "URL Mappings Manual | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "URL Mappings Manual This document describes the URL Mappings module, settings, and configuration for administrators to manage URL redirections effectively across their Oqtane site. Overview The URL Mappings feature allows administrators to define mappings from one URL to another, enabling effective redirection strategies. This feature is useful for managing broken links, ensuring users are directed to the correct resources. Control Panel Walkthrough Accessing the URL Mappings Feature Click the control panel icon to access additional settings. In the control panel, select the button to open the admin dashboard. In the admin dashboard, click on the URL Mappings icon to configure your URL mappings. Configuring URL Mappings Once in the URL Mappings settings, administrators can view and manage URL mappings. Managing Mapped URLs The Mapped URLs tab displays all existing URL mappings, including the original URL, the mapped destination, the number of requests, and the last requested date. You can choose to view either mapped URLs or broken URLs using the dropdown select menu. Use the Add URL Mapping button to create a new mapping. This will open a popup modal for adding a mapped URL. Reviewing and Editing URL Mappings After adding a URL mapping, it will appear in the list below the search feature. You can select an existing URL mapping to edit or delete it if it is no longer needed. Managing Broken URLs Switch to the Broken URLs tab using the dropdown select menu. This will display all captured broken URLs that require attention. You can edit or delete broken URLs as necessary to redirect them accordingly. URL Mapping Settings Administrators can configure the URL Mappings module through Host > URL Mappings. The primary setting available is: Setting Description Capture Broken URLs? Toggles the feature to automatically capture and save broken URLs in the URL Mappings. When set to Yes, any broken link encountered will be recorded for further management. In the Settings tab, administrators can toggle the Capture Broken URLs setting. Set this option to Yes to automatically capture broken URLs when they are accessed. Click the Save button to apply changes. Conclusion The URL Mappings module in Oqtane provides an effective way for administrators to manage URL redirection strategies. By leveraging the features outlined in this manual, site administrators can enhance user experience and maintain the integrity of web links across their sites." + }, + "manuals/admin/admin-management/user-management.html": { + "href": "manuals/admin/admin-management/user-management.html", "title": "User Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "User Management One of your primary responsibilities as the site administrator will likely be to manage users on your site. You might need to create, edit, or delete users. You might also be required to add and remove abilities from users on your site. Everything that you need to do in these examples can be done from this one menu. The options that are provided on this user manager includes: Add User: The add new user button is exactly what it sounds like it allows you to add a new user to your site and upon being clicked, it brings up a window that asks for all of the essential information for an account with a username, password, email, and full name. There is also the profile tab which allows for more extensive information to be provided for a user account and may have some fields that are required to be input in order to create an account, which is specified in the required field of the profile manager. Find User: Provides a text field to input a user's account name that will search through all of the site's users and return the account below this field with the following options: Edit User: This allows for basic fields in the identity field such as password, email, and full name to be modified as well as the ability to give the user a profile image and the profile tab to specify more information about a user. There is also the profile tab which goes into more detail about a user allowing for the specification of things like postal code, phone number and address. Delete User: This is exactly as it sounds, it will delete the user's account. User Roles: This allows for a user account to placed into a security role that has been previously defined in the role manager, and requires a date that this security role will take effect and will expire for the user account." }, - "manuals/admin/control-panel/index.html": { - "href": "manuals/admin/control-panel/index.html", + "manuals/admin/admin-management/visitor-management.html": { + "href": "manuals/admin/admin-management/visitor-management.html", + "title": "Visitor Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Visitor Management The Visitor Management feature in the Oqtane admin dashboard allows administrators to track and manage site visitors effectively. This feature is accessible via the admin dashboard under Admin > Visitor Management. Overview The Visitor Management feature provides tools for monitoring and managing visitor data on your site, helping administrators understand user interactions and enhance site performance. Control Panel Walkthrough Accessing the Visitor Management Feature Click the control panel icon to access additional settings. In the control panel, select the button to open the admin dashboard. In the admin dashboard, click on the Visitor Management icon to configure visitor tracking. Tabs Overview The Visitor Management module consists of two main tabs: Visitors and Settings. 1. Visitors Tab The Visitors tab displays a list of site visitors and provides options to filter the displayed visitors based on type and time period. Dropdown Selections Visitor Type: Select the type of visitors to display. All Visitors: Shows all visitors to the site. Users Only: Filters to show only registered users. Period: Choose the time period for which visitors are displayed. Past Day: Shows visitors from the last 24 hours. Past Week: Shows visitors from the last week. Past Month: Shows visitors from the last month. Visitor List Below the dropdown selections, a list of visitors is displayed, showing the following details: Detail IP Address User Language Visits Visited Created Details Button Visitor IP Address Visitor Username Visitor Language Number of Visits Last Visited Date Created Date Each entry includes a Details button that opens a detailed view of the selected visitor's information. 2. Settings Tab The Settings tab allows administrators to configure visitor tracking settings. Settings Fields Tracking Enabled: Specify if visitor tracking is enabled (Yes/No). Session Duration: Set the duration (in minutes) that is considered a distinct visit. Filter: Provide a comma-separated list of terms that should not be tracked in visitor data (e.g., specific IP addresses or user agents). Retention: Define the number of days to retain visitor activity data. Correlate Visitors: Specify whether new visitors should be correlated based on their IP address (Yes/No). Save Changes A Save button is provided at the bottom of the Settings tab to apply any changes made to the visitor tracking settings. Conclusion The Visitor Management feature provides essential tools for monitoring and managing visitor data on your site, helping administrators to understand user interactions and enhance site performance." + }, + "manuals/admin/content-management/adding-modules.html": { + "href": "manuals/admin/content-management/adding-modules.html", + "title": "Adding Modules to a Page | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Adding Modules to a Page In order to add a module to a page, simply open the control panel with the gear icon in the top right of a page and in the module management feature there is the ability to select a new module from the options of: Admin Module: These are only available to people within the administrator role and there are many more default modules available to put onto your webpages. Common Module: These are available both to administrators and to registered users to be able to use on pages that are specified as personalizable, meaning users can modify them as they see fit and they are unique and only viewable to registered users. Developer Module: This feature is for placing a module creator onto a page which will provide you with useful pre-built structure and methods for writing code for your own modules. There are also features after selecting the module that you would like which are the: Title: Which is what will be displayed directly above the module as its title, if nothing is selected then the module's name will be put as the title. Pane: Select which content pane you want the module to go inside of. Panes are made visible with the content editor. Container: Select if you would like to have a title displayed above the module or not have one. Adding One Module Across Multiple Pages As noted earlier, modules are reusable pieces of functionality, and as such a single module can be inserted across multiple pages in a site. Say, for example, you have an HTML module that holds a banner image and you want that banner image to also exist on five specific pages in your site. Instead of adding a new module to all five of those pages and then inserting the same image, you can simply go into the Control Panel and then click Add an Existing Module to the page. Adding already existing modules or sharing modules across multiple pages makes managing content that's repeated much more efficient. A content manager can then make edits in one module and instantly have those edits reflected across every page on which the module is shared. When a user hovers over the Modules menu item just below the Add New Module option is the Add Existing Module option. This is the option you select when you want to add a module that already exists in the site to a different page. When opting to use Add Existing Module, you must first select the page to copy a module from, which will populate the drop-down list of modules. You can then follow the same process of adding a module to the page." + }, + "manuals/admin/content-management/content-editor.html": { + "href": "manuals/admin/content-management/content-editor.html", + "title": "Content Editor | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Content Editor The content editor is what allows you to edit the modules on the page in a variety of ways. You access the content editor by clicking on the pencil on the top right side of the page which then shows the borders of the content pane which the modules are put inside of, as well as a small downward pointing arrow beside each module that allows you to open a menu to interact with the modules. The options for the module's menu are: Manage Settings: Brings up the module's settings and permissions which allow you to change the: Title: The title displayed above the module. Container: Specify if you want the title to be displayed for the module. Display on All Pages: Choose whether you want this module to be on every page on the site. Page: Change the page that the module is displayed on. Permissions: Specify either what roles or individual users should be able to view or edit the page. Unpublish Module: Hides the module from everyone, but the site administrators for instances where you want to edit modules. Delete Module: Deletes the module from the page. Import Content: Enter a file's address to import it into the module, such as a image address to include it. Export Content: Enter a file address to select where to export data from a module. Move to Top: Moves the modules to the top of the page to be the first module displayed. Move Up: Moves the module up to be above the module above it. Move Down: Move the module down below the module beneath it. Move to Bottom: Moves the module to the bottom of the page, below all other modules. If the page has the layout for multiple panes, which will allows for three center rows and a top and bottom row that can have content inserted into them, then there will be additional options available which are: Move to Top Pane: Moves the module to the content pane at the top of the page. Move to Left Pane: Moves the module to the left-most column. Move to Right Pane: Moves the module to the right-most column. Move to Content Pane: Moves the module to the central column. Move to Bottom Pane: Moves the module to the pane at the bottom of the page." + }, + "manuals/admin/content-management/control-panel.html": { + "href": "manuals/admin/content-management/control-panel.html", "title": "Control Panel | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Control Panel When managing your Oqtane site as an administrator, you will most likely be doing most of your daily work in the Control Panel. As an administrator, you will be able to use nearly every part of the Control Panel. The control panel is accessible through the gear icon located in the top right-hand corner of the screen and provides the ability to interact with the: admin dashboard page manager module manager Those with content management permissions, which are defined by a user account's roles, in Oqtane are often referred to as “content editors.” Content editors can typically view only some of the Control Panel—the parts that are required in order to perform other related tasks, such as adding a module to a page. It is worth noting that the Control Panel you'll be using is the one that ships “out of the box” with Oqtane. However, it is one of numerous extension points in Oqtane. Like modules, themes, and other extensions, the Control Panel can be replaced with a custom or third-party alternative." + "keywords": "Control Panel Site administration in Oqtane is the processes, tasks, and features that it takes to effectively run a website in Oqtane. This includes things like managing users, security, site settings, configurations, and content using the features available to them, in both the control panel and the admin dashboard. Site administration can take on many forms, but there are two use cases that you should be familiar with. First, there's site administration as defined by Oqtane.You enable this by adding the Administrators security role as one of the assigned roles for the account. That way, all “admin” features will be available for that user across that specific site. Site administration can take on a hybrid of another sort as well, where you as the site administrator can define a different kind of administration for your site. This would be a kind of administration where you define a subset of administration capabilities and assign them to more privileged users to avoid having to make them an actual administrator. As an example, there may be times when you want to create a security role in the role manager that might be named something like Site Admin. You would then create a page or pages on the site that contain some of the Admin modules, assigning permission to the newly created Site Admin security role so that only participants of that security role can see them. In these areas, you can also add references or links to features that normally require Administrator permissions, provided you set up your permissions properly in those other areas and that the chosen feature(s) allows this. In summary, you can perform all of the configuration and content management tasks that you need to in order to run your own site." }, - "manuals/admin/control-panel/modules.html": { - "href": "manuals/admin/control-panel/modules.html", - "title": "Modules | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Modules Modules are a key feature of Oqtane as they allow for you to insert a massive variety of things into your web page. There are a wide variety of different that can be added to your page for a high level of customization. An administrator also has the ability to both download new modules onto the website or upload modules you have created to the marketplace, options which are found in the admin dashboard's module management feature. On the side control panel's module management section, you have the option to: Add A New Module: which will put a new module of your choosing onto the page which has the option of being a: Admin Module: These are only available to people within the administrator role and there are many more default modules available to put onto your webpages. Common Module: These are available both to administrators and to registered users to be able to use on pages that are specified as personalizable, meaning users can modify them as they see fit and they are unique and only viewable to registered users. Developer Module: This feature is for placing a module creator onto a page which will provide you with useful pre-built structure and methods for writing code for your own modules. Add An Existing Module: Provides the ability to select modules that are already on other pages from your website. Page: A list of other your other web pages where you can select a page on your site that has the module you would like. Modules: A list of modules that are on the selected web page for you to select. Directly below these options, when a module is selected, the module's description will appear in a purple box so you have a better understanding of what the module is for. The other module options below this are: Title: Which is what will be displayed directly above the module as its title, if nothing is selected then the module's name will be put as the title. Pane: Select which content pane you want the module to go inside of. Panes are made visible with the content editor. Container: Select if you would like to have a title displayed above the module or not have one." + "manuals/admin/content-management/index.html": { + "href": "manuals/admin/content-management/index.html", + "title": "Content Management Introduction | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Content Management Introduction When managing your Oqtane site as an administrator, you will most likely be doing most of your daily work in the Control Panel. As an administrator, you will be able to use nearly every part of the Control Panel. The control panel is accessible through the gear icon located in the top right-hand corner of the screen and provides the ability to interact with the: admin dashboard page manager module manager Those with content management permissions, which are defined by a user account's roles, in Oqtane are often referred to as “content editors.” Content editors can typically view only some of the Control Panel—the parts that are required in order to perform other related tasks, such as adding a module to a page. It is worth noting that the Control Panel you'll be using is the one that ships “out of the box” with Oqtane. However, it is one of numerous extension points in Oqtane. Like modules, themes, and other extensions, the Control Panel can be replaced with a custom or third-party alternative." }, - "manuals/admin/control-panel/page-management.html": { - "href": "manuals/admin/control-panel/page-management.html", + "manuals/admin/content-management/module-configuration.html": { + "href": "manuals/admin/content-management/module-configuration.html", + "title": "Module Configuration | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Module Configuration Explore the various configuration options available for modules in Oqtane and customize their settings to meet your specific requirements. Overview Modules in Oqtane offer a range of configuration options, allowing you to customize their behavior and appearance to suit your needs. Configuring Modules To configure a module in Oqtane, follow these steps: Navigate to the Module Management section in the Administration Dashboard. Locate the module you want to configure and click on its settings icon. Adjust the module settings as needed. Click \"Save\" to apply the changes. Configuration Options Depending on the module, configuration options may include: Settings for data sources Display options Permissions and access control Integration with other modules or services Best Practices Regularly review and update module configurations to ensure optimal performance and functionality. Test module configurations in a development environment before deploying them to production." + }, + "manuals/admin/content-management/module-management.html": { + "href": "manuals/admin/content-management/module-management.html", + "title": "Module Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Module Management Modules are a key feature of Oqtane as they allow for you to insert a massive variety of things into your web page. There are a wide variety of different that can be added to your page for a high level of customization. An administrator also has the ability to both download new modules onto the website or upload modules you have created to the marketplace, options which are found in the admin dashboard's module management feature. On the side control panel's module management section, you have the option to: Add A New Module: which will put a new module of your choosing onto the page which has the option of being a: Admin Module: These are only available to people within the administrator role and there are many more default modules available to put onto your webpages. Common Module: These are available both to administrators and to registered users to be able to use on pages that are specified as personalizable, meaning users can modify them as they see fit and they are unique and only viewable to registered users. Developer Module: This feature is for placing a module creator onto a page which will provide you with useful pre-built structure and methods for writing code for your own modules. Add An Existing Module: Provides the ability to select modules that are already on other pages from your website. Page: A list of other your other web pages where you can select a page on your site that has the module you would like. Modules: A list of modules that are on the selected web page for you to select. Directly below these options, when a module is selected, the module's description will appear in a purple box so you have a better understanding of what the module is for. The other module options below this are: Title: Which is what will be displayed directly above the module as its title, if nothing is selected then the module's name will be put as the title. Pane: Select which content pane you want the module to go inside of. Panes are made visible with the content editor. Container: Select if you would like to have a title displayed above the module or not have one." + }, + "manuals/admin/content-management/page-management.html": { + "href": "manuals/admin/content-management/page-management.html", "title": "Control Panel Page Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Control Panel Page Management The page management feature allows you to manipulate the page you are currently on, by providing options for adding, editing, deleting, and publishing pages. This feature also has many of the same capabilities as the admin dashboard's Page Management feature, with the only difference being that the control panel's page manager only has the ability to change the page you are currently on. Add The add feature adds a new page to your website and brings up the page management window, which allows you to specify the settings, appearance, and permissions for the page you are adding. The fields which exist in the page management window are the: Settings Name: Which specifies the name that will be displayed in the navigation bar. Parent: Which will specify the page that this page will be underneath, meaning that the added page will be put to the right of the page specified in the navigation bar at the top. Insert: Specify where the name for the page will appear in the navigation bar, by saying where the page should appear among all of the children of the parent that has been selected. Navigation: Say whether you want the page to be displayed to users that fit within the permissions, or if you want the page to be hidden to everyone but administrators which can be useful while editing a page. URL Path: The url is what is put in the web page's address, for example if the url path is set to page1 then the address might be www.website/page1.com. If no URL path is specified then the URL will by default be set to be the same as the name field above. Redirect: Input a URL that is the same as the URL path of another page in the site that user will be sent to, remember that if no URL path is specified for another page then the name will be used. If this feature is implemented then you will not be able stay on the page to use the control panel's page manager, so you will need to use the admin dashboard's page management feature to edit or delete page's with this feature. Appearance Title: The name that is displayed on the web page's tab. Theme: The theme that the web page will take on from a selection of styles and colors that can be downloaded by the host user in the theme manager. Layout: The amount of content panes that will be available. Which are basically how many columns will be available to have content and modules inserted inside of. Default Container: Choose the layout of modules for the page, like hw the titles typically displayed above the modules will be. Icon: Input a favicon address or other icon address to include an icon beside the name of your page. Personalizable: This feature gives a page that is unique to every individual and allows them to add modules and edit the content of the page, so only the individual can see what they put onto the page. Permissions View: This is what allows different users to see certain pages and any users that are within certain roles, that can be specified in the admin dashboard's role management feature will be able to see or not see the page depending on what you have checked the box for the role they fit into. Edit: This allows users that fit into the specified roles to be able to edit pages using the content editor. Specific Users: The permissions tab also has the ability for you to enter a specific username and allow for you to set custom permissions for any specific users that you want. Edit The edit feature shares all of the same features as the add feature, allowing you to change the settings, appearances, and permissions of any page, with the insert feature being replaced by the move feature. The edit feature also shows you when a page was created and when the page was last edited at the bottom of the page management window. Delete The delete feature will delete the page that you are currently on. Publish The publish feature makes any page public that you have previously specified to be hidden, if you have marked a page as not navigable when the page was created. It is useful to have this feature to be able to work on a page that is hidden from regular users until it is finished and ready to be officially added to the site." + "keywords": "Control Panel Page Management The Page Management feature allows you to manipulate the page you are currently on by providing options for adding, editing, deleting, and publishing pages. This feature shares many capabilities with the admin dashboard's Page Management feature, but is limited to changing the page you are currently managing. Add The Add feature allows you to create a new page on your website. When you select this option, a page management window will appear, enabling you to specify the following settings: Add Page Configration Settings Name: The name displayed in the navigation bar. Parent: The page that this new page will fall under in the navigation structure. Insert: Specifies the position of the page among its siblings under the selected parent. Navigation: Determines if the page should be visible to users with appropriate permissions or hidden from everyone but administrators. URL Path: Sets the URL for the page. If no path is specified, it defaults to the name. Redirect: URL to redirect users if this page is accessed. If set, you will need to use the admin dashboard’s page management feature to manage this page further. Appearance Title: Name displayed on the web browser tab. Theme: Select a theme from those available in the theme manager. Layout: Number of content panes (columns) available on the page. Default Container: Layout style for module titles above the content. Icon: URL for a favicon or other icon associated with the page. Personalizable: Allows users to customize the page uniquely for themselves. Page Content Head Content: Optionally enter content to be included in the page head (ie. meta, link, or script tags) Body Content: Optionally enter content to be included in the page body (ie. script tags) Permissions View: Controls which user roles can see the page, based on settings in the admin dashboard’s role management feature. Edit: Grants specified roles permission to edit pages using the content editor. Specific Users: Custom permissions can be assigned to individual users. Edit The Edit feature provides similar functionality to the Add feature but modifies the current existing page instead of creating a new one. This section allows you to update the settings, including the appearance, permissions, modules, and theme settings of the current page. The settings configuration has the Insert field replaced by a Move feature to adjust the page's position in the navigation. Additionally, the edit panel displays the creation date and last edited date for the page at the bottom. To edit the page: Click on the Edit button located in the control panel. Modify the settings, permissions, modules, and theme settings. Settings As described in the Add section, you can modify the page's name, parent, navigation visibility, URL path, and redirect options. The only difference is that the Insert field is replaced by a Move feature for adjusting the page's position in the navigation. Permissions Permissions work the same as in the Add feature, allowing you to control which users can view or edit the page. Modules This tab allows you to manage the modules on the page, giving you the ability to modify or reorder existing modules. This provides a more granular control over the content displayed on your page. Edit: Access the module’s configuration to modify settings, permissions, and layout. Delete: Remove the module from the page. Theme Settings In the Theme Settings tab, you can adjust the theme and layout of the page. This includes options for the page’s appearance, such as selecting a different theme or changing layout configurations. Setting Scope: Choose between Site or Page for theme application scope. Show Login?: Toggle login visibility (options: Not Specified/Yes/No). Show Register?: Toggle registration visibility (options: Not Specified/Yes/No). Display Fixed Footer?: Toggle a fixed footer (options: Not Specified/Yes/No). By using the Edit feature, you can effectively customize the current page, ensuring that it meets your requirements and reflects any necessary changes. Delete The Delete feature allows you to permanently remove the page you are currently managing. To delete the page, simply click the Delete button. Warning: This action is irreversible. Ensure that the page is no longer needed before proceeding. Publish/Unpublish The Publish feature enables you to make a page public if it was previously marked as hidden. This is particularly useful for working on a page that you want to keep inaccessible to regular users until it is fully prepared for release. To toggle the publish status, click the Publish button, which will switch between publishing and unpublishing the page. This detailed overview of the Page Management feature provides administrators with the essential tools to manage individual pages effectively. Each button feature is clearly defined to enhance user understanding and facilitate efficient page management." }, - "manuals/admin/host-administration/event-log.html": { - "href": "manuals/admin/host-administration/event-log.html", + "manuals/admin/content-management/working-with-modules.html": { + "href": "manuals/admin/content-management/working-with-modules.html", + "title": "Working With Modules | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Working With Modules In order to access a module's settings, you must be in the content editor. To get into the editor, simply click over the pencil icon top-right corner of the page. This puts you into the edit mode where you will see small white arrows in the top-right corner of every module on the page. These small arrows at the top left corners of each module allow you to move the module on the page, access the module's settings, edit the module, delete the module, and access any specific functionality related to the module. Once in Edit mode you will notice that Oqtane uses a very user-friendly and intuitive approach to managing content. Whenever you want to edit content in Oqtane, you go to the location where the content resides and edit it right there in place. Moving Modules Once a module is on the page, you can move its location again if needed. All that is needed is to enter the content editor by clicking on the pencil icon in the top right hand side with editing permission on a certain page. And then selecting the small downward pointing arrow in the top left of the module to do a variety of things to it, including: Move to Top: Moves the modules to the top of the page to be the first module displayed. Move Up: Moves the module up to be above the module above it. Move Down: Move the module down below the module beneath it. Move to Bottom: Moves the module to the bottom of the page, below all other modules. If the page has the layout for multiple panes, which will allows for three center rows and a top and bottom row that can have content inserted into them, then there will be additional options available which are: Move to Top Pane: Moves the module to the content pane at the top of the page. Move to Left Pane: Moves the module to the left-most column. Move to Right Pane: Moves the module to the right-most column. Move to Content Pane: Moves the module to the central column. Move to Bottom Pane: Moves the module to the pane at the bottom of the page." + }, + "manuals/admin/host-management/event-log.html": { + "href": "manuals/admin/host-management/event-log.html", "title": "Event Log | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Event Log The Event log allows you to know what's happening on your website at all times. On the surface, the Event log may seem very simple and it is. You have a listing of the most recent events immediately visible on page load. This list is going to be any number of pages with 10 events by default on each page of results and the option to see more rows at a time. A paging feature at the bottom of the list allows you to move from page to page. If you want to filter the events to see more or fewer events, you have three controls at the top of the listing to help you. You can filter by the type of event that you want to see with the event Level and Function: Level: The level specifies the severity of the event and includes options for: Trace Debug Information Warning Error Critical Function: The function is what type of feature is being used and is color-coated for easier viewing. It includes options for: Create Read Update Delete Security Other Rows: Choose how many rows you would like to have displayed on page. The feature and date are also shown in the event list but aren't sortable fields, with the feature showing what part of the Oqtane framework is being used. For example, you might be interested only in seeing instances of site users attempting to log in. To see this, simply change the Function drop-down list to Security, and only security events like the login event will be shown to you. In other cases, you might want to see a larger list of events. There are many reasons for this. One reason might be searching for something specific using built-in features of your web browser, such as using Ctrl+F to “find” something in the page. As an example, you could switch the event log to show 100 events by changing the rows. For each event that is displayed you can select the detail button to show more information on where the event happened and a more in-depth description on what the event is." }, - "manuals/admin/host-administration/index.html": { - "href": "manuals/admin/host-administration/index.html", - "title": "Host Administration | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Host Administration The host user has the highest possible level of permissions in a Oqtane instance and can manage any individual site, set defaults for the creation of new sites, and manage additional configurations that support all sites. An Oqtane site administrator is primarily concerned with the look, feel, functionality, and content of a site. A host is more concerned with the configuration, performance, monitoring, and support of the entire Oqtane instance. As the Oqtane host (or any user with superuser permissions), you need to have a working grasp of all the features and configuration options available to you. A host logs into a Oqtane site just like any other user, just using the host account that is created when the Oqtane application is first launched. In addition to the site options discussed in the site administration control panel and admin dashboard, the host account has more options than an administrator account in the admin dashboard, which includes: Event Log: Which contain information on various events that have occurred on the site like errors or anything that has been created, updated, or deleted with more info on event log. Site Management: Which allows for the addition and modification for all of the different sites you have with more info on site management. Module Management: Which allows you to install new modules and edit existing modules with more info on module management. Theme Management: Which allows you to install new themes to change the look of you webpages with more info on theme management. Scheduled Jobs: Which allows for the creation of jobs that will do something every time a specified amount of time passes with more info on scheduled jobs. SQL Management: Which lets you run SQL queries in your databases with more info on sql management. System Info: Which gives information on your version of the Oqtane framework and allows you to see information and methods in Oqtane's api with more info on system info. System Update: Which allows you to keep the Oqtane framework up to date and allow you to use Nuget packages with more info on system update." + "manuals/admin/host-management/index.html": { + "href": "manuals/admin/host-management/index.html", + "title": "Host Management Introduction | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", + "keywords": "Host Management Introduction The host user has the highest possible level of permissions in a Oqtane instance and can manage any individual site, set defaults for the creation of new sites, and manage additional configurations that support all sites. An Oqtane site administrator is primarily concerned with the look, feel, functionality, and content of a site. A host is more concerned with the configuration, performance, monitoring, and support of the entire Oqtane instance. As the Oqtane host (or any user with superuser permissions), you need to have a working grasp of all the features and configuration options available to you. A host logs into a Oqtane site just like any other user, just using the host account that is created when the Oqtane application is first launched. In addition to the site options discussed in the site administration control panel and admin dashboard, the host account has more options than an administrator account in the admin dashboard, which includes: Event Log: Which contain information on various events that have occurred on the site like errors or anything that has been created, updated, or deleted with more info on event log. Site Management: Which allows for the addition and modification for all of the different sites you have with more info on site management. Module Management: Which allows you to install new modules and edit existing modules with more info on module management. Theme Management: Which allows you to install new themes to change the look of you webpages with more info on theme management. Scheduled Jobs: Which allows for the creation of jobs that will do something every time a specified amount of time passes with more info on scheduled jobs. SQL Management: Which lets you run SQL queries in your databases with more info on sql management. System Info: Which gives information on your version of the Oqtane framework and allows you to see information and methods in Oqtane's api with more info on system info. System Update: Which allows you to keep the Oqtane framework up to date and allow you to use Nuget packages with more info on system update." }, - "manuals/admin/host-administration/module-management.html": { - "href": "manuals/admin/host-administration/module-management.html", + "manuals/admin/host-management/module-management.html": { + "href": "manuals/admin/host-management/module-management.html", "title": "Module Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Module Management The module manager provides a list of all of the modules that are currently installed in your version of the Oqtane framework. Modules are a key feature of Oqtane and allow for a variety of features to be placed on your pages. At the top of the module manager page there is a install button to install a module from the list provided or by using the upload tab, you can use a Nuget package of a module, so that it will be included as one of the possible modules to use on the site. Inside the list of modules there is also the options to edit modules which will show an overview of the module with a description and an option to delete any module that is not a default Oqtane module." }, - "manuals/admin/host-administration/scheduled-jobs.html": { - "href": "manuals/admin/host-administration/scheduled-jobs.html", + "manuals/admin/host-management/scheduled-jobs.html": { + "href": "manuals/admin/host-management/scheduled-jobs.html", "title": "Scheduled Jobs | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Scheduled Jobs The Schedule page enables you to manage what is essentially recurring, scheduled batch processing for Oqtane.There are many instances where a host may want to set something up to automatically do some task like sending a notification to users and this can be accomplished with the use of this feature. The options that are available on this page are: Add Job: Adds a new job by filling out the fields of: Name: Choose the jobs name. Type: Specify the type by either using NotificationJob or by creating your own job method in the infrastructure.jobs class in the Oqtane server. You will need to specify the location of the job in the framework, Ex. (Oqtane.Infrastructure.NotificationJob, Oqtane.Server) with the job being a notification job from the infrastructure class, which is a class inside of the Oqtane.Server. Enabled: A yes or no to say if you want the job to be active at this time or not. Runs Every: Choose an amount of time that specifies how often the job will execute. Starting: Enter a date for when you want the job to start. Ending: Enter a date for when you want the job to end. Retention Log: A number to specify the amount of logs that will be retained. View Logs: Shows all of the logs generated by all of your jobs within their retention log number. Refresh: This refreshes the page to get new logs that have been made while you have been on this page. Below this these options is a list of all of the jobs that are currently set up to be executed, that have a few options: Edit: Has all of the same fields as adding a job plus a field for the next execution: Next execution: Input a date that will be the next time the job will run after the stop button has been pushed. Delete: Deletes the job so that it will never execute again. Log: View the logs that this jobs has generated. Stop: Stops the job from executing anymore, until a next execution has been specified in the edit window." }, - "manuals/admin/host-administration/site-management.html": { - "href": "manuals/admin/host-administration/site-management.html", + "manuals/admin/host-management/site-management.html": { + "href": "manuals/admin/host-management/site-management.html", "title": "Site Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Site Management Oqtane provides the ability to have multiple sites at you disposal within the singular Oqtane application. The Site Management page provides an inventory of all the sites in a Oqtane instance and quick access to the Site Settings functionality for each. Deleting your sites is permanent! So it should not be done unless you are certain you want to delete this site. The options to add and edit the set has a few options: Site Name: This field is what the site will be called. Aliases: This is what the address of the site is that is being created and can create websites under the default top level website, by using a / forward slash with the a name you want under the top level website. Default Theme: Choose the theme, which is the colors and styles that will be the default for pages created on this website. Default Layout: Choose how many content panes you want to have on a page by default. Default Container: Choose if you want a title header for your modules on the site by default. Site Template: Select if you want a template for your site or no template for your site. Tenant: Select the tenant for the site, which is the database that will be used for the site. If you want to create a new tenant or database then you will have to select the \"create a new tenant\" option which will drop down with another menu that allows for a new tenant to be created, this menu includes: Name: This is the name for the new tenant on the site, that you will be creating and what will be displayed when selecting tenants in the future. Database Type: Choose if you would like the database to have a local database, which will create a Microsoft SQL database on your local database on your system, and an SQL server which creates a that is linked to an SQL server. Server: This is the location of where the server where the database will be located and a default value is provided for a local database. Database: This is the name that is initialized for the database inside of the server and a default value is provided for a local database. Integrated Security: Choose if you want the host superuser for the site to have the same credentials (username and password) as the database's root account. Host Username: This is the username of the super user host account that will be created for the site, it will also be the database's root username if integrated security is set as true. Hosts Password: This is the super user host account's password, it will also be the database's root account password if integrated security is set as true." }, - "manuals/admin/host-administration/sql-management.html": { - "href": "manuals/admin/host-administration/sql-management.html", + "manuals/admin/host-management/sql-management.html": { + "href": "manuals/admin/host-management/sql-management.html", "title": "SQL Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "SQL Management The SQL console permits database access directly from inside Oqtane. So the host, even if it's not near an instance of SQL Server Management Studio, still has access to a powerful database tool. This allows for SQL statements to be run directly from the Oqtane application onto the tenants which are also called databases. The results of any SQL query that is run will be returned directly below the execute button." }, - "manuals/admin/host-administration/system-info.html": { - "href": "manuals/admin/host-administration/system-info.html", + "manuals/admin/host-management/system-info.html": { + "href": "manuals/admin/host-management/system-info.html", "title": "System Info | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "System Info All of the general information that you need to know about the Oqtane framework is available in the system information feature, which includes things like the Oqtane framework version, the blazor runtime, the server path, the CLR version, the OS version, and the server's current time. The System Info feature also provides access to Oqtane's API with many of Oqtane's methods and the ability to try them out using the Swagger user interface. There is also the option to restart the Oqtane framework on this page if you have made a change to the system that would require a restart such as installing or deleting themes or modules." }, - "manuals/admin/host-administration/system-update.html": { - "href": "manuals/admin/host-administration/system-update.html", + "manuals/admin/host-management/system-update.html": { + "href": "manuals/admin/host-management/system-update.html", "title": "System Update | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "System Update The system update feature allows you to update the Oqtane framework to keep your website up to date and ensure that administrators will have access to all capabilities and features that Oqtane provides. The system update feature also provides the ability to upload a Nuget package to be included with your local version of the Oqtane framework and is uploaded by selecting the Nuget file from its location on your system and then pressing the upload button to place the Nuget package within a version of the framework, then pressing the install button to update you version of the framework to include the uploaded Nuget package. Uploading a Nuget package is for the use of uploading features that exist in a newer version of Oqtane, but you have not installed the newest version of Oqtane." }, - "manuals/admin/host-administration/theme-management.html": { - "href": "manuals/admin/host-administration/theme-management.html", + "manuals/admin/host-management/theme-management.html": { + "href": "manuals/admin/host-management/theme-management.html", "title": "Theme Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Theme Management The theme page is not used that often. Generally, it's used during the development of a new site and sometimes is used during the rollout of a new site brand. It allows you to view the available themes and containers that have been installed in your site and then applied as the default for new and existing pages and modules. Themes on Oqtane provide a multitude of different colors and styles for pages to be presented in. These themes can provide unique looking pages and websites as a whole. There are two default themes for Oqtane, the Blazor theme and the Oqtane theme. You can also download new themes to use by clicking the install theme button at the top of the page and choosing some themes to download, so you change the look of your site. There is also an upload tab which allows you to put Nuget files for themes that are not available in the download menu onto your Oqtane framework." }, "manuals/admin/index.html": { "href": "manuals/admin/index.html", "title": "Oqtane Administrative Documentaion | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Oqtane Administrative Documentaion This administrative documentation outlines the various ways that administrators and user can interact with the oqtane platform in a variety of ways, including but not limited to: Adding modules to pages, moving them around and editing them. Various host administrative tasks, such as jobs, event logs, and themes. Administrative functions, such as file and user management. The different processes of the control panel. What the admin dashboard includes. Basic installation instructions." + "keywords": "Oqtane Administrative Documentaion Introduction This administrative documentation outlines the various ways that administrators and user can interact with the oqtane platform in a variety of ways, including but not limited to: Basic installation instructions. The different processes of the control panel. What the admin dashboard includes. Content management for adding modules to pages, moving them around and editing them. Administrative functions, such as file and user management. Various host administrative tasks, such as jobs, event logs, installing modules and themes. Basic development features like creating modules and themes from the related admin dashboard features." }, "manuals/admin/installation/databases.html": { "href": "manuals/admin/installation/databases.html", @@ -2284,11 +2454,6 @@ "title": "Resources | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "Resources This section provides a collection of links and resources that can help you with Oqtane installation, development, and usage. You can find information and guidance on various topics, such as Oqtane framework, IDE tools, IIS and .NET Core hosting, databases, modules, themes, localization, security, and more. You can also access the Oqtane blog and GitHub repository for the latest news, tips, and tutorials. Note: The links in this section are external and may lead to websites that are not affiliated with Oqtane. Please use them at your own discretion and follow their respective terms and policies. Oqtane Framework Oqtane Framework Releases: Download the latest Oqtane release for installation. Oqtane GitHub Repository: Contribute to the Oqtane project and report issues on GitHub. Oqtane Blog: Stay updated with the latest news, tips, and tutorials. IDE Tools Visual Studio and VS Code Downloads: Download Visual Studio (Windows Only) and Visual Studio Code (Windows and Linux) IDEs for development. IIS & .NET Core Hosting Microsoft .NET Downloads: Download the .NET Core Hosting Bundle for hosting .NET Core applications on Windows servers. IIS URL Rewrite Module: Download and install URL Rewrite Module for configuring URL rewriting rules in IIS. WebSocket Support on IIS: Instructions for enabling WebSockets on IIS. Publish an ASP.NET Core app to IIS: This tutorial demonstrates how to host an ASP.NET Core app on an IIS server. ASP.NET Core security topics: This article provides an overview of ASP.NET Core security features, including authentication, authorization, data protection, HTTPS enforcement, safe storage of app secrets, XSRF/CSRF prevention, CORS, and XSS attack prevention. Databases SQL Server SQL Server Downloads: Download SQL Server. Windows SQL Server 2022 Evaluation Download: A free trial version of SQL Server 2022, the latest release of the relational database management system from Microsoft. SQL Server Management Studio (SSMS) Download: Download SQL Server Management Studio for database management. SQL Server Installation Guide for Linux Ubuntu: Detailed guide on installing SQL Server on Ubuntu. Visual Studio Code mssql Extension: The mssql extension for Visual Studio Code (VS Code) to work with databases in SQL Server on Windows, macOS, and Linux, as well as Azure SQL Database and Azure SQL Managed Instance. MySQL MySQL Downloads: Download MySQL Community Server. MySQL Workbench Download: MySQL Workbench for database administration. MySQL Documentation for Windows Installation: Installing MySQL on Microsoft Windows. MySQL Documentation for Ubuntu Installation: Quick guide for installing MySQL on Ubuntu using APT repository. PostgreSQL PostgreSQL Downloads: Download the latest version of PostgreSQL. pgAdmin Download: Tool for PostgreSQL administration. PostgreSQL Documentation Tutorial: Tutorial to help with installing, configuring and using PostgreSQL database server. PostgreSQL Documentation for Ubuntu Installation: Installation guide specific to Ubuntu environment. SQLite SQLite Downloads: Download SQLite for Ubuntu. SQLite Documentation: Official documentation for SQLite. Windows OS Windows Server 2022 Evaluation Download: A free trial version of Windows Server 2022, the latest release of the server operating system from Microsoft.application platform, and storage. Windows 11 Enterprise Evaluation Download: A free trial version of Windows 11 Enterprise, the most advanced and secure edition of Windows 11, the latest operating system from Microsoft. Linux Ubuntu OS Downloads: Ubuntu Downloads: Download the latest version of Ubuntu. Installation Guide Ubuntu Installation Guide: Step-by-step guide for installing Ubuntu Desktop edition. Ubuntu Server Installation Guide: Installation guide for Ubuntu Server edition. Nano Editor Online Manual: This is the online manual for the Nano text editor, providing detailed documentation on its usage and features. GNU Nano Official Website: Visit the official website of GNU Nano to find additional resources, downloads, and community support. GNU Nano Documentation: Access the comprehensive documentation for GNU Nano, including guides, FAQs, and release notes. Apache HTTP Server Apache HTTP Server Documentation: Official documentation for the Apache HTTP Server, providing comprehensive guides, configuration references, and troubleshooting tips. Apache Foundation: The official website of the Apache Software Foundation, where you can find information about all Apache projects, including the HTTP Server. Ubuntu: Install and Configure Apache: Tutorial going through the steps of setting up an Apache server on Ubuntu. Host ASP.NET Core on Linux with Apache: This article explains how to set up Apache as a reverse proxy server on CentOS 7 to redirect HTTP traffic to an ASP.NET Core web app running on the Kestrel server. Resources Mozilla Developer Network (MDN): Visit MDN for comprehensive documentation and resources on web development, including HTML, CSS, JavaScript, and more. Mozilla Server Side TLS Guidelines: Mozilla provides guidelines for configuring server-side TLS to enhance security. These guidelines cover various aspects of TLS configuration, including cipher suites, protocols, and certificate management. Mozilla SSL Configuration Generator: This tool helps generate secure SSL configurations for popular web servers, including Apache, Nginx, and others. It provides recommended configurations based on Mozilla's SSL/TLS best practices. Let's Encrypt: Let's Encrypt is a free, automated, and open certificate authority (CA) that provides SSL/TLS certificates to enable HTTPS on websites. Their website offers detailed documentation and resources for setting up HTTPS on web servers. ← Back to Installation Home" }, - "manuals/admin/installation/troubleshooting.html": { - "href": "manuals/admin/installation/troubleshooting.html", - "title": "Installation Troubleshooting | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Installation Troubleshooting Overview Encountering issues during the installation process can be frustrating, but with the right troubleshooting steps, you can overcome common obstacles and successfully set up Oqtane. Below are some common troubleshooting tips for both Windows and Linux installations: Windows Installation Troubleshooting Check Prerequisites: Ensure that all prerequisites, such as .NET Framework, IIS, or SQL Server, are installed correctly and meet the minimum version requirements specified in the Oqtane documentation. Permissions: Verify that you have sufficient permissions to install and configure Oqtane. Running installation processes with administrative privileges can help resolve permission-related issues. Firewall and Antivirus: Temporarily disable firewall or antivirus software during the installation process, as they may interfere with file downloads or server connections. Error Logs: Check error logs generated during the installation process for any specific error messages or exceptions. These logs can provide valuable insights into the root cause of installation failures. Linux Installation Troubleshooting Package Dependencies: Ensure that all required dependencies, such as Mono, Apache, MySQL, or PostgreSQL, are installed and configured correctly on your Linux system. Use package managers like apt or yum to install missing dependencies. File Permissions: Check file and directory permissions to ensure that the installation directory and relevant files are accessible by the installation process. Adjust permissions using chmod or chown commands as needed. Service Status: Verify the status of Apache or other web servers, as well as database services like MySQL or PostgreSQL, to ensure they are running properly. Restart services if necessary to resolve any issues. SELinux: If SELinux is enabled on your Linux system, it may restrict certain operations during the installation process. Temporarily disable SELinux or adjust its policies to allow necessary operations for Oqtane installation. Additional Resources For further assistance and discussions on installation troubleshooting, you can explore the Oqtane Framework GitHub repository and review existing issues and discussions related to installation problems. Engaging with the community and seeking help from experienced users and developers can often provide valuable insights and solutions to resolve installation issues. Oqtane Supported Databases Oqtane Installation Resources ← Back to Installation Home" - }, "manuals/admin/installation/upgrade.html": { "href": "manuals/admin/installation/upgrade.html", "title": "Upgrading Oqtane | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", @@ -2319,126 +2484,6 @@ "title": "| Oqtane Docs - APIs and more for the Modular Blazor Application Framework", "keywords": "" }, - "manuals/admin/marketplace/index.html": { - "href": "manuals/admin/marketplace/index.html", - "title": "Oqtane Marketplace Overview | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Oqtane Marketplace Overview The Oqtane Marketplace is a central hub where users and developers can discover, share, and distribute themes, modules, and translations for the Oqtane framework. Whether you're a developer looking to showcase your creations or a user seeking new features and enhancements for your Oqtane-based application, the Marketplace provides a convenient platform to meet your needs. Using the Oqtane Marketplace Learn how to navigate the Oqtane Marketplace, find and install themes and modules, and explore the available offerings. This guide will walk you through the process of discovering and utilizing resources from the Marketplace to enhance your Oqtane experience. Submitting Contributions Are you a developer interested in sharing your themes, modules, or translations with the Oqtane community? This manual provides detailed instructions on how to prepare and submit your contributions to the Oqtane Marketplace, making them accessible to users worldwide. Monetization Options Discover opportunities for monetization within the Oqtane Marketplace. Whether you're interested in offering commercial products or exploring sponsorship and advertising options, this guide outlines various strategies for monetizing your contributions to the Oqtane ecosystem. Troubleshooting Encountering issues while using the Oqtane Marketplace? This troubleshooting guide offers solutions to common problems and helps you resolve issues related to theme and module installation, compatibility, and other Marketplace functionalities. Explore the Oqtane Marketplace and unleash the full potential of your Oqtane-based applications today!" - }, - "manuals/admin/marketplace/monetization.html": { - "href": "manuals/admin/marketplace/monetization.html", - "title": "Monetization Options in the Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Monetization Options in the Oqtane Marketplace Overview The Oqtane Marketplace offers various opportunities for developers to monetize their contributions, including themes, modules, and translations. Whether you're looking to generate revenue from your creations or support your development efforts, the Marketplace provides several monetization options to suit your needs. Pricing Models Explore different pricing models available in the Oqtane Marketplace, including free, freemium, subscription-based, and one-time purchase options. Learn how to choose the right pricing model for your products and maximize your revenue potential. Licensing and Usage Rights Understand the licensing and usage rights associated with products listed on the Oqtane Marketplace. From open-source licenses to commercial licenses, this section provides guidance on selecting the appropriate licensing model for your themes, modules, or translations. Payment Processing Learn about the payment processing options available for commercial products in the Oqtane Marketplace. Whether you prefer to use integrated payment gateways or manage transactions independently, this section covers the steps involved in setting up payment processing for your products. Sponsorship and Advertising Explore opportunities for sponsorship and advertising within the Oqtane Marketplace. From promoting your products to sponsoring specific features or sections of the Marketplace, this section discusses how to leverage sponsorship and advertising to increase visibility and reach a wider audience. Analytics and Reporting Gain insights into the performance of your products in the Oqtane Marketplace through analytics and reporting tools. Learn how to track key metrics such as downloads, revenue, and user engagement to optimize your monetization strategies and drive growth. Support and Maintenance Services Discover the value of offering support and maintenance services for your products listed on the Oqtane Marketplace. From providing timely updates and bug fixes to offering premium support packages, this section explores ways to enhance the customer experience and build long-term relationships with users. Promotional Strategies Develop effective promotional strategies to increase awareness and sales of your products in the Oqtane Marketplace. Whether through targeted marketing campaigns, cross-promotions with other developers, or participation in community events, this section offers practical tips for promoting your monetized offerings. By leveraging the monetization options available in the Oqtane Marketplace, you can turn your passion for development into a sustainable source of income while contributing to the growth and success of the Oqtane ecosystem." - }, - "manuals/admin/marketplace/submitting-contributions.html": { - "href": "manuals/admin/marketplace/submitting-contributions.html", - "title": "Submitting Contributions to the Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Submitting Contributions to the Oqtane Marketplace Overview This manual provides detailed instructions for developers interested in contributing themes, modules, and translations to the Oqtane Marketplace. By sharing your creations with the Oqtane community, you can make your work accessible to users worldwide and contribute to the growth of the ecosystem. Preparing Your Contributions Before submitting your themes, modules, or translations to the Marketplace, it's essential to ensure they meet certain standards and requirements. This section outlines the steps you need to take to prepare your contributions for submission. Submitting Themes Themes play a crucial role in defining the appearance and user experience of Oqtane-based applications. Learn how to package and submit your themes to the Marketplace, making them available for users to enhance the visual aesthetics of their sites. Submitting Modules Modules provide additional functionality and features to Oqtane applications. This section guides you through the process of packaging and submitting your modules to the Marketplace, enabling users to extend the capabilities of their applications. Submitting Translations Translating applications into different languages enhances accessibility and usability for users worldwide. Discover how to prepare and submit your translations to the Marketplace, allowing users to customize their applications to suit their linguistic preferences. Review Process Once you've submitted your contributions to the Marketplace, they will undergo a review process to ensure quality and compatibility. This section provides an overview of the review process and what to expect during the evaluation of your submissions. Making Updates After your contributions are live on the Marketplace, you may need to make updates or revisions based on user feedback or changes in Oqtane's framework. Learn how to manage and update your submissions to provide the best possible experience for users. Promoting Your Contributions Promoting your themes, modules, and translations can help increase visibility and adoption within the Oqtane community. Discover strategies for effectively promoting your contributions and reaching a broader audience of users. By following the guidelines outlined in this manual, you can contribute to the growth and development of the Oqtane ecosystem while showcasing your talents and expertise to the community." - }, - "manuals/admin/marketplace/troubleshooting.html": { - "href": "manuals/admin/marketplace/troubleshooting.html", - "title": "Troubleshooting in the Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Troubleshooting in the Oqtane Marketplace Overview Encountering issues while using the Oqtane Marketplace? This troubleshooting guide offers solutions to common problems and helps you resolve issues related to theme and module installation, compatibility, and other Marketplace functionalities. Common Issues and Solutions Learn about common issues that users may encounter when using the Oqtane Marketplace and how to troubleshoot them effectively. From installation errors to compatibility issues, this section provides step-by-step solutions to help you resolve issues quickly and get back to using the Marketplace. Issue 1: Theme or Module Installation Error Solution: If you encounter an error while installing a theme or module from the Marketplace, follow these steps to troubleshoot the issue: Check the error message for any specific details or error codes. Ensure that your Oqtane site is running on a compatible version of the framework. Verify that you have sufficient permissions to install themes or modules on your Oqtane site. If the issue persists, try reinstalling the theme or module from the Marketplace. Issue 2: Compatibility Problems Solution: If you experience compatibility issues between themes, modules, or translations installed from the Marketplace and your Oqtane site, consider the following solutions: Check the compatibility requirements specified by the theme or module developer. Update your Oqtane site to the latest version to ensure compatibility with the latest themes and modules. Contact the developer or support team for assistance if compatibility issues persist. Issue 3: Marketplace Navigation Problems Solution: If you encounter navigation problems or difficulties accessing certain sections of the Oqtane Marketplace, try the following troubleshooting steps: Clear your browser cache and cookies to ensure that you have the latest version of the Marketplace interface. Verify that your internet connection is stable and not experiencing any disruptions. If the issue persists, try accessing the Marketplace from a different web browser or device to isolate the problem. Reporting Issues If you encounter an issue that is not covered in this troubleshooting guide or need further assistance, you can report the problem to the Oqtane support team for investigation and resolution. Provide detailed information about the issue, including any error messages or screenshots, to help expedite the troubleshooting process. By following the troubleshooting steps outlined in this guide and reporting any unresolved issues to the Oqtane support team, you can ensure a smooth and hassle-free experience while using the Oqtane Marketplace." - }, - "manuals/admin/marketplace/using-oqtane-marketplace.html": { - "href": "manuals/admin/marketplace/using-oqtane-marketplace.html", - "title": "Using The Oqtane Marketplace | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Using The Oqtane Marketplace Overview This manual will guide you through the process of using the Marketplace to enhance your Oqtane-based applications with themes, modules, and translations. To get started, navigate to the Module Management administration page to use the Oqtane Marketplace from the Administration Dashboard of your Oqtane site. From there, you can browse, install, and manage various resources to customize and extend your applications. Browsing and Discovering The Marketplace offers a vast selection of themes, modules, and translations for you to explore. Learn how to navigate the Marketplace and discover new resources for your Oqtane applications. Installing Resources Once you've found the themes, modules, or translations you need, it's time to install them on your Oqtane site. This section will walk you through the installation process, ensuring that you can quickly and easily add new features to your applications. Managing Installed Resources After installing resources from the Marketplace, you may need to manage them from time to time. Whether you want to enable, disable, or uninstall a resource, this section will show you how to effectively manage your installed themes, modules, and translations." - }, - "manuals/admin/modules/adding-modules.html": { - "href": "manuals/admin/modules/adding-modules.html", - "title": "Adding Modules to a Page | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Adding Modules to a Page In order to add a module to a page, simply open the control panel with the gear icon in the top right of a page and in the module management feature there is the ability to select a new module from the options of: Admin Module: These are only available to people within the administrator role and there are many more default modules available to put onto your webpages. Common Module: These are available both to administrators and to registered users to be able to use on pages that are specified as personalizable, meaning users can modify them as they see fit and they are unique and only viewable to registered users. Developer Module: This feature is for placing a module creator onto a page which will provide you with useful pre-built structure and methods for writing code for your own modules. There are also features after selecting the module that you would like which are the: Title: Which is what will be displayed directly above the module as its title, if nothing is selected then the module's name will be put as the title. Pane: Select which content pane you want the module to go inside of. Panes are made visible with the content editor. Container: Select if you would like to have a title displayed above the module or not have one. Adding One Module Across Multiple Pages As noted earlier, modules are reusable pieces of functionality, and as such a single module can be inserted across multiple pages in a site. Say, for example, you have an HTML module that holds a banner image and you want that banner image to also exist on five specific pages in your site. Instead of adding a new module to all five of those pages and then inserting the same image, you can simply go into the Control Panel and then click Add an Existing Module to the page. Adding already existing modules or sharing modules across multiple pages makes managing content that's repeated much more efficient. A content manager can then make edits in one module and instantly have those edits reflected across every page on which the module is shared. When a user hovers over the Modules menu item just below the Add New Module option is the Add Existing Module option. This is the option you select when you want to add a module that already exists in the site to a different page. When opting to use Add Existing Module, you must first select the page to copy a module from, which will populate the drop-down list of modules. You can then follow the same process of adding a module to the page." - }, - "manuals/admin/modules/creating-a-module.html": { - "href": "manuals/admin/modules/creating-a-module.html", - "title": "Creating a Module | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Creating a Module Learn how to create custom modules for Oqtane to extend its functionality and add new features to your applications. Overview Creating a module in Oqtane involves several steps, including setting up the project, defining module components, implementing functionality, and testing the module in different environments. Getting Started To create a module for Oqtane, follow these steps: Use the Oqtane Administration Dashboard > Module Management Create Module button to scaffold a new module project. Navigate to the project which will be located in the root folder of the Oqtane.Framework folder. Open the solution file in another instance of Visual Studio and build the project. Restart your Oqtane.Server Visual Studio application used to create the module. Implement module components, including views, services, and controllers. Define module configuration settings and permissions. Test the module locally to ensure that it behaves as expected. Package the module for distribution and installation on other Oqtane sites. Development Process The module development process typically involves: Project setup and configuration Component implementation and integration Testing and debugging Documentation and packaging Best Practices Follow the Oqtane module development guidelines and coding standards. Use dependency injection for managing dependencies and promoting modularity. Utilize Oqtane services and APIs for interacting with the platform and accessing data. Test your module in different environments to ensure compatibility and stability." - }, - "manuals/admin/modules/customizing-module-appearance.html": { - "href": "manuals/admin/modules/customizing-module-appearance.html", - "title": "Customizing Module Appearance | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Customizing Module Appearance Discover how to customize the appearance and styling of modules in Oqtane to match your site's design and branding. Overview Modules in Oqtane can be customized to align with your site's visual identity and user experience goals. By applying custom styles and design elements, you can enhance the look and feel of individual modules and create a cohesive user interface across your site. Styling Options To customize the appearance of modules in Oqtane, consider the following options: CSS stylesheets: Apply custom styles to module elements using CSS. Theme integration: Integrate modules with your site's theme to ensure consistency in design and branding. Bootstrap components: Utilize Bootstrap components and utilities for responsive and accessible design. Implementation To implement custom styling for modules in Oqtane, follow these steps: Identify the module components and elements you want to customize. Create CSS stylesheets or modify existing styles to achieve the desired appearance. Apply the styles to the module components using class names or CSS selectors. Test the custom styles across different devices and browsers to ensure compatibility and responsiveness. Best Practices Use modular CSS styles to facilitate maintenance and scalability. Leverage Oqtane's theming capabilities to ensure consistent design across modules and pages. Test custom styles in various scenarios to identify potential issues and ensure a seamless user experience." - }, - "manuals/admin/modules/index.html": { - "href": "manuals/admin/modules/index.html", - "title": "Modules | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Modules Welcome to the Modules section of the Oqtane documentation. Here you'll find detailed guides on working with modules in your Oqtane-based applications. Whether you're adding new functionality, configuring existing modules, or troubleshooting issues, this section provides comprehensive resources to assist you. What is a Module? A module is a reusable, plug-and-play piece of functionality. It's a way to extend the functionality of the framework with whatever functionality you desire. Examples of modules could be photo galleries, blogs, rotators, forms, and so on. There can be multiple modules on a page and even multiple instances of the same module on a page. It's very common to see multiple HTML modules on a single page. When you install Oqtane, the platform ships with a base set of modules already installed in the system. There are too many that come with the solution out of the box to list here, but suffice it to say that all modules needed for basic functionality within a website come with the solution. More modules can also be downloaded for use or modules that you can created can be uploaded. Modules on Pages Modules are placed onto pages in locations called “panes”. These panes are defined by the theme's designer. These themes dictates the overall look and feel of your site and is usually created by a front-end designer. Panes can span the full width of the page or be positioned in a column fashion. It may be helpful to think of panes as windows in the design of the site where you can drop in modules. You can move modules around the panes by using the content editor. This is an example of a content pane. Topics Adding Modules: Learn how to add new modules to your Oqtane site to extend its functionality. Working With Modules: Explore various tasks and operations related to managing installed modules on your site. Installing Modules: Step-by-step instructions for installing modules on your Oqtane site. Configurating Modules: Customize and configure module settings to suit your specific requirements. Troubleshooting Modules: Troubleshooting tips and solutions for common issues encountered with modules. Developing Modules: Resources and guidelines for developing custom modules for Oqtane. Feel free to explore each topic to find the information you need to effectively work with modules in your Oqtane applications." - }, - "manuals/admin/modules/module-configuration.html": { - "href": "manuals/admin/modules/module-configuration.html", - "title": "Module Configuration | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Module Configuration Explore the various configuration options available for modules in Oqtane and customize their settings to meet your specific requirements. Overview Modules in Oqtane offer a range of configuration options, allowing you to customize their behavior and appearance to suit your needs. Configuring Modules To configure a module in Oqtane, follow these steps: Navigate to the Module Management section in the Administration Dashboard. Locate the module you want to configure and click on its settings icon. Adjust the module settings as needed. Click \"Save\" to apply the changes. Configuration Options Depending on the module, configuration options may include: Settings for data sources Display options Permissions and access control Integration with other modules or services Best Practices Regularly review and update module configurations to ensure optimal performance and functionality. Test module configurations in a development environment before deploying them to production." - }, - "manuals/admin/modules/module-deployment.html": { - "href": "manuals/admin/modules/module-deployment.html", - "title": "Module Deployment | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Module Deployment Once you've developed and tested your module, it's time to deploy it to your Oqtane site. Deployment involves installing the module on your site and configuring it to meet your specific requirements. Installing the Module To install a module on your Oqtane site, follow these steps: Access Module Management: Navigate to the Module Management section in the Administration Dashboard of your Oqtane site. Upload Module Package: Click on the \"Upload Module\" button and select the module package file (*.oqp) from your local machine. Install Module: Once the module package is uploaded, click on the \"Install\" button to initiate the installation process. Confirmation: After installation, you'll receive a confirmation message indicating that the module was installed successfully. Activating the Module Modules in Oqtane are typically activated automatically upon installation. However, if needed, you can adjust module permissions to control access to the module's features. Configuring the Module After installation, you may need to configure the module settings to suit your specific requirements. This can include setting up permissions, defining custom settings, or integrating the module with other components of your site. Best Practices Testing: Before deploying the module to a production environment, thoroughly test it in a development or staging environment to ensure that it functions as expected. Documentation: Provide clear and comprehensive documentation for your module to help users understand its features and how to use them effectively. Version Control: Use version control systems like Git to manage the development and deployment of your module, allowing for easy tracking of changes and collaboration with other developers. By following these best practices, you can effectively deploy modules to your Oqtane site and enhance its functionality with custom features and capabilities." - }, - "manuals/admin/modules/module-development.html": { - "href": "manuals/admin/modules/module-development.html", - "title": "Module Development Basics | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Module Development Basics This manual provides an introduction to module development in Oqtane, covering fundamental concepts and best practices. Overview Module development in Oqtane involves creating custom components that extend the platform's functionality. Whether you're building a simple module to display content or a complex module with advanced features, understanding the basics of module development is essential. Getting Started To begin developing modules for Oqtane, you'll need: A working knowledge of ASP.NET Core Familiarity with client-side web development technologies (HTML, CSS, JavaScript) Visual Studio or a similar IDE for .NET development The Oqtane CLI for scaffolding new module projects Key Concepts Module architecture and structure Dependency injection Module lifecycle events Data access and storage User interface components and interactions Best Practices Follow the Oqtane module development guidelines and coding standards. Test your modules thoroughly in different environments to ensure compatibility and stability. Document your code and provide clear instructions for module installation and usage." - }, - "manuals/admin/modules/module-installation.html": { - "href": "manuals/admin/modules/module-installation.html", - "title": "Installing Modules | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Installing Modules Learn how to install modules on your Oqtane site to extend its functionality and add new features. Overview To install modules on your Oqtane site, follow these steps: Navigate to the Module Management section in the Administration Dashboard. Click on the \"Install Module\" button. Select the module package file (.nupkg) from your local system. Click \"Upload\" to install the module. Installation Process Navigate to the Module Management section in the Administration Dashboard. Click on the \"Install Module\" button. Browse your local system and select the module package file (.nupkg). Click \"Upload\" to initiate the installation process. Once the module is successfully installed, you'll see it listed in the Module Management section." - }, - "manuals/admin/modules/troubleshooting.html": { - "href": "manuals/admin/modules/troubleshooting.html", - "title": "Troubleshooting Modules | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Troubleshooting Modules Encountering issues with module installation or configuration? Here are some common problems and solutions: Common Issues Module Not Installing If you're having trouble installing a module, ensure that you have the correct module package and that it is compatible with your version of Oqtane. Also, check for any errors in the installation process. Module Not Functioning Properly If a module is not working as expected, verify that it is configured correctly and that any required dependencies are installed. Check the Oqtane logs for error messages or warnings that may indicate the cause of the issue. Error Messages If you encounter error messages during module installation or configuration, note down the error message and any accompanying details. Search for solutions online or consult the Oqtane community forums for assistance. Troubleshooting Steps Check Compatibility: Ensure that the module is compatible with your version of Oqtane and any other installed modules or themes. Review Configuration: Double-check the module configuration settings to ensure that everything is configured correctly. Inspect Logs: Look for error messages or warnings in the Oqtane log files, located in the /Logs directory of your Oqtane installation. Update Dependencies: Make sure that all dependencies required by the module are up-to-date and installed correctly. Contact Support: If you're unable to resolve the issue on your own, reach out to the module developer or the Oqtane community for assistance. By following these troubleshooting steps, you should be able to diagnose and resolve most module-related issues on your Oqtane site." - }, - "manuals/admin/modules/working-with-modules.html": { - "href": "manuals/admin/modules/working-with-modules.html", - "title": "Working With Modules | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Working With Modules In order to access a module's settings, you must be in the content editor. To get into the editor, simply click over the pencil icon top-right corner of the page. This puts you into the edit mode where you will see small white arrows in the top-right corner of every module on the page. These small arrows at the top left corners of each module allow you to move the module on the page, access the module's settings, edit the module, delete the module, and access any specific functionality related to the module. Once in Edit mode you will notice that Oqtane uses a very user-friendly and intuitive approach to managing content. Whenever you want to edit content in Oqtane, you go to the location where the content resides and edit it right there in place. Moving Modules Once a module is on the page, you can move its location again if needed. All that is needed is to enter the content editor by clicking on the pencil icon in the top right hand side with editing permission on a certain page. And then selecting the small downward pointing arrow in the top left of the module to do a variety of things to it, including: Move to Top: Moves the modules to the top of the page to be the first module displayed. Move Up: Moves the module up to be above the module above it. Move Down: Move the module down below the module beneath it. Move to Bottom: Moves the module to the bottom of the page, below all other modules. If the page has the layout for multiple panes, which will allows for three center rows and a top and bottom row that can have content inserted into them, then there will be additional options available which are: Move to Top Pane: Moves the module to the content pane at the top of the page. Move to Left Pane: Moves the module to the left-most column. Move to Right Pane: Moves the module to the right-most column. Move to Content Pane: Moves the module to the central column. Move to Bottom Pane: Moves the module to the pane at the bottom of the page." - }, - "manuals/admin/site-administration/content-editor.html": { - "href": "manuals/admin/site-administration/content-editor.html", - "title": "Content Editor | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Content Editor The content editor is what allows you to edit the modules on the page in a variety of ways. You access the content editor by clicking on the pencil on the top right side of the page which then shows the borders of the content pane which the modules are put inside of, as well as a small downward pointing arrow beside each module that allows you to open a menu to interact with the modules. The options for the module's menu are: Manage Settings: Brings up the module's settings and permissions which allow you to change the: Title: The title displayed above the module. Container: Specify if you want the title to be displayed for the module. Display on All Pages: Choose whether you want this module to be on every page on the site. Page: Change the page that the module is displayed on. Permissions: Specify either what roles or individual users should be able to view or edit the page. Unpublish Module: Hides the module from everyone, but the site administrators for instances where you want to edit modules. Delete Module: Deletes the module from the page. Import Content: Enter a file's address to import it into the module, such as a image address to include it. Export Content: Enter a file address to select where to export data from a module. Move to Top: Moves the modules to the top of the page to be the first module displayed. Move Up: Moves the module up to be above the module above it. Move Down: Move the module down below the module beneath it. Move to Bottom: Moves the module to the bottom of the page, below all other modules. If the page has the layout for multiple panes, which will allows for three center rows and a top and bottom row that can have content inserted into them, then there will be additional options available which are: Move to Top Pane: Moves the module to the content pane at the top of the page. Move to Left Pane: Moves the module to the left-most column. Move to Right Pane: Moves the module to the right-most column. Move to Content Pane: Moves the module to the central column. Move to Bottom Pane: Moves the module to the pane at the bottom of the page." - }, - "manuals/admin/site-administration/index.html": { - "href": "manuals/admin/site-administration/index.html", - "title": "Site Administration | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Site Administration Site administration in Oqtane is the processes, tasks, and features that it takes to effectively run a website in Oqtane. This includes things like managing users, security, site settings, configurations, and content using the features available to them, in both the control panel and the admin dashboard. Site administration can take on many forms, but there are two use cases that you should be familiar with. First, there's site administration as defined by Oqtane.You enable this by adding the Administrators security role as one of the assigned roles for the account. That way, all “admin” features will be available for that user across that specific site. Site administration can take on a hybrid of another sort as well, where you as the site administrator can define a different kind of administration for your site. This would be a kind of administration where you define a subset of administration capabilities and assign them to more privileged users to avoid having to make them an actual administrator. As an example, there may be times when you want to create a security role in the role manager that might be named something like Site Admin. You would then create a page or pages on the site that contain some of the Admin modules, assigning permission to the newly created Site Admin security role so that only participants of that security role can see them. In these areas, you can also add references or links to features that normally require Administrator permissions, provided you set up your permissions properly in those other areas and that the chosen feature(s) allows this. In summary, you can perform all of the configuration and content management tasks that you need to in order to run your own site." - }, - "manuals/admin/themes/assets/placeholder.html": { - "href": "manuals/admin/themes/assets/placeholder.html", - "title": "| Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "" - }, - "manuals/admin/themes/index.html": { - "href": "manuals/admin/themes/index.html", - "title": "| Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Overview Get an overview of the themes section and its contents. Theme Management Explore theme management options, including installation, configuration, and troubleshooting. Installation Learn how to install themes on your Oqtane site to customize its appearance and enhance user experience. Configuration Explore the various configuration options available for themes in Oqtane and customize their settings to meet your specific requirements. Troubleshooting Encountering issues with theme installation or configuration? This section provides troubleshooting tips and solutions to common problems. Developing Themes Learn how to develop custom themes for your Oqtane site." - }, - "manuals/admin/themes/theme-configuration.html": { - "href": "manuals/admin/themes/theme-configuration.html", - "title": "Theme Configuration | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Theme Configuration Overview This manual provides guidance on configuring themes in Oqtane to customize their appearance and behavior according to your preferences. To access theme configuration settings, navigate to the Theme Management section in the Administration Dashboard of your Oqtane site. You can find this section by following these steps: Go to the Control Panel in the Administration Dashboard. Select \"Theme Management\" from the menu to access the theme configuration page. From there, you can adjust various options and settings to tailor the theme to your needs. Customization Options Themes in Oqtane offer a range of customization options, including: Color schemes Fonts and typography Layout and design elements Navigation menus Widget placement and configuration Step-by-Step Guide Navigate to the Administration Dashboard of your Oqtane site. Click on \"Theme Management\" to access the theme configuration page. Select the theme you want to configure from the list of installed themes. Explore the available customization options and settings. Make adjustments as desired to customize the theme to your liking. Save your changes to apply the configuration settings to the selected theme. Best Practices Experiment with different configuration options to find the look and feel that best suits your site. Regularly review and update theme configuration settings to keep your site's design fresh and relevant. Test the theme after making configuration changes to ensure that everything displays correctly and functions as expected. By following these guidelines, you can effectively configure themes in Oqtane to create visually appealing and user-friendly websites. Site Settings To configure themes at the site level, navigate to the \"Site Settings\" section in the Control Panel's Administration Dashboard. Here, you can access theme configuration settings and customize the appearance of your entire site. Page Management To configure themes at the page level, access the \"Page Management\" section in the Control Panel. Click the \"Edit\" button next to the page you want to configure, and then navigate to the Appearance Configuration section. Here, you can customize the appearance of individual pages using theme-specific settings." - }, - "manuals/admin/themes/theme-development.html": { - "href": "manuals/admin/themes/theme-development.html", - "title": "Developing Themes | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Developing Themes Overview This manual serves as a guide for developers who want to create custom themes for the Oqtane framework. Whether you're looking to customize the appearance of your own site or contribute themes to the Oqtane Marketplace, this guide will help you get started with theme development. Getting Started To begin developing themes for Oqtane, you'll need a basic understanding of HTML, CSS, and JavaScript. Familiarity with Razor syntax and Blazor components is also beneficial, as Oqtane themes are built using these technologies. Theme Structure Oqtane themes follow a modular structure and consist of various components, including: Layouts: Define the overall structure and design of the theme. Views: Render content and components within the theme layout. Stylesheets: Define the visual appearance and styling of theme elements. JavaScript: Add interactivity and dynamic behavior to the theme. Theme Development Tools Several tools and resources are available to aid in theme development for Oqtane, including: Visual Studio: A lightweight and versatile code editor with support for HTML, CSS, and JavaScript. Visit Visual Studio for more information. Visual Studio Code: A lightweight and versatile code editor with support for HTML, CSS, and JavaScript. Visit Visual Studio Code for more information. Browser Developer Tools: Built-in tools for debugging and inspecting elements in web browsers (F12). Best Practices When developing themes for Oqtane, consider the following best practices: Keep your theme code modular, organized, and well-documented. Optimize your theme assets (HTML, CSS, JavaScript) for performance and accessibility. Test your theme across different browsers and devices to ensure compatibility and responsiveness. Stay up to date with Oqtane updates and conventions to leverage the latest features and improvements. By following these guidelines and best practices, you can create high-quality themes for Oqtane that enhance the visual appeal and usability of your applications." - }, - "manuals/admin/themes/theme-installation.html": { - "href": "manuals/admin/themes/theme-installation.html", - "title": "Theme Installation | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Theme Installation Overview This manual will guide you through the process of installing themes on your Oqtane site to customize its appearance and enhance user experience. To get started, navigate to the Theme Management section in the Administration Dashboard of your Oqtane site. From there, you can browse and install themes from the available options. Step-by-Step Guide Navigate to the Administration Dashboard of your Oqtane site. Click on \"Theme Management\" to access the theme installation page. Browse the available themes and select the one you want to install. Click on the \"Install\" button next to the chosen theme. Follow any prompts or instructions provided to complete the installation process. Once the installation is complete, the theme will be available for use on your Oqtane site. Additional Considerations Ensure that the theme you choose is compatible with your Oqtane site version. Check for any dependencies or additional requirements specified by the theme developer. Test the theme after installation to ensure that it displays correctly and functions as expected. By following these steps, you can easily install themes on your Oqtane site and customize its appearance to suit your needs." - }, - "manuals/admin/themes/theme-management.html": { - "href": "manuals/admin/themes/theme-management.html", - "title": "Theme Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Theme Management Installation Learn how to install themes on your Oqtane site to customize its appearance and enhance user experience. Configuration Explore the various configuration options available for themes in Oqtane and customize their settings to meet your specific requirements. Troubleshooting Encountering issues with theme installation or configuration? This section provides troubleshooting tips and solutions to common problems." - }, - "manuals/admin/themes/troubleshooting.html": { - "href": "manuals/admin/themes/troubleshooting.html", - "title": "Troubleshooting | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", - "keywords": "Troubleshooting Encountering issues with theme installation or configuration? Here are some common problems and solutions: Common Issues Theme Not Installing If you're having trouble installing a theme, ensure that you have the correct theme package and that it is compatible with your version of Oqtane. Also, check for any errors in the installation process. Theme Appearance Not Changing If you've installed a theme but don't see any changes on your site, try clearing your browser cache and refreshing the page. Additionally, check if the theme is activated and configured correctly in the Theme Management section. Error Messages If you encounter error messages during theme installation or configuration, note down the error message and any accompanying details. Search for solutions online or consult the Oqtane community forums for assistance. Troubleshooting Steps Check Compatibility: Ensure that the theme is compatible with your version of Oqtane and any other installed modules or themes. Review Configuration: Double-check the theme configuration settings to ensure that everything is configured correctly. Inspect Logs: Look for error messages or warnings in the Oqtane log files, located in the /Logs directory of your Oqtane installation. Update Dependencies: Make sure that all dependencies required by the theme are up-to-date and installed correctly. Contact Support: If you're unable to resolve the issue on your own, reach out to the theme developer or the Oqtane community for assistance. By following these troubleshooting steps, you should be able to diagnose and resolve most theme-related issues on your Oqtane site." - }, "manuals/how-to/restart/index.html": { "href": "manuals/how-to/restart/index.html", "title": "How To Restart Oqtane | Oqtane Docs - APIs and more for the Modular Blazor Application Framework", diff --git a/docs/manifest.json b/docs/manifest.json index cd35b39a4..1e0cb8545 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -4584,1960 +4584,4073 @@ }, { "type": "Conceptual", - "source_relative_path": "pages/guides/render/index.md", + "source_relative_path": "pages/guides/installation/index.md", "output": { ".html": { - "relative_path": "guides/render/index.html" + "relative_path": "guides/installation/index.html" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/guides/roadmap/index.md", + "type": "Toc", + "source_relative_path": "pages/guides/installation/toc.yml", "output": { ".html": { - "relative_path": "guides/roadmap/index.html" - } - }, - "version": "" - }, - { - "type": "Resource", - "source_relative_path": "pages/guides/themes/assets/oqtane-theme-blazor-cms.org.jpg", - "output": { - "resource": { - "relative_path": "pages/guides/themes/assets/oqtane-theme-blazor-cms.org.jpg" - } - }, - "version": "" - }, - { - "type": "Resource", - "source_relative_path": "pages/guides/themes/assets/oqtane-theme-files-in-wwwroot.jpg", - "output": { - "resource": { - "relative_path": "pages/guides/themes/assets/oqtane-theme-files-in-wwwroot.jpg" - } - }, - "version": "" - }, - { - "type": "Resource", - "source_relative_path": "pages/guides/themes/assets/oqtane-theme-solution.jpg", - "output": { - "resource": { - "relative_path": "pages/guides/themes/assets/oqtane-theme-solution.jpg" - } - }, - "version": "" - }, - { - "type": "Resource", - "source_relative_path": "pages/guides/themes/generator/assets/system-themes-with-new-theme.jpg", - "output": { - "resource": { - "relative_path": "pages/guides/themes/generator/assets/system-themes-with-new-theme.jpg" - } - }, - "version": "" - }, - { - "type": "Resource", - "source_relative_path": "pages/guides/themes/generator/assets/theme-build-package-solution.jpg", - "output": { - "resource": { - "relative_path": "pages/guides/themes/generator/assets/theme-build-package-solution.jpg" + "relative_path": "pages/guides/installation/toc.html" + }, + ".json": { + "relative_path": "pages/guides/installation/toc.json" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/guides/themes/generator/assets/theme-folder-side-by-side.jpg", + "type": "Conceptual", + "source_relative_path": "pages/guides/marketplace/index.md", "output": { - "resource": { - "relative_path": "pages/guides/themes/generator/assets/theme-folder-side-by-side.jpg" + ".html": { + "relative_path": "guides/marketplace/index.html" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/guides/themes/generator/assets/theme-folder-solution-file.jpg", + "type": "Conceptual", + "source_relative_path": "pages/guides/marketplace/monetization.md", "output": { - "resource": { - "relative_path": "pages/guides/themes/generator/assets/theme-folder-solution-file.jpg" + ".html": { + "relative_path": "guides/marketplace/monetization.html" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/guides/themes/generator/assets/theme-solution-showing-theme-info.jpg", + "type": "Conceptual", + "source_relative_path": "pages/guides/marketplace/submitting-contributions.md", "output": { - "resource": { - "relative_path": "pages/guides/themes/generator/assets/theme-solution-showing-theme-info.jpg" + ".html": { + "relative_path": "guides/marketplace/submitting-contributions.html" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/guides/themes/generator/assets/theme-wizard-confirmation.jpg", + "type": "Toc", + "source_relative_path": "pages/guides/marketplace/toc.yml", "output": { - "resource": { - "relative_path": "pages/guides/themes/generator/assets/theme-wizard-confirmation.jpg" + ".html": { + "relative_path": "pages/guides/marketplace/toc.html" + }, + ".json": { + "relative_path": "pages/guides/marketplace/toc.json" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/guides/themes/generator/assets/theme-wizard-step-1.jpg", + "type": "Conceptual", + "source_relative_path": "pages/guides/marketplace/using-oqtane-marketplace.md", "output": { - "resource": { - "relative_path": "pages/guides/themes/generator/assets/theme-wizard-step-1.jpg" + ".html": { + "relative_path": "guides/marketplace/using-oqtane-marketplace.html" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/guides/themes/generator/assets/theme-wizard-step-before.jpg", + "type": "Conceptual", + "source_relative_path": "pages/guides/modules/creating-a-module.md", "output": { - "resource": { - "relative_path": "pages/guides/themes/generator/assets/theme-wizard-step-before.jpg" + ".html": { + "relative_path": "guides/modules/creating-a-module.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/guides/themes/generator/index.md", + "source_relative_path": "pages/guides/modules/customizing-module-appearance.md", "output": { ".html": { - "relative_path": "guides/themes/generator/index.html" + "relative_path": "guides/modules/customizing-module-appearance.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/guides/themes/index.md", + "source_relative_path": "pages/guides/modules/index.md", "output": { ".html": { - "relative_path": "guides/themes/index.html" + "relative_path": "guides/modules/index.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/guides/themes/oqtane-theme-code-explained.md", + "source_relative_path": "pages/guides/modules/module-deployment.md", "output": { ".html": { - "relative_path": "guides/themes/oqtane-theme-code-explained.html" + "relative_path": "guides/modules/module-deployment.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/guides/themes/oqtane-theme-distribution.md", + "source_relative_path": "pages/guides/modules/module-development.md", "output": { ".html": { - "relative_path": "guides/themes/oqtane-theme-distribution.html" + "relative_path": "guides/modules/module-development.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/guides/themes/oqtane-theme-solution-explained.md", + "source_relative_path": "pages/guides/modules/module-installation.md", "output": { ".html": { - "relative_path": "guides/themes/oqtane-theme-solution-explained.html" + "relative_path": "guides/modules/module-installation.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/guides/themes/parts-of-an-oqtane-theme.md", + "source_relative_path": "pages/guides/modules/modules.md", "output": { ".html": { - "relative_path": "guides/themes/parts-of-an-oqtane-theme.html" + "relative_path": "guides/modules/modules.html" } }, "version": "" }, { "type": "Toc", - "source_relative_path": "pages/guides/themes/toc.yml", + "source_relative_path": "pages/guides/modules/toc.yml", "output": { ".html": { - "relative_path": "pages/guides/themes/toc.html" + "relative_path": "pages/guides/modules/toc.html" }, ".json": { - "relative_path": "pages/guides/themes/toc.json" + "relative_path": "pages/guides/modules/toc.json" } }, "version": "" }, { - "type": "Toc", - "source_relative_path": "pages/guides/toc.yml", + "type": "Conceptual", + "source_relative_path": "pages/guides/render/index.md", "output": { ".html": { - "relative_path": "pages/guides/toc.html" - }, - ".json": { - "relative_path": "pages/guides/toc.json" + "relative_path": "guides/render/index.html" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/add-page.png", + "type": "Conceptual", + "source_relative_path": "pages/guides/roadmap/index.md", "output": { - "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/add-page.png" + ".html": { + "relative_path": "guides/roadmap/index.html" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/add-profile.png", + "source_relative_path": "pages/guides/themes/assets/oqtane-theme-blazor-cms.org.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/add-profile.png" + "relative_path": "pages/guides/themes/assets/oqtane-theme-blazor-cms.org.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/admin-dash.png", + "source_relative_path": "pages/guides/themes/assets/oqtane-theme-files-in-wwwroot.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/admin-dash.png" + "relative_path": "pages/guides/themes/assets/oqtane-theme-files-in-wwwroot.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/edit-profile.png", + "source_relative_path": "pages/guides/themes/assets/oqtane-theme-solution.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/edit-profile.png" + "relative_path": "pages/guides/themes/assets/oqtane-theme-solution.jpg" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/file-management.png", + "type": "Conceptual", + "source_relative_path": "pages/guides/themes/assets/placeholder.md", "output": { - "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/file-management.png" + ".html": { + "relative_path": "guides/themes/assets/placeholder.html" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/page-appearance.png", + "source_relative_path": "pages/guides/themes/generator/assets/system-themes-with-new-theme.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/page-appearance.png" + "relative_path": "pages/guides/themes/generator/assets/system-themes-with-new-theme.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/page-management.png", + "source_relative_path": "pages/guides/themes/generator/assets/theme-build-package-solution.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/page-management.png" + "relative_path": "pages/guides/themes/generator/assets/theme-build-package-solution.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/permissions.png", + "source_relative_path": "pages/guides/themes/generator/assets/theme-folder-side-by-side.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/permissions.png" + "relative_path": "pages/guides/themes/generator/assets/theme-folder-side-by-side.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/profile-management.png", + "source_relative_path": "pages/guides/themes/generator/assets/theme-folder-solution-file.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/profile-management.png" + "relative_path": "pages/guides/themes/generator/assets/theme-folder-solution-file.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/pwa-settings.png", + "source_relative_path": "pages/guides/themes/generator/assets/theme-solution-showing-theme-info.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/pwa-settings.png" + "relative_path": "pages/guides/themes/generator/assets/theme-solution-showing-theme-info.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/recycle-bin.png", + "source_relative_path": "pages/guides/themes/generator/assets/theme-wizard-confirmation.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/recycle-bin.png" + "relative_path": "pages/guides/themes/generator/assets/theme-wizard-confirmation.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/site-settings-1.png", + "source_relative_path": "pages/guides/themes/generator/assets/theme-wizard-step-1.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/site-settings-1.png" + "relative_path": "pages/guides/themes/generator/assets/theme-wizard-step-1.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/site-settings-2.png", + "source_relative_path": "pages/guides/themes/generator/assets/theme-wizard-step-before.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/site-settings-2.png" + "relative_path": "pages/guides/themes/generator/assets/theme-wizard-step-before.jpg" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/smtp-settings.png", + "type": "Conceptual", + "source_relative_path": "pages/guides/themes/generator/index.md", "output": { - "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/smtp-settings.png" + ".html": { + "relative_path": "guides/themes/generator/index.html" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/user-identity.png", + "type": "Conceptual", + "source_relative_path": "pages/guides/themes/index-old.md", "output": { - "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/user-identity.png" + ".html": { + "relative_path": "guides/themes/index-old.html" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/user-management.png", + "type": "Conceptual", + "source_relative_path": "pages/guides/themes/index.md", "output": { - "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/user-management.png" + ".html": { + "relative_path": "guides/themes/index.html" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/manuals/admin/admin-dashboard/assets/user-profile.png", + "type": "Conceptual", + "source_relative_path": "pages/guides/themes/oqtane-theme-code-explained.md", "output": { - "resource": { - "relative_path": "pages/manuals/admin/admin-dashboard/assets/user-profile.png" + ".html": { + "relative_path": "guides/themes/oqtane-theme-code-explained.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/admin-dashboard/file-management.md", + "source_relative_path": "pages/guides/themes/oqtane-theme-distribution.md", "output": { ".html": { - "relative_path": "manuals/admin/admin-dashboard/file-management.html" + "relative_path": "guides/themes/oqtane-theme-distribution.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/admin-dashboard/index.md", + "source_relative_path": "pages/guides/themes/oqtane-theme-solution-explained.md", "output": { ".html": { - "relative_path": "manuals/admin/admin-dashboard/index.html" + "relative_path": "guides/themes/oqtane-theme-solution-explained.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/admin-dashboard/page-management.md", + "source_relative_path": "pages/guides/themes/parts-of-an-oqtane-theme.md", "output": { ".html": { - "relative_path": "manuals/admin/admin-dashboard/page-management.html" + "relative_path": "guides/themes/parts-of-an-oqtane-theme.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/admin-dashboard/profile-management.md", + "source_relative_path": "pages/guides/themes/theme-configuration.md", "output": { ".html": { - "relative_path": "manuals/admin/admin-dashboard/profile-management.html" + "relative_path": "guides/themes/theme-configuration.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/admin-dashboard/recycle-bin.md", + "source_relative_path": "pages/guides/themes/theme-development.md", "output": { ".html": { - "relative_path": "manuals/admin/admin-dashboard/recycle-bin.html" + "relative_path": "guides/themes/theme-development.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/admin-dashboard/role-management.md", + "source_relative_path": "pages/guides/themes/theme-installation.md", "output": { ".html": { - "relative_path": "manuals/admin/admin-dashboard/role-management.html" + "relative_path": "guides/themes/theme-installation.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/admin-dashboard/site-settings.md", + "source_relative_path": "pages/guides/themes/theme-management.md", "output": { ".html": { - "relative_path": "manuals/admin/admin-dashboard/site-settings.html" + "relative_path": "guides/themes/theme-management.html" } }, "version": "" }, { "type": "Toc", - "source_relative_path": "pages/manuals/admin/admin-dashboard/toc.yml", + "source_relative_path": "pages/guides/themes/toc.yml", "output": { ".html": { - "relative_path": "pages/manuals/admin/admin-dashboard/toc.html" + "relative_path": "pages/guides/themes/toc.html" }, ".json": { - "relative_path": "pages/manuals/admin/admin-dashboard/toc.json" + "relative_path": "pages/guides/themes/toc.json" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/admin-dashboard/user-management.md", + "type": "Toc", + "source_relative_path": "pages/guides/toc.yml", "output": { ".html": { - "relative_path": "manuals/admin/admin-dashboard/user-management.html" + "relative_path": "pages/guides/toc.html" + }, + ".json": { + "relative_path": "pages/guides/toc.json" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/manuals/admin/control-panel/assets/add-page.png", + "type": "Conceptual", + "source_relative_path": "pages/guides/troubleshooting/index.md", "output": { - "resource": { - "relative_path": "pages/manuals/admin/control-panel/assets/add-page.png" + ".html": { + "relative_path": "guides/troubleshooting/index.html" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/manuals/admin/control-panel/assets/control-panel-modules.png", + "type": "Toc", + "source_relative_path": "pages/guides/troubleshooting/toc.yml", "output": { - "resource": { - "relative_path": "pages/manuals/admin/control-panel/assets/control-panel-modules.png" + ".html": { + "relative_path": "pages/guides/troubleshooting/toc.html" + }, + ".json": { + "relative_path": "pages/guides/troubleshooting/toc.json" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/manuals/admin/control-panel/assets/control-panel.png", + "type": "Conceptual", + "source_relative_path": "pages/guides/troubleshooting/troubleshooting-installations.md", "output": { - "resource": { - "relative_path": "pages/manuals/admin/control-panel/assets/control-panel.png" + ".html": { + "relative_path": "guides/troubleshooting/troubleshooting-installations.html" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/manuals/admin/control-panel/assets/page-appearance.png", + "type": "Conceptual", + "source_relative_path": "pages/guides/troubleshooting/troubleshooting-login-issues.md", "output": { - "resource": { - "relative_path": "pages/manuals/admin/control-panel/assets/page-appearance.png" + ".html": { + "relative_path": "guides/troubleshooting/troubleshooting-login-issues.html" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/manuals/admin/control-panel/assets/page-management.png", + "type": "Conceptual", + "source_relative_path": "pages/guides/troubleshooting/troubleshooting-marketplace.md", "output": { - "resource": { - "relative_path": "pages/manuals/admin/control-panel/assets/page-management.png" + ".html": { + "relative_path": "guides/troubleshooting/troubleshooting-marketplace.html" } }, "version": "" }, { - "type": "Resource", - "source_relative_path": "pages/manuals/admin/control-panel/assets/permissions.png", + "type": "Conceptual", + "source_relative_path": "pages/guides/troubleshooting/troubleshooting-modules.md", "output": { - "resource": { - "relative_path": "pages/manuals/admin/control-panel/assets/permissions.png" + ".html": { + "relative_path": "guides/troubleshooting/troubleshooting-modules.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/control-panel/index.md", + "source_relative_path": "pages/guides/troubleshooting/troubleshooting-themes.md", "output": { ".html": { - "relative_path": "manuals/admin/control-panel/index.html" + "relative_path": "guides/troubleshooting/troubleshooting-themes.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/control-panel/modules.md", + "source_relative_path": "pages/guides/troubleshooting/troubleshooting-user-registration-email-verification.md", "output": { ".html": { - "relative_path": "manuals/admin/control-panel/modules.html" + "relative_path": "guides/troubleshooting/troubleshooting-user-registration-email-verification.html" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/control-panel/page-management.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/add-page.png", "output": { - ".html": { - "relative_path": "manuals/admin/control-panel/page-management.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/add-page.png" } }, "version": "" }, { - "type": "Toc", - "source_relative_path": "pages/manuals/admin/control-panel/toc.yml", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/add-profile.png", "output": { - ".html": { - "relative_path": "pages/manuals/admin/control-panel/toc.html" - }, - ".json": { - "relative_path": "pages/manuals/admin/control-panel/toc.json" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/add-profile.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/host-administration/assets/edit-jobs.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-dash.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/host-administration/assets/edit-jobs.png" + "relative_path": "pages/manuals/admin/admin-management/assets/admin-dash.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/host-administration/assets/event-function.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-file-management.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/host-administration/assets/event-function.png" + "relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-file-management.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/host-administration/assets/event-level.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-language-management.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/host-administration/assets/event-level.png" + "relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-language-management.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/host-administration/assets/module-management.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-page-management.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/host-administration/assets/module-management.png" + "relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-page-management.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/host-administration/assets/site-management.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-profile-management.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/host-administration/assets/site-management.png" + "relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-profile-management.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/host-administration/assets/sql-management.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-recycle-bin.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/host-administration/assets/sql-management.png" + "relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-recycle-bin.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/host-administration/assets/theme-management.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-role-management.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/host-administration/assets/theme-management.png" + "relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-role-management.jpg" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/host-administration/event-log.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-search-settings.jpg", "output": { - ".html": { - "relative_path": "manuals/admin/host-administration/event-log.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-search-settings.jpg" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/host-administration/index.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-search.jpg", "output": { - ".html": { - "relative_path": "manuals/admin/host-administration/index.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-search.jpg" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/host-administration/module-management.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-site-settings.jpg", "output": { - ".html": { - "relative_path": "manuals/admin/host-administration/module-management.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-site-settings.jpg" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/host-administration/scheduled-jobs.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-url-mappings.jpg", "output": { - ".html": { - "relative_path": "manuals/admin/host-administration/scheduled-jobs.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-url-mappings.jpg" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/host-administration/site-management.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-user-management.jpg", "output": { - ".html": { - "relative_path": "manuals/admin/host-administration/site-management.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-user-management.jpg" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/host-administration/sql-management.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-visitor-management.jpg", "output": { - ".html": { - "relative_path": "manuals/admin/host-administration/sql-management.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/admin-dashboard-visitor-management.jpg" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/host-administration/system-info.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-pwa-settings.png", "output": { - ".html": { - "relative_path": "manuals/admin/host-administration/system-info.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/admin-pwa-settings.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/host-administration/system-update.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/admin-search-settings-administration.jpg", "output": { - ".html": { - "relative_path": "manuals/admin/host-administration/system-update.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/admin-search-settings-administration.jpg" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/host-administration/theme-management.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/control-panel-admin-dashboard-button.jpg", "output": { - ".html": { - "relative_path": "manuals/admin/host-administration/theme-management.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/control-panel-admin-dashboard-button.jpg" } }, "version": "" }, { - "type": "Toc", - "source_relative_path": "pages/manuals/admin/host-administration/toc.yml", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/control-panel-button.jpg", "output": { - ".html": { - "relative_path": "pages/manuals/admin/host-administration/toc.html" - }, - ".json": { - "relative_path": "pages/manuals/admin/host-administration/toc.json" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/control-panel-button.jpg" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/index.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/edit-profile.png", "output": { - ".html": { - "relative_path": "manuals/admin/index.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/edit-profile.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/admin-dashboard-site-settings.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/file-management-add-folder-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/admin-dashboard-site-settings.png" + "relative_path": "pages/manuals/admin/admin-management/assets/file-management-add-folder-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/apache-http-server-logo.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/file-management-download-files.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/apache-http-server-logo.png" + "relative_path": "pages/manuals/admin/admin-management/assets/file-management-download-files.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/control-panel-admin-dashboard.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/file-management-edit-file-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/control-panel-admin-dashboard.png" + "relative_path": "pages/manuals/admin/admin-management/assets/file-management-edit-file-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/linux-logo.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/file-management-edit-file.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/linux-logo.png" + "relative_path": "pages/manuals/admin/admin-management/assets/file-management-edit-file.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/maui-run-windows-machine.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/file-management-edit-folder-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/maui-run-windows-machine.png" + "relative_path": "pages/manuals/admin/admin-management/assets/file-management-edit-folder-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/maui-set-local-development-url.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/file-management-search.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/maui-set-local-development-url.png" + "relative_path": "pages/manuals/admin/admin-management/assets/file-management-search.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/maui-set-url.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/file-management-select-folder.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/maui-set-url.png" + "relative_path": "pages/manuals/admin/admin-management/assets/file-management-select-folder.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/maui-solution.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/file-management-upload-files-buttons.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/maui-solution.png" + "relative_path": "pages/manuals/admin/admin-management/assets/file-management-upload-files-buttons.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/microsoft-azure-logo.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/file-management-upload-files.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/microsoft-azure-logo.png" + "relative_path": "pages/manuals/admin/admin-management/assets/file-management-upload-files.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/microsoft-dot-net-logo.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/file-management-upload-folder-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/microsoft-dot-net-logo.png" + "relative_path": "pages/manuals/admin/admin-management/assets/file-management-upload-folder-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/microsoft-office-teams-logo.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/file-management-upload-folder.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/microsoft-office-teams-logo.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/file-management-upload-folder.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/ms-sql-server-logo.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/file-management.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/ms-sql-server-logo.png" + "relative_path": "pages/manuals/admin/admin-management/assets/file-management.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/mysql-logo.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/language-management-add-language-settings.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/mysql-logo.png" + "relative_path": "pages/manuals/admin/admin-management/assets/language-management-add-language-settings.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/oqtane-automated-upgrade-process.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/language-management-add-language.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/oqtane-automated-upgrade-process.png" + "relative_path": "pages/manuals/admin/admin-management/assets/language-management-add-language.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/postgresql-logo.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/language-management-edit-delete-buttons.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/postgresql-logo.png" + "relative_path": "pages/manuals/admin/admin-management/assets/language-management-edit-delete-buttons.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/red-hat-enterprise-linux-logo.svg.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/language-management-edit-settings.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/red-hat-enterprise-linux-logo.svg.png" + "relative_path": "pages/manuals/admin/admin-management/assets/language-management-edit-settings.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/site-settings-ui-component-settings-hybrid-enabled.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/language-management-list.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/site-settings-ui-component-settings-hybrid-enabled.png" + "relative_path": "pages/manuals/admin/admin-management/assets/language-management-list.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/sqlite-logo.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/language-management-navigation-menu-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/sqlite-logo.png" + "relative_path": "pages/manuals/admin/admin-management/assets/language-management-navigation-menu-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/ubuntu-logo-2022.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/language-management-navigation-select-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/ubuntu-logo-2022.png" + "relative_path": "pages/manuals/admin/admin-management/assets/language-management-navigation-select-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/ubuntu-logo.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/language-management-search.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/ubuntu-logo.png" + "relative_path": "pages/manuals/admin/admin-management/assets/language-management-search.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/user-management-token-settings.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/language-management.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/user-management-token-settings.png" + "relative_path": "pages/manuals/admin/admin-management/assets/language-management.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/visual-studio-logo.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/navigation-search.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/visual-studio-logo.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/navigation-search.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/visual-studio-logo.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/page-appearance.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/visual-studio-logo.png" + "relative_path": "pages/manuals/admin/admin-management/assets/page-appearance.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/windows-11-logo.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/page-management-add-page-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/windows-11-logo.png" + "relative_path": "pages/manuals/admin/admin-management/assets/page-management-add-page-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/windows-logo.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/page-management-modules.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/windows-logo.png" + "relative_path": "pages/manuals/admin/admin-management/assets/page-management-modules.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/assets/windows-server-2022-logo.svg.png", + "source_relative_path": "pages/manuals/admin/admin-management/assets/page-management-page-action-buttons.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/assets/windows-server-2022-logo.svg.png" + "relative_path": "pages/manuals/admin/admin-management/assets/page-management-page-action-buttons.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/databases.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/page-management-permissions.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/databases.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/page-management-permissions.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/deploy-to-azure.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/page-management-search-page.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/deploy-to-azure.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/page-management-search-page.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/development-vs-code-linux.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/page-management-settings-appearance.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/development-vs-code-linux.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/page-management-settings-appearance.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/development-vs-code.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/page-management-settings-page-content.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/development-vs-code.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/page-management-settings-page-content.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/development.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/page-management-settings.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/development.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/page-management-settings.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/index.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/page-management-theme-settings.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/index.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/page-management-theme-settings.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/linux-ubuntu-apache-mysql.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/page-management.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/linux-ubuntu-apache-mysql.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/page-management.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/linux-ubuntu-apache-postgresql.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/permissions.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/linux-ubuntu-apache-postgresql.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/permissions.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/maui-setup.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/profile-management-add-button.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/maui-setup.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/profile-management-add-button.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/resources.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/profile-management-add.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/resources.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/profile-management-add.png" } }, "version": "" }, { - "type": "Toc", - "source_relative_path": "pages/manuals/admin/installation/toc.yml", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/profile-management-edit-button.png", "output": { - ".html": { - "relative_path": "pages/manuals/admin/installation/toc.html" - }, - ".json": { - "relative_path": "pages/manuals/admin/installation/toc.json" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/profile-management-edit-button.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/troubleshooting.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/profile-management-edit.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/troubleshooting.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/profile-management-edit.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/upgrade.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/profile-management-search.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/upgrade.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/profile-management-search.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/121 Get from Github.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/profile-management.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/121 Get from Github.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/profile-management.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/200 Compile Oqtane.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-modules-restore-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/200 Compile Oqtane.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-modules-restore-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/201 Disable HotReload.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-modules.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/201 Disable HotReload.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-modules.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Installing.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-pages-remove-all-deleted-modules-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Installing.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-pages-remove-all-deleted-modules-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Settings.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-pages-remove-all-deleted-modules-confirmation.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Settings.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-pages-remove-all-deleted-modules-confirmation.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/291 Oqtane Installed.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-pages-remove-all-deleted-pages-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/291 Oqtane Installed.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-pages-remove-all-deleted-pages-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/292 Login as Super User.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-pages-remove-all-deleted-pages-confirmation.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/292 Login as Super User.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-pages-remove-all-deleted-pages-confirmation.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/293 Oqtane Logged In.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-pages-restore-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/293 Oqtane Logged In.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin-pages-restore-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/311 Go to Modules - Open Menu.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/311 Go to Modules - Open Menu.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/recycle-bin.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/312 Go to Modules - Admin Dashboard.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/role-management-add-role-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/312 Go to Modules - Admin Dashboard.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/role-management-add-role-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/313 Go to Modules - Module Management.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/role-management-add.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/313 Go to Modules - Module Management.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/role-management-add.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/321 Install Module Start.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/role-management-edit-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/321 Install Module Start.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/role-management-edit-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/322 Select Module.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/role-management-search.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/322 Select Module.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/role-management-search.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/323 Accept Module License.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/role-management-users-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/323 Accept Module License.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/role-management-users-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/324 Installed.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/role-management-users.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/324 Installed.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/role-management-users.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/331 Restart Oqtane.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/role-management.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/331 Restart Oqtane.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/role-management.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/332 Confirm Restart.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/search-reindex-button.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/332 Confirm Restart.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/search-reindex-button.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/333 Restarting.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/search-settings-administration.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/333 Restarting.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/search-settings-administration.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/334 Restart in Visual Studio.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/site-setings-appearance.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/334 Restart in Visual Studio.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/site-setings-appearance.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/341 Add Page.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/site-settings-1.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/341 Add Page.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/site-settings-1.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/342 New Page Name and Permissions.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/site-settings-2.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/342 New Page Name and Permissions.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/site-settings-2.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/351 Add Content Module.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/site-settings-functionality.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/351 Add Content Module.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/site-settings-functionality.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/361 Install 2sxc Content Package.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/site-settings-page-content.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/361 Install 2sxc Content Package.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/site-settings-page-content.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/362 Install 2sxc Content Package - Confirm.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/site-settings-pwa-settings.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/362 Install 2sxc Content Package - Confirm.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/site-settings-pwa-settings.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/363 Install 2sxc Content Package - Installing.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/site-settings-smtp-settings-test-smtp-configuration-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/363 Install 2sxc Content Package - Installing.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/site-settings-smtp-settings-test-smtp-configuration-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/364 Install 2sxc Content Package - Complete.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/site-settings-smtp-settings.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/364 Install 2sxc Content Package - Complete.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/site-settings-smtp-settings.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/371 2sxc Select Content Type.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/site-settings.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/371 2sxc Select Content Type.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/site-settings.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/372 2sxc Preview Content Type.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/smtp-settings.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/372 2sxc Preview Content Type.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/smtp-settings.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/373 2sxc Content Added.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-add-url.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/373 2sxc Content Added.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-add-url.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/411 Add App.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-broken-urls.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/411 Add App.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-broken-urls.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/421 App Auto-Installer - Select.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-broken-urls.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/421 App Auto-Installer - Select.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-broken-urls.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/422 App Auto-Installer - Confirm.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-edit-broken-urls.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/422 App Auto-Installer - Confirm.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-edit-broken-urls.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/423 App Auto-Installer - Installing.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-edit-mapped-urls.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/423 App Auto-Installer - Installing.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-edit-mapped-urls.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/424 App Auto-Installer - Complete.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-mapped-urls.jpg", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/424 App Auto-Installer - Complete.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-mapped-urls.jpg" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper - Confirm.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-mapped-urls.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper - Confirm.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-mapped-urls.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper.jpg", + "source_relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-settings.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper.jpg" + "relative_path": "pages/manuals/admin/admin-management/assets/url-mappings-settings.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/index.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/url-mappings.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/walkthrough-dev/index.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/url-mappings.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/windows-iis-express-sql-express.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/user-identity.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/windows-iis-express-sql-express.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/user-identity.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/windows-iis-localdb.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/user-management-settings-user-settings.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/windows-iis-localdb.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/user-management-settings-user-settings.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/installation/windows-iis-sql.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/user-management.png", "output": { - ".html": { - "relative_path": "manuals/admin/installation/windows-iis-sql.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/user-management.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/marketplace/assets/placeholder.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/user-profile.png", "output": { - ".html": { - "relative_path": "manuals/admin/marketplace/assets/placeholder.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/user-profile.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/marketplace/index.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/visitor-management-details.png", "output": { - ".html": { - "relative_path": "manuals/admin/marketplace/index.html" + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/visitor-management-details.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/marketplace/monetization.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/visitor-management-settings-tab.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/visitor-management-settings-tab.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/visitor-management-visitors-tab.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/visitor-management-visitors-tab.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/admin-management/assets/visitor-management.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/admin-management/assets/visitor-management.png" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/admin-management/file-management.md", + "output": { + ".html": { + "relative_path": "manuals/admin/admin-management/file-management.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/admin-management/index.md", + "output": { + ".html": { + "relative_path": "manuals/admin/admin-management/index.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/admin-management/language-management.md", + "output": { + ".html": { + "relative_path": "manuals/admin/admin-management/language-management.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/admin-management/page-management.md", + "output": { + ".html": { + "relative_path": "manuals/admin/admin-management/page-management.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/admin-management/profile-management.md", + "output": { + ".html": { + "relative_path": "manuals/admin/admin-management/profile-management.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/admin-management/recycle-bin.md", + "output": { + ".html": { + "relative_path": "manuals/admin/admin-management/recycle-bin.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/admin-management/role-management.md", + "output": { + ".html": { + "relative_path": "manuals/admin/admin-management/role-management.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/admin-management/search-settings.md", "output": { ".html": { - "relative_path": "manuals/admin/marketplace/monetization.html" + "relative_path": "manuals/admin/admin-management/search-settings.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/marketplace/submitting-contributions.md", + "source_relative_path": "pages/manuals/admin/admin-management/site-settings.md", "output": { ".html": { - "relative_path": "manuals/admin/marketplace/submitting-contributions.html" + "relative_path": "manuals/admin/admin-management/site-settings.html" } }, "version": "" }, { "type": "Toc", - "source_relative_path": "pages/manuals/admin/marketplace/toc.yml", + "source_relative_path": "pages/manuals/admin/admin-management/toc.yml", "output": { ".html": { - "relative_path": "pages/manuals/admin/marketplace/toc.html" + "relative_path": "pages/manuals/admin/admin-management/toc.html" }, ".json": { - "relative_path": "pages/manuals/admin/marketplace/toc.json" + "relative_path": "pages/manuals/admin/admin-management/toc.json" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/admin-management/url-mappings.md", + "output": { + ".html": { + "relative_path": "manuals/admin/admin-management/url-mappings.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/marketplace/troubleshooting.md", + "source_relative_path": "pages/manuals/admin/admin-management/user-management.md", "output": { ".html": { - "relative_path": "manuals/admin/marketplace/troubleshooting.html" + "relative_path": "manuals/admin/admin-management/user-management.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/marketplace/using-oqtane-marketplace.md", + "source_relative_path": "pages/manuals/admin/admin-management/visitor-management.md", "output": { ".html": { - "relative_path": "manuals/admin/marketplace/using-oqtane-marketplace.html" + "relative_path": "manuals/admin/admin-management/visitor-management.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/modules/adding-modules.md", + "source_relative_path": "pages/manuals/admin/content-management/adding-modules.md", "output": { ".html": { - "relative_path": "manuals/admin/modules/adding-modules.html" + "relative_path": "manuals/admin/content-management/adding-modules.html" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/modules/assets/adding-modules.png", + "source_relative_path": "pages/manuals/admin/content-management/assets/content-arrow.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/modules/assets/adding-modules.png" + "relative_path": "pages/manuals/admin/content-management/assets/content-arrow.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/modules/assets/content-pane.png", + "source_relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-html-editor-edit-content-button.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/modules/assets/content-pane.png" + "relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-html-editor-edit-content-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/modules/assets/installing-modules-2.png", + "source_relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-button-options.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/modules/assets/installing-modules-2.png" + "relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-button-options.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/modules/assets/installing-modules.png", + "source_relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-options-delete-module.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/modules/assets/installing-modules.png" + "relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-options-delete-module.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/modules/assets/moving-menu.png", + "source_relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-options-import-export-content.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/modules/assets/moving-menu.png" + "relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-options-import-export-content.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/modules/assets/pencil.png", + "source_relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-options-manage-settings.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/modules/assets/pencil.png" + "relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-options-manage-settings.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/modules/creating-a-module.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-options-move-to-pane.png", "output": { - ".html": { - "relative_path": "manuals/admin/modules/creating-a-module.html" + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-options-move-to-pane.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/modules/customizing-module-appearance.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-options-move.png", "output": { - ".html": { - "relative_path": "manuals/admin/modules/customizing-module-appearance.html" + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-options-move.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/modules/index.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-options-unpublish-module.png", "output": { - ".html": { - "relative_path": "manuals/admin/modules/index.html" + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-module-options-unpublish-module.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/modules/module-configuration.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-modules-options-button.png", "output": { - ".html": { - "relative_path": "manuals/admin/modules/module-configuration.html" + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-modules-options-button.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/modules/module-deployment.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-pane-border.png", "output": { - ".html": { - "relative_path": "manuals/admin/modules/module-deployment.html" + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-pane-border.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/modules/module-development.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-pane-name.png", "output": { - ".html": { - "relative_path": "manuals/admin/modules/module-development.html" + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-pane-name.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/modules/module-installation.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-pane.png", "output": { - ".html": { - "relative_path": "manuals/admin/modules/module-installation.html" + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/content-edit-mode-pane.png" } }, "version": "" }, { - "type": "Toc", - "source_relative_path": "pages/manuals/admin/modules/toc.yml", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/control-panel-add-module-to-page-button.png", "output": { - ".html": { - "relative_path": "pages/manuals/admin/modules/toc.html" - }, - ".json": { - "relative_path": "pages/manuals/admin/modules/toc.json" + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/control-panel-add-module-to-page-button.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/modules/troubleshooting.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/control-panel-button.jpg", "output": { - ".html": { - "relative_path": "manuals/admin/modules/troubleshooting.html" + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/control-panel-button.jpg" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/modules/working-with-modules.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/control-panel-logout-button.png", "output": { - ".html": { - "relative_path": "manuals/admin/modules/working-with-modules.html" + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/control-panel-logout-button.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/site-administration/assets/admin-dash.png", + "source_relative_path": "pages/manuals/admin/content-management/assets/control-panel-module-management.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/site-administration/assets/admin-dash.png" + "relative_path": "pages/manuals/admin/content-management/assets/control-panel-module-management.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/site-administration/assets/content-arrow.png", + "source_relative_path": "pages/manuals/admin/content-management/assets/control-panel-page-management.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/site-administration/assets/content-arrow.png" + "relative_path": "pages/manuals/admin/content-management/assets/control-panel-page-management.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/site-administration/assets/control-panel.png", + "source_relative_path": "pages/manuals/admin/content-management/assets/control-panel.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/site-administration/assets/control-panel.png" + "relative_path": "pages/manuals/admin/content-management/assets/control-panel.png" } }, "version": "" }, { "type": "Resource", - "source_relative_path": "pages/manuals/admin/site-administration/assets/pencil-edit.png", + "source_relative_path": "pages/manuals/admin/content-management/assets/html-text-editor-raw-html.png", "output": { "resource": { - "relative_path": "pages/manuals/admin/site-administration/assets/pencil-edit.png" + "relative_path": "pages/manuals/admin/content-management/assets/html-text-editor-raw-html.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/site-administration/content-editor.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/html-text-editor-settings.png", "output": { - ".html": { - "relative_path": "manuals/admin/site-administration/content-editor.html" + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/html-text-editor-settings.png" } }, "version": "" }, { - "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/site-administration/index.md", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/html-text-editor-versions.png", "output": { - ".html": { - "relative_path": "manuals/admin/site-administration/index.html" + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/html-text-editor-versions.png" } }, "version": "" }, { - "type": "Toc", - "source_relative_path": "pages/manuals/admin/site-administration/toc.yml", + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/html-text-editor.png", "output": { - ".html": { - "relative_path": "pages/manuals/admin/site-administration/toc.html" - }, - ".json": { - "relative_path": "pages/manuals/admin/site-administration/toc.json" + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/html-text-editor.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/navigation-menu-content-edit-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/navigation-menu-content-edit-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/navigation-menu-content-edit-mode-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/navigation-menu-content-edit-mode-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/page-management-add-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/page-management-add-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/page-management-edit-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/page-management-edit-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/page-management-edit-modules.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/page-management-edit-modules.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/page-management-edit-permissions.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/page-management-edit-permissions.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/page-management-edit-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/page-management-edit-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/page-management-edit-theme-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/page-management-edit-theme-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/page-management-permissions.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/page-management-permissions.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/page-management-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/page-management-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/content-management/assets/page-management.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/content-management/assets/page-management.png" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/themes/assets/placeholder.md", + "source_relative_path": "pages/manuals/admin/content-management/content-editor.md", "output": { ".html": { - "relative_path": "manuals/admin/themes/assets/placeholder.html" + "relative_path": "manuals/admin/content-management/content-editor.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/themes/index.md", + "source_relative_path": "pages/manuals/admin/content-management/control-panel.md", "output": { ".html": { - "relative_path": "manuals/admin/themes/index.html" + "relative_path": "manuals/admin/content-management/control-panel.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/themes/theme-configuration.md", + "source_relative_path": "pages/manuals/admin/content-management/index.md", "output": { ".html": { - "relative_path": "manuals/admin/themes/theme-configuration.html" + "relative_path": "manuals/admin/content-management/index.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/themes/theme-development.md", + "source_relative_path": "pages/manuals/admin/content-management/module-configuration.md", "output": { ".html": { - "relative_path": "manuals/admin/themes/theme-development.html" + "relative_path": "manuals/admin/content-management/module-configuration.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/themes/theme-installation.md", + "source_relative_path": "pages/manuals/admin/content-management/module-management.md", "output": { ".html": { - "relative_path": "manuals/admin/themes/theme-installation.html" + "relative_path": "manuals/admin/content-management/module-management.html" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/themes/theme-management.md", + "source_relative_path": "pages/manuals/admin/content-management/page-management.md", "output": { ".html": { - "relative_path": "manuals/admin/themes/theme-management.html" + "relative_path": "manuals/admin/content-management/page-management.html" } }, "version": "" }, { "type": "Toc", - "source_relative_path": "pages/manuals/admin/themes/toc.yml", + "source_relative_path": "pages/manuals/admin/content-management/toc.yml", "output": { ".html": { - "relative_path": "pages/manuals/admin/themes/toc.html" + "relative_path": "pages/manuals/admin/content-management/toc.html" }, ".json": { - "relative_path": "pages/manuals/admin/themes/toc.json" + "relative_path": "pages/manuals/admin/content-management/toc.json" } }, "version": "" }, { "type": "Conceptual", - "source_relative_path": "pages/manuals/admin/themes/troubleshooting.md", + "source_relative_path": "pages/manuals/admin/content-management/working-with-modules.md", "output": { ".html": { - "relative_path": "manuals/admin/themes/troubleshooting.html" + "relative_path": "manuals/admin/content-management/working-with-modules.html" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/control-panel-admin-dasboard-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/control-panel-admin-dasboard-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/control-panel-icon-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/control-panel-icon-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/event-log-details-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/event-log-details-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/event-log-details.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/event-log-details.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/event-log-options.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/event-log-options.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/event-log-settings-clear-events-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/event-log-settings-clear-events-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/event-log-settings-clear-events-confirmation.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/event-log-settings-clear-events-confirmation.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/event-log-settings-clear-events.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/event-log-settings-clear-events.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/event-log-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/event-log-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/event-log.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/event-log.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-event-log.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-event-log.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-language-management.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-language-management.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-module-management.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-module-management.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-scheduled-jobs.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-scheduled-jobs.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-site-management.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-site-management.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-site-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-site-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-sql-management.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-sql-management.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-system-info.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-system-info.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-system-update.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-system-update.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-theme-management.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-theme-management.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-user-management.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard-user-management.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/host-admin-dashboard.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/language-management-upload-buttons.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/language-management-upload-buttons.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/language-management-upload.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/language-management-upload.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-create-module-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-create-module-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-edit-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-edit-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-edit-definition.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-edit-definition.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-edit-pages-browse-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-edit-pages-browse-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-edit-permissions-add-user.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-edit-permissions-add-user.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-edit-permissions.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-edit-permissions.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-edit-translations.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-edit-translations.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-install-marketplace-open-source-commercial-options.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-install-marketplace-open-source-commercial-options.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-install-marketplace.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-install-marketplace.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-install-module-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-install-module-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-install-search.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-install-search.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-install-sort-options.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-install-sort-options.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-install-upload.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-install-upload.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management-module-category.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management-module-category.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/module-management.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/module-management.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/oqtane-login.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/oqtane-login.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/scheduled-jobs-refresh-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/scheduled-jobs-refresh-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/scheduled-jobs-restart.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/scheduled-jobs-restart.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/scheduled-jobs-search.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/scheduled-jobs-search.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/scheduled-jobs-view-all-logs-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/scheduled-jobs-view-all-logs-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/scheduled-jobs-view-all-logs.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/scheduled-jobs-view-all-logs.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/scheduled-jobs.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/scheduled-jobs.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/site-management-add-site-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/site-management-add-site-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/site-management-add-site.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/site-management-add-site.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/site-management-browse-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/site-management-browse-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/site-management-edit-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/site-management-edit-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/site-management-edit-site-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/site-management-edit-site-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/site-management-search.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/site-management-search.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/site-management.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/site-management.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/site-settings-database.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/site-settings-database.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/site-settings-site-urls.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/site-settings-site-urls.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/site-settings-ui-component-settings-interactivity.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/site-settings-ui-component-settings-interactivity.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/site-settings-ui-component-settings-render-mode.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/site-settings-ui-component-settings-render-mode.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/site-settings-ui-component-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/site-settings-ui-component-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/site-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/site-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/sql-management-add-connection-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/sql-management-add-connection-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/sql-management-add-connection.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/sql-management-add-connection.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/sql-management-default-connection.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/sql-management-default-connection.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/sql-management-execute-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/sql-management-execute-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/sql-management-select-connection.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/sql-management-select-connection.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/sql-management.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/sql-management.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/system-info-log-clear-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/system-info-log-clear-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/system-info-log-clear-confirmation-message.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/system-info-log-clear-confirmation-message.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/system-info-log.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/system-info-log.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/system-info-options-access-swagger-api-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/system-info-options-access-swagger-api-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/system-info-options.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/system-info-options.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/system-info-restart-application-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/system-info-restart-application-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/system-info.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/system-info.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/system-update-development-environment.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/system-update-development-environment.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/system-update-system-up-to-date-notification.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/system-update-system-up-to-date-notification.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/system-update-upload-file-buttons.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/system-update-upload-file-buttons.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/system-update-upload-upgrade-buttton.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/system-update-upload-upgrade-buttton.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/system-update-upload.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/system-update-upload.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/theme-management-create-theme-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/theme-management-create-theme-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/theme-management-create-theme-message.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/theme-management-create-theme-message.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-create-theme-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-create-theme-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-owner-name.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-owner-name.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-theme-name.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-theme-name.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/theme-management-create-theme.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/theme-management-create-theme.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/theme-management-edit-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/theme-management-edit-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/theme-management-edit.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/theme-management-edit.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/theme-management-install-theme-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/theme-management-install-theme-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/theme-management.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/theme-management.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-add-user-identity.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-add-user-identity.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-add-user-profile.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-add-user-profile.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-assign-administrators-role.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-assign-administrators-role.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-assign-host-users-role.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-assign-host-users-role.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-edit-users.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-edit-users.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-import-users-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-import-users-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-import-users-template-button.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-import-users-template-button.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-import-users-template-text-file.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-import-users-template-text-file.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-import-users.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-import-users.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-settings-external-lockout-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-settings-external-lockout-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-settings-lockout-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-settings-lockout-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-settings-password-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-settings-password-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-settings-token-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-settings-token-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-settings-user-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-settings-user-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/host-management/assets/user-management.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/host-management/assets/user-management.png" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/host-management/event-log.md", + "output": { + ".html": { + "relative_path": "manuals/admin/host-management/event-log.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/host-management/index.md", + "output": { + ".html": { + "relative_path": "manuals/admin/host-management/index.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/host-management/module-management.md", + "output": { + ".html": { + "relative_path": "manuals/admin/host-management/module-management.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/host-management/scheduled-jobs.md", + "output": { + ".html": { + "relative_path": "manuals/admin/host-management/scheduled-jobs.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/host-management/site-management.md", + "output": { + ".html": { + "relative_path": "manuals/admin/host-management/site-management.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/host-management/sql-management.md", + "output": { + ".html": { + "relative_path": "manuals/admin/host-management/sql-management.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/host-management/system-info.md", + "output": { + ".html": { + "relative_path": "manuals/admin/host-management/system-info.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/host-management/system-update.md", + "output": { + ".html": { + "relative_path": "manuals/admin/host-management/system-update.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/host-management/theme-management.md", + "output": { + ".html": { + "relative_path": "manuals/admin/host-management/theme-management.html" + } + }, + "version": "" + }, + { + "type": "Toc", + "source_relative_path": "pages/manuals/admin/host-management/toc.yml", + "output": { + ".html": { + "relative_path": "pages/manuals/admin/host-management/toc.html" + }, + ".json": { + "relative_path": "pages/manuals/admin/host-management/toc.json" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/index.md", + "output": { + ".html": { + "relative_path": "manuals/admin/index.html" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/admin-dashboard-site-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/admin-dashboard-site-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/apache-http-server-logo.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/apache-http-server-logo.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/control-panel-admin-dashboard.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/control-panel-admin-dashboard.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/linux-logo.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/linux-logo.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/maui-run-windows-machine.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/maui-run-windows-machine.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/maui-set-local-development-url.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/maui-set-local-development-url.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/maui-set-url.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/maui-set-url.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/maui-solution.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/maui-solution.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/microsoft-azure-logo.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/microsoft-azure-logo.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/microsoft-dot-net-logo.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/microsoft-dot-net-logo.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/microsoft-office-teams-logo.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/microsoft-office-teams-logo.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/ms-sql-server-logo.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/ms-sql-server-logo.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/mysql-logo.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/mysql-logo.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/oqtane-automated-upgrade-process.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/oqtane-automated-upgrade-process.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/postgresql-logo.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/postgresql-logo.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/red-hat-enterprise-linux-logo.svg.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/red-hat-enterprise-linux-logo.svg.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/site-settings-ui-component-settings-hybrid-enabled.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/site-settings-ui-component-settings-hybrid-enabled.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/sqlite-logo.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/sqlite-logo.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/ubuntu-logo-2022.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/ubuntu-logo-2022.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/ubuntu-logo.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/ubuntu-logo.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/user-management-token-settings.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/user-management-token-settings.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/visual-studio-logo.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/visual-studio-logo.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/visual-studio-logo.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/visual-studio-logo.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/windows-11-logo.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/windows-11-logo.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/windows-logo.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/windows-logo.png" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/assets/windows-server-2022-logo.svg.png", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/assets/windows-server-2022-logo.svg.png" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/databases.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/databases.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/deploy-to-azure.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/deploy-to-azure.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/development-vs-code-linux.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/development-vs-code-linux.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/development-vs-code.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/development-vs-code.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/development.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/development.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/index.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/index.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/linux-ubuntu-apache-mysql.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/linux-ubuntu-apache-mysql.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/linux-ubuntu-apache-postgresql.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/linux-ubuntu-apache-postgresql.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/maui-setup.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/maui-setup.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/resources.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/resources.html" + } + }, + "version": "" + }, + { + "type": "Toc", + "source_relative_path": "pages/manuals/admin/installation/toc.yml", + "output": { + ".html": { + "relative_path": "pages/manuals/admin/installation/toc.html" + }, + ".json": { + "relative_path": "pages/manuals/admin/installation/toc.json" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/upgrade.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/upgrade.html" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/121 Get from Github.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/121 Get from Github.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/200 Compile Oqtane.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/200 Compile Oqtane.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/201 Disable HotReload.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/201 Disable HotReload.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Installing.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Installing.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Settings.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Settings.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/291 Oqtane Installed.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/291 Oqtane Installed.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/292 Login as Super User.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/292 Login as Super User.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/293 Oqtane Logged In.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/293 Oqtane Logged In.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/311 Go to Modules - Open Menu.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/311 Go to Modules - Open Menu.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/312 Go to Modules - Admin Dashboard.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/312 Go to Modules - Admin Dashboard.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/313 Go to Modules - Module Management.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/313 Go to Modules - Module Management.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/321 Install Module Start.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/321 Install Module Start.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/322 Select Module.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/322 Select Module.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/323 Accept Module License.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/323 Accept Module License.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/324 Installed.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/324 Installed.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/331 Restart Oqtane.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/331 Restart Oqtane.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/332 Confirm Restart.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/332 Confirm Restart.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/333 Restarting.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/333 Restarting.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/334 Restart in Visual Studio.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/334 Restart in Visual Studio.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/341 Add Page.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/341 Add Page.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/342 New Page Name and Permissions.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/342 New Page Name and Permissions.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/351 Add Content Module.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/351 Add Content Module.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/361 Install 2sxc Content Package.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/361 Install 2sxc Content Package.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/362 Install 2sxc Content Package - Confirm.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/362 Install 2sxc Content Package - Confirm.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/363 Install 2sxc Content Package - Installing.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/363 Install 2sxc Content Package - Installing.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/364 Install 2sxc Content Package - Complete.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/364 Install 2sxc Content Package - Complete.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/371 2sxc Select Content Type.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/371 2sxc Select Content Type.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/372 2sxc Preview Content Type.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/372 2sxc Preview Content Type.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/373 2sxc Content Added.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/373 2sxc Content Added.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/411 Add App.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/411 Add App.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/421 App Auto-Installer - Select.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/421 App Auto-Installer - Select.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/422 App Auto-Installer - Confirm.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/422 App Auto-Installer - Confirm.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/423 App Auto-Installer - Installing.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/423 App Auto-Installer - Installing.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/424 App Auto-Installer - Complete.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/424 App Auto-Installer - Complete.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper - Confirm.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper - Confirm.jpg" + } + }, + "version": "" + }, + { + "type": "Resource", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper.jpg", + "output": { + "resource": { + "relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper.jpg" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/index.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/walkthrough-dev/index.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/windows-iis-express-sql-express.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/windows-iis-express-sql-express.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/windows-iis-localdb.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/windows-iis-localdb.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/installation/windows-iis-sql.md", + "output": { + ".html": { + "relative_path": "manuals/admin/installation/windows-iis-sql.html" + } + }, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "pages/manuals/admin/marketplace/assets/placeholder.md", + "output": { + ".html": { + "relative_path": "manuals/admin/marketplace/assets/placeholder.html" + } + }, + "version": "" + }, + { + "type": "Toc", + "source_relative_path": "pages/manuals/admin/marketplace/toc.yml", + "output": { + ".html": { + "relative_path": "pages/manuals/admin/marketplace/toc.html" + }, + ".json": { + "relative_path": "pages/manuals/admin/marketplace/toc.json" } }, "version": "" diff --git a/docs/manuals/admin/admin-management/file-management.html b/docs/manuals/admin/admin-management/file-management.html new file mode 100644 index 000000000..3a0b8ad2f --- /dev/null +++ b/docs/manuals/admin/admin-management/file-management.html @@ -0,0 +1,124 @@ + + + + + File Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

File Management

+ +

Nearly everything you could need to do with files and folders in Oqtane can be done from this view. You have the ability to upload, edit, and delete files and folders. You can also control where files are stored and what permissions should be applied to which folders. Folder permissions specified by roles allow you to determine who can see folders and files and who is allowed to modify the contents of a folder. +The options provided by the file manager are:

+
    +
  • A drop down menu to select the file in which you what your view to placed in.
    • +
  • Edit Folder: Lets you change the parent of the folder, the name of the folder, and the permissions for what roles are able to see and access the folder and its files.
    • +
  • Add Folder: Allows you to create a new folder with the ability to choose a name, parent folder, and permissions to access.
    • +
  • Upload Files: This is the feature that allows for user to upload files like images from their local system to a folder in Oqtane and allows for files to downloaded from Oqtane to their local system. +file-management
    • +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/admin-management/index.html b/docs/manuals/admin/admin-management/index.html new file mode 100644 index 000000000..149f0db84 --- /dev/null +++ b/docs/manuals/admin/admin-management/index.html @@ -0,0 +1,128 @@ + + + + + Admin Management Introduction | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Admin Management Introduction

+ +

The admin dashboard has a variety of different tools for administrators to use in order to better manage their website and to add a great amount of functionality to the website. By selecting the gear icon in the top right of a page while being on an administrator account, then selecting the admin dashboard option at the top of the control panel, which will bring up a menu with a variety of options that can be selected.

+

adminDash

+

The default options in the dashboard that Oqtane offers for an administrator to use are:

+
    +
  • Site Settings: Which provides a variety of settings to be able to modify and personalize your website with more information in the site settings.
    • +
  • Page Management: Which provides a list of all pages on your website and provides the ability to to manipulate them in a variety of ways with more info on page management.
    • +
  • User Management: Which allows for the additional and modification of user accounts with more info on user management.
    • +
  • Profile Management: Which lets you specify what informational fields are available for a user to both optionally have and must have on their account with more info on profile management.
    • +
  • Role Management: Which specifies what type of security group the user's account belongs in like giving an account administrative rights, with more info on role management.
    • +
  • File Management: Which allows the uploading of files like images to be inserted into pages with more info on file management.
    • +
  • Recycle Bin: Which allows for the restoration or full deletion of pages that were previously deleted with more info on recycle bin. +If you want to add new options to the admin dashboard, then that can be done by creating a new page either in the control panel or in the admin dashboard's page management and specifying that you want "Admin" as the parent of the new page.
    • +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/admin-management/language-management.html b/docs/manuals/admin/admin-management/language-management.html new file mode 100644 index 000000000..07f6b89ae --- /dev/null +++ b/docs/manuals/admin/admin-management/language-management.html @@ -0,0 +1,174 @@ + + + + + Language Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Language Management

+ +

Language Management Feature

+

This document describes the Language Management module, settings, and configuration for administrators to manage language resources effectively across their Oqtane site.

+

Overview

+

The Language Management feature allows administrators to manage translations for their site, ensuring that the site content is available in multiple languages, enhancing accessibility and user experience.

+
+

Control Panel Walkthrough

+

Accessing the Language Management Feature

+
    +

  1. Click the control panel icon to access additional settings.

    +

    Control Panel Icon

    +
    2. +

  2. In the control panel, select the button to open the admin dashboard.

    +

    Open Admin Dashboard

    +
    3. +

  3. In the admin dashboard, click on the Language Management icon to configure your language resources.

    +

    Admin Dashboard Language Management

    +
    4. +
+
+

Configuring Language Management

+

Once in the Language Management settings, administrators can view and manage language resources.

+

Main Index Page

+

The Language Management main index page displays all installed languages.

+

Language Management Index Page

+
    +

  1. The list includes the name of each language, along with options to edit or delete (except for the default English language).

    +

    Edit/Delete Buttons

    +
    2. +
+

Adding a Language

+
    +

  1. Use the Add Language button to open a popup modal for adding a new language.

    +

    Add Language Popup

    +
      +
    • In the popup, select the language by name and set it as default using the Yes/No dropdown options.
      • +
    +

    Add Language Settings

    +
    2. +
+

Searching Languages

+

The search feature allows administrators to filter through installed languages, which is particularly helpful when many languages are available.

+

Language Management Index Page

+

Reviewing and Editing Languages

+
    +

  1. To edit an existing language, click the Edit button next to the desired language.

    +

    Edit/Delete Buttons

    +
    2. +

  2. This will open the edit popup, where you can modify the language settings.

    +

    Edit Language Popup

    +
      +
    • You can set the language as default using the Yes/No dropdown option.
      • +
    +
    3. +

  3. To delete a language, click the Delete button next to the language. Note that the default English language cannot be deleted.

    +
    4. +
+
+

Conclusion

+

The Language Management module in Oqtane provides an effective way for administrators to manage language resources and translations. By leveraging the features outlined in this manual, site administrators can enhance user experience and ensure their content is accessible in multiple languages.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/admin-management/page-management.html b/docs/manuals/admin/admin-management/page-management.html new file mode 100644 index 000000000..637ba31e1 --- /dev/null +++ b/docs/manuals/admin/admin-management/page-management.html @@ -0,0 +1,151 @@ + + + + + Page Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Page Management

+ +

Pretty much every website starts out as one thing first and foremost: a collection of pages that constitute a web presence. Each page will have a purpose (we hope) and serve it well. As you have seen after the default installation of Oqtane, you are even given a home page to work with on the first load of your new site. Your next step might be to create additional pages, such as About Us, Contact Us, and more. +As your site continues to become successful and grows to meet the needs of your customers and other visitors, you will undoubtedly begin to have more and more pages on your site. You'll have so many that at some point you will need to manage them from a centralized location. In other cases, you might have pages that are hidden from the menu and are not easily accessible. This is where the Page Management feature comes in to allow for a larger overview of the pages on your website, with all pages on your website viewable in a list format. These pages can be manipulated in the page manager by being able to add, edit, and delete pages. +page-management

+

Add

+

The add feature adds a new page to your website and brings up the page management window, which allows you to specify the settings, appearance, and permissions for the page you are adding. +The fields which exist in the page management window are the:

+
+

Settings

+

Name: Which specifies the name that will be displayed in the navigation bar. +Parent: Which will specify the page that this page will be underneath, meaning that the added page will be put to the right of the page specified in the navigation bar at the top. +Insert: Specify where the name for the page will appear in the navigation bar, by saying where the page should appear among all of the children of the parent that has been selected. +Navigation: Say whether you want the page to be displayed to users that fit within the permissions, or if you want the page to be hidden to everyone but administrators which can be useful while editing a page. +URL Path: The url is what is put in the web page's address, for example if the url path is set to page1 then the address might be www.website/page1.com. If no URL path is specified then the URL will by default be set to be the same as the name field above. +Redirect: Input a URL that is the same as the URL path of another page in the site that user will be sent to, remember that if no URL path is specified for another page then the name will be used. If this feature is implemented then you will not be able stay on the page to use the control panel's page manager, so you will need to edit or delete page's with this feature. +add-page

+
+
+

Appearance

+

Title: The name that is displayed on the web page's tab. +Theme: The theme that the web page will take on. In the admin dashboard's theme management feature you can see more information on these theme and import new themes to be used. +Default Container: Choose the layout of modules for the page, like hw the titles typically displayed above the modules will be. +Icon: Input a favicon address or other icon address to include an icon beside the name of your page. +Personalizable: This feature gives a page that is unique to every individual and allows them to add modules and edit the content of the page, so only the individual can see what they put onto the page. +page-appearance

+
+
+

Permissions

+

View: This is what allows different users to see certain pages and any users that are within certain roles, that can be specified in the admin dashboard's role management feature will be able to see or not see the page depending on what you have checked the box for the role they fit into. +Edit: This allows users that fit into the specified roles to be able to edit pages using the content editor. +Specific Users: The permissions tab also has the ability for you to enter a specific username and allow for you to set custom permissions for any specific users that you want. +permissions

+
+

Edit

+

The edit feature shares all of the same features as the add feature, allowing you to change the settings, appearances, and permissions of any page, with the insert feature being replaced by the move feature. The edit feature also shows you when a page was created and when the page was last edited at the bottom of the page management window.

+

Delete

+

The delete feature will delete the page that you are currently on and you can recover the page or fully delete the page in the admin dashboard's recycle bin.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/admin-management/profile-management.html b/docs/manuals/admin/admin-management/profile-management.html new file mode 100644 index 000000000..07e766c3b --- /dev/null +++ b/docs/manuals/admin/admin-management/profile-management.html @@ -0,0 +1,134 @@ + + + + + Profile Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Profile Management

+ +

The profile manager exposes one of the more powerful and under-appreciated features that Oqtane has to offer. The profile manager expose to you a few features, but the primary feature is the profile editor, which allows you to customize completely the profile fields that a user account has in nearly every way possible. This is the backbone of all of the user profile features in Oqtane. +The Oqtane profile manager allows for a user to specify more things about themselves than the typical information from a basic user account. Fields from the profile can be made to be required upon making an account such as making a name or address a required field. +profile-management +The profile page has an add profile button at the top of its page which includes:

+
    +
  • Name: The name of the profile item as it would be accessible in the database.
    • +
  • Title: The title of the field displayed to the user.
    • +
  • Description: Enter a description for the profile that will be what shows up for the help icon for the field.
    • +
  • Category: The name for a grouping of fields such as the name or address headings that are by default included in the profile tab above their respective groupings of fields.
    • +
  • Order: Choose the spot where in the list of profile fields that this one will appear with 0 being the first position.
    • +
  • Lenth: The maximum length that can be input into this field, with a 0 for unlimited length.
    • +
  • Default Value: The value that will be put into this field if the user doesn't enter anything into it.
    • +
  • Options: Has the ability to create a list of items that can be selected and is enter by a list with commas in between the items (a,b,c).
    • +
  • Required?: Specify whether or not the field is required upon the creation of a new account.
    • +
  • Private: Specify whether it should be seen by regular user or should just been seen by administrators. +add-profile
    • +
+

There is also the option to edit or delete any of the fields that have already been created with edit and delete buttons on each item in the list of profile fields. +edit-profile

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/admin-management/recycle-bin.html b/docs/manuals/admin/admin-management/recycle-bin.html new file mode 100644 index 000000000..7c9b0817f --- /dev/null +++ b/docs/manuals/admin/admin-management/recycle-bin.html @@ -0,0 +1,119 @@ + + + + + Recycle Bin | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Recycle Bin

+ +

The Recycle Bin is a very useful and often overlooked feature of Oqtane, especially for new users. Oftentimes, a newly designated administrator for a site will simply assume that when something is deleted, it is gone. The next logical step would probably be to re-create the content that was just deleted. This could lead to frustrations with Oqtane. The Recycle Bin allows you to restore the content in most cases, which can save you time and frustration. +The Recycle Bin has two types of objects that can be restored, Pages and Modules. When you delete a page or a module, it will show up in the respective list. You can switch which list you're looking at by clicking the tabs at the top of the page. Clicking retore on one of the pages or modules will allow you to restore the selected item to their original place in your site. +The recycle bin feature has two options, restore and delete. With the restore button, the page or module is restored to its original location. The delete button permanently deletes the page from your website and you will cause it be removed permanently. +recycle-bin

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/admin-management/role-management.html b/docs/manuals/admin/admin-management/role-management.html new file mode 100644 index 000000000..9b6559624 --- /dev/null +++ b/docs/manuals/admin/admin-management/role-management.html @@ -0,0 +1,121 @@ + + + + + Role Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Role Management

+ +

Security Roles in Oqtane are nothing more than a grouping of one or more users for a purpose. That purpose is up to you. The purpose could be to see exclusive content in a specific area of the site or on specific pages in the site. It could also be to have the ability to edit content on one or more pages or to create content in a specific module, like a blog. We could go on and on. Just remember that Security Roles can be used for content targeting, editing, and hiding sections of your site. +Security Roles work the same as most permissions-based systems, such as Windows. You first create a Security Role if it doesn't already exist to create a grouping of users. Then, you add one or more people to that group. Once you do that minimal setup, you can apply that group to various capabilities, permissions, and features. +Permissions are set when creating or editing pages and modules by selecting which roles can edit or view them. +permissions +At the top of the page is the add role button that allows for the addition of a new group you want to make, with a name, description, and saying if it should be automatically assigned to users. You can edit, delete, and manage users in each role except for the default administrator and registered users roles which you cannot edit or delete, you can only manage their users. +When adding a user into a role, there are fields for effective date and expiry date, which determines when a user will be added to a roles and how long they will be inside of a role.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/admin-management/search-settings.html b/docs/manuals/admin/admin-management/search-settings.html new file mode 100644 index 000000000..abe6e5871 --- /dev/null +++ b/docs/manuals/admin/admin-management/search-settings.html @@ -0,0 +1,206 @@ + + + + + Search Manual | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Search Manual

+ +

This document describes the Search module, settings, and configuration for administrators to set up effective search functionality across their Oqtane site.

+

Overview

+

The Search feature allows users to locate relevant content quickly across the site. Through scheduled indexing, the Search service keeps the content index updated. The following sections cover search settings, scheduling, and customization options for the administrator.

+
+

Search Settings

+

Administrators can configure the Search module through Host > Search Settings. Below are explanations for each setting:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SettingDescription
Search ProviderSpecifies the provider responsible for indexing and retrieving search results. Example: DatabaseSearchProvider.
EnabledToggles the search feature on or off. When set to Yes, the site content is regularly indexed, and search queries return up-to-date results.
Last IndexedDisplays the last date and time the site was indexed. This helps administrators know the freshness of indexed data in search results.
Ignore PagesA list of pages excluded from indexing. Prevents certain content from appearing in search results, e.g., pages with sensitive or irrelevant content.
Ignore EntitiesSpecifies types of entities to exclude from indexing, such as Modules or Users.
Word LengthDefines the minimum character length for words indexed in search results. Only words meeting or exceeding this length will be indexed.
Ignore WordsCommonly ignored words in search queries (e.g., "and," "the"). This list helps refine search results by avoiding indexing or returning results for these words.
+
+

Search Components

+

Search.resx File

+

The .resx file includes localization data for search terms and placeholders in the search UI. Examples include:

+
<data name="Search" xml:space="preserve">
+    <value>Search</value>
+</data>
+<data name="SearchPlaceHolder" xml:space="preserve">
+    <value>Search</value>
+</data>
+
+
+

Configuring Search in Oqtane

+

This guide provides a step-by-step walkthrough for configuring the search functionality in Oqtane.

+
+

1. Accessing the Search Feature in the Default Theme

+

To get started, locate the search feature in the navigation bar of the default theme.

+

Search Feature in Navigation

+
+

2. Opening the Control Panel

+

Next, click the control panel icon to access additional settings.

+

Control Panel Icon

+
+

3. Navigating to the Admin Dashboard

+

In the control panel, select the button to open the admin dashboard, where you can manage various site settings.

+

Open Admin Dashboard

+
+

4. Accessing Search Settings

+

Finally, in the admin dashboard, click on the search settings icon to configure your search options.

+

Admin Dashboard Search Settings

+
+

Configuring Search Settings

+

Once in the search settings, you can adjust various parameters to customize how the search operates on your site.

+

Admininstration Search Settings

+

Using the Reindex Button

+

After configuring your search settings, you may need to reindex your content to ensure that the latest changes take effect.

+

Reindex Button Description

+

The Reindex button initiates the process of scanning your site's content and updating the search index accordingly. This is essential after making changes to your site's content, structure, or search settings.

+

Search Reindex Button

+

How to Use the Reindex Button

+
    +
  1. Navigate to the search settings page as described in the previous sections.
    2. +
  2. Locate the Reindex button on the settings page.
    3. +
  3. Click the Reindex button to start the indexing process.
    4. +
+

Note: Depending on the amount of content on your site, the reindexing process may take some time. You will receive a notification once the process is complete.

+
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/admin-management/site-settings.html b/docs/manuals/admin/admin-management/site-settings.html new file mode 100644 index 000000000..9617d99a3 --- /dev/null +++ b/docs/manuals/admin/admin-management/site-settings.html @@ -0,0 +1,149 @@ + + + + + Site Settings | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Site Settings

+ +

The Site Settings feature contains a large number of settings that you can use to perform high-level administrative configuration for your site. The Settings mostly contains set-it-and-forget it options that should be managed once when you build your site. Some of these settings include the default look and feel for new pages created on your site, your site logo, and default metadata for pages. The main parts of the settings are basic settings, SMTP configuration, and progressive web app configuration.

+

Basic Settings

+

Basic Settings mostly contains set-it-and-forget it options that should be managed once when you build your site.

+
    +
  • Name: What you want to call the website.
    • +
  • Tenant: The name of the database you wan the site to use.
    • +
  • Aliases: The name that will appear for the sites URL.
    • +
  • Logo: The logo that will appear in the navigation bar.
    • +
  • Favicon: Enter a favicon address or another icon address to have a default icon to appear beside each page in the navigation bar.
    • +
  • Default Theme: Choose a default theme tht will give a different color scheme and structure.
    • +
  • Default Layout: Choose how many columns a page has by default. +site-settings-1
    • +
  • Default Container: Choose if you want titles to appear about each module by default.
    • +
  • Allow User Registration: Should users be able to create their own accounts or should only administrators be able to create accounts.
    • +
  • Is Deleted: Select whether you want to delete this site. +site-settings-2
    • +
+

SMTP Server (Secure Mail Transfer Protocol)

+

The Oqtane instance sends outbound email for a variety of reasons, from the host or site admin or in the form of password reminders, event notifications, newsletters, or other business-specific use cases. A valid SMTP server is required for this to work; you should consult your network administrator for the appropriate credentials to use in a production configuration. Most non-Exchange Server SMTP hosts will require “Basic” authentication and a valid username/password combination. Some will also require that SSL be enabled.

+
    +
  • Host: Enter the host name for the server.
    • +
  • Port: Enter the port number that the server is on.
    • +
  • SSL Enabled: Specify yes or no if the SMTP server has an SSL certificate.
    • +
  • Username: Enter the username for the SMTP server you are accessing.
    • +
  • Password: Enter the password for the SMTP server you are accessing. +smtp-settings
    • +
+

Progressive Web Application Settings

+
    +
  • Is Enabled: Choose whether or not you want the site to be set up as a progressive web application.
    • +
  • App Icon: Select a PNG image that is 192 X 192 pixels which will be the app icon for your application.
    • +
  • Splash Icon: Select a PNG image that is 512 X 512 pixels which will appear on the screen while the application is loading. +pwa-settings
    • +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/admin-management/url-mappings.html b/docs/manuals/admin/admin-management/url-mappings.html new file mode 100644 index 000000000..aae582024 --- /dev/null +++ b/docs/manuals/admin/admin-management/url-mappings.html @@ -0,0 +1,187 @@ + + + + + URL Mappings Manual | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

URL Mappings Manual

+ +

URL Mappings Feature

+

This document describes the URL Mappings module, settings, and configuration for administrators to manage URL redirections effectively across their Oqtane site.

+

Overview

+

The URL Mappings feature allows administrators to define mappings from one URL to another, enabling effective redirection strategies. This feature is useful for managing broken links, ensuring users are directed to the correct resources.

+
+

Control Panel Walkthrough

+

Accessing the URL Mappings Feature

+
    +

  1. Click the control panel icon to access additional settings.

    +

    Control Panel Icon

    +
    2. +

  2. In the control panel, select the button to open the admin dashboard.

    +

    Open Admin Dashboard

    +
    3. +

  3. In the admin dashboard, click on the URL Mappings icon to configure your URL mappings.

    +

    Admin Dashboard URL Mappings

    +
    4. +
+
+

Configuring URL Mappings

+

Once in the URL Mappings settings, administrators can view and manage URL mappings.

+

Managing Mapped URLs

+
    +

  1. The Mapped URLs tab displays all existing URL mappings, including the original URL, the mapped destination, the number of requests, and the last requested date. You can choose to view either mapped URLs or broken URLs using the dropdown select menu.

    +

    Mapped URLs

    +
    2. +

  2. Use the Add URL Mapping button to create a new mapping. This will open a popup modal for adding a mapped URL.

    +

    Add URL Mapping

    +
    3. +
+

Reviewing and Editing URL Mappings

+
    +

  1. After adding a URL mapping, it will appear in the list below the search feature. You can select an existing URL mapping to edit or delete it if it is no longer needed.

    +

    Edit URL Mapping

    +
    2. +
+

Managing Broken URLs

+
    +

  1. Switch to the Broken URLs tab using the dropdown select menu. This will display all captured broken URLs that require attention.

    +

    Broken URLs

    +
    2. +

  2. You can edit or delete broken URLs as necessary to redirect them accordingly.

    +

    Edit Broken URL

    +
    3. +
+

URL Mapping Settings

+

Administrators can configure the URL Mappings module through Host > URL Mappings. The primary setting available is:

+ + + + + + + + + + + + + +
SettingDescription
Capture Broken URLs?Toggles the feature to automatically capture and save broken URLs in the URL Mappings. When set to Yes, any broken link encountered will be recorded for further management.
+

In the Settings tab, administrators can toggle the Capture Broken URLs setting.

+
    +

  1. Set this option to Yes to automatically capture broken URLs when they are accessed.

    +
    2. +

  2. Click the Save button to apply changes.

    +

    Admin URL Mappings Settings

    +
    3. +
+
+

Conclusion

+

The URL Mappings module in Oqtane provides an effective way for administrators to manage URL redirection strategies. By leveraging the features outlined in this manual, site administrators can enhance user experience and maintain the integrity of web links across their sites.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/admin-management/user-management.html b/docs/manuals/admin/admin-management/user-management.html new file mode 100644 index 000000000..38de1323f --- /dev/null +++ b/docs/manuals/admin/admin-management/user-management.html @@ -0,0 +1,131 @@ + + + + + User Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

User Management

+ +

One of your primary responsibilities as the site administrator will likely be to manage users on your site. You might need to create, edit, or delete users. You might also be required to add and remove abilities from users on your site. Everything that you need to do in these examples can be done from this one menu. +user-management +The options that are provided on this user manager includes:

+
    +
  • Add User: The add new user button is exactly what it sounds like it allows you to add a new user to your site and upon being clicked, it brings up a window that asks for all of the essential information for an account with a username, password, email, and full name. There is also the profile tab which allows for more extensive information to be provided for a user account and may have some fields that are required to be input in order to create an account, which is specified in the required field of the profile manager.
    • +
  • Find User: Provides a text field to input a user's account name that will search through all of the site's users and return the account below this field with the following options: +
      +
    • Edit User: This allows for basic fields in the identity field such as password, email, and full name to be modified as well as the ability to give the user a profile image and the profile tab to specify more information about a user. +user-identity +There is also the profile tab which goes into more detail about a user allowing for the specification of things like postal code, phone number and address. +user-profile
      • +
    • Delete User: This is exactly as it sounds, it will delete the user's account.
      • +
    • User Roles: This allows for a user account to placed into a security role that has been previously defined in the role manager, and requires a date that this security role will take effect and will expire for the user account.
      • +
    +
    • +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/admin-management/visitor-management.html b/docs/manuals/admin/admin-management/visitor-management.html new file mode 100644 index 000000000..ce0c3de4e --- /dev/null +++ b/docs/manuals/admin/admin-management/visitor-management.html @@ -0,0 +1,198 @@ + + + + + Visitor Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Visitor Management

+ +

Visitor Management Feature

+

The Visitor Management feature in the Oqtane admin dashboard allows administrators to track and manage site visitors effectively. This feature is accessible via the admin dashboard under Admin > Visitor Management.

+

Overview

+

The Visitor Management feature provides tools for monitoring and managing visitor data on your site, helping administrators understand user interactions and enhance site performance.

+
+

Control Panel Walkthrough

+

Accessing the Visitor Management Feature

+
    +

  1. Click the control panel icon to access additional settings.

    +

    Control Panel Icon

    +
    2. +

  2. In the control panel, select the button to open the admin dashboard.

    +

    Open Admin Dashboard

    +
    3. +

  3. In the admin dashboard, click on the Visitor Management icon to configure visitor tracking.

    +

    Admin Dashboard Visitor Management

    +
    4. +
+
+

Tabs Overview

+

The Visitor Management module consists of two main tabs: Visitors and Settings.

+

1. Visitors Tab

+

The Visitors tab displays a list of site visitors and provides options to filter the displayed visitors based on type and time period.

+

Visitors Tab

+ +
    +

  • Visitor Type: Select the type of visitors to display.

    +
      +
    • All Visitors: Shows all visitors to the site.
      • +
    • Users Only: Filters to show only registered users.
      • +
    +
    • +

  • Period: Choose the time period for which visitors are displayed.

    +
      +
    • Past Day: Shows visitors from the last 24 hours.
      • +
    • Past Week: Shows visitors from the last week.
      • +
    • Past Month: Shows visitors from the last month.
      • +
    +
    • +
+

Visitor List

+

Below the dropdown selections, a list of visitors is displayed, showing the following details:

+ + + + + + + + + + + + + + + + + + + + + + + +
DetailIP AddressUserLanguageVisitsVisitedCreated
Details ButtonVisitor IP AddressVisitor UsernameVisitor LanguageNumber of VisitsLast Visited DateCreated Date
+

Each entry includes a Details button that opens a detailed view of the selected visitor's information.

+

Visitor Details

+

2. Settings Tab

+

The Settings tab allows administrators to configure visitor tracking settings.

+

Settings Tab

+

Settings Fields

+
    +
  • Tracking Enabled: Specify if visitor tracking is enabled (Yes/No).
    • +
  • Session Duration: Set the duration (in minutes) that is considered a distinct visit.
    • +
  • Filter: Provide a comma-separated list of terms that should not be tracked in visitor data (e.g., specific IP addresses or user agents).
    • +
  • Retention: Define the number of days to retain visitor activity data.
    • +
  • Correlate Visitors: Specify whether new visitors should be correlated based on their IP address (Yes/No).
    • +
+

Save Changes

+

A Save button is provided at the bottom of the Settings tab to apply any changes made to the visitor tracking settings.

+

Conclusion

+

The Visitor Management feature provides essential tools for monitoring and managing visitor data on your site, helping administrators to understand user interactions and enhance site performance.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/content-management/adding-modules.html b/docs/manuals/admin/content-management/adding-modules.html new file mode 100644 index 000000000..1af49ef15 --- /dev/null +++ b/docs/manuals/admin/content-management/adding-modules.html @@ -0,0 +1,131 @@ + + + + + Adding Modules to a Page | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Adding Modules to a Page

+ +

In order to add a module to a page, simply open the control panel with the gear icon in the top right of a page and in the module management feature there is the ability to select a new module from the options of:

+
    +
  • Admin Module: These are only available to people within the administrator role and there are many more default modules available to put onto your webpages.
    • +
  • Common Module: These are available both to administrators and to registered users to be able to use on pages that are specified as personalizable, meaning users can modify them as they see fit and they are unique and only viewable to registered users.
    • +
  • Developer Module: This feature is for placing a module creator onto a page which will provide you with useful pre-built structure and methods for writing code for your own modules.
    • +
+

There are also features after selecting the module that you would like which are the:

+
    +
  • Title: Which is what will be displayed directly above the module as its title, if nothing is selected then the module's name will be put as the title.
    • +
  • Pane: Select which content pane you want the module to go inside of. Panes are made visible with the content editor.
    • +
  • Container: Select if you would like to have a title displayed above the module or not have one.
    • +
+

adding-modules

+

Adding One Module Across Multiple Pages

+

As noted earlier, modules are reusable pieces of functionality, and as such a single module can be inserted across multiple pages in a site. Say, for example, you have an HTML module that holds a banner image and you want that banner image to also exist on five specific pages in your site. Instead of adding a new module to all five of those pages and then inserting the same image, you can simply go into the Control Panel and then click Add an Existing Module to the page. Adding already existing modules or sharing modules across multiple pages makes managing content that's repeated much more efficient. A content manager can then make edits in one module and instantly have those edits reflected across every page on which the module is shared.

+

When a user hovers over the Modules menu item just below the Add New Module option is the Add Existing Module option. This is the option you select when you want to add a module that already exists in the site to a different page. When opting to use Add Existing Module, you must first select the page to copy a module from, which will populate the drop-down list of modules. You can then follow the same process of adding a module to the page.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/content-management/content-editor.html b/docs/manuals/admin/content-management/content-editor.html new file mode 100644 index 000000000..6f87c57a9 --- /dev/null +++ b/docs/manuals/admin/content-management/content-editor.html @@ -0,0 +1,144 @@ + + + + + Content Editor | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Content Editor

+ +

The content editor is what allows you to edit the modules on the page in a variety of ways. You access the content editor by clicking on the pencil on the top right side of the page which then shows the borders of the content pane which the modules are put inside of, as well as a small downward pointing arrow beside each module that allows you to open a menu to interact with the modules.

+

pencil-edit

+

content-arrow

+

The options for the module's menu are:

+
    +
  • Manage Settings: Brings up the module's settings and permissions which allow you to change the: +
      +
    • Title: The title displayed above the module.
      • +
    • Container: Specify if you want the title to be displayed for the module.
      • +
    • Display on All Pages: Choose whether you want this module to be on every page on the site.
      • +
    • Page: Change the page that the module is displayed on.
      • +
    • Permissions: Specify either what roles or individual users should be able to view or edit the page.
      • +
    +
    • +
  • Unpublish Module: Hides the module from everyone, but the site administrators for instances where you want to edit modules.
    • +
  • Delete Module: Deletes the module from the page.
    • +
  • Import Content: Enter a file's address to import it into the module, such as a image address to include it.
    • +
  • Export Content: Enter a file address to select where to export data from a module.
    • +
  • Move to Top: Moves the modules to the top of the page to be the first module displayed.
    • +
  • Move Up: Moves the module up to be above the module above it.
    • +
  • Move Down: Move the module down below the module beneath it.
    • +
  • Move to Bottom: Moves the module to the bottom of the page, below all other modules. +If the page has the layout for multiple panes, which will allows for three center rows and a top and bottom row that can have content inserted into them, then there will be additional options available which are:
    • +
  • Move to Top Pane: Moves the module to the content pane at the top of the page.
    • +
  • Move to Left Pane: Moves the module to the left-most column.
    • +
  • Move to Right Pane: Moves the module to the right-most column.
    • +
  • Move to Content Pane: Moves the module to the central column.
    • +
  • Move to Bottom Pane: Moves the module to the pane at the bottom of the page.
    • +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/content-management/control-panel.html b/docs/manuals/admin/content-management/control-panel.html new file mode 100644 index 000000000..12757f2f1 --- /dev/null +++ b/docs/manuals/admin/content-management/control-panel.html @@ -0,0 +1,122 @@ + + + + + Control Panel | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Control Panel

+ +

Site administration in Oqtane is the processes, tasks, and features that it takes to effectively run a website in Oqtane. +This includes things like managing users, security, site settings, configurations, and content using the features available to them, in both the control panel and the admin dashboard.

+

control-panel

+

Site administration can take on many forms, but there are two use cases that you should be familiar with. First, there's site administration as defined by Oqtane.You enable this by adding the Administrators security role as one of the assigned roles for the account. That way, all “admin” features will be available for that user across that specific site.

+

Site administration can take on a hybrid of another sort as well, where you as the site administrator can define a different kind of administration for your site. This would be a kind of administration where you define a subset of administration capabilities and assign them to more privileged users to avoid having to make them an actual administrator.

+

As an example, there may be times when you want to create a security role in the role manager that might be named something like Site Admin. You would then create a page or pages on the site that contain some of the Admin modules, assigning permission to the newly created Site Admin security role so that only participants of that security role can see them. In these areas, you can also add references or links to features that normally require Administrator permissions, provided you set up your permissions properly in those other areas and that the chosen feature(s) allows this.

+

In summary, you can perform all of the configuration and content management tasks that you need to in order to run your own site.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/content-management/index.html b/docs/manuals/admin/content-management/index.html new file mode 100644 index 000000000..1fee17e6e --- /dev/null +++ b/docs/manuals/admin/content-management/index.html @@ -0,0 +1,124 @@ + + + + + Content Management Introduction | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Content Management Introduction

+ +

When managing your Oqtane site as an administrator, you will most likely be doing most of your daily work in the Control Panel. As an administrator, you will be able to use nearly every part of the Control Panel. The control panel is accessible through the gear icon located in the top right-hand corner of the screen and provides the ability to interact with the:

+ +

control-panel

+

Those with content management permissions, which are defined by a user account's roles, in Oqtane are often referred to as “content editors.” Content editors can typically view only some of the Control Panel—the parts that are required in order to perform other related tasks, such as adding a module to a page. +It is worth noting that the Control Panel you'll be using is the one that ships “out of the box” with Oqtane. However, it is one of numerous extension points in Oqtane. Like modules, themes, and other extensions, the Control Panel can be replaced with a custom or third-party alternative.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/content-management/module-configuration.html b/docs/manuals/admin/content-management/module-configuration.html new file mode 100644 index 000000000..06ffa05b6 --- /dev/null +++ b/docs/manuals/admin/content-management/module-configuration.html @@ -0,0 +1,139 @@ + + + + + Module Configuration | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Module Configuration

+ +

Explore the various configuration options available for modules in Oqtane and customize their settings to meet your specific requirements.

+

Overview

+

Modules in Oqtane offer a range of configuration options, allowing you to customize their behavior and appearance to suit your needs.

+

Configuring Modules

+

To configure a module in Oqtane, follow these steps:

+
    +
  1. Navigate to the Module Management section in the Administration Dashboard.
    2. +
  2. Locate the module you want to configure and click on its settings icon.
    3. +
  3. Adjust the module settings as needed.
    4. +
  4. Click "Save" to apply the changes.
    5. +
+

Configuration Options

+

Depending on the module, configuration options may include:

+
    +
  • Settings for data sources
    • +
  • Display options
    • +
  • Permissions and access control
    • +
  • Integration with other modules or services
    • +
+

Best Practices

+
    +
  • Regularly review and update module configurations to ensure optimal performance and functionality.
    • +
  • Test module configurations in a development environment before deploying them to production.
    • +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/content-management/module-management.html b/docs/manuals/admin/content-management/module-management.html new file mode 100644 index 000000000..a97bf0e3c --- /dev/null +++ b/docs/manuals/admin/content-management/module-management.html @@ -0,0 +1,143 @@ + + + + + Module Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Module Management

+ +

Modules are a key feature of Oqtane as they allow for you to insert a massive variety of things into your web page. +There are a wide variety of different that can be added to your page for a high level of customization. +An administrator also has the ability to both download new modules onto the website or upload modules you have created to the marketplace, +options which are found in the admin dashboard's module management feature.

+

On the side control panel's module management section, you have the option to:

+
    +

  • Add A New Module: which will put a new module of your choosing onto the page which has the option of being a:

    +
      +
    • Admin Module: These are only available to people within the administrator role and there are many more default modules available to put onto your webpages.
      • +
    • Common Module: These are available both to administrators and to registered users to be able to use on pages that are specified as personalizable, meaning users can modify them as they see fit and they are unique and only viewable to registered users.
      • +
    • Developer Module: This feature is for placing a module creator onto a page which will provide you with useful pre-built structure and methods for writing code for your own modules.
      • +
    +
    • +

  • Add An Existing Module: Provides the ability to select modules that are already on other pages from your website.

    +
      +
    • Page: A list of other your other web pages where you can select a page on your site that has the module you would like.
      • +
    • Modules: A list of modules that are on the selected web page for you to select.
      • +
    +
    • +
+

Directly below these options, when a module is selected, the module's description will appear in a purple box so you have a better understanding of what the module is for. +The other module options below this are:

+
    +
  • Title: Which is what will be displayed directly above the module as its title, if nothing is selected then the module's name will be put as the title.
    • +
  • Pane: Select which content pane you want the module to go inside of. Panes are made visible with the content editor.
    • +
  • Container: Select if you would like to have a title displayed above the module or not have one.
    • +
+

control-panel-module

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/content-management/page-management.html b/docs/manuals/admin/content-management/page-management.html new file mode 100644 index 000000000..8f4aaf79b --- /dev/null +++ b/docs/manuals/admin/content-management/page-management.html @@ -0,0 +1,203 @@ + + + + + Control Panel Page Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Control Panel Page Management

+ +

The Page Management feature allows you to manipulate the page you are currently on by providing options for adding, editing, deleting, and publishing pages. This feature shares many capabilities with the admin dashboard's Page Management feature, but is limited to changing the page you are currently managing.

+

page management

+

Add

+

The Add feature allows you to create a new page on your website. When you select this option, a page management window will appear, enabling you to specify the following settings:

+

Page Management Add Button

+

Add Page Configration

+
+

Settings

+
    +
  • Name: The name displayed in the navigation bar.
    • +
  • Parent: The page that this new page will fall under in the navigation structure.
    • +
  • Insert: Specifies the position of the page among its siblings under the selected parent.
    • +
  • Navigation: Determines if the page should be visible to users with appropriate permissions or hidden from everyone but administrators.
    • +
  • URL Path: Sets the URL for the page. If no path is specified, it defaults to the name.
    • +
  • Redirect: URL to redirect users if this page is accessed. If set, you will need to use the admin dashboard’s page management feature to manage this page further.
    • +
+

Appearance

+
    +
  • Title: Name displayed on the web browser tab.
    • +
  • Theme: Select a theme from those available in the theme manager.
    • +
  • Layout: Number of content panes (columns) available on the page.
    • +
  • Default Container: Layout style for module titles above the content.
    • +
  • Icon: URL for a favicon or other icon associated with the page.
    • +
  • Personalizable: Allows users to customize the page uniquely for themselves.
    • +
+

Page Content

+
    +
  • Head Content: Optionally enter content to be included in the page head (ie. meta, link, or script tags)
    • +
  • Body Content: Optionally enter content to be included in the page body (ie. script tags)
    • +
+

page management add settings

+
+

Permissions

+
    +
  • View: Controls which user roles can see the page, based on settings in the admin dashboard’s role management feature.
    • +
  • Edit: Grants specified roles permission to edit pages using the content editor.
    • +
  • Specific Users: Custom permissions can be assigned to individual users.
    • +
+

page management permissions

+
+

Edit

+

The Edit feature provides similar functionality to the Add feature but modifies the current existing page instead of creating a new one. This section allows you to update the settings, including the appearance, permissions, modules, and theme settings of the current page. The settings configuration has the Insert field replaced by a Move feature to adjust the page's position in the navigation.

+

Additionally, the edit panel displays the creation date and last edited date for the page at the bottom.

+

To edit the page:

+
    +
  1. Click on the Edit button located in the control panel.
    2. +
+

edit page button

+
    +
  1. Modify the settings, permissions, modules, and theme settings.
    2. +
+

Settings

+

As described in the Add section, you can modify the page's name, parent, navigation visibility, URL path, and redirect options. The only difference is that the Insert field is replaced by a Move feature for adjusting the page's position in the navigation.

+

page-management-edit-settings

+

Permissions

+

Permissions work the same as in the Add feature, allowing you to control which users can view or edit the page.

+

page-management-edit-permissions

+

Modules

+

This tab allows you to manage the modules on the page, giving you the ability to modify or reorder existing modules. This provides a more granular control over the content displayed on your page.

+
    +
  • Edit: Access the module’s configuration to modify settings, permissions, and layout.
    • +
  • Delete: Remove the module from the page.
    • +
+

page-management-edit-modules

+

Theme Settings

+

In the Theme Settings tab, you can adjust the theme and layout of the page. This includes options for the page’s appearance, such as selecting a different theme or changing layout configurations.

+
    +
  • Setting Scope: Choose between Site or Page for theme application scope.
    • +
  • Show Login?: Toggle login visibility (options: Not Specified/Yes/No).
    • +
  • Show Register?: Toggle registration visibility (options: Not Specified/Yes/No).
    • +
  • Display Fixed Footer?: Toggle a fixed footer (options: Not Specified/Yes/No).
    • +
+

page-management-edit-theme-settings

+

By using the Edit feature, you can effectively customize the current page, ensuring that it meets your requirements and reflects any necessary changes.

+
+

Delete

+

The Delete feature allows you to permanently remove the page you are currently managing. To delete the page, simply click the Delete button.

+

Control Panel Delete Button

+
+

Warning: This action is irreversible. Ensure that the page is no longer needed before proceeding.

+
+
+

Publish/Unpublish

+

The Publish feature enables you to make a page public if it was previously marked as hidden. This is particularly useful for working on a page that you want to keep inaccessible to regular users until it is fully prepared for release.

+

To toggle the publish status, click the Publish button, which will switch between publishing and unpublishing the page.

+

Control Panel Delete Button

+
+

This detailed overview of the Page Management feature provides administrators with the essential tools to manage individual pages effectively. Each button feature is clearly defined to enhance user understanding and facilitate efficient page management.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/content-management/working-with-modules.html b/docs/manuals/admin/content-management/working-with-modules.html new file mode 100644 index 000000000..287cc68c3 --- /dev/null +++ b/docs/manuals/admin/content-management/working-with-modules.html @@ -0,0 +1,133 @@ + + + + + Working With Modules | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Working With Modules

+ +

In order to access a module's settings, you must be in the content editor. To get into the editor, simply click over the pencil icon top-right corner of the page. This puts you into the edit mode where you will see small white arrows in the top-right corner of every module on the page. These small arrows at the top left corners of each module allow you to move the module on the page, access the module's settings, edit the module, delete the module, and access any specific functionality related to the module.

+

pencil

+

Once in Edit mode you will notice that Oqtane uses a very user-friendly and intuitive approach to managing content. Whenever you want to edit content in Oqtane, you go to the location where the content resides and edit it right there in place.

+

Moving Modules

+

Once a module is on the page, you can move its location again if needed. All that is needed is to enter the content editor by clicking on the pencil icon in the top right hand side with editing permission on a certain page. And then selecting the small downward pointing arrow in the top left of the module to do a variety of things to it, including:

+
    +
  • Move to Top: Moves the modules to the top of the page to be the first module displayed.
    • +
  • Move Up: Moves the module up to be above the module above it.
    • +
  • Move Down: Move the module down below the module beneath it.
    • +
  • Move to Bottom: Moves the module to the bottom of the page, below all other modules. +If the page has the layout for multiple panes, which will allows for three center rows and a top and bottom row that can have content inserted into them, then there will be additional options available which are:
    • +
  • Move to Top Pane: Moves the module to the content pane at the top of the page.
    • +
  • Move to Left Pane: Moves the module to the left-most column.
    • +
  • Move to Right Pane: Moves the module to the right-most column.
    • +
  • Move to Content Pane: Moves the module to the central column.
    • +
  • Move to Bottom Pane: Moves the module to the pane at the bottom of the page.
    • +
+

moving-menu

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/host-management/event-log.html b/docs/manuals/admin/host-management/event-log.html new file mode 100644 index 000000000..a574d9554 --- /dev/null +++ b/docs/manuals/admin/host-management/event-log.html @@ -0,0 +1,151 @@ + + + + + Event Log | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Event Log

+ +

The Event log allows you to know what's happening on your website at all times. On the surface, the Event log may seem very simple and it is. You have a listing of the most recent events immediately visible on page load. This list is going to be any number of pages with 10 events by default on each page of results and the option to see more rows at a time.

+

A paging feature at the bottom of the list allows you to move from page to page. +If you want to filter the events to see more or fewer events, you have three controls at the top of the listing to help you. You can filter by the type of event that you want to see with the event Level and Function:

+
    +
  • Level: The level specifies the severity of the event and includes options for: +
      +
    • Trace
      • +
    • Debug
      • +
    • Information
      • +
    • Warning
      • +
    • Error
      • +
    • Critical
      • +
    +
    • +
+

event-level

+
    +
  • Function: The function is what type of feature is being used and is color-coated for easier viewing. It includes options for: +
      +
    • Create
      • +
    • Read
      • +
    • Update
      • +
    • Delete
      • +
    • Security
      • +
    • Other
      • +
    +
    • +
+

event-function

+
    +
  • Rows: Choose how many rows you would like to have displayed on page. +The feature and date are also shown in the event list but aren't sortable fields, with the feature showing what part of the Oqtane framework is being used. +For example, you might be interested only in seeing instances of site users attempting to log in. To see this, simply change the Function drop-down list to Security, and only security events like the login event will be shown to you. +In other cases, you might want to see a larger list of events. There are many reasons for this. One reason might be searching for something specific using built-in features of your web browser, such as using Ctrl+F to “find” something in the page. As an example, you could switch the event log to show 100 events by changing the rows. +For each event that is displayed you can select the detail button to show more information on where the event happened and a more in-depth description on what the event is.
    • +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/host-management/index.html b/docs/manuals/admin/host-management/index.html new file mode 100644 index 000000000..95b9db2be --- /dev/null +++ b/docs/manuals/admin/host-management/index.html @@ -0,0 +1,129 @@ + + + + + Host Management Introduction | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Host Management Introduction

+ +

The host user has the highest possible level of permissions in a Oqtane instance and can manage any individual site, set defaults for the creation of new sites, and manage additional configurations that support all sites.

+

An Oqtane site administrator is primarily concerned with the look, feel, functionality, and content of a site. A host is more concerned with the configuration, performance, monitoring, and support of the entire Oqtane instance. As the Oqtane host (or any user with superuser permissions), you need to have a working grasp of all the features and configuration options available to you.

+

A host logs into a Oqtane site just like any other user, just using the host account that is created when the Oqtane application is first launched.

+

In addition to the site options discussed in the site administration control panel and admin dashboard, the host account has more options than an administrator account in the admin dashboard, which includes:

+
    +
  • Event Log: Which contain information on various events that have occurred on the site like errors or anything that has been created, updated, or deleted with more info on event log.
    • +
  • Site Management: Which allows for the addition and modification for all of the different sites you have with more info on site management.
    • +
  • Module Management: Which allows you to install new modules and edit existing modules with more info on module management.
    • +
  • Theme Management: Which allows you to install new themes to change the look of you webpages with more info on theme management.
    • +
  • Scheduled Jobs: Which allows for the creation of jobs that will do something every time a specified amount of time passes with more info on scheduled jobs.
    • +
  • SQL Management: Which lets you run SQL queries in your databases with more info on sql management.
    • +
  • System Info: Which gives information on your version of the Oqtane framework and allows you to see information and methods in Oqtane's api with more info on system info.
    • +
  • System Update: Which allows you to keep the Oqtane framework up to date and allow you to use Nuget packages with more info on system update.
    • +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/host-management/module-management.html b/docs/manuals/admin/host-management/module-management.html new file mode 100644 index 000000000..1e4d7cc99 --- /dev/null +++ b/docs/manuals/admin/host-management/module-management.html @@ -0,0 +1,119 @@ + + + + + Module Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Module Management

+ +

The module manager provides a list of all of the modules that are currently installed in your version of the Oqtane framework. Modules are a key feature of Oqtane and allow for a variety of features to be placed on your pages.

+

At the top of the module manager page there is a install button to install a module from the list provided or by using the upload tab, you can use a Nuget package of a module, so that it will be included as one of the possible modules to use on the site.

+

Inside the list of modules there is also the options to edit modules which will show an overview of the module with a description and an option to delete any module that is not a default Oqtane module.

+

module-management

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/host-management/scheduled-jobs.html b/docs/manuals/admin/host-management/scheduled-jobs.html new file mode 100644 index 000000000..5c2858aea --- /dev/null +++ b/docs/manuals/admin/host-management/scheduled-jobs.html @@ -0,0 +1,143 @@ + + + + + Scheduled Jobs | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Scheduled Jobs

+ +

The Schedule page enables you to manage what is essentially recurring, scheduled batch processing for Oqtane.There are many instances where a host may want to set something up to automatically do some task like sending a notification to users and this can be accomplished with the use of this feature. The options that are available on this page are:

+
    +
  • Add Job: Adds a new job by filling out the fields of: +
      +
    • Name: Choose the jobs name.
      • +
    • Type: Specify the type by either using NotificationJob or by creating your own job method in the infrastructure.jobs class in the Oqtane server. You will need to specify the location of the job in the framework, Ex. (Oqtane.Infrastructure.NotificationJob, Oqtane.Server) with the job being a notification job from the infrastructure class, which is a class inside of the Oqtane.Server.
      • +
    • Enabled: A yes or no to say if you want the job to be active at this time or not.
      • +
    • Runs Every: Choose an amount of time that specifies how often the job will execute.
      • +
    • Starting: Enter a date for when you want the job to start.
      • +
    • Ending: Enter a date for when you want the job to end.
      • +
    • Retention Log: A number to specify the amount of logs that will be retained.
      +edit-jobs
      • +
    +
    • +
  • View Logs: Shows all of the logs generated by all of your jobs within their retention log number.
    • +
  • Refresh: This refreshes the page to get new logs that have been made while you have been on this page.
    • +
+

Below this these options is a list of all of the jobs that are currently set up to be executed, that have a few options:

+
    +
  • Edit: Has all of the same fields as adding a job plus a field for the next execution: +
      +
    • Next execution: Input a date that will be the next time the job will run after the stop button has been pushed.
      • +
    +
    • +
  • Delete: Deletes the job so that it will never execute again.
    • +
  • Log: View the logs that this jobs has generated.
    • +
  • Stop: Stops the job from executing anymore, until a next execution has been specified in the edit window.
    • +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/host-management/site-management.html b/docs/manuals/admin/host-management/site-management.html new file mode 100644 index 000000000..7d53dfc98 --- /dev/null +++ b/docs/manuals/admin/host-management/site-management.html @@ -0,0 +1,137 @@ + + + + + Site Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Site Management

+ +

Oqtane provides the ability to have multiple sites at you disposal within the singular Oqtane application. The Site Management page provides an inventory of all the sites in a Oqtane instance and quick access to the Site Settings functionality for each. Deleting your sites is permanent! So it should not be done unless you are certain you want to delete this site. The options to add and edit the set has a few options:

+

site-management

+
    +
  • Site Name: This field is what the site will be called.
    • +
  • Aliases: This is what the address of the site is that is being created and can create websites under the default top level website, by using a / forward slash with the a name you want under the top level website.
    • +
  • Default Theme: Choose the theme, which is the colors and styles that will be the default for pages created on this website.
    • +
  • Default Layout: Choose how many content panes you want to have on a page by default.
    • +
  • Default Container: Choose if you want a title header for your modules on the site by default.
    • +
  • Site Template: Select if you want a template for your site or no template for your site.
    • +
  • Tenant: Select the tenant for the site, which is the database that will be used for the site. +
      +
    • If you want to create a new tenant or database then you will have to select the "create a new tenant" option which will drop down with another menu that allows for a new tenant to be created, this menu includes:
      • +
    • Name: This is the name for the new tenant on the site, that you will be creating and what will be displayed when selecting tenants in the future.
      • +
    • Database Type: Choose if you would like the database to have a local database, which will create a Microsoft SQL database on your local database on your system, and an SQL server which creates a that is linked to an SQL server.
      • +
    • Server: This is the location of where the server where the database will be located and a default value is provided for a local database.
      • +
    • Database: This is the name that is initialized for the database inside of the server and a default value is provided for a local database.
      • +
    • Integrated Security: Choose if you want the host superuser for the site to have the same credentials (username and password) as the database's root account.
      • +
    • Host Username: This is the username of the super user host account that will be created for the site, it will also be the database's root username if integrated security is set as true.
      • +
    • Hosts Password: This is the super user host account's password, it will also be the database's root account password if integrated security is set as true.
      • +
    +
    • +
+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/host-management/sql-management.html b/docs/manuals/admin/host-management/sql-management.html new file mode 100644 index 000000000..8f3a6f213 --- /dev/null +++ b/docs/manuals/admin/host-management/sql-management.html @@ -0,0 +1,117 @@ + + + + + SQL Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

SQL Management

+ +

The SQL console permits database access directly from inside Oqtane. So the host, even if it's not near an instance of SQL Server Management Studio, still has access to a powerful database tool. This allows for SQL statements to be run directly from the Oqtane application onto the tenants which are also called databases. The results of any SQL query that is run will be returned directly below the execute button.

+

sql-management

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/host-management/system-info.html b/docs/manuals/admin/host-management/system-info.html new file mode 100644 index 000000000..b1ebf5a70 --- /dev/null +++ b/docs/manuals/admin/host-management/system-info.html @@ -0,0 +1,118 @@ + + + + + System Info | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

System Info

+ +

All of the general information that you need to know about the Oqtane framework is available in the system information feature, which includes things like the Oqtane framework version, the blazor runtime, the server path, the CLR version, the OS version, and the server's current time.

+

The System Info feature also provides access to Oqtane's API with many of Oqtane's methods and the ability to try them out using the Swagger user interface. +There is also the option to restart the Oqtane framework on this page if you have made a change to the system that would require a restart such as installing or deleting themes or modules.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/host-management/system-update.html b/docs/manuals/admin/host-management/system-update.html new file mode 100644 index 000000000..846a46b81 --- /dev/null +++ b/docs/manuals/admin/host-management/system-update.html @@ -0,0 +1,116 @@ + + + + + System Update | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

System Update

+ +

The system update feature allows you to update the Oqtane framework to keep your website up to date and ensure that administrators will have access to all capabilities and features that Oqtane provides. The system update feature also provides the ability to upload a Nuget package to be included with your local version of the Oqtane framework and is uploaded by selecting the Nuget file from its location on your system and then pressing the upload button to place the Nuget package within a version of the framework, then pressing the install button to update you version of the framework to include the uploaded Nuget package. Uploading a Nuget package is for the use of uploading features that exist in a newer version of Oqtane, but you have not installed the newest version of Oqtane.

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/host-management/theme-management.html b/docs/manuals/admin/host-management/theme-management.html new file mode 100644 index 000000000..cdb35e8a9 --- /dev/null +++ b/docs/manuals/admin/host-management/theme-management.html @@ -0,0 +1,119 @@ + + + + + Theme Management | Oqtane Docs - APIs and more for the Modular Blazor Application Framework + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+

Theme Management

+ +

The theme page is not used that often. Generally, it's used during the development of a new site and sometimes is used during the rollout of a new site brand. It allows you to view the available themes and containers that have been installed in your site and then applied as the default for new and existing pages and modules.

+

Themes on Oqtane provide a multitude of different colors and styles for pages to be presented in. These themes can provide unique looking pages and websites as a whole. There are two default themes for Oqtane, the Blazor theme and the Oqtane theme.

+

You can also download new themes to use by clicking the install theme button at the top of the page and choosing some themes to download, so you change the look of your site. There is also an upload tab which allows you to put Nuget files for themes that are not available in the download menu onto your Oqtane framework.

+

theme-management

+ +
+ +
+ Edit this page +
+ + + +
+ +
+ +
+
+ +
+ +
+
+
+ Made with docfx +
+
+
+ + diff --git a/docs/manuals/admin/index.html b/docs/manuals/admin/index.html index 9ae7f923d..fface8c3e 100644 --- a/docs/manuals/admin/index.html +++ b/docs/manuals/admin/index.html @@ -86,14 +86,16 @@
Table of Contents

Oqtane Administrative Documentaion

+

Introduction

This administrative documentation outlines the various ways that administrators and user can interact with the oqtane platform in a variety of ways, including but not limited to:

    -
  • Adding modules to pages, moving them around and editing them.
    • -
  • Various host administrative tasks, such as jobs, event logs, and themes.
    • -
  • Administrative functions, such as file and user management.
    • +
  • Basic installation instructions.
  • The different processes of the control panel.
  • What the admin dashboard includes.
    • -
  • Basic installation instructions.
    • +
  • Content management for adding modules to pages, moving them around and editing them.
    • +
  • Administrative functions, such as file and user management.
    • +
  • Various host administrative tasks, such as jobs, event logs, installing modules and themes.
    • +
  • Basic development features like creating modules and themes from the related admin dashboard features.
diff --git a/docs/manuals/admin/installation/index.html b/docs/manuals/admin/installation/index.html index d4d9cf061..1368ec51d 100644 --- a/docs/manuals/admin/installation/index.html +++ b/docs/manuals/admin/installation/index.html @@ -152,7 +152,7 @@

Linux Apache

Resources

Explore additional installation resources and access the Oqtane blog and GitHub repository: