New TOC and Shelf icons for consistency, efficiency, and metadata editing

kathi-fletcher commented 10 years ago

Design: Consistent edit content/edit metadata/rename/delete icons

Design for making the icons in the bookshelf and toc consistent, functional, and efficient. Most of this issue should be implemented in bookish, and the text for the book parts in github-bookeditor.

Goals

Pick bootstrap icons to use
Have just two icons show up on each item.
Make the behavior consistent and predictable.
Make common activities doable with one click. a. Unfolding books and chapters to see inside them by clicking on the title. b. Opening books, chapters, and modules for editing by clicking on the arrow ->.
Provide a way to edit module and book metadata
Basic Design

Note that the mockup isn't exactly like the current editor. The shelf is called the picker in the mockups and various other differences. Anything unrelated to the icons should be ignored.

Step 1. Global design and variations checklist

[x] Find and add the icons that Max used. They are on mockup-toc-icons-06 I think.
[x] Move delete under the down arrow "v".
[x] Use new icons on everything in the shelf/workspace and in the TOC
[x] Use new menu icon on the Book title in the TOC so that we can rename the book or edit its metadata from there.
[x] Variation: Change "Edit description/authors" to "Edit authors, license, etc." to be consistent with the in-module metadata mechanism (on a separate issue).
Step 2. Book icons behavior
[ ] Hover over the down arrow opens a menu
[x] "Rename this book" inside the menu (down arrow)
[x] "Edit authors, license, etc." inside the menu
[x] "Delete this book" inside the menu
[x] Hover over the right arrow says "Go edit this book": (It says "Edit this " right now.)
[x] Clicking on the right arrow opens the book in the TOC and the first module of the book in the editor
[x] Clicking on the book title unfolds the book in the shelf and either does nothing, or opens the metadata editor, whichever is easier.
Step 3. Book division / folder icons behavior
[ ] Hover over the down arrow opens a menu
[x] "Rename this book division" inside the menu (down arrow) : Currently says "Rename this UNKNOWN_PRETTY_NAME"
[x] No metadata editing should show up
[x] "Delete this book division" inside the menu (down arrow) : Currently says "Rename this UNKNOWN_PRETTY_NAME"
[x] Hover over the right arrow says "Go edit this book division" : Currently says "Edit this UNKNOWN_PRETTY_NAME"
[x] Clicking on the right arrow in the shelf opens the book in the TOC and unfolds the selected division and opens the first module of the book division in the editor : Currently does open the book, and highlights the division, but it does not unfold the division, or open the first module for editing.
[ ] Clicking on the right arrow in the TOC unfolds the selected division and opens the first module of the book division in the editor
[x] Clicking on the book division title unfolds the book division in the picker and the TOC.
Step 4. Module icons behavior
[ ] Hover over the down arrow opens a menu
[x] "Rename this module" inside the menu (down arrow)
[x] "Edit authors, license, etc." inside the menu (down arrow) This may exist, but not on the branch I am testing.
[x] "Delete this module" inside the menu (down arrow)
[x] Hover over the right arrow says "Go edit this module" Almost, just missing the "Go"
[x] Clicking on the right arrow opens the book in the TOC and opens the module in the editor, unfolding whatever divisions are necessary : Currently this does not unfold the containing division, if the correct book was already open.
[x] Clicking on the module title (which looks like a link) opens the module for editing as described above. : This has the exact same problem about not unfolding the division, but works otherwise.

kathi-fletcher commented 10 years ago

To make retesting easier, I am copying just the remaining tasks here, so I know what to recheck.

Step 1. Global design and variations checklist

[x] Use new menu icon on the Book title in the TOC so that we can rename the book or edit its metadata from there.
[x] Variation: Change "Edit description/authors" to "Edit authors, license, etc." to be consistent with the in-module metadata mechanism (on a separate issue).

Step 2. Book icons behavior

[ ] DO AS A SECOND STAGE Hover over the down arrow opens a menu
[x] Hover over the right arrow says "Go edit this book": (It says "Edit this " right now.)

Step 3. Book division / folder icons behavior

[ ] DO AS A SECOND STAGE Hover over the down arrow opens a menu
[x] "Rename this book division" inside the menu (down arrow) : Currently says "Rename this UNKNOWN_PRETTY_NAME"
[x] "Delete this book division" inside the menu (down arrow) : Currently says "Rename this UNKNOWN_PRETTY_NAME"
[x] Hover over the right arrow says "Go edit this book division" : Currently says "Edit this UNKNOWN_PRETTY_NAME"
[x] Clicking on the right arrow in the shelf opens the book in the TOC and unfolds the selected division and opens the first module of the book division in the editor : Currently does open the book, and highlights the division, but it does not unfold the division, or open the first module for editing.
[ ] Clicking on the right arrow in the TOC unfolds the selected division and opens the first module of the book division in the editor

Step 4. Module icons behavior

[ ] DO AS A SECOND STAGE Hover over the down arrow opens a menu
[x] "Edit authors, license, etc." inside the menu (down arrow) This may exist, but not on the branch I am testing.
[x] Hover over the right arrow says "Go edit this module" Almost, just missing the "Go"
[x] Clicking on the right arrow opens the book in the TOC and opens the module in the editor, unfolding whatever divisions are necessary : Currently this does not unfold the containing division, if the correct book was already open.
[x] Clicking on the module title (which looks like a link) opens the module for editing as described above. : This has the exact same problem about not unfolding the division, but works otherwise.

kathi-fletcher commented 10 years ago

This didn't work for me. Everything else worked.

[ ] On a book division, clicking on the right arrow in the TOC unfolds the selected division and opens the first module of the book division in the editor
[x] Not sure exactly when this happened, but extra space got into the top of the bookshelf.

spacing-in-shelf-borked

oerpub / github-bookeditor