Skip to content

kiwix desktop 2 concept

Jump to bottom
schoenbaechler edited this page May 31, 2018 · 18 revisions

Kiwix Desktop 2 Design Concept

About this document

Please be aware that this document is work in progress and will be updated regularly.

Minimum Viable Product (MVP)

General

  • If the application is closed with a book open, it should reopen with the last book opened

Typography

  • Typeface Choice on Windows: Segoe UI (native)

  • Todo (Robin): Evaluate default typeface on Linux (Ubuntu/Fedora)

Design

  • Layout grid: Based on a 1024px to make it as accessible as possible

  • Baseline grid: Design bases on an 8px baseline grid

  • Design approach: Smallest resolution first (similar to mobile first): if it works on smaller screens it works on bigger screens as well

  • App design is constantly being tested in low resolutions (Tool: SwitchResX)

  • Base Font Size (16px)

  • Keyboard accessible

  • Click/tap targets at least 40x40px (makes it accessible for hybrid devices with touch screens)

  • Todo (Robin): Unify enabled state of icons. Elements to consider: - Sidebar - Download - Library - Settings

  • Todo (Robin): Design Kiwix app icon for Windows/Linux

  • Todo (Robin): Define button states

Tabs

  • Adding Favicon to tabs, high importance to orient if multiple tabs are open

  • Define min width of tabs (Chrome as Example)

  • Show tab bar only when there are open tabs

  • Navigate with keyboard shortcuts (switch with ctrl + 1 etc.)

  • Move tabs (e.g. with Ctrl Alt + Arrow Left/Right)

  • Todo (Robin): Loading indicator in tab (spinner)

  • Todo (Robin): Sticky tabs design

  • Todo (Robin): Empty Tab State design

  • Todo (Robin): Usage of Language 639-1 ISO Codes to recognize tabs from a certain source (currently applied when opening a book from the library)

Toolbar

  • Contents
    • Show the previous page
    • Show the next page
    • Show/hide sidebar
    • Open library
    • Full screen mode (show/hide toolbar)
      • If toolbar is hidden, it reveals the toolbar on mouse over (similar to Google Chrome’s behavior)
      • The tab bar stays visible all the time (also in full screen)
    • Share with nearby computer
    • Random article
    • Print
    • Zoom in / Zoom out (increase / decrease) text size
    • Menu
      • If there’s not enough screen estate (e.g. a viewport of 1024px and below), the toolbar shortcuts are accessible in the menu

Menu

  • The Kiwix browser menu is accessible via „Menu“ icon (three dots) in the toolbar
  • If there’s not enough screen estate (e.g. a viewport of 1024px and below) the toolbar shortcuts are accessible in the menu
  • Below these toolbar shortcuts, a classic Windows menu can be found
  • Menu information architecture and corresponding keyboard shortcuts:
    • Full screen [icon] F11
    • Share with nearby computer [icon] Ctrl I
    • Random article [icon] Ctrl R
    • Print [icon] Ctrl P
    • File F when menu is open
      • New tab Ctrl T
      • New window Ctrl N
      • Close tab Ctrl W
      • Close window Ctrl Shift W
      • Reopen closed tab Ctrl Shift T
      • Browse library [icon] Ctrl E
      • Open file Ctrl O
      • Recently open
        • Displays a list of recently opened files
      • Save page as ... Ctrl S
      • Print Ctrl P
        • Unified „Print“ and „Print to PDF“ since this is handled by system dialog
      • Exit Ctrl Shift Q
    • Edit E when menu is open
      • Search articles Ctrl L
      • Search library Ctrl Shift L
      • Search Find in page Ctrl F
        • Find next Ctrl G
        • Find previous Ctrl Shift G
      • Copy Ctrl C
      • Select all Ctrl A
      • Preferences
        • Moved to quick access in menu and renamed it to „Settings“
    • View V when menu is open
      • Enter/Exit full screen [icon] F11
      • Show/Hide sidebar [icon] Ctrl Shift L
      • Show/Hide table of contents sidebar [icon] Ctrl Shift 1
      • Show/Hide reading list sidebar [icon] Ctrl Shift 2
      • Zoom
        • Zoom in Ctrl +
        • Zoom out Ctrl –
        • Actual size Ctrl 0
      • Tabs
        • Removed, tab bar is always shown
      • Status bar
        • Removed, status bar is unnecessary
      • Language
        • Moved to preferences, system language is used by default
      • Skin
        • Deprecated, night/dark mode possible in a future version
      • Inverted colors
        • Deprecated, night/dark mode possible in a future version
    • Tools
      • Random article
        • Moved to quick access in menu
      • Server
        • Now called share and moved to quick access in menu
      • Launch indexing
      • Integrity check
      • Purge history
    • Help
      • Help (F1)
      • Feedback
      • Report a bug
      • Request a feature
      • About Kiwix
    • Settings [icon] F12
    • Exit [icon] Ctrl Shift Q

