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