Skip to content

Commit 6610440

Browse files
deepakdebdeepakdeb
committed
application user guide section updated
1 parent 10e61c3 commit 6610440

File tree

11 files changed

+258
-11
lines changed

11 files changed

+258
-11
lines changed

‎docs/.vitepress/config.ts

+3-4
Original file line numberDiff line numberDiff line change
@@ -194,11 +194,10 @@ export default {
194194
collapsible: true,
195195
items: [
196196
{ text: 'General', link: '/comfortjobapp/user-guide/general' },
197-
{ text: 'Settings Manager', link: '/comfortjobapp/user-guide/settings-manager' },
198-
{ text: 'Agency Manager', link: '/comfortjobapp/user-guide/agency-manager' },
199-
{ text: 'Account Manager', link: '/comfortjobapp/user-guide/account-manager' },
200-
{ text: 'Category Manager', link: '/comfortjobapp/user-guide/category-manager' },
197+
{ text: 'Application Manager', link: '/comfortjobapp/user-guide/application-manager' },
198+
{ text: 'Settings Manager', link: '/comfortjobapp/user-guide/settings' },
201199
{ text: 'Tools Manager', link: '/comfortjobapp/user-guide/tools-manager' },
200+
{ text: 'Emails', link: '/comfortjobapp/user-guide/emails' },
202201
],
203202
}
204203
],

‎docs/comfortjob/user-guide/settings.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ The Comfort Job plugin is designed with a modular and intuitive settings structu
2727
Navigate to **Comfort Job > Settings** in the WordPress admin dashboard. This section is organized into various sections, each dedicated to specific configuration options.
2828

2929
## Basic Settings ##
30-
These fundamental settings allow you to define core parameters for your accounting system. Some key options:
30+
These fundamental settings allow you to define core parameters for your job builder system. Some key options:
3131

32-
**Pages Slug** Set the slug country for different pages over the plugin.\
32+
**Pages Slug** Set the slug country for different pages over the plugin.
3333

3434
### File Attachments
3535
The File Upload/Attachments Settings section allows users to manage file attachments within the Comfort Job plugin, particularly for the Log component. These settings ensure that file uploads are handled securely and efficiently, aligning with your operational requirements.

‎docs/comfortjobapp/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ card: "article"
1111
---
1212
# Comfort Job Application Documentation
1313

14-
Welcome to the Comfort Job Application main page.
14+
ComfortJobApp simplifies the job application process for candidates and recruiters. Manage applications efficiently with this plugin.
1515

1616

‎docs/comfortjobapp/user-guide/application-manager.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "Comfort Job Application Documentation"
3+
description: "Documentation for Comfort Job Application"
4+
keywords: "comfort resume, wordpress, wordpress resume plugin, plugin"
5+
url: "/comfortjobapp/user-guide/resume-manager"
6+
type: "type"
7+
site_name: "Comfort HRM"
8+
image: "https://comforthrm.com/assets/images/seo.png"
9+
card: "article"
10+
11+
---
12+
13+
## Managing Application Listings
14+
15+
1. Go to `Comfort Job Application > Application Manager`.
16+
2. View, edit, or delete application listings as needed.
17+
3. Use the filters to search for specific application listings.
18+
19+
## Edit Application
20+
21+
1. Go to `Comfort Job Application > Edit Application`.
22+
2. Fill in the application details. The fields are:
23+
- **Application Status**: Update the application current status.
24+
- **Application Step**: Select the specific step for the specific Application.
25+
- **Application Step**: Check if hired or not.
26+
- **Application Form data**: Update any form data from applied form.
27+
- **Application File Upload**: upload/edit/delete a file from edit page for the specific application.
28+
4. Publish the application listing.

‎docs/comfortjobapp/user-guide/emails.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: "Comfort Job Application Documentation"
3+
description: "Documentation for Comfort Job Application"
4+
keywords: "comfort resume, wordpress, wordpress resume plugin, plugin"
5+
url: "/comfortjobapp/user-guide/emails"
6+
type: "type"
7+
site_name: "Comfort HRM"
8+
image: "https://comforthrm.com/assets/images/seo.png"
9+
card: "article"
10+
11+
---
12+
13+
## Email System
14+
15+
The Comfort Job Application plugin includes an email system to notify users about various events such as job application submissions.
16+
17+
#### Customizing Email Templates
18+
19+
1. Copy the desired email template file from `wp-content/plugins/comfortjobapp/templates/emails/` to your theme's directory, maintaining the folder structure.
20+
2. Edit the copied template file as needed.
21+
22+
#### Available Email Templates
23+
- **Notify Employer on application submission**: `job_apply_employer_notification.php`
24+
- **Notify Candidate on application submission**: `job_apply_candidate_notification.php`
25+
- **Notify guest user on application submission**: `guest_email_confirmation.php`
26+
27+
### Single Email Settings
28+
29+
1. Go to `Comfort Job Application > Emails`.
30+
2. Configure the following email settings:
31+
32+
- **Subject**: The subject of the email.
33+
- **Email heading**: The heading of the email.
34+
- **Additional content**: The Additional content of the emails.
35+
- **From Name**: The name that will appear as the sender of the emails.
36+
- **From Email**: The email address that will appear as the sender of the emails.
37+
- **Admin Email**: The email address where admin notifications will be sent(if admin notification).
38+
- **CC/BCC**: The CC & BCC of the email.
39+
40+
3. Save changes.
41+

