Skip to content

Commit

Permalink
5.2.4 updates (#88)
Browse files Browse the repository at this point in the history
* fix image link

* fix links

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update event-log.md

* Update module-management.md

* Update module-management.md

* Update module-management.md

* Update scheduled-jobs.md

* Update site-management.md

* Update site-management.md

* Update sql-management.md

* Update sql-management.md

* Update system-info.md

* Update system-info.md

* Update theme-management.md

* Update theme-management.md

* Update module-management.md

* Update page-management.md

* Update profile-management.md

* Update recycle-bin.md

* Update role-management.md

* Update site-settings.md

* Update page-management.md

* Update html-text-editor.md

* Update module-management.md

* Rename content-edit-module-options-caret-bottom-button.png to content-editor-module-options-caret-bottom-button.png

* Update url-mappings.md

* Delete src/pages/manuals/admin/content-management/image.png

* Create site-settings.md

* Update toc.yml

* adds site settings images

* fix image url to site settings dashboard icon

* Update site-settings images and links.md

* Update site-settings.md add url button image

* Update site-settings.md fix links to admin management site settings

* Create language-management.md

* Update toc.yml language management

* add langauge management images

* Rename language-management-upload.png to language-management-upload-window.png

* Update language-management.md

* Update language-management.md

* Update language-management.md

* Update theme-management.md

* adds theme creator images

* Rename theme-management-create-theme-settings-create-theme-reference.png to theme-management-create-theme-settings-reference.png

* Rename theme-management-create-theme-settings-create-theme-template.png to theme-management-create-theme-settings-template.png

* Rename theme-management-create-theme-settings-reference.png to theme-management-create-theme-settings-framework-reference.png

* Add files via upload

* Delete src/pages/manuals/admin/host-management/assets/theme-management-create-theme-settings-theme-template.png

* Add files via upload

* Add files via upload

* Update module-management.md

* add create module settings images

* Update module-management.md

* Add files via upload

* Update module-management.md

* Update theme-management.md

* Add files via upload

* Update theme-management.md

* Update theme-management.md

* Add files via upload

* Add files via upload

* Update module-management.md
  • Loading branch information
thabaum authored Nov 7, 2024
1 parent 153f718 commit f3348f5
Show file tree
Hide file tree
Showing 51 changed files with 1,531 additions and 192 deletions.
145 changes: 117 additions & 28 deletions src/pages/manuals/admin/admin-management/page-management.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,131 @@
# Page Management

![page-management](./assets/page-management.png)
![Page Management](./assets/page-management.png)

## Overview

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
## Control Panel Walk-through

### Accessing the Page Management Feature

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

![Control Panel Icon](assets/control-panel-button.png)

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

![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.png)

3. In the admin dashboard, click on the **Page Management** icon to configure your pages.

![Admin Dashboard Page Management](assets/admin-dashboard-page-management.png)

---

## Adding a Page

The add page 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.

Page management has an "Add Page" button, and when clicked, you get the following:

![Add Page Settings](./assets/page-management-add-page-button.png)

A window will appear with two tabs: **Settings** and **Permissions**.

### Settings Tab
- **Name:** Enter a page name.
- **Parent:** Select the parent for the page in the site hierarchy (setting this to admin will create an admin dashboard page).
- **Insert:** Select the location where you would like the page to be inserted in relation to other pages (While in edit, this is changed to Move: Select the location where you would like the page to be moved in relation to other pages, so be sure to update this when talking about editing a page).
- **Navigation:** Select whether the page is part of the site navigation or hidden.
- **Clickable?:** Select whether the link in the site navigation is enabled or disabled.
- **URL Path:** Optionally enter a URL path for this page (i.e., home). If you do not provide a URL path, the page name will be used. If the page is intended to be the root path, specify '/'.
- **Redirect:** Optionally enter a URL which this page should redirect to when a user navigates to it.
- **Icon:** Optionally provide an icon class name for this page which will be displayed in the site navigation.
- **Effective Date:** The date that this page is active.
- **Expiry Date:** The date that this page expires.
- **Personalizable?:** Select whether you would like users to be able to personalize this page with their own content.

![Add Page Settings](./assets/page-management-add-page-settings.png)

**Appearance**
- **Title:** Optionally enter the page title. If you do not provide a page title, the page name will be used.
- **Theme:** Select the theme for this page.
- **Default Container:** Select the default container for the page.

![Add Page Setttings Appearance](./assets/page-management-add-page-settings-appearance.png)

**Page Content**
- **Head Content:** Optionally enter content to be included in the page head (i.e., meta, link, or script tags).
- **Body Content:** Optionally enter content to be included in the page body (i.e., script tags).

![Add Page Settings Page Content](./assets/page-management-add-page-settings-page-content.png)

### Permissions Tab

The permissions tab has the following:
- A list of roles with "View Page" and "Edit Page" checkbox permissions to the right.
- Below that is a way to search for a user's name via text input and click the "Add" button.
- When users are added, below the "Role" list section will be an added "User" list that displays users with the permissions they have been granted.

![Add Page Permissions](./assets/page-management-add-page-permissions.png)

Use the **Save** button to save the page or **Cancel** button or use the **X** to close the window to escape it.

## Search Pages

Below the "Add Page" button on the main form:
- **Search by Name** input field to search for pages with a "Search" button to click to perform the search and a "Reset" button to reset the form.

![Page Search](./assets/page-management-search.png)

After this, there is a paginated list of pages with 3 buttons: Edit, Delete, and Browse.

## Edit Page

The edit page 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.

**Edit** button will pop up a window to edit the page features (tabs discussed while adding it).

![Edit Page Button](./assets/page-management-edit-page-button.png)

Editing page settings is as discussed in adding it with the exception of "Insert" option is now a"Move" option.

![Edit Page Settings](./assets/page-management-edit-page-settings.png)

Edit Page Appearance and Page Content options are the same as add page as shown below:

![Edit Page Settings Page Appearance](./assets/page-management-edit-page-settings-appearance.png)

![Edit Page Settings Page Content](./assets/page-management-edit-page-settings-page-content.png)

In addition to these tabs are two more tabs:

- **Modules:** Lists all the modules you can then "Edit" the modules on the page with an edit button to access that module's settings, or "Delete" to delete the module from the page.

![Edit Page Modules](./assets/page-management-edit-page-modules.png)

- **Theme Settings:** Includes the following settings you can set that are all dropdown selections.
- **Settings Scope:** Specify if the settings are applicable to this page or the entire site.
- **Show Login:** Specify if a Login option should be displayed. Note that this option does not prevent the login page from being accessible via a direct URL.
- **Show Register:** Specify if a Register option should be displayed. Note that this option is also dependent on the Allow Registration option in Site Settings.
- **Display Fixed Footer?:** Specify if a Footer pane should always be displayed in a fixed location at the bottom of the page.

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:
![Edit Page Theme Settings](./assets/page-management-edit-page-theme-settings.png)

>#### 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](./assets/add-page.png)
## Delete 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](./assets/page-appearance.png)
You can **Delete** a page in the list of pages with a confirmation window popping up. 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](recycle-bin.md).

