Skip to content

Commit 651a98a

Browse files
deepakdebdeepakdeb
committed
user guide section added in job
1 parent ab9a28b commit 651a98a

File tree

9 files changed

+499
-45
lines changed

9 files changed

+499
-45
lines changed

‎docs/.vitepress/config.ts‎

Lines changed: 108 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ export default {
5050
},
5151
// Navbar Link
5252
nav: [
53-
{ text: "Job 2", link: "/comfortjob/" },
5453
{ text: "Resume", link: "/comfortresume/" },
54+
{ text: "Job", link: "/comfortjob/" },
5555
{ text: "Job Application", link: "/comfortjobapp/" },
5656
],
5757
//Social Icons
@@ -81,10 +81,6 @@ export default {
8181
{ text: 'How to install', link: '/comfortjob/how-to-install' },
8282
{ text: 'How to Translate', link: '/comfortjob/how-to-translate' },
8383
{ text: 'Template Override', link: '/comfortjob/template-override' },
84-
//{ text: 'Shortcodes', link: '/comfortjob/shortcodes' },
85-
// { text: 'Classic Widgets', link: '/comfortjob/classic-widgets' },
86-
// { text: 'Elementor Widget', link: '/comfortjob/elementor-widgets' },
87-
// { text: 'Gutenberg Blocks', link: '/comfortjob/gutenberg-blocks' },
8884
{ text: 'Hooks and Filters', link: '/comfortjob/hooks-and-filters' },
8985
{ text: 'Code Samples', link: '/comfortjob/code-samples' },
9086
],
@@ -93,15 +89,7 @@ export default {
9389
text: 'Shortcode',
9490
collapsible: true,
9591
items: [
96-
// { text: 'How to install', link: '/comfortjob/how-to-install' },
97-
// { text: 'How to Translate', link: '/comfortjob/how-to-translate' },
98-
// { text: 'Template Override', link: '/comfortjob/template-override' },
9992
{ text: '9 Shortcodes', link: '/comfortjob/shortcodes' },
100-
// { text: 'Classic Widgets', link: '/comfortjob/classic-widgets' },
101-
// { text: 'Elementor Widget', link: '/comfortjob/elementor-widgets' },
102-
// { text: 'Gutenberg Blocks', link: '/comfortjob/gutenberg-blocks' },
103-
// { text: 'Hooks and Filters', link: '/comfortjob/hooks-and-filters' },
104-
// { text: 'Code Samples', link: '/comfortjob/code-samples' },
10593
],
10694
},
10795
{
@@ -112,42 +100,119 @@ export default {
112100
{ text: 'Elementor Widget', link: '/comfortjob/elementor-widgets' },
113101
{ text: 'Gutenberg Blocks', link: '/comfortjob/gutenberg-blocks' },
114102
],
115-
}
116-
],
117-
118-
119-
// Sidebar for `/guide/` section
120-
'/comfortresume/': [
121-
{
122-
text: 'Comfort Resume',
123-
collapsible: true,
124-
items: [
125-
{ text: 'How to install', link: '/comfortresume/how-to-install' },
126-
{ text: 'How to Translate', link: '/comfortresume/how-to-translate' },
127-
{ text: 'Template Override', link: '/comfortresume/template-override' },
128-
{ text: 'Shortcodes', link: '/comfortresume/shortcodes' },
129-
{ text: 'Classic Widgets', link: '/comfortresume/classic-widgets' },
130-
{ text: 'Elementor Widget', link: '/comfortresume/elementor-widgets' },
131-
{ text: 'Gutenberg Blocks', link: '/comfortresume/gutenberg-blocks' },
132-
{ text: 'Hooks and Filters', link: '/comfortresume/hooks-and-filters' },
133-
{ text: 'Code Samples', link: '/comfortresume/code-samples' },
134-
],
135103
},
136-
],
137-
'/comfortjobapp/': [
138104
{
139-
text: 'Comfort Job Application',
105+
text: 'User Guide',
140106
collapsible: true,
141107
items: [
142-
{ text: 'How to install', link: '/comfortjobapp/how-to-install' },
143-
{ text: 'How to Translate', link: '/comfortjobapp/how-to-translate' },
144-
{ text: 'Template Override', link: '/comfortjobapp/template-override' },
145-
{ text: 'Shortcodes', link: '/comfortjobapp/shortcodes' },
146-
{ text: 'Hooks and Filters', link: '/comfortjobapp/hooks-and-filters' },
147-
{ text: 'Code Samples', link: '/comfortjobapp/code-samples' },
108+
{ text: 'General', link: '/comfortjob/user-guide/general' },
109+
{ text: 'Job Manager', link: '/comfortjob/user-guide/job-manager' },
110+
{ text: 'Settings Manager', link: '/comfortjob/user-guide/settings-manager' },
111+
{ text: 'Company Manager', link: '/comfortjob/user-guide/company-manager' },
112+
{ text: 'Category Manager', link: '/comfortjob/user-guide/category-manager' },
113+
{ text: 'Category Manager', link: '/comfortjob/user-guide/category-manager' },
114+
{ text: 'Tools Manager', link: '/comfortjob/user-guide/tools-manager' },
148115
],
149-
},
116+
}
150117
],
118+
119+
'/comfortresume/': [
120+
{
121+
text: 'Comfort Resume',
122+
collapsible: false,
123+
},
124+
{
125+
text: 'Getting Started',
126+
collapsible: true,
127+
items: [
128+
{ text: 'How to install', link: '/comfortresume/how-to-install' },
129+
{ text: 'How to Translate', link: '/comfortresume/how-to-translate' },
130+
{ text: 'Template Override', link: '/comfortresume/template-override' },
131+
{ text: 'Hooks and Filters', link: '/comfortresume/hooks-and-filters' },
132+
{ text: 'Code Samples', link: '/comfortresume/code-samples' },
133+
],
134+
},
135+
{
136+
text: 'Shortcode',
137+
collapsible: true,
138+
items: [
139+
{ text: '9 Shortcodes', link: '/comfortresume/shortcodes' },
140+
],
141+
},
142+
{
143+
text: 'Widgets',
144+
collapsible: true,
145+
items: [
146+
{ text: 'Classic Widgets', link: '/comfortresume/classic-widgets' },
147+
{ text: 'Elementor Widget', link: '/comfortresume/elementor-widgets' },
148+
{ text: 'Gutenberg Blocks', link: '/comfortresume/gutenberg-blocks' },
149+
],
150+
},
151+
{
152+
text: 'User Guide',
153+
collapsible: true,
154+
items: [
155+
{ text: 'General', link: '/comfortresume/user-guide/general' },
156+
{ text: 'Settings Manager', link: '/comfortresume/user-guide/settings-manager' },
157+
{ text: 'Agency Manager', link: '/comfortresume/user-guide/agency-manager' },
158+
{ text: 'Account Manager', link: '/comfortresume/user-guide/account-manager' },
159+
{ text: 'Category Manager', link: '/comfortresume/user-guide/category-manager' },
160+
{ text: 'Tools Manager', link: '/comfortresume/user-guide/tools-manager' },
161+
],
162+
}
163+
],
164+
165+
166+
'/comfortjobapp/': [
167+
{
168+
text: 'Comfort Resume',
169+
collapsible: false,
170+
},
171+
{
172+
text: 'Getting Started',
173+
collapsible: true,
174+
items: [
175+
{ text: 'How to install', link: '/comfortjobapp/how-to-install' },
176+
{ text: 'How to Translate', link: '/comfortjobapp/how-to-translate' },
177+
{ text: 'Template Override', link: '/comfortjobapp/template-override' },
178+
{ text: 'Hooks and Filters', link: '/comfortjobapp/hooks-and-filters' },
179+
{ text: 'Code Samples', link: '/comfortjobapp/code-samples' },
180+
],
181+
},
182+
{
183+
text: 'Shortcode',
184+
collapsible: true,
185+
items: [
186+
{ text: '9 Shortcodes', link: '/comfortjobapp/shortcodes' },
187+
],
188+
},
189+
{
190+
text: 'User Guide',
191+
collapsible: true,
192+
items: [
193+
{ text: 'General', link: '/comfortjobapp/user-guide/general' },
194+
{ text: 'Settings Manager', link: '/comfortjobapp/user-guide/settings-manager' },
195+
{ text: 'Agency Manager', link: '/comfortjobapp/user-guide/agency-manager' },
196+
{ text: 'Account Manager', link: '/comfortjobapp/user-guide/account-manager' },
197+
{ text: 'Category Manager', link: '/comfortjobapp/user-guide/category-manager' },
198+
{ text: 'Tools Manager', link: '/comfortjobapp/user-guide/tools-manager' },
199+
],
200+
}
201+
],
202+
// '/comfortjobapp/': [
203+
// {
204+
// text: 'Comfort Job Application',
205+
// collapsible: true,
206+
// items: [
207+
// { text: 'How to install', link: '/comfortjobapp/how-to-install' },
208+
// { text: 'How to Translate', link: '/comfortjobapp/how-to-translate' },
209+
// { text: 'Template Override', link: '/comfortjobapp/template-override' },
210+
// { text: 'Shortcodes', link: '/comfortjobapp/shortcodes' },
211+
// { text: 'Hooks and Filters', link: '/comfortjobapp/hooks-and-filters' },
212+
// { text: 'Code Samples', link: '/comfortjobapp/code-samples' },
213+
// ],
214+
// },
215+
// ],
151216
},
152217
// you can disable the previous and next page here
153218
docFooter: {

‎docs/comfortjob/hooks-and-filters.md‎

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,62 @@ site_name: "Comfort HRM"
88
image: "https://comforthrm.com/assets/images/seo.png"
99
card: "article"
1010
---
11-
# Hooks and Filters
1211

1312

13+
Comfort Job provides a variety of hooks and filters that allow developers to customize and extend the plugin's functionality. These hooks and filters can be used to modify the behavior of the plugin, add new features, or integrate with other plugins or themes.
1414

15-
**Last modified:** December 9, 2024
15+
## Hooks
16+
17+
Hooks in Comfort Job are points in the code where developers can add custom functions or code to modify the plugin's behavior. There are two types of hooks in WordPress: action hooks and filter hooks.
18+
19+
### Activation and Deactivation
20+
21+
- register_activation_hook(__FILE__, 'activate_comfortjob');
22+
- register_deactivation_hook(__FILE__, 'deactivate_comfortjob');
23+
24+
### Action Hooks
25+
26+
Action hooks allow developers to execute custom functions at specific points in the plugin's code. These functions can perform actions such as displaying content, updating data, or sending notifications. Action hooks in Comfort Job are typically triggered by events such as saving a job listing or deleting a company.
27+
28+
Here are some common action hooks in Comfort Job:
29+
30+
- `comfortjob_before_job_listing`: Triggered before a job listing is displayed on the frontend.
31+
- `comfortjob_after_job_listing`: Triggered after a job listing is displayed on the frontend.
32+
- `comfortjob_job_saved`: Triggered after a job listing is saved in the database.
33+
34+
Developers can create custom functions and hook them into these action hooks to add new functionality to Comfort Job.
35+
36+
### Filter Hooks
37+
38+
Filter hooks allow developers to modify or filter data before it is displayed or processed by the plugin. Filters in Comfort Job are used to customize the output of job listings, companies, or other data displayed by the plugin. Developers can use filter hooks to change text, alter URLs, or modify data structures.
39+
40+
Here are some common filter hooks in Comfort Job:
41+
42+
- `comfortjob_job_title`: Filters the title of a job listing.
43+
- `comfortjob_company_name`: Filters the name of a company.
44+
- `comfortjob_job_location`: Filters the location of a job listing.
45+
46+
Developers can create custom filter functions and hook them into these filter hooks to customize the output of Comfort Job.
47+
48+
## Using Hooks and Filters
49+
50+
To use hooks and filters in Comfort Job, developers can create custom functions in their theme's `functions.php` file or in a custom plugin. These functions should be defined with the `add_action()` or `add_filter()` functions, specifying the hook name and the custom function to be executed.
51+
52+
For example, to add a custom function to the `comfortjob_after_job_listing` action hook, developers can use the following code:
53+
54+
```php
55+
function my_custom_function() {
56+
// Custom code to be executed after a job listing is displayed
57+
}
58+
add_action('comfortjob_after_job_listing');
59+
```
60+
61+
### Custom Actions
62+
63+
- `do_action('comfortjob_before_main_content');`
64+
- `do_action('comfortjob_after_main_content');`
65+
- `do_action('comfortjob_job_single_start', $job);`
66+
- `do_action('comfortjob_job_single_end', $job);`
67+
68+
69+
**Last modified:** December 26, 2024

‎docs/comfortjob/user-guide/category-manager.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Comfort Job Documentation"
3+
description: "Comfort Job index description."
4+
keywords: "Comfort Job index keywords."
5+
url: "/comfortjob/user-guide/category-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+
### Job Categories
14+
15+
1. Go to `Comfort Job > Job Categories`.
16+
2. Add new job categories by filling in the name and description.
17+
3. Save changes.
18+
19+

‎docs/comfortjob/user-guide/company-manager.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "Comfort Job Documentation"
3+
description: "Comfort Job index description."
4+
keywords: "Comfort Job index keywords."
5+
url: "/comfortjob/"
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 Company
14+
15+
1. Go to `Comfort Job > Companies`.
16+
2. View, edit, or delete companies listings as needed.
17+
3. Use the filters to search for specific company listings.
18+
19+
## Adding Company Listings
20+
21+
1. Go to `Comfort Job > Add New Company`.
22+
2. Fill in the Company details such as title, description, website, email address, and phone number etc.
23+
3. Publish the Company.
24+
25+

0 commit comments

Comments
 (0)