Sidebar

  • Pushes content aside in a responsive way
  • Currently contains reading lists and table of contents
  • Both reading lists and table of contents are part of the sidebar that can be triggered from the app’s toolbar
  • The sidebar content has the advantage that it can be extended with features in the future.

Table of contents

  • The table of contents can be accessed by clicking its dedicated icon in the toolbar or via the sidebar
  • Once an item has been clicked in the table of content, the article page on the right scrolls to the corresponding position
  • In page search (search in article)
    • TOC sidebar includes the in page search
      • It can be opened with the keyboard shortcut Ctrl F
      • Table of contents highlights where search results are found
      • Previous / next is accessible via buttons in the sidebar or with the keyboard shortcuts Ctrl G (next) or Ctrl Shift G (previous)

Reading lists

  • Reading lists provide basic functionality to save/favorite/bookmark articles

  • A reading list icon appears as soon as an article has been fully loaded. It replaces the search icon (magnifier glass) on the left side of the address bar

  • The current page can be favorited with the reading list icon in the address bar

  • A filled reading list icon (black) indicates that an article has been added previously to the reading list. If it hasn’t been added previously, the icon is filled white (default),

  • Articles that have been added to the reading list area accessible via the sidebar

  • The reading list in the sidebar shows the most recently added articles first and lets users filter the list

  • A blue dot next to the article title in the reading list (sidebar) indicates that an article has been added recently. If users click on an article, a tab with the page opens and the blue dot disappears

  • Todo (Robin): Provide design for reading list item where the source (ZIM file) has been removed from the library)

Address bar

Search

  • Default search across all books (can be filtered) see chapter „Search Filter“

  • After typing, the address bar auto suggests relevant search results (I’ll leave the complexity of the search up to Mathieu but I’m happy to consult) here

  • Search results can be selected by mouse or keyboard and the return key takes users to the respective page

  • Kiwix search should work similar to a search engine or file search, we don’t want to bother users with settings.

  • This requires that the search experience needs to be smart and group search results

  • Searches across favorites and search history

  • Todo (Robin): Empty state of search field? What is displayed when there are no books added yet? What is display when the search field is clicked on? Bookmarks? Recent search? Safari displays bookmarks and frequently visited. Chrome and FF don’t use the pattern.

  • Todo (Robin): No search results, suggest to download books via media library

  • Todo (Robin): Open tabs should be listed in search bar as well

  • Todo (Robin): Design/Concept for in page search

Filter

  • Default Search -> All books

  • Show active filter number when a filter is set

  • The goal is to find content and not bother users with settings

  • Once a filter is set, the app remembers the choice

  • If a user specifically opens a book from a library, it automatically applies the filter for that respective book. If only 1 book is selected as a search source, the interface displays the name of the book (e.g. Wikipedia EN)

  • Todo (Robin): Enhance filter dropdown with find functionality

  • Todo (Robin): Add possibility to quickly remove a filter in the search bar (e.g. with an „x“ to reset)

Library