>#### 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](./assets/permissions.png)
## Browse Page

### Edit
A **Browse** button allows you to navigate to that page to view it on the site.

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.
![Edit Page Theme Settings](./assets/page-management-browse-page-button.png)

### Delete
## Conclusion

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](recycle-bin.md).
Page Management provides a robust interface to control your website's pages effectively. With options to add, edit, delete, and manage permissions, you can ensure that your site grows and evolves as needed while maintaining a user-friendly experience.
95 changes: 77 additions & 18 deletions src/pages/manuals/admin/admin-management/profile-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,80 @@

![profile-management](./assets/profile-management.png)

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](../host-administration/sql-management.md).
* 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](./assets/add-profile.png)

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](./assets/edit-profile.png)
# Overview

Profile Management in Oqtane provides a flexible and powerful way to customize user profiles. This feature is often underappreciated but is essential for creating tailored user experiences. The Profile Manager enables you to customize the fields of user accounts, from the name and address to custom fields with specific validation, required settings, and more.

In Oqtane, the Profile Manager is primarily used to define profile fields, set field properties, and organize them into categories. Administrators can configure profile fields that users will interact with during account creation or editing.

## Control Panel Walk-through

### Accessing the Profile Management Feature

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

![Control Panel Icon](assets/control-panel-button.png)

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

