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