Updated progress as of August 29.
[atutor.git] / docs / themes / mobile / readme.txt
1 ******************************************************************************************
2 Theme:          1.6.4 Mobile Theme
3 Date:           August 2011
4 ******************************************************************************************
5
6
7 Installing:      See section "Installing a New Theme" in the themes_readme.txt file located in the themes/ top directory.
8 Licence:        Falls under the GPL agreement.  See http://www.gnu.org/copyleft/gpl.html.
9
10 ==============================================================================
11 What's new: 
12 ==============================================================================
13
14 /mobile.css 
15 * style for android, iphone, & ipod rolled into one stylesheet
16 * improved subnavigation and in-course navigation
17
18 /tablet.css 
19 * new style for tablet devices, beginning with -webkit browsers
20 * generic CSS used to broaden browser support
21
22 include/header.tmpl.php
23 * accessibility: increased support for ARIA roles that Safari recognizes. Note: ARIA roles create HTML validation errors.
24
25 ==================================================================================
26 Known Issues / More work needed
27 ==================================================================================
28
29 Important:
30 * Mobile instructor users can currently see modules that have been disabled through their module.php file, and it
31 needs to be fixed so that they cannot have this option. 
32
33 Towards a simplified desktop theme: 
34 * develop a desktop theme based on tablet.css (harder) 
35 * develop a desktop theme based on mobile.css (easier) & do a final update to ensure generic CSS is used
36 * erase commented out styles from mobile.css and tablet.css and re-order where necessary
37
38 Aesthetic improvements, mobile: 
39 * on activation (done), the Subnavigation div (done), Resume, Previous, Next on mobile should highlight as a block 
40 *Instructor user: (done) /docs/mods/_standard/statistics/course_stats.php - (template now includes graph)
41
42
43 * "0004796: Student user's Preferences template won't display"
44 ** see: http://atutor.ca/atutor/mantis/view.php?id=4796
45 ** see: http://atutor.ca/atutor/mantis/view.php?id=4679
46
47
48 * "Activation hightlighting is visible on the desktop but not the on the mobile device"
49 ** see: http://issues.fluidproject.org/browse/FLUID-4313
50 ** both arrows and background color don't highlight.
51 ** affects .fl-lists, including:
52 *** the "Navigation" menus on mobiles and tablets after a link is highlighted 
53 *** docs/users/browse.php in mobile and tablets
54
55 ==================================================================================
56 Omitted from mobile/
57 ==================================================================================
58 Administrator user: 
59 *Patcher 
60 */docs/mods/_core/cats_categories/admin/course_categories.php
61 */docs/mods/_core/enrolment/admin/privileges.php 
62 */docs/mods/_core/modules/install_modules.php
63 */docs/mods/_core/languages/language_editor.php
64
65 Instructor user: 
66 */docs/mods/_standard/assignments/add_assignment.php
67 *Course Tools
68 */docs/mods/_core/enrolment/create_course_list.php
69 */docs/mods/_core/enrolment/privileges.php
70 *mods/_core/file_manager/index.php
71 *file manager -- removed for mobile 
72 *reading list
73 *groups
74 *gradebook
75 *glossary
76 *patcher
77 *student tools
78
79 ===================================================================================================
80 Accessibility notes, features, & validation issues 
81 ===================================================================================================
82 *Newer versions of iPods, iPads, & iPhones have limited support for WAI-ARIA. I deployed the roles that were supported. 
83 VoiceOver users can enable or disable speaking, for example, of various WAI-ARIA roles. Here is Apple's documentation:
84  http://developer.apple.com/library/safari/#documentation/appleapplications/reference/SafariHTMLRef/Articles/AccessibilityRoles.html
85
86 WCAG AA
87 I primarily used WCAG to guide the evolution of content generated from the header and footer. 
88 Below are Success Criteria that apply to my work, and I have listed criteria that don't pass
89  or that may need more attention. Further Success Criteria apply to the LMS but would depend on, 
90 for example, course content used.  I checked for WCAG as a part of my AChecker workflow 
91 (to WCAG AA) along with validating markup, and manually on the following capstone pages: 
92 **
93
94 Applicable Success Criteria 
95 1.1.1 Non-text Content***
96 1.3.1 Info and Relationships 
97         Note: should fieldset/legends and onkeydown be added to these pages?
98         /docs/mods/_core/users/users.php 
99         /docs/mods/_core/users/instructor_requests.php
100         /docs/mods/_core/users/master_list.php 
101         /docs/mods/_core/users/admins/index.php 
102         /docs/mods/_core/users/admins/log.php 
103         /docs/mods/_core/courses/admin/courses.php 
104         /docs/mods/_standard/forums/admin/forums.php 
105         /docs/mods/_core/courses/admin/default_mods.php 
106         /docs/mods/_core/modules/index.php 
107         /docs/mods/_standard/rss_feeds/index.php 
108         /docs/mods/_standard/announcements/index.php
109         /docs/mods/_standard/assignments/index_instructor.php
110         /docs/mods/_core/backups/index.php
111         /docs/mods/_standard/chat/manage/index.php
112         /docs/mods/_core/content/index.php 
113         /docs/mods/_standard/tracker/tools/page_student_stats.php
114         /docs/mods/_standard/forums/index.php
115         /docs/mods/_standard/faq/index_instructor.php
116         /docs/mods/_standard/polls/tools/index.php
117  
118
119 1.3.2 Meaningful Sequence
120 Mobile - passes, but Tablet - fails. Logged into a course as a student user, the DOM order should match the visual order.
121 I have listed this as an issue.  
122
123 1.3.3 Sensory Characteristics
124 1.4.3 Contrast (Minimum)
125 1.4.4 Resize text
126 -- Applies but unsure how to test using the zoom feature (i.e. to what proportion it magnifies to). 
127 -- Increasing text size with finger gestures is disabled, but using Apple's zoom feature, text appears readable.
128
129 2.1.1 Keyboard
130 **Mobile - passes, but Tablet - fails (Navigation button). I have listed this as an issue. 
131 2.1.2 No Keyboard Trap
132 2.4.1 Bypass Blocks
133 **Note: This passes for both mobile & tablet because heading groupings are used at the beginning of content. 
134 **Also, skip-links are working with VoiceOver now on tablet.
135 2.4.3 Focus Order
136 2.4.4 Link Purpose (In Context)
137 2.4.5 Multiple Ways
138 2.4.6 Headings and Labels
139 2.4.7 Focus Visible
140 3.1.1 Language of Page
141 3.2.1 On Focus
142 **Is this violated by the pop-up "guide" button in the mobile and tablet devices? 
143
144 3.2.3 Consistent Navigation
145 3.2.4 Consistent Identification
146 3.3.2 Labels or Instructions
147 3.3.3 Error Suggestion - already handled 
148 4.1.1 Parsing, 4.1.2 Name, Role, Value
149
150
151 ADMINISTRATORS: MOBILE ----------------------------------------------------------------------------------
152
153 NOTE there are 4 errors in HTML validator due to using an ARIA role. 
154
155 [ADMIN-HOME] 
156 1. /docs/admin/index.php -  ****  DONE / WCAG AA / Valid HTML
157 2. /docs/mods/_core/users/admins/my_edit.php  ****  DONE / WCAG AA / Valid HTML
158 3. /docs/mods/_core/users/admins/my_password.php  ****  DONE / WCAG AA / Valid HTML
159
160 [USERS]
161 1.  /docs/mods/_core/users/user_enrollment.php **** DONE / WCAG AA / Valid HTML
162 2.  /docs/mods/_core/users/password_user.php **** DONE / WCAG AA / Valid HTML
163 3.  /docs/mods/_core/users/create_user.php **** DONE / WCAG AA / Valid HTML
164 4.  /docs/mods/_core/users/users.php **** DONE / WCAG AA / Valid HTML
165 5.  /docs/mods/_core/users/instructor_requests.php **** DONE / WCAG AA / Valid HTML
166 6.  /docs/mods/_core/users/master_list.php **** DONE / WCAG AA / Valid HTML (note: lacks fieldset, added onkeydown)
167 7.  /docs/mods/_core/users/admin_email.php **** DONE / WCAG AA / Valid HTML  
168 8.  /docs/mods/_core/users/admins/index.php **** DONE / WCAG AA / Valid HTML  (note: lacks fieldset, added onkeydown)
169 9.  /docs/mods/_core/users/admins/edit.php **** DONE / WCAG AA / Valid HTML  
170 10. /docs/mods/_core/users/admins/password.php **** DONE / WCAG AA / Valid HTML 
171 11. /docs/mods/_core/users/admins/create.php **** DONE / WCAG AA / Valid HTML
172 12. /docs/mods/_core/users/admins/log.php **** DONE / WCAG AA / Valid HTML
173 13. /docs/mods/_core/users/admins/reset_log.php  **** DONE / WCAG AA / Valid HTML  
174 14. /docs/mods/_core/users/edit_user.php?id=4 **** DONE / WCAG AA / Valid HTML
175
176 [COURSES]
177 1.  /docs/mods/_core/courses/admin/courses.php **** DONE / WCAG AA / Valid HTML (note: lacks fieldset, added onkeydown)
178 2.  /docs/mods/_core/properties/admin/edit_course.php *** DONE (Linearizes)
179 3.  /docs/mods/_standard/forums/admin/forums.php ****DONE HTML (note: lacks fieldset, added onkeydown)
180 4.  /docs/mods/_standard/forums/admin/forum_add.php **** DONE / WCAG AA / Valid HTML
181 5.  /docs/mods/_standard/forums/admin/forum_edit.php **** DONE / WCAG AA / Valid HTML
182 6.  /docs/mods/_core/courses/admin/create_course.php *** DONE (Linearizes)
183 7.  /docs/mods/_core/enrolment/admin/index.php3 ****  DONE / WCAG AA / Valid HTML
184 8.  /docs/mods/_core/enrolment/admin/privileges.php  **** NOT DONE NEEDS TEMPLATING 
185 9.  /docs/mods/_core/courses/admin/default_mods.php *** DONE / WCAG AA / Valid HTML - should not be a part of mobile.
186 10. /docs/mods/_core/courses/admin/default_side.php **** DONE / HELP WCAG / Valid HTML
187 11. /docs/mods/_standard/support_tools/scaffolds.php **** DONE / WCAG AA / Valid HTML
188 12. /docs/mods/_core/cats_categories/admin/create_category.php  **** DONE /WCAG AA / Valid HTML
189 13. /docs/mods/_core/cats_categories/admin/course_categories.php **** NOT DONE NEEDS TEMPLATING  (subcategories must display)
190
191 [PATCHER] 
192 DON'T INCLUDE IN MOBILE THEME. 
193 http://localhost/GSoC2011/docs/mods/_standard/patcher/index_admin.php
194
195
196 [PHOTOS] 
197 1.  /docs/mods/_standard/photos/index_admin.php **** DONE / WCAG AA / Valid HTML 
198 2.  /docs/mods/_standard/photos/admin/preferences.php  **** DONE / WCAG AA / Valid HTML 
199
200 [MODULES] 
201 1.  /docs/mods/_core/modules/index.php **** DONE / WCAG AA / Valid HTML (note: lacks fieldset, added onkeydown) -  ?
202 2.  /docs/mods/_core/modules/install_modules.php  **** INSTALL MODULES SHOULD BE ENABLED FOR IPAD.CSS and NOT MOBILE -- TOO COMPLICATED 
203 3.  /docs/mods/_core/modules/details.php **** DONE / WCAG AA / Valid HTML *** won't text wrap. 
204
205 [SYSTEM PREFERENCES]
206 1.  /docs/admin/config_edit.php  **** DONE / WCAG AA / Valid HTML 
207 2.  /docs/mods/_core/languages/language_translate.php -- **** DONE, VALID WCAG, Valid HTML
208 3.  /docs/mods/_core/languages/language_import.php  -- **** DONE, WCAG AA, VALID HTML 
209 4.  /docs/mods/_core/languages/language.php -- **** DONE, VALID WCAG, HELP on HTML (CHANNEL BUG)  *** valid HTML except for fieldset
210 5.  /docs/mods/_core/languages/language_editor.php -  **** NOT DONE NEEDS TEMPLATING 
211 6.  /docs/mods/_standard/rss_feeds/preview.php
212 7.  /docs/mods/_standard/rss_feeds/edit_feed.php **** DONE / WCAG AA / Valid HTML
213 8.  /docs/mods/_standard/rss_feeds/index.php **** DONE / WCAG AA / Valid HTML (note: lacks fieldset, added onkeydown)
214 9. /docs/mods/_standard/rss_feeds/add_feed.php **** DONE / WCAG AA / Valid HTML
215 10. /docs/mods/_standard/tile_search/admin/module_setup.php **** DONE / HELP WCAG / HELP HTML (CHANNEL BUG)
216 11. /docs/mods/_standard/google_search/admin/module_prefs.php **** DONE, VALID WCAG, HTML good (except for legacy <b> tag)
217 12. /docs/mods/_standard/social/admin/delete_applications.php ==  already templated
218 13. /docs/mods/_standard/social/index_admin.php **** DONE / WCAG AA / Valid HTML
219 14. /docs/admin/cron_config.php **** DONE / WCAG AA / Valid HTML -- wrap bug. 
220 15. /docs/admin/error_logging.php
221
222 INSTRUCTORS: MOBILE ---------------------------------------------------------------------------------- 
223         --- course home ***DONE 
224         --- networking ***DONE 
225         --- glossary ***DONE 
226         --- mytracker ***DONE 
227         --- index ***DONE
228
229 [INBOX]
230 /docs/inbox/index.php **** DONE
231 /docs/inbox/sent_messages.php **** DONE
232 /docs/inbox/send_message.php **** DONE
233 /docs/inbox/export.php **** DONE
234
235 [ANNOUNCEMENTS] 
236 /docs/mods/_standard/announcements/index.php **** DONE 
237 /docs/mods/_standard/announcements/add_news.php **** DONE
238 /docs/mods/_standard/announcements/edit_news.php **** DONE 
239
240 [ASSIGNMENTS]
241 /docs/mods/_standard/assignments/index_instructor.php **** DONE
242 NOT DONE: /docs/mods/_standard/assignments/add_assignment.php **** NOT DONE, remove for mobile? 
243
244 [BACKUPS]
245 /docs/mods/_core/backups/index.php  **** DONE 
246 /docs/mods/_core/backups/create.php **** DONE 
247 /docs/mods/_core/backups/edit.php **** DONE 
248 /docs/mods/_core/backups/upload.php **** DONE
249 /docs/mods/_core/backups/delete.php **** DONE 
250
251 [CHAT] 
252 /docs/mods/_standard/chat/manage/index.php **** DONE 
253 /docs/mods/_standard/chat/manage/start_transcript.php **** 
254
255 [CONTENT]
256 /docs/mods/_core/content/index.php  **** DONE 
257 /docs/mods/_core/editor/edit_content_folder.php?cid=240 **** DONE 
258 /docs/mods/_standard/tracker/tools/page_student_stats.php **** DONE 
259 /docs/mods/_standard/tracker/tools/index.php  **** DONE 
260 /docs/mods/_standard/tracker/tools/student_usage.php **** DONE 
261 /docs/mods/_standard/tracker/tools/reset.php ***** DONE 
262 /docs/mods/_core/editor/add_content.php **** NOT DONE, remove for mobile? 
263 /docs/mods/_core/editor/edit_content.php? **** NOT DONE, remove for mobile? (link from /index.php should be removed)
264
265 [COURSE EMAIL] 
266 http://localhost/GSoC2011/docs/mods/_standard/course_email/course_email.php **** DONE 
267
268 [ENROLLMENT]
269 /docs/mods/_core/enrolment/export_course_list.php **** DONE 
270 /docs/mods/_core/enrolment/import_course_list.php **** DONE 
271 /docs/mods/_core/enrolment/create_course_list.php *** Remove for mobile
272 /docs/mods/_core/enrolment/index.php **** DONE 
273 /docs/mods/_core/enrolment/privileges.php   **** NOT DONE
274
275
276 [FORUMS]
277 /docs/mods/_standard/forums/edit_forum.php  *** DONE
278 /docs/mods/_standard/forums/index.php  *** DONE
279 /docs/mods/_standard/forums/add_forum.php  *** DONE
280 /docs/mods/_standard/farchive/index_instructor.php  *** DONE
281
282
283 [FAQ] 
284 /docs/mods/_standard/faq/add_question.php  *** DONE
285 /docs/mods/_standard/faq/index_instructor.php  *** DONE
286 /docs/mods/_standard/faq/add_topic.php *** DONE  *** DONE
287 /docs/mods/_standard/faq/edit_topic.php *** DONE  *** DONE
288 /docs/mods/_standard/faq/edit_question.php  *** DONE
289
290
291 [GLOSSARY]
292 /docs/mods/_core/glossary/tools/add.php
293 NOT DONE
294
295 [GRADEBOOK]
296 NOT DONE
297
298 [GROUPS]
299 /docs/mods/_core/groups/create.php
300 /docs/mods/_core/groups/create_automatic.php
301 /docs/mods/_core/groups/create_manual.php
302 NOT DONE: - /docs/mods/_core/groups/index.php
303
304
305 [POLLS] 
306 /docs/mods/_standard/polls/tools/index.php  *** DONE
307 /docs/mods/_standard/polls/tools/edit.php  *** DONE
308 /docs/mods/_standard/polls/tools/add.php  *** DONE
309
310 [PROPERTIES] 
311 http://localhost/GSoC2011/docs/mods/_core/properties/course_properties.php  *** DONE
312
313 [STUDENT TOOLS]
314 NOT DONE: /docs/mods/_standard/student_tools/instructor_index.php 
315
316 ----------------------------------------------------------------------------------------
317 TABLET TEMPLATE: STUDENT 
318 *Note: there are 4 ARIA-errors! 
319
320 /docs/login.php - WCAG AA / Valid HTML
321 /docs/browse.php - WCAG AA / Valid HTML - 6 errors - ARIA-related
322 /docs/users/profile.php  - WCAG AA / Valid HTML
323 /docs/users/preferences.php - WCAG AA / Valid HTML
324 /docs/users/index.php - WCAG AA / Problem with HTML validation, likely to do with the "Things Current" list
325 /docs/registration.php