![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.png)

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

![Admin Dashboard Profile Management](assets/admin-dashboard-profile-management.png)

---

## Adding a Profile Item

At the top of the Profile Management page, you will see an **Add Profile** button. Clicking this button brings up the settings for adding a new profile item.

![profile-management-add-button](./assets/profile-management-add-button.png)

### Profile Item Settings

When adding a profile, the following settings are available:

1. **Name**: The internal name of the profile item, used for database access.
2. **Title**: The label displayed to users for this profile item (e.g., "Full Name").
3. **Description**: Help text displayed next to the field for user guidance.
4. **Category**: The grouping name for the profile item (e.g., "Personal Information").
5. **Order**: The index position where this item will appear in the profile form. `0` is the first position.
6. **Length**: The maximum number of characters allowed for this profile field. Set to `0` for unlimited length.
7. **Rows**: The number of rows for text input. If set to more than one row, the input changes from a single-line text field to a multi-line text area.
8. **Default Value**: The pre-filled value for the profile item if the user does not provide one.
9. **Options**: A comma-separated list of selectable options (e.g., "Male,Female,Other").
10. **Required?**: Whether this field is required for the user to complete when creating their account.
11. **Validation**: Optionally, provide a regular expression (RegEx) for validating the entered value (e.g., for email addresses).
12. **Autocomplete**: The HTML `autocomplete` attribute for browser assistance with autofilling the field. Options include blank (default), 'on', 'off', or any value from the standardized taxonomy.
13. **Private?**: Whether this profile field is visible to all users or only administrators.

Once these settings are configured, click **Save** to create the profile item. You can also cancel the action or close the window by clicking the **X** in the top-right corner.

![Profile Management Add Settings Window](./assets/profile-management-add-settings-window.png)

## Searching Profiles

Below the **Add Profile** button, there is a **Search** input field. This allows you to search for profile items based on their **Title** or **Category**. You can enter a search term and click **Search** to filter the list of profile items. To reset the search results, click the **Reset** button.

![profile-management-search](./assets/profile-management-search.png)

## Profile List

Below the search field, a list of existing profile items is displayed. For each profile item, the following properties are shown:

- **Name**: The internal name.
- **Title**: The displayed label for the profile item.
- **Category**: The group/category the profile item belongs to.
- **Order**: The position of the profile item in the list.

Each profile item has two buttons:

- **Edit**: Clicking this button opens the profile settings in an editable form where you can change any of the properties. After editing, click **Save** to apply changes, or **Cancel** to discard them. You can also close the settings window by clicking the **X** at the top-right.
- **Delete**: Clicking the delete button opens a confirmation window asking you to confirm the deletion of the profile item. Once confirmed, the profile item is permanently deleted.

![Profile Management Edit Settings Window](./assets/profile-management-edit-settings-window.png)

## Conclusion

The Profile Management feature in Oqtane provides administrators with powerful tools to customize and manage user profiles. Whether you're creating new profile fields or setting validation rules, this feature is essential for tailoring the user experience on your site. Be sure to explore all options to make the most of your site’s profile management capabilities.
Loading

0 comments on commit f3348f5

Please sign in to comment.