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