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