48482cde5ea3fdff96ee20de85ea7f544e392581
[atutor.git] / mods / job_board / README
1 MODULE DETAILS:
2 ---------------
3 Description:
4 Allow users to add job postings to the board.  
5
6 Version:
7 1.0
8
9 License:
10 GPL/ATutor
11
12
13 -------------------------------------------------------------------
14 TABLE OF CONTENT
15 -------------------------------------------------------------------
16 1. Job board
17         1.1. Job Listing
18         1.2. Simple Search
19         1.3. Advanced Search
20         1.4. View Posting
21         1.5. Job Cart
22
23 2. Employers
24         2.1. Registration
25         2.2. Adding a job posting
26         2.3. Update employer profile
27         2.4. Edit/Delete Postings
28 3. Administrator
29         3.1. Edit/Delete Posting
30                 3.1.1. Approving Postings
31         3.2. Preference Settings
32         3.3. Job Categories
33         3.4. Employers
34                 3.4.1. Approving Employers
35
36
37 -------------------------------------------------------------------
38 1.1. Job Listing
39 -------------------------------------------------------------------
40 - Job listing can be sorted by clicking the column headers.  Not all columns can be sorted, only the ones with an up/down arrows can be sorted.  Namely, job title, created, closing date.
41 - Clicking on the column header again will change the sorting from ascending order to descending order.  Vice versa.
42
43 -------------------------------------------------------------------
44 1.2. Simple Search
45 -------------------------------------------------------------------
46 - Search box allow users to search for any job post that matches your search query.  Specifically, it will genereate a list that matches its title, and description. 
47
48 -------------------------------------------------------------------
49 1.3. Advanced Search
50 -------------------------------------------------------------------
51 - Advanced search allow users to add specific parameters to refine their search.  
52 - If bookmark is checked, it will filter out all entries that are bookmarked by the ATutor user.
53 - If archive is checked, it will generate all postings even if its closing date is expired.
54
55 -------------------------------------------------------------------
56 1.4. View Posting
57 -------------------------------------------------------------------
58 - Click on any entries and you will be brought to another page that shows the content of the posting
59 - Users have the option to bookmark this entry by clicking "Add to job cart" on the right floating box.
60
61 -------------------------------------------------------------------
62 1.5. Job Cart
63 -------------------------------------------------------------------
64 - "Job cart" is a bookmarking system.  It is made to allow users to track the posting they like.  
65 - Bookmarked entries will have a '*' in the job listing.
66
67
68 -------------------------------------------------------------------
69 2.1. Registration
70 -------------------------------------------------------------------
71 - Only employers have the privilege to post jobs
72 - To allow third party users to post jobs within ATutor.  ie. you do not have to be registered in ATutor to post a job.
73 - Email need to be valid in order to activate your account. 
74 - Registration is needed to filter out spammers.
75
76 -------------------------------------------------------------------
77 2.2. Adding a job posting
78 -------------------------------------------------------------------
79 1.  Register as an Employer by clicking on "Register as Employer"; or if you already have an Job board account, log in with your username.  Note: this username is different than the ATutor ID.
80 2. Click on "Add a job posting" on the submenu on top.
81 3. 
82 - Title, is the title of your Job Post.  Should always include the position in the title.
83 - Category, is used for ATutor users to get subscription and search for.  If there is no matching category, you may suggest it to the ATutor admin so they can add it in.
84 - Closing date, is the deadline of the job post.  Once the post expired, it will no longer show up in the job board unless the user search for archives in the advanced search box.  
85 - Description, should always include Job Title, Brief Description, Requirements, Contacts.
86 4. Once ready, click submit and it will be posted.  (Might not show up if the post requires administrator approval)
87
88 -------------------------------------------------------------------
89 2.3. Update Employer profile
90 -------------------------------------------------------------------
91 1. Log in
92 2. Click on "Update Profile" on the submenu.
93 3. Make your changes and click save.
94
95 -------------------------------------------------------------------
96 2.4. Edit/Delete Posting
97 -------------------------------------------------------------------
98 1. On the listing page, click on edit/delete.  
99
100
101 -------------------------------------------------------------------
102 3.1. Edit/Delete Posting
103 -------------------------------------------------------------------
104 - Refer to 2.4.
105
106 -------------------------------------------------------------------
107 3.1.1. Approving Posting
108 -------------------------------------------------------------------
109 - From listing, click on Edit.
110 - Within Admin mode, there is an option called "Approval State".  "Confirmed" will allow the posting to show up publicly.  "Unconfirmed" will hide it from the public listing.
111
112 -------------------------------------------------------------------
113 3.2. Preference Settings
114 -------------------------------------------------------------------
115 - if required posting approval is set to "Yes", all posting will needed to be approved.  
116 - To know how to approve a posting, check 3.1.1.
117
118 -------------------------------------------------------------------
119 3.3. Job Categories
120 -------------------------------------------------------------------
121 - Admin has the ability to add more category by entering the new category name in the textbox.
122 - To delete any categories, click "Delete" beside the desired category.
123 - Note: Categories are always sorted alphanumerically.
124
125 -------------------------------------------------------------------
126 3.4. Employers
127 -------------------------------------------------------------------
128 - Admin has the ability to edit employers.  Click on 'Edit'.
129
130 -------------------------------------------------------------------
131 3.4.1. Approving Employer 
132 -------------------------------------------------------------------
133 - Employers can be disabled by clicking on 'Edit' as mentioned in 3.4.  
134 - Under "Approval State"
135         "Unconfirmed" means the employer has not been confirmed and cannot post any job posting.
136         "Confirmed" means the employer is evaludated and has the right to post any job posting they want.
137         "Suspended" means the employer has violated the job board rules and can no longer post or login.  
138