‎docs/comfortjobapp/user-guide/general.md

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
title: "Comfort Job Application Documentation"
3+
description: "Documentation for Comfort Job Application"
4+
keywords: "Comfort Job Application index keywords."
5+
url: "/comfortjobapp/user-guide/general"
6+
type: "type"
7+
site_name: "Comfort HRM"
8+
image: "https://comforthrm.com/assets/images/seo.png"
9+
card: "article"
10+
11+
---
12+
13+
# Comfort Job Application User Guide
14+
15+
ComfortJobApp simplifies the job application process for candidates and recruiters. Manage applications efficiently with this plugin.
16+
17+
## File Structure
18+
19+
```
20+
resume/
21+
├── assets/
22+
│ ├── css/
23+
│ ├── js/
24+
│ ├── vendors/
25+
├── includes/
26+
│ ├── Api/
27+
│ ├── Controllers/
28+
│ ├── Helpers/
29+
│ ├── Models/
30+
│ ├── ComfortJobApp.php
31+
│ ├── ComfortJobAppAdmin.php
32+
│ ├── ComfortJobAppHooks.php
33+
│ ├── ComfortJobAppPublic.php
34+
│ └── ComfortJobAppUninstall.php
35+
├── templates/
36+
│ ├── admin/
37+
│ ├── emails/
38+
│ ├── form-fields/
39+
├── comfortjobapp.php
40+
└── readme.txt
41+
```
42+
## Key Files and Directories
43+
44+
- **assets/**: Contains CSS, JavaScript, and vendor files.
45+
- **includes/**: Contains core PHP files for the plugin, including API routes, controllers, helpers, models, and main plugin classes.
46+
- **templates/**: Contains template files for the plugin's frontend and admin views.
47+
- **comfortjobapp.php**: The main plugin file that initializes the plugin.
48+
49+
### ComfortJobApp
50+
51+
The main class for the plugin, located in `wp-content/plugins/comfortjobapp/includes/ComfortJobApp.php`.
52+
53+
```php
54+
class ComfortJobApp {
55+
public static function instance() {
56+
// Returns the main instance of ComfortJobApp.
57+
}
58+
59+
public function __construct() {
60+
// Constructor method.
61+
}
62+
63+
private function include_files() {
64+
// Includes necessary files.
65+
}
66+
}
67+
```
68+
### ComfortJobAppAdmin
69+
Handles the admin functionalities of the plugin, located in `ComfortJobAppAdmin.php`.
70+
71+
```
72+
<?php
73+
class ComfortJobAppAdmin {
74+
public function create_menus() {
75+
// Creates admin menus.
76+
}
77+
78+
public function display_resume_listing_page() {
79+
// Displays the resume listing page.
80+
}
81+
}
82+
```
83+
### ComfortJobAppPublic
84+
Handles the public-facing functionalities of the plugin, located in `ComfortJobAppPublic.php`.
85+
86+
```
87+
<?php
88+
class ComfortJobAppPublic {
89+
public function enqueue_scripts() {
90+
// Enqueues public scripts and styles.
91+
}
92+
}
93+
```
94+
95+
## Uninstallation
96+
97+
The uninstallation script is located in ComfortJobAppUninstall.php.
98+
99+
```
100+
<?php
101+
ComfortJobAppUninstall::uninstall();
102+
```

‎docs/comfortjobapp/user-guide/settings.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: "Comfort Job Application Documentation"
3+
description: "Documentation for Comfort Job Application"
4+
keywords: "comfort resume, wordpress, wordpress resume plugin, plugin"
5+
url: "/comfortjobapp/user-guide/settings"
6+
type: "type"
7+
site_name: "Comfort HRM"
8+
image: "https://comforthrm.com/assets/images/seo.png"
9+
card: "article"
10+
11+
---
12+
13+
# Comfort Job Application User Guide
14+
15+
### General Settings
16+
17+
1. Go to `Comfort Job Application > Settings`.
18+
2. Configure the general settings such as geneal settings, pages, and other options.
19+
3. Save changes.
20+
21+
This short guide provides a basic walkthrough for setting up the Comfort Job Application plugin. For detailed instructions on each component, refer to the specific sections in the plugin documentation.
22+
23+
# General Settings Overview #
24+
The Comfort Job Application plugin is designed with a modular and intuitive settings structure, ensuring that users can easily configure and tailor the plugin to their specific needs. Below is an overview of the key configuration areas:
25+
26+
# Accessing the Settings Panel #
27+
Navigate to **Comfort Job Application > Settings** in the WordPress admin dashboard. This section is organized into various sections, each dedicated to specific configuration options.
28+
29+
## General Settings ##
30+
These fundamental settings allow you to define core parameters for your application system. Some key options:
31+
32+
**Pages Slug** Set the slug country for different pages over the plugin.
33+
34+
## Pages ##
35+
Select the page where you have placed the shortcodes.
36+
37+
### File Upload Settings
38+
The File Upload/Attachments Settings section allows users to manage file attachments within the Comfort Job Application plugin, particularly for the Log component. These settings ensure that file uploads are handled securely and efficiently, aligning with your operational requirements.
39+
40+
**File Attachments** Enable/Disable file attachments on application
41+
**Allowed File Mime Type:** Text field to specify permitted file types (e.g. image/jpeg,image/png)\
42+
**Max File Size (MB):** A numeric field where users can define the maximum allowable file size for uploads, measured in megabytes (MB).
43+
44+
Other options like **Email template**, **Job applications**, **Update settings**, **Form builder** and others are self introductory. Labels are there to guide.
45+
46+
47+
48+
49+
50+

‎docs/comfortjobapp/user-guide/tools-manager.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "Comfort Job Application Documentation"
3+
description: "Documentation for Comfort Job Application"
4+
keywords: "comfort job application, wordpress, wordpress job application plugin, plugin"
5+
url: "/comfortjobapp/user-guide/tools-manager"
6+
type: "type"
7+
site_name: "Comfort HRM"
8+
image: "https://comforthrm.com/assets/images/seo.png"
9+
card: "article"
10+
11+
---
12+
13+
# Tools Manager
14+
15+
The Tools Manager provides essential utilities for managing **system data** and configurations within the platform. It offers two powerful features to enhance data management and ensure smooth operations. These tools help users maintain the integrity of their system and migrate database table.
16+
17+
## Options ##
18+
19+
**Reset Option Data**:
20+
+ The Reset Option Data feature allows users to **reset specific option** data within the system. Users can view the available options and choose which one to reset. This feature ensures that users can easily clear outdated or incorrect option data, restoring the system to its default or desired state.
21+
22+
**Migration Files**:
23+
+ The Migration Files feature provides users with visibility into which migration files have been successfully migrated and which have not. Users can also initiate **migrations directly** from this section, allowing for streamlined data transfer and system updates. This functionality is crucial for maintaining data consistency during system upgrades or migrations.
24+
25+
The Tools Manager is an integral part of the system, offering critical utilities to **keep data organized**, ensure smooth migrations. These features enhance data integrity and improve the overall functionality of the system.
26+

‎docs/comfortresume/user-guide/emails.md

-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ The Comfort Resume plugin includes an email system to notify users about various
2020
2. Edit the copied template file as needed.
2121

2222
#### Available Email Templates
23-
Sends notification to admin on resume created by guest user.
2423
- **Resume creation guest user Email for Admin**: `guest_resume_create_to_admin.php`
2524
- **Job Application Email with resume Email**: `job_applied_by_resume.php`
2625
- **Resume Saved as Draft Email For User**: `resume_draft_to_user.php`

‎docs/comfortresume/user-guide/general.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,20 @@ resume/
3535
│ └── ComfortResumeUninstall.php
3636
├── templates/
3737
│ ├── admin/
38+
│ ├── emails/
3839
│ ├── global/
40+
│ ├── loop/
3941
│ ├── resume/
4042
│ └── shortcodes/
41-
├── resume.php
43+
├── comfortresume.php
4244
└── readme.txt
4345
```
4446
## Key Files and Directories
4547

4648
- **assets/**: Contains CSS, JavaScript, and vendor files.
4749
- **includes/**: Contains core PHP files for the plugin, including API routes, controllers, helpers, models, and main plugin classes.
4850
- **templates/**: Contains template files for the plugin's frontend and admin views.
49-
- **resume.php**: The main plugin file that initializes the plugin.
51+
- **comfortresume.php**: The main plugin file that initializes the plugin.
5052

5153
### ComfortResume
5254

‎docs/comfortresume/user-guide/settings.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The Comfort Resume plugin is designed with a modular and intuitive settings stru
2727
Navigate to **Comfort Resume > Settings** in the WordPress admin dashboard. This section is organized into various sections, each dedicated to specific configuration options.
2828

2929
## General Settings ##
30-
These fundamental settings allow you to define core parameters for your accounting system. Some key options:
30+
These fundamental settings allow you to define core parameters for your system. Some key options:
3131

3232
**Pages Slug** Set the slug country for different pages over the plugin.
3333

0 commit comments

Comments
 (0)