How to navigate to, browse and search the library (InVision Screen # 12-13)

  • As in Kiwix Desktop 1, users can access the library via library icon the toolbar
  • It’s a shortcut and opens a new tab that is called „Kiwix library“
  • The tab will initially open as a first tab but can be moved to a different position by users.
  • To avoid cluttering the interface: if users clicks the library icon in the toolbar and the „Kiwix Library“ tab has been opened before, it redirects users to the tab that’s already open
  • Default view prioritization: 1) Local books 2) Online books
  • Book search:
    • The search functionality is straight forward, typing a term updates the list view below with matching results (no auto suggestion to keep this simple)
    • The search includes matches from local and online books
    • Local books get listed first when the search term matches
  • Book filters:
    • Filters can be set on the left side of the library search
    • All files | Local files: „All files“ displays online and offline books, „Local files“ only displays books that have been downloaded before
    • Browse by category: Content can be filtered by category, e.g. Wikipedia. Results view on the right is updated once a category is selected. By default, all categories are searched.
    • Language: After choosing a language, results view on the right is updated and only shows results from the selected language
    • Content type: Provides an option to filter by media type (text, picture, audio, video). By default, it searches all media type. Allows multiple active filters.
  • Results table header consists of File name, Size, Date and Content type. By default, the view is sorted by date. Once a search term is entered, it sorted by name/relevancy.
  • Detail option for library items
    • Users can access details of a file by clicking on an item (UI: accordion)
    • The details view provides extended information about a file
      • Contains file description, release notes, meta file info and the option to remove files from the local library

Download and open books (InVision Screen # 14-17)

  • Books can be downloaded by clicking the blue download link
  • Once clicked, a download status indicator appears below the clicked button. It features the current download progress.
  • To also indicate that a book is currently downloaded, an icon with the download status is added to the main toolbar of the app. This makes sure that users are informed about an ongoing download in all views of the app. A click on that icon takes the user to the Kiwix library tab which lists books that are currently downloaded first.
  • „Open“ opens the home page of the book in a new tab next the „Kiwix library“ tab and adds a book specific filter to the article search in the app’s toolbar. The user assumption here is that once a user decides to open a specific book, the search should only display results from within the book. The filter in the toolbar however, can be reset at any time

Updating / extending books (InVision Screen # 18-20)

  • If a book update is available: an „Update“ section appears in the sidebar

  • The „Update“ section in the sidebar features a „notification“ bubble that shows how many updates are available

  • After clicking the update button, the download indicator appears

  • Users can continue to use the app while performing updates/downloads

  • Once updated, the book’s meta info „Date“ displays the latest update date

  • Todo (Robin): Design a notification system (use native notifications on Windows or Linux?) for the user that informs about a finished download and a dialog that asks if the old version of the file should be kept or not. Use native notification system on Windows/Linux for this functionality as far as possible.

Start server / sharing

  • Currently positioned in the toolbar as „Share with nearby computers“ (W.I.P.)
  • Todo (Robin): Study old functionality and think about ways to make the feature more user friendly

Settings

  • Todo (Robin): Provide design for settings page

Help

  • Todo (Robin): Provide design for help page

Future / Feature ideas

  • Browsing history? Similar to web browsers? E.g. when searching books?
  • Introduce an „Open quickly“ feature
    • Similar to code editors (Atom, Sublime, etc.) / Spotlight on macOS
    • Considers
      • Local and remote library items
      • Local and remote articles
      • Menu items
      • Reading list items
      • Table of contents
  • Introduce ratings for contents in „store“
  • Reading mode, similar to Safari?
  • Enhanced filter capabilities
  • Customizable toolbar, possibly featuring an icon for
    • History
    • Favorites
    • Library
    • Tab overview
    • Zoom
    • Print
    • Settings
    • Display options:
  • Library list view: Lets users switch the view ↓
    • Question @Team: Do we need a list view of the books? I’ve added the iconography for list view to the mockups. I suggest to not go down that path for the first version but if you think Kiwix users might miss it, please intervene.
      • Emmanuel: Yes, only nice to have IMO. Card view should be good enough first. Lets try to implement not to many features, but the right ones... and properly.
  • Stéphane: Export a reading list so as to share it with nearby users. The discussion was about a teacher preparing a curriculum and sharing it with his/her many students
  • Customize Toolbar, e.g. drag and dropping icons
  • ZIM Extensions
    • Question @Team: I’m not quite sure yet how extensions will completely work yet but I envision a similar process as for the updates. Do you see any obstacles in treating extensions similar to updates? (from a design perspective, not technical)
      • Emmanuel: That seems to me the right approach. But we can not deal with that problem for 2.0. Too much work.
Clone this wiki locally