Difference between revisions of "WMF UX Improvement Effort"

From Kiwix
Jump to navigation Jump to search
(Replaced content with "== Archives == * Feb. to Jun. 2011")
Line 1: Line 1:
=== Phases ===
== Archives ==
 
* [[/01-02-2011_01-01-06-2011|Feb. to Jun. 2011]]
==== Search engine phase (3/8/11 - 3/29/11) ====
 
{|{{Prettytable}}
! Task !! width="300px"| Title !! Description !! Next step !! Progress !! Bug !! Priority !! Difficulty
 
|- style="vertical-align: top;"
| #5 || '''[[#Google-styled search result page]]''' || Displaying the results in the sidebar is not good. We should display the results like google in a tab. || closed || 100% || || Medium || 20 hours
 
|- style="vertical-align: top;"
| #0 || '''[[#Search in text improvement]]''' || Better error message for search in page, possibly switching from dialog box to toolbar || closed || 100% ||  || Low || 20 hours
 
|- style="vertical-align: top;"
| #9 || '''[[#Search misses some articles]]''' || Some articles included in the Wikipedia Version 0.5 ZIM file I tested were not matched by searching and could only be viewed by clicking a link to them. || closed || 100% || || N/A || N/A
 
|- style="vertical-align: top;"
| #10 || '''[[#Unnecessary doubleclick by suggestions]]''' || If a match is chosen from the pop-up search suggestions, it should probably go ahead and execute that search rather than waiting for the user to hit enter. || closed || 100% || || Low || 2 hours
 
|- style="vertical-align: top;"
| #12 || '''[[#Large search button should launch search in page]]''' || Currently executes search from search bar (see below) || closed || 100% ||[https://sourceforge.net/tracker/?func=detail&aid=3098294&group_id=175508&atid=873518] || High || 1 hour
 
|- style="vertical-align: top;"
| #x || '''Add small search button inside search field''' || Similar to Firefox, Explorer, Wikipedia, for searching entire ZIM file. This function is currently done by the large search button (see above) || closed  || 100% ||[https://sourceforge.net/tracker/?func=detail&aid=3098294&group_id=175508&atid=873518] || High || 1 hour
 
|}
 
==== Q/A Cycle (3/29/11 - 4/5/11) ====
 
==== Integrated Downloader phase (4/5/11 - 6/3/11) ====
 
{|{{Prettytable}}
! Task !! width="300px"| Title !! Description !! Next step !! Progress !! Bug !! Priority !! Difficulty
 
|- style="vertical-align: top;"
| #40 || '''[[#Download Platform]]''' || Finish the download platform using mirrorbrain and provide a working metalink solution. || closed || 100% || || Medium || 10 hours
 
|- style="vertical-align: top;"
| #41 || '''[[#New library manager]]''' || The library manager is the intern component/piece of code which provides all the necessary API to deal with content. This will be used by kiwix, kiwix-serve and kiwix-library. Should be in c++, using a small/fast/portable XML parser. For kiwix an XPCOM component should be done. || closed || 100% || [https://sourceforge.net/tracker/?func=detail&aid=3064386&group_id=175508&atid=873515] || High || 20 hours
 
|- style="vertical-align: top;"
| #42 || '''[[#kiwix-manage]]''' || Kiwix-manage in a new console tool to setup the library.xml file which lists content files available for download. [[Kiwix-library|More infos...]]|| closed || 100% || || High || 20 hours
 
|- style="vertical-align: top;"
| #43 || '''[[#User Interface]]''' || Introducing a user interface listing content available offline and online (to download). This user provides for each content an overview and gives the possibility to download/load/delete the content. || closed || 100% || [https://sourceforge.net/tracker/?func=detail&aid=2987622&group_id=175508&atid=873518] || Medium || 20 hours
 
|- style="vertical-align: top;"
| #44 || '''[[#Downloader core]]''' || The downloader core is the piece of code dealing with the aria2c binary. Responsible for downloading/sharing the content. || closed || 100% || ||High  || 20 hours
 
|- style="vertical-align: top;"
| #45 || '''[[#Document Feed Format]]''' || Document feed [[FeedFormat|format]]. || closed || 100% || || Low || 1 hour
 
|}
 
