X-Git-Url: http://git.nikiroo.be/?p=fanfix.git;a=blobdiff_plain;f=docs%2Fandroid%2Fandroid.md;fp=docs%2Fandroid%2Fandroid.md;h=fab8e88a8f478ba70ffaf584461b420d08f1bb27;hp=5be4ac3dd0a8f322048bc0632f3a73e973cb7bfc;hb=9978a56a375a8f6f456f0bfc7d1124d9281eea49;hpb=76f58e5637fb3b329ce15d847987f24b9fdaf04d diff --git a/docs/android/android.md b/docs/android/android.md index 5be4ac3..fab8e88 100644 --- a/docs/android/android.md +++ b/docs/android/android.md @@ -44,7 +44,7 @@ Examples : ### Library (main screen) -[image] +![Main library](screens/main_lib.jpg) #### Header @@ -61,6 +61,10 @@ Title can vary upon the current displayed books: The navigation icon open the Navigation drawer. +##### Search + +![Search/Filter](screens/search.jpg) + The search icon is actually a filter: it will hide all the books that don't contain the given text (search on LUID, title and author). #### List @@ -80,16 +84,20 @@ This list will hold books. Each item will be represented by : Material.IO: -- Title, navigation icon, search icon : Header -- List : TODO: List? AdaptiveList? (I forgot the full name...) +- Title, navigation icon, search icon : [App bar top](https://material.io/design/components/app-bars-top.html) +- List : [Cards](https://material.io/design/components/cards.html) -A tap will open the target book. +A tap will open the target book in full-screen mode (i.e., the details about the card). -A long press will first "select" the book (visually alter it so the user know which book is the target) then open the context menu. +On the detailed card, you will see the description (see Description Page) and 3 buttons : + +- Open +- Delete +- "..." for a menu ### Navigation drawer -[Image] +![Navigation Drawer](screens/navigation.jpg) The navigation drawer will list 4 destinations: @@ -107,17 +115,17 @@ The navigation drawer will list 4 destinations: Those subpanels will either contain the sources/authors **or** sub-subpanels with sources/authors. See fanfix.jar (BasicLibrary.getSourcesGrouped() and BasicLibrary.getAuthorsGrouped()). +Note: if those last two cause problems, they can be removed; the first four options would be enough to cover the main use cases. + #### UI Material.IO: - Navigation drawer: navigation drawer -TODO: is it ok to have 3 levels of drawers? - ### Context menu -[image] +![Context Menu](screens/menu.jpg) The context menu options are as follow for stories: @@ -155,13 +163,13 @@ For other books (sources and authors): Material.IO: -- menu: menu +- menu: [menu](https://developer.android.com/guide/topics/ui/menus.html) -### Description page +The menu will NOT use sublevels but link to a [list](https://material.io/design/components/lists.html) instead. -[image-portrait] +### Description page -[image-landscape] +![Description Page](screens/desc.jpg) #### Header @@ -175,6 +183,8 @@ An example can be seen in be.nikiroo.fanfix.ui.GuiReaderViewerTextOutput.java. ### Options page +![Options Page](screens/options.jpg) + It consists of a "Remote Library" panel: - enable : an option to enable/disable the remote library (if disabled, use the local library instead) @@ -221,7 +231,7 @@ The program will have an internal viewer that will be able to display the 2 kind This is common to both of the viewer (this is **not** an architectural directives, I only speak about the concept here). -[image] +![Base Viewer](screens/viewer.jpg) #### Header @@ -243,11 +253,11 @@ It contains 4 action buttons (first, previous, next and last chapter) and the ti Matrial.IO: - Header : Header -- Navigator : Bottom sheet +- Navigator : [Sheets bottom](https://material.io/design/components/sheets-bottom.html) ### Text viewer -[image] +![Text Viewer](screens/viewer-text.jpg) It will contain the content of the current chapter (Story.getChapters().get(index - 1)). @@ -255,7 +265,7 @@ Same layout as the Properties page uses for the resume, with just a small differ ### Image viewer -[image] +![Image Viewer](screens/viewer-image.jpg) #### Image