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