==== Q/A Cycle (6/6/11 - 6/10/11) ====
 
==== Last phase (6/13/11 - 6/17/11) ====
 
{|{{Prettytable}}
! Task !! width="300px"| Title !! Description !! Next step !! Progress !! Bug !! Priority !! Difficulty
 
|- style="vertical-align: top;"
| #1 || '''[[#Bad MacOSX Quit menu item]]''' || MacOSX Quit menu item in File menu is odd to see || closed || 100% || [https://sourceforge.net/tracker/?func=detail&aid=3165259&group_id=175508&atid=873515] || ||
 
|- style="vertical-align: top;"
| #2 || '''[[#Dead "adding content" link in the help]]''' || "Adding Content" paragraph does not exist in the Help page in English || closed || 100% || [https://sourceforge.net/tracker/?func=detail&aid=3165272&group_id=175508&atid=873515] || || 2 hours
 
|- style="vertical-align: top;"
| #6 || '''[[#Localization improvement]]''' || Kiwix has too few locales and it is too complicated to update them. || closed || 100% || || High || 20 hours
 
|- style="vertical-align: top;"
| #7 || '''[[#ESC to quit Fullscreen]]''' || This should be possible to press ESC to qui the fullscreen. || closed || 100% || || ||
 
|- style="vertical-align: top;"
| #8 || '''[[#User unfriendly index dialogbox]]''' || Change the invitation to index message to "This file does not include a search index. Creating one may take several minutes. Do you want to index your ZIM file now?". || closed || 100% || || ||
 
|- style="vertical-align: top;"
| #14 || '''[[#Unusual keyboard shortcuts on OSX]]''' || In the Mac version, the Keyboard shortcuts are not typical for a Mac application (normally the Command key is used rather than Control). Regardless, they do not actually work using either keys. || closed || 100% || || || 2 hours
 
|- style="vertical-align: top;"
| #16 || '''[[#Back button wrong behaviour]]''' ||While it was indexing, I decided to try clicking some article links. This worked fine, although I was not able to return to the home page by using the back button. (Strangely this only happened the first time I left the home page. On subsequent attempts I was able to go back to the home page by clicking the back button.) || abandoned || 0% || ||  High || 1 hour
 
|- style="vertical-align: top;"
| #17 || '''[[#Preferences dialog box]]''' || It might be nice to have a preferences pane where you could set things like "Always show the tab bar", "Remember browsing history", etc.  || closed || 100% || || Medium || depends what we want inside the preference dialog
 
|- style="vertical-align: top;"
| #19 || '''[[#DNS prefetching]]''' || although this isn't a user interface issue, it seems that Kiwix makes DNS requests on all the external links included in each Wikipedia article it loads (without clicking on them). So if I pull up World War II, for example, Kiwix might make a couple hundred DNS requests. This isn't bad for someone living in the US, but if you are in a remote area and don't have unlimited data for free, it could be an unexpected surprise, since Kiwix is supposed to be an "offline" reader. Just thought I would pass it along. || closed || 100% || || ||
 
|- style="vertical-align: top;"
| #20 || '''[[#Major Release]]''' || Major release for OSX, Linux, and Windows. || closed || 100% || || High ||
|}
 
==== Posponed ====
 
{|{{Prettytable}}
! Task !! width="300px"| Title !! Description !! Next step !! Progress !! Bug !! Priority !! Difficulty
 
|- style="vertical-align: top;"
| #1 || '''[[#Revamp the help page]]''' || The help page must be more complete, more ''sexy'', with screenshots. It should also provide an easy way to download new content. || proposal || 0% || || Low || 30 hours
 
|- style="vertical-align: top;"
| #2 || '''[[#Kiosk mode]]''' || It would also be cool to have a kiosk mode available in which the interface would be fullscreen unless a special keyboard command was issued. || discussion || 0% || || low || 5 hours (must also be more detailed)
 
|- style="vertical-align: top;"
| #3 || '''[[#History navigator]]''' || You can purge your history, but you can't view it. It would be nice to be able to browse through your history either from a menu or the Sidebar.. || discussion || 0% || || Low || really depends what we want here. A few hours to get a simple list of pages but a lot of work if you want a mgmt tool.
 
|- style="vertical-align: top;"
| #4 || '''[[#Desktop File browser integration]]''' || ZIM file mime-type should be recognized as "application/x-zim", icon should be the kiwix one and double click on them should start kiwix and open the file. || realization || 50% || || Medium || 20 hours
 
|- style="vertical-align: top;"
| #5 || '''[[#Bad "transliteration" menuitem on OSX]]''' ||  || closed || 100% || [https://sourceforge.net/tracker/?func=detail&aid=3167823&group_id=175508&atid=873515] || ||
 
|- style="vertical-align: top;"
| #6 || '''Allow multzim search and make it configurable''' || || concept || 0% || || Low || 15 hours
 
|- style="vertical-align: top;"
| #7 || '''Filters and sorting''' || Add ability to filter and sort listed ZIM files || concept || 0% || || Low || XX
 
|- style="vertical-align: top;"
| #8 || '''Searching''' || Add ability to search available ZIM files (title and description) || concept || 0% || || Low || XX
 
|}
 
== Retrospectives ==
 
* Need a better build system. We spent way too much time trying to build the application on Windows, Ubuntu, OSX (pending) rather then developing it
 
== Details ==
 
=== Search in text improvement ===
 
There is also a small bug: If the search term is not found, it returns an error saying "[JavaScript Application] The text you entered was not found." The "[JavaScript Application]" part should probably be removed or replaced. Ryan
 
=== Bad MacOSX Quit menu item ===
 
=== Dead "adding content" link in the help ===
 
=== Revamp the help page ===
 
=== Download manager ===
 
=== Google-styled search result page ===
 
As previously discussed, Google-style search results would be a nice alternative to the current Sidebar implementation, especially if it could include a brief snippet from each article. Perhaps you could configure what type of search you prefer from a preferences menu. Ryan
 
=== Localization improvement ===
 
We will migration to translatewiki.net. We know how to make the migration, I still need to work on the migraation scripts, new templates and import scripts. [[User:Kelson|Kelson]] 13:02, 26 February 2011 (UTC)
 
=== ESC to quit Fullscreen ===
 
=== User unfriendly index dialogbox ===
 
=== Search misses some articles ===
 
=== Unnecessary doubleclick by suggestions ===
 
=== Desktop File browser integration ===
 
Gnome done, OSX, KDE and Windows still to do. [[User:Kelson|Kelson]] 14:12, 26 February 2011 (UTC)
 
=== Large search button should launch search in page ===
It is not clear what the function of the large search button in the toolbar is. Usually that icon is associated with launching a "Search in page" feature. If someone assumes that that is its function, they will be confused when they click on it and nothing happens. Ideally the search box itself should have a small magnifying glass ''within'' the search box, like Firefox, Explorer, and Wikipedia, and the large search icon should launch the search in page dialog.
 
=== Bad "transliteration" menuitem on OSX ===
 
=== Unusual keyboard shortcuts on OSX ===
 
=== History navigator ===
 
=== Back button wrong behaviour ===
 
=== Preferences dialog box ===
 
Some settings ideas
 
* Font selection and size
: IMO this is the job of the ZIM publisher to provide such feature: he is responsible that the content is well displayed. This should/could be done using javascript/css/webfont/cookies pretty easily. I guess around 10 hours of work to introduce that option in my ZIM build process. The result would be a font selector on every page (for example on the top left corner) [[User:Kelson|Kelson]] 12:16, 6 April 2011 (UTC)
 
* Dont track history
* Online/Offline mode if external links are present. Would make links disappear if your in offline mode
* Default location for zim files
 
=== Kiosk mode ===
 
=== DNS prefetching ===
 
== See also ==
* [[User_interface_feedback]]
* [[/Testers]]

Revision as of 11:58, 12 August 2011