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