Merge branch 'android' of git.nikiroo.be:git/fanfix into android android
authorNiki Roo <niki@nikiroo.be>
Tue, 9 Apr 2019 06:30:15 +0000 (08:30 +0200)
committerNiki Roo <niki@nikiroo.be>
Tue, 9 Apr 2019 06:30:15 +0000 (08:30 +0200)
docs/android/android.md
docs/android/screens/desc.jpg [new file with mode: 0755]
docs/android/screens/main_lib.jpg [new file with mode: 0755]
docs/android/screens/menu.jpg [new file with mode: 0755]
docs/android/screens/navigation.jpg [new file with mode: 0755]
docs/android/screens/options.jpg [new file with mode: 0755]
docs/android/screens/search.jpg [new file with mode: 0755]
docs/android/screens/viewer-image.jpg [new file with mode: 0755]
docs/android/screens/viewer-text.jpg [new file with mode: 0755]
docs/android/screens/viewer.jpg [new file with mode: 0755]

index 5be4ac3dd0a8f322048bc0632f3a73e973cb7bfc..fab8e88a8f478ba70ffaf584461b420d08f1bb27 100644 (file)
@@ -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
 
diff --git a/docs/android/screens/desc.jpg b/docs/android/screens/desc.jpg
new file mode 100755 (executable)
index 0000000..766b746
Binary files /dev/null and b/docs/android/screens/desc.jpg differ
diff --git a/docs/android/screens/main_lib.jpg b/docs/android/screens/main_lib.jpg
new file mode 100755 (executable)
index 0000000..e105824
Binary files /dev/null and b/docs/android/screens/main_lib.jpg differ
diff --git a/docs/android/screens/menu.jpg b/docs/android/screens/menu.jpg
new file mode 100755 (executable)
index 0000000..ea67163
Binary files /dev/null and b/docs/android/screens/menu.jpg differ
diff --git a/docs/android/screens/navigation.jpg b/docs/android/screens/navigation.jpg
new file mode 100755 (executable)
index 0000000..997cb32
Binary files /dev/null and b/docs/android/screens/navigation.jpg differ
diff --git a/docs/android/screens/options.jpg b/docs/android/screens/options.jpg
new file mode 100755 (executable)
index 0000000..b4ad836
Binary files /dev/null and b/docs/android/screens/options.jpg differ
diff --git a/docs/android/screens/search.jpg b/docs/android/screens/search.jpg
new file mode 100755 (executable)
index 0000000..f32257e
Binary files /dev/null and b/docs/android/screens/search.jpg differ
diff --git a/docs/android/screens/viewer-image.jpg b/docs/android/screens/viewer-image.jpg
new file mode 100755 (executable)
index 0000000..8f5c742
Binary files /dev/null and b/docs/android/screens/viewer-image.jpg differ
diff --git a/docs/android/screens/viewer-text.jpg b/docs/android/screens/viewer-text.jpg
new file mode 100755 (executable)
index 0000000..574f688
Binary files /dev/null and b/docs/android/screens/viewer-text.jpg differ
diff --git a/docs/android/screens/viewer.jpg b/docs/android/screens/viewer.jpg
new file mode 100755 (executable)
index 0000000..d8b130a
Binary files /dev/null and b/docs/android/screens/viewer.